版本为3.0.5
|
Constants |
Top Previous Next |
These types can be used for the Type-parameter of the functions ScSetLongValue() and ScGetLongValue().
| scComSAMLightClientCtrlLongValueTypeNumMarksCompleted | = HEX 01 |
Returns the number of marks. Helpful in Mark Trigger mode.
| scComSAMLightClientCtrlLongValueTypeOptoIO | = HEX 04 |
This value can be used to set the Opto-IOs or to get the current input state of them.
The flag is related to the currently used pen. By default the FlagsSet is 0, following values can be set enabled.
| scComStandardDeviceEnableFlagGroupStyle | = 0 |
| scComStandardDeviceEnableFlagGroupOptoOut | = 1 |
Note: Only with scComSAMLightClientCtrlLongValueTypeDeviceEnableFlagsValue a value is set.
The flag is related to the currently used pen. Used to specify a constant of type scComStandardDeviceEnableFlagConstants that has to be set or get for the previously defined FlagsSet. Note: The flag has to be enabled with scComSAMLightClientCtrlLongValueTypeDeviceEnableFlagsSet before.
Enabled with scComStandardDeviceEnableFlagGroupStyle:
| scComStandardDeviceStyleFlagEnableLongDelay | = HEX 1 |
-> Enables Time delay between pen alternation
| scComStandardDeviceStyleFlagEnableWobble | = HEX 8 |
-> Enables Wobble
| scComStandardDeviceStyleFlagEnableYAGStandBy | = HEX 20 |
-> Enables YAG StandBy
| scComStandardDeviceStyleFlagEnablePixelOutput | = HEX 40 |
-> Sets Pixel Hardware Mode
| scComStandardDeviceStyleFlagEnablePort1 | = HEX 4 |
| scComStandardDeviceStyleFlagEnablePort2 | = HEX 80 |
| scComStandardDeviceStyleFlagEnableDA1 | = HEX 200 |
| scComStandardDeviceStyleFlagEnableDA2 | = HEX 400 |
| scComStandardDeviceStyleFlagEnableSkyWriting | = HEX 2000 |
-> Enables SkyWriting
Enabled with scComStandardDeviceEnableFlagGroupOptoOut:
-> Sets Opto Output Bits
| scComSAMLightClientCtrlLongValueTypeTotalEntityNum | = HEX 0A |
Using this type parameter it is possible to count the total number of available entities including the ones that are nested in groups.
| scComSAMLightClientCtrlLongValueTypeToplevelEntityNum | = HEX 0B |
This type parameter can be used together with ScGetLongValue() to evaluate the top level entities. That means using this value that number of entities is returned that is visible on the highest level, excluding the contents of groups.
| scComSAMLightClientCtrlLongValueTypeJobExecutionDelay | = HEX 0C |
This type can be used to get/set the global parameter "job execution delay", adjustable within the settings IO page. Unit is [ms].
| scComSAMLightClientCtrlLongValueTypeBufferQueueLength | = HEX 0E |
This value can be used to get and set the command queue that can be accessed using the command ScSetEntityLongData() together with the flag scComSAMLightClientCtrlStringDataIdFlagEnqueueCtrlCmd and scComSAMLightClientCtrlStringDataIdFlagEnqueueLastCtrlCmd (please see below). If it is used it returns the current fill state of the internal command queue. By using the set-command together with this option and together with the value 0 the internal command queue for buffered trigger mode job modifications is flushed completely and all enqueued commands are removed from it. Other values than 0 are not valid for the set-operation.
For some more information about the queue functionality please refer to the Examples section.
| scComSAMLightClientCtrlLongValueTypeQuantity | = HEX 05 |
Gets or sets the current quantity if the quantity counter is enabled
| scComSAMLightClientCtrlLongValueTypeMaxQuantity | = HEX 0F |
Gets or sets the current maximum quantity after that an message has to open. When a value of -1 is set the quantity counter functionality is disabled.
| scComSAMLightClientCtrlLongValueTypeOverridePen | = HEX 10 |
Axis value: 0 to 4, or -1 for all axis.
Value: 0 or 1, 1 defines that application waits till motion finished, with 0 application comes back immidiately.Default value is 1.
| scComSAMLightClientCtrlLongValueTypeMotionMoving | = HEX 13 |
Returns motion state of motion defined with scComSAMLightClientCtrlLongValueTypeMotionAxis.
| scComSAMLightClientCtrlLongValueTypeLineRampingPowerStartRampActive | = HEX 16 |
| scComSAMLightClientCtrlLongValueTypeLineRampingPowerEndRampActive | = HEX 17 |
| scComSAMLightClientCtrlLongValueTypeLineRampingSpeedStartRampActive | = HEX 18 |
| scComSAMLightClientCtrlLongValueTypeLineRampingSpeedEndRampActive | = HEX 19 |
These constants return and set the ramping flags of the current selected pen. See also ScSetPen() and ScGetPen() functions.
-scComSAMLightClientCtrlLongValueTypeAngularSplittingParts = HEX 21
These types can be used for the Type-parameter of the functions ScSetDoubleValue() and ScGetDoubleValue().
| scComSAMLightClientCtrlDoubleValueTypeOverrideSpeed | = 1 |
| scComSAMLightClientCtrlDoubleValueTypeOverridePower | = 2 |
| scComSAMLightClientCtrlDoubleValueTypeOverrideFrequ | = 3 |
| scComSAMLightClientCtrlDoubleValueTypeOverridePower2 | = 22 |
These constants can be used to define override-values for marking speed, power and frequency.
| scComSAMLightClientCtrlDoubleValueTypeMarkSpeed | = 4 |
| scComSAMLightClientCtrlDoubleValueTypeJumpSpeed | = 5 |
| scComSAMLightClientCtrlDoubleValueTypeFrequency | = 6 |
| scComSAMLightClientCtrlDoubleValueTypeJumpDelay | = 7 |
| scComSAMLightClientCtrlDoubleValueTypeMarkDelay | = 8 |
| scComSAMLightClientCtrlDoubleValueTypePolyDelay | = 9 |
| scComSAMLightClientCtrlDoubleValueTypeLaserOnDelay | = 10 |
| scComSAMLightClientCtrlDoubleValueTypeLaserOffDelay | = 11 |
| scComSAMLightClientCtrlDoubleValueTypeScannerXPos | = 12 |
| scComSAMLightClientCtrlDoubleValueTypeScannerYPos | = 13 |
| scComSAMLightClientCtrlDoubleValueTypeScannerZPos | = 14 |
| scComSAMLightClientCtrlDoubleValueTypePulseLength | = 15 |
| scComSAMLightClientCtrlDoubleValueTypeFirstPulseLength | = 16 |
| scComSAMLightClientCtrlDoubleValueTypeLaserPower | = 17 |
| scComSAMLightClientCtrlDoubleValueTypeSizePowerMap | = 18 |
| scComSAMLightClientCtrlDoubleValueTypeMaxPower | = 20 |
| scComSAMLightClientCtrlDoubleValueTypeLineRampingPowerStartRampValue | = 26 |
| scComSAMLightClientCtrlDoubleValueTypeLineRampingPowerStartRampLength | = 27 |
| scComSAMLightClientCtrlDoubleValueTypeLineRampingPowerEndRampValue | = 28 |
| scComSAMLightClientCtrlDoubleValueTypeLineRampingPowerEndRampLength | = 29 |
| scComSAMLightClientCtrlDoubleValueTypeLineRampingSpeedStartRampValue | = 30 |
| scComSAMLightClientCtrlDoubleValueTypeLineRampingSpeedStartRampLength | = 31 |
| scComSAMLightClientCtrlDoubleValueTypeLineRampingSpeedEndRampValue | = 32 |
| scComSAMLightClientCtrlDoubleValueTypeLineRampingSpeedEndRampLength | = 33 |
| scComSAMLightClientCtrlDoubleValueTypeSkyWritingStartLength | = 35 |
| scComSAMLightClientCtrlDoubleValueTypeSkyWritingEndLength | = 36 |
| scComSAMLightClientCtrlDoubleValueTypeSkyWritingBreakAngle | = 37 |
| scComSAMLightClientCtrlDoubleValueTypeHalfPeriod | = 43 |
| scComSAMLightClientCtrlDoubleValueTypeLaserCo2Power1 | = 48 |
| scComSAMLightClientCtrlDoubleValueTypeLaserCo2Power2 | = 49 |
Angle in rad; these constants return and set the corresponding values of the current selected pen. See also ScSetPen() and ScGetPen() functions.
| scComSAMLightClientCtrlDoubleValueTypeLastExpectedMarkTime | = 34 |
Returns the expected marking time. It can be used in combination with a previous mark operation in preview mode. See sample.
| scComSAMLightClientCtrlDoubleValueTypeLastMarkTime | = 21 |
This value is not pen-specific, it can be used to evaluate the time that was needed for the last marking operation. The unit is seconds.
| scComSAMLightClientCtrlDoubleValueTypeHomePosX | = 23 |
| scComSAMLightClientCtrlDoubleValueTypeHomePosY | = 24 |
| scComSAMLightClientCtrlDoubleValueTypeHomePosZ | = 25 |
Get and set the home position.
| scComSAMLightClientCtrlDoubleValueTypeMotionAxisPositionRelative | = 40 |
| scComSAMLightClientCtrlDoubleValueTypeMotionAxisAngleRelative | = 41 |
| scComSAMLightClientCtrlDoubleValueTypeMotionAxisSpeed | = 42 |
These constants are motion drive related values.
Sets resolution for bitmap to be taken from view.
| scComSAMLightClientCtrlDoubleValueTypeGainX | = 46 |
| scComSAMLightClientCtrlDoubleValueTypeGainY | = 47 |
Using these constants the gain X and gain Y correction factor of the optic can be set and get
scComSAMLightClientCtrlDoubleValueTypeAngularSplittingTotalDiameter = 50
scComSAMLightClientCtrlDoubleValueTypeAngularSplittingAngle = 51
Using these constants the Diameter and Angle for the Splitting Mode can be set and get.
scComSAMLightClientCtrlDoubleValueTypeHorizontalSplittingValue =52
scComSAMLightClientCtrlDoubleValueTypeVerticalSplittingValue =53
Using these constants the Horizontal and Vertical split size for the Splitting Mode can be set and get.
scComSAMLightClientCtrlDoubleValueTypeWobbleFrequency = 54
scComSAMLightClientCtrlDoubleValueTypeWobbleAmplitude = 55
Using these constants the Frequency and Amplitude for the Wobble Mode can be set and get.
scComSAMLightClientCtrlDoubleValueTypeStartSplittingPosX =56
scComSAMLightClientCtrlDoubleValueTypeStartSplittingPosY =57
Using these constants a start value for the first and second axis in splitting mode can be set and get.
scComSAMLightClientCtrlDoubleValueTypeOffsetX =58
scComSAMLightClientCtrlDoubleValueTypeOffsetY =59
Using these constants the offset X and offset Y correction factor of the optic can be set and get
The following types can be used for the Type-parameter of the functions ScSetStringValue() and ScGetStringValue().
| scComSAMLightClientCtrlStringValueTypeJobFileName | = 4 |
Returns the current loaded Job file name with the complete path
| scComSAMLightClientCtrlStringValueTypeSaveView2D160 | = 6 |
| scComSAMLightClientCtrlStringValueTypeSaveView2D320 | = 7 |
| scComSAMLightClientCtrlStringValueTypeSaveView2DFull | = 9 |
These types can be used to create a screenshot from the main view and all contained entities. The filename where to save the captured BMP-file is given as string parameter. The several command types differ only in the maximum picture size (width or height) the bitmap file is created with: 160 pixels, 320 pixels or the full, not scaled size. To let this function work successfully it has to be made sure that the main window of the controlled scanner application is visible and not hidden by something else. So the window can't be minimized and no screensaver should be active.
| scComSAMLightClientCtrlStringValueTypeControlCmdCW300 | = 50 |
The control command constant above has to be used to access a separate laser controller using an additional command string as value. For a detailed description on how to use these commands and how to access the specific controller, please refer to the specification that should be delivered together with the control. (sc_ht_use_the_CW300_rs232.pdf). This control command constant is valid only for the functions ScSetStringValue(), ScSetStringLongValue(), ScSetStringDblValue() and ScGetStringDblValue().
Defines string for send as RS232 string to the port defined within motion settings.
| scComSAMLightClientCtrlStringValueTypeSaveView2DAdjustableDPI | = 12 |
Creates a bitmap holding the working area and saves the bitmap file into given path. The Resolution is set with ScSetDoubleValue() and Value Type scComSAMLightClientCtrlDoubleValueTypeSaveView2DBitmapDPI.
| scComSAMLightClientCtrlStringValueTypeCorrectionFile | = 13 |
Using this constant a new correction file name can be set or the current one can be fetched.
| scComSAMLightClientCtrlStringValueTypeGetLastErrorMessageInput | = 14 |
| scComSAMLightClientCtrlStringValueTypeGetLastInfoMessageInput | = 15 |
Using these constants it is possible to get the last error or info message that can be set via Settings->System->IO->Message Inputs for the input Bits of the used scanner card.
The following is a list of valid DataIds for the function ScSetEntityLongData() and ScGetEntityLongData().
| scComSAMLightClientCtrlLongDataIdFlagDontUpdateView | = HEX 10000 |
If this bit is set, the view will not be refreshed. This can be helpful for increasing performance.
| scComSAMLightClientCtrlLongDataIdFlagDontUpdateEntity | = HEX 20000 |
If this bit is set, the entity will not be regenerated and updated. This can be helpful for increasing performance.
| scComSAMLightClientCtrlStringDataIdFlagEnqueueCtrlCmd | = HEX 80000 |
| scComSAMLightClientCtrlStringDataIdFlagEnqueueLastCtrlCmd | = HEX 100000 |
These flags can be used only when marking in triggered mode with the USC-1 internal buffering is enabled. They cause the application not to execute the related command immediately but to put them into a queue. This queue of commands then is executed without any feedback after one entity was marked due to an external trigger signal. Here all commands sent with scComSAMLightClientCtrlStringDataIdFlagEnqueueCtrlCmd are executed for the same trigger signal as long as the flag scComSAMLightClientCtrlStringDataIdFlagEnqueueLastCtrlCmd is used. That means every sequence of calls to ScSetEntityLongData() finished with scComSAMLightClientCtrlStringDataIdFlagEnqueueLastCtrlCmd using these flags causes modifications of the job per trigger signal. This flag is useful for very fast modifications of a job in triggered/buffered operation mode.
If this flag is set the return value of the appropriate set-function specifies if the command could be added to the queue successfully or if the queue is full. For the last case the function has to be called again using the same parameters after some time.
For some more information about the queue functionality please refer to the Examples section.
| scComSAMLightClientCtrlLongDataIdFlagToplevelOnly | = HEX 200000 |
If this bit is set, it will be only searched for entities in first level of the job. This can be helpful for increasing performance.
| scComSAMLightClientCtrlLongDataIdUserData | = 1 |
The parameter Data then contains a long value with the data to store inside the entity.
| scComSAMLightClientCtrlLongDataIdTextAlignment | = 2 |
The parameter Data then contains a long value with the alignment flag fields with the following possible values:
| scComSAMLightClientCtrlTextAlignmentCenter | = HEX 1 |
| scComSAMLightClientCtrlTextAlignmentLeft | = HEX 2 |
| scComSAMLightClientCtrlTextAlignmentRight | = HEX 4 |
| scComSAMLightClientCtrlTextAlignmentTop | = HEX 8 |
| scComSAMLightClientCtrlTextAlignmentBottom | = HEX 10 |
| scComSAMLightClientCtrlTextAlignmentMiddle | = HEX 20 |
| scComSAMLightClientCtrlTextAlignmentRadialCenter | = HEX 40 |
| scComSAMLightClientCtrlTextAlignmentRadialEnd | = HEX 80 |
| scComSAMLightClientCtrlTextAlignmentLineLeft | = HEX 100 |
| scComSAMLightClientCtrlTextAlignmentLineRight | = HEX 200 |
| scComSAMLightClientCtrlTextAlignmentLineCenter | = HEX 400 |
| scComSAMLightClientCtrlLongDataIdEntitySelected | = 3 |
This function can be used to change the selection state of entities or to get information whether the entity is selected. The parameter Data has to be 0 or 1.
| scComSAMLightClientCtrlLongDataIdEntityArrayCountX | = 4 |
This function can be used to change the array x count value of the entity.
The parameter date
| scComSAMLightClientCtrlLongDataIdEntityArrayCountY | = 5 |
This function can be used to change the array y count value of the entity.
| scComSAMLightClientCtrlLongDataIdEntityArrayStepX | = 6 |
This function can be used to change the array x step value of the entity. The unit factor of the long value is 0.001.
| scComSAMLightClientCtrlLongDataIdEntityArrayStepY | = 7 |
This function can be used to change the array y step value of the entity. The unit factor of the long value is 0.001.
| scComSAMLightClientCtrlLongDataIdEntityArrayOrderFlags | = 8 |
This function can be used to change the output order of the array. The parameter Data then contains a flag field with a combination out of the following values:
| scComSAMLightClientCtrlEntityArrayOrderFlagMainDirX | = HEX 400 |
Use X as the main direction for array copying
| scComSAMLightClientCtrlEntityArrayOrderFlagNegX | = HEX 100 |
Go from left to right in horizontal direction if this flag is set, elsewhere go from right to left
| scComSAMLightClientCtrlEntityArrayOrderFlagNegY | = HEX 200 |
Go from top to bottom in vertical direction, from bottom to top elsewhere
| scComSAMLightClientCtrlEntityArrayOrderFlagBiDir | = HEX 800 |
Use bi-directional mode (horizontal), that means array copy is done into one direction and back instead of using only one direction, jump back and start from the beginning using the same direction again
The parameter Data then contains a long value with the char flag fields with the following possible values:
| scComSAMLightClientCtrlLongDataIdTextCharFlagItalic | = HEX 10000 |
| scComSAMLightClientCtrlLongDataIdTextCharFlagRadial | = HEX 20000 |
| scComSAMLightClientCtrlLongDataIdTextCharFlagRadialAlignToCharOutline | = HEX 40000 |
| scComSAMLightClientCtrlLongDataIdTextCharFlagReverseOrder | = HEX 80000 |
| scComSAMLightClientCtrlLongDataIdTextCharFlagMirrorCharOnXAxis | = HEX 100000 |
| scComSAMLightClientCtrlLongDataIdTextCharFlagMirrorCharOnYAxis | = HEX 200000 |
| scComSAMLightClientCtrlLongDataIdTextCharFlagSwapLines | = HEX 400000 |
| scComSAMLightClientCtrlLongDataIdTextCharFlagSetToLimitLength | = HEX 800000 |
| scComSAMLightClientCtrlLongDataIdTextCharFlagSetToLimitHeight | = HEX 1000000 |
| scComSAMLightClientCtrlLongDataIdTextCharFlagSetToLimitKeepAspect | = HEX 2000000 |
This DataId is used for manipulating a named bitmap. Please note the scanner bitmap is created after every call to ScSetEntityLongData() as long as the flag scComSAMLightClientCtrlDoubleDataIdFlagDontUpdateEntity is not set. On the other hand the scanner bitmap isn't created if brightness, ditherstep or intensity are modified, here in every case setting the flags is required.
The Data that can be set with this DataId correspond to the functionality of the bitmap property page:
| scComSAMLightClientCtrlLongDataIdBitmapModeInvert | = HEX 0001 |
| scComSAMLightClientCtrlLongDataIdBitmapModeGreyscale | = HEX 0002 |
| scComSAMLightClientCtrlLongDataIdBitmapModeDrillmode | = HEX 0004 |
| scComSAMLightClientCtrlLongDataIdBitmapModeBidirectional | = HEX 0008 |
| scComSAMLightClientCtrlLongDataIdBitmapModeStartlastline | = HEX 0010 |
| scComSAMLightClientCtrlLongDataIdBitmapModeNolineincr | = HEX 0020 |
-> No increment of line position
The following two Data-flags define what bitmap has to be displayed into the view. If none of them is set, nothing will be shown and the imported bitmap will disappear.
| scComSAMLightClientCtrlLongDataIdBitmapModeShowBitmap | = HEX 0100 |
| scComSAMLightClientCtrlLongDataIdBitmapModeShowScanner | = HEX 0200 |
| scComSAMLightClientCtrlLongDataIdTextWeight | = 50 |
Using this DataId the style of a text can be modified. Please note: for an italic style refer to data values of the scComSAMLightClientCtrlLongDataIdTextCharFlags DataId. For the weight following Data constants are defined:
| scComCharWeightThin | = 100 |
| scComCharWeightExtraLight | = 200 |
| scComCharWeightLight | = 300 |
| scComCharWeightNormal | = 400 |
| scComCharWeightMedium | = 500 |
| scComCharWeightSemiBold | = 600 |
| scComCharWeightBold | = 700 |
| scComCharWeightExtraBold | = 800 |
| scComCharWeightHeavy | = 900 |
| scComSAMLightClientCtrlLongDataIdEnableHatching2 | = 52 |
Using these DataIds the both hatchers can be enabled or disabled or the actual enabling state can be retrieved. Disabling is done by setting the appropriate Data field to 0. A value not equal 0 defines the hatching mode, here following values are possible:
1 - wavy line without marking the jumps
2 - horizontal left to right without marking the jumps
3 - horizontal right to left without marking the jumps
4 - rotational, applies only to rectangle, ellipse and triangle structures in the current version
5 - wavy line including the jumps
6 - zigzag
| scComSAMLightClientCtrlLongDataIdEntityMarkLoopCount | = 55 |
This function can be used to change the mark loop count value of the entity.
| scComSAMLightClientCtrlLongDataIdEntityMarkBeatCount | = 56 |
This function can be used to change the mark beat count value of the entity.
| scComSAMLightClientCtrlLongDataIdEntityMarkStartCount | = 57 |
This function can be used to change the mark start count value of the entity.
| scComSAMLightClientCtrlLongDataIdEntitySetPen | = 60 |
The adjusted pen number of an entity can be changed.
| scComSAMLightClientCtrlLongDataIdEntitySetTimerValue | = 61 |
Using this constant the time value of a ScTimer object can be changed. The unit for the related long-value is milliseconds.
| scComSAMLightClientCtrlLongDataIdEntitySetInOutValue | = 62 |
Here a new bit can be set for a ScSetOutput entity to set an output or for a ScWaitForInput entity to wait for a signal on the related input. Please note: the long value that is handed over together with this constant can't be a combination of several bits, here exactly one has to be defined, values with more than one bit or with no bit set are not allowed and may lead to undefined results.
| scComSAMLightClientCtrlLongDataIdEntitySetOutputPulse | = 64 |
Using this parameter a time for an ScSetOutput entities output pulse can be defined. A long-value that is greater than 0 enables the output pulse functionality and sets this value (in unit milliseconds), if a value of -1 is handed over the output pulse is disabled and the value specified using scComSAMLightClientCtrlLongDataIdEntitySetInOutValue and scComSAMLightClientCtrlLongDataIdEntitySetInOutLevel is set as long as it isn't replaced by an other one.
| scComSAMLightClientCtrlLongDataIdEntitySetInOutLevel | = 65 |
The entities ScSetOutput and ScWaitForInput may act on different signal levels. Using this constant that level can be defined: setting it to 0 means a low signal is set to the output pin or a low-level will be expected at the input defined with scComSAMLightClientCtrlLongDataIdEntitySetInOutValue. If a 1 is set as long-value a high-signal is set or expected. Other values than 0 for low and 1 for high aren't allowed here.
| scComSAMLightClientCtrlLongDataIdEntityGetTimerValue | = 66 |
Here the current delay time of the ScTimerentity is read.
| scComSAMLightClientCtrlLongDataIdEntityGetInOutValue | = 67 |
Using this constant the bit can be read that will be set by the related ScSetOutput entity or the related ScWaitForInput will wait for.
| scComSAMLightClientCtrlLongDataIdEntityGetOutputPulse | = 69 |
If there is an output pulse value defined for a ScSetOutput entity using this constant its long value can be read. If the output pulse feature is disabled for thie entity, -1 is returned.
| scComSAMLightClientCtrlLongDataIdEntityGetInOutLevel | = 70 |
The ScSetOutput and ScWaitForInput entities can act or react on a definable level "low" or "high". Using this constant the current configuration of the entity can be evaluated, if a 1 is returned the entity uses a high-signal, in case of a 0, the low-signal is used.
| scComSAMLightClientCtrlLongDataIdEntitySerialStartValue | = 71 |
Get / Set the start value of a serial number, this value is used after a serial number is reset.
| scComSAMLightClientCtrlLongDataIdEntitySerialIncrValue | = 72 |
Get / Set the increment value for a serial number object.
| scComSAMLightClientCtrlLongDataIdEntitySerialCurrValue | = 73 |
Get the current (actual) value for a serial number.
| scComSAMLightClientCtrlLongDataIdEntityGetPen | = 74 |
The pen number of the specified entity can be retrieved.
| scComSAMLightClientCtrlLongDataIdEntityOpticFlags | = 75 |
This function can be used for changing the Mark Contour and the Mark Hatch flags of an object.
The parameter is a bitfield defining which flags to set:
| scComSAMLightClientCtrlLongDataIdEntityOpticFlagContour | = HEX 1 |
| scComSAMLightClientCtrlLongDataIdEntityOpticFlagHatch | = HEX 2 |
The following is a list of valid DataIds for the function ScSetEntityDoubleData() and ScGetEntityDoubleData()
| scComSAMLightClientCtrlDoubleDataIdFlagDontUpdateView | = HEX 10000 |
If this bit is set, the view will not be refreshed. This can be helpful for increasing performance.
If this bit is set, the entity will not be regenerated and updated. This can be helpful for increasing performance.
| scComSAMLightClientCtrlDoubleDataIdFlagToplevelOnly | = HEX 40000 |
If this bit is set, it will be only searched for entities in first level of the job. This can be helpful for increasing performance.
| scComSAMLightClientCtrlDoubleDataIdTextSize | = 1 |
The parameter data contains the size of the text.
| scComSAMLightClientCtrlDoubleDataIdTextCharSpacing | = 2 |
Change the strings char spacing. 1 equals 100%.
| scComSAMLightClientCtrlDoubleDataIdTextLengthLimit | = 3 |
Change the length limit of the text object.
| scComSAMLightClientCtrlDoubleDataIdTextHeightLimit | = 4 |
Change the height limit of the text object.
| scComSAMLightClientCtrlDoubleDataIdTextRadius | = 5 |
Change the radius of a radial text.
| scComSAMLightClientCtrlDoubleDataIdTextStartAngle | = 6 |
Change the start angle of a radial text. Unit: Rad.
| scComSAMLightClientCtrlDoubleDataIdBitmapIntensity | = 33 |
Changes the intensity of the related bitmap but doesn't re-creates the appropriate scanner bitmap. Please refer to the bitmap mode flags for more information.
| scComSAMLightClientCtrlDoubleDataIdBitmapBrightness | = 34 |
Changes the brightness of the related bitmap but doesn't re-creates the appropriate scanner bitmap. Please refer to the bitmap mode flags for more information.
| scComSAMLightClientCtrlDoubleDataIdBitmapDitherstep | = 35 |
Changes the rasterization size of the scanner bitmap but doesn't re-creates it immediately. The recreation is done by setting the required bitmap mode flags.
| scComSAMLightClientCtrlDoubleDataIdTextOrientation | = 36 |
Changes the orientation of a text. With a parameter of 0 for the Data field of ScSetEntityDoubleData() it is oriented in horizontal size, when a value of PI/2 is handed over, it is displayed vertical.
The following constants define hatching-related values. Please note: Some of them depend on the hatching mode selected using the scComSAMLightClientCtrlLongDataIdEnableHatching constants.
| scComSAMLightClientCtrlDoubleDataIdHatchDistance1 | = 37 |
| scComSAMLightClientCtrlDoubleDataIdHatchDistance2 | = 45 |
Modifies or retrieves the hatch distance for the hatcher number one/two.
| scComSAMLightClientCtrlDoubleDataIdHatchAngle1 | = 38 |
| scComSAMLightClientCtrlDoubleDataIdHatchAngle2 | = 46 |
Using this DataId the hatch angle for the first/second hatch can be get or set. Please note: the angle has to be specified in radians!
| scComSAMLightClientCtrlDoubleDataIdHatchMinjump1 | = 39 |
| scComSAMLightClientCtrlDoubleDataIdHatchMinjump2 | = 47 |
Hatch minimal jump value for hatch one/two
| scComSAMLightClientCtrlDoubleDataIdHatchStartoffset1 | = 40 |
| scComSAMLightClientCtrlDoubleDataIdHatchStartoffset2 | = 48 |
The hatching start offset value for the first/second hatcher
| scComSAMLightClientCtrlDoubleDataIdHatchLinereduct1 | = 41 |
| scComSAMLightClientCtrlDoubleDataIdHatchLinereduct2 | = 49 |
Specifies the amount of line reduction for the hatcher number one/two
| scComSAMLightClientCtrlDoubleDataIdHatchEndoffset1 | = 42 |
| scComSAMLightClientCtrlDoubleDataIdHatchEndoffset2 | = 50 |
The hatching end offset value for the first/second hatcher
| scComSAMLightClientCtrlDoubleDataIdHatchBeamcompensation1 | = 43 |
| scComSAMLightClientCtrlDoubleDataIdHatchBeamcompensation2 | = 51 |
Hatch beam compensation value for hatch one/two
scComSAMLightClientCtrlDoubleDataIdHatchNumloops1 =44
scComSAMLightClientCtrlDoubleDataIdHatchNumloops2 =52
Number of hatch loops for the hatch one/two
| scComSAMLightClientCtrlDoubleDataIdBarcodeLinereduction | = 69 |
The bar code line reduction value in percent for reducing the size of a bar code line.
The following is a list of valid DataIds for the function ScSetEntityStringData(), ScGetEntityStringData() and other string-related functions. These DataIds are splitted into two parts: the first one - here marked with a "HEX" can be used for OR-concatenating the parameter that is handed over to ScSetEntityStringData() and influence the behavior of the set method when the operation is performed that is specified by the second part of values. These second values that populate the lower 16 bit of the parameter DataId aren't organized as a flagset and therefore can't be OR-concatenated, here one of them has to be used exclusively.
| scComSAMLightClientCtrlStringDataIdFlagDontUpdateView | = HEX 10000 |
If this bit is set in the upper 16 bit of the parameter DataID, the view will not be refreshed. This can be helpful for increasing performance.
| scComSAMLightClientCtrlStringDataIdFlagDontUpdateEntity | = HEX 20000 |
If this bit is set in the upper 16 bit of the parameter DataID, the entity will not be regenerated and updated. This can be helpful for increasing performance.
| scComSAMLightClientCtrlStringDataIdFlagToplevelOnly | = HEX 200000 |
If this bit is set, it will be only searched for entities in first level of the job. This can be helpful for increasing performance.
| scComSAMLightClientCtrlStringDataIdTextFontName | = 1 |
The parameter data contains the font name.
| scComSAMLightClientCtrlStringDataIdTextText | = 2 |
The parameter data contains the string of the text object.
| scComSAMLightClientCtrlStringDataIdGetToplevelEntity | = 17 |
This value can be used together with the function SCGetIDStringData() to get the name of an entity that is specified by a zero based index number.
| scComSAMLightClientCtrlStringDataIdSetBarcodeType | = 19 |
Using this value a barcode object of type ScBarCode12Chars2D can be modified, together with a call to ScSetEntityStringData() a new barcode type can be specified and set for that object. The string parameter the function expects is the name of the barcode type, there for an example "EAN" or "I-2/5" can be used. This value can be combined with the flags for the upper 16 bit like described above.
| scComSAMLightClientCtrlStringDataIdGetBarcodeType | = 20 |
This value can be used to retrieve the type name of a ScBarCode12Chars2D. After it doesn't modifies the displayed barcode the upper 16 bits are ignored, so the view-flags don't have any influence on an appropriate call to ScGetEntityStringData().
| scComSAMLightClientCtrlStringDataIdGetEntityName | = 21 |
Type to retrieve name of an entity by index. The index is zero based and starts from top level going through the tree on the base of the first object, going on with the siblings.
| scComSAMLightClientCtrlStringDataIdGetEntityType | = 22 |
Type to retrieve type of an entity by index. The index is zero based and starts from top level going through the tree on the base of the first object, going on with the siblings.
Constants for Function call ScExecCommand().
| scComSAMLightClientCtrlExecCommandTest | = 1 |
Pops up a message box within SAMLight. Can be used for checking the communication between the applications.
| scComSAMLightClientCtrlExecCommandResetSequence | = 2 |
Resets the marking sequence to initial state. This is important for jobs using the beat count and beat offset parameters.
| scComSAMLightClientCtrlExecCommandNewJob | = 3 |
Deletes the current job.
| scComSAMLightClientCtrlExecCommandFitViewToWorkingArea | = 4 |
Fit the view to the working area.
| scComSAMLightClientCtrlExecCommandFitViewToAllEntities | = 5 |
Fit the view to all entities in the job.
| scComSAMLightClientCtrlExecCommandFitViewToSelectedEntities | = 6 |
Fit the view to the selected entities in the job.
| scComSAMLightClientCtrlExecCommandResetCounter | = 7 |
Resets the mark quantity counter, see chapter Mark Status Bar.
| scComSAMLightClientCtrlExecCommandResetSerialNumber | = 8 |
Resets serial number.
| scComSAMLightClientCtrlExecCommandAutoCompensateOff | = 10 |
Scanner auto-calibration functionality (works only with hardware that supports it): turn auto calibration mode off
| scComSAMLightClientCtrlExecCommandAutoCompensateRef | = 11 |
Scanner auto-calibration functionality (works only with hardware that supports it): turn auto calibration mode on and go to reference position for initial calibration
| scComSAMLightClientCtrlExecCommandAutoCompensateCal | = 12 |
Scanner auto-calibration functionality (works only with hardware that supports it): recalibrate
| scComSAMLightClientCtrlExecCommandResplitJob | = 13 |
Resplit a job that is in splitting mode and was modified so that the splitted data have to be updated by this option.
| scComSAMLightClientCtrlExecCommandMotionStopMove | = 14 |
Stops motions which are defined with scComSAMLightClientCtrlLongValueTypeMotionAxis
| scComSAMLightClientCtrlExecCommandMotionHome | = 15 |
Calls home for motions which are defined with scComSAMLightClientCtrlLongValueTypeMotionAxis
| scComSAMLightClientCtrlExecCommandMotionGo | = 16 |
Executes movement for motions which are defined with scComSAMLightClientCtrlLongValueTypeMotionAxis. Thereby Value scComSAMLightClientCtrlLongValueTypeMotionWaitForEnd is taken into account. Position gets defined with scComSAMLightClientCtrlDoubleValueTypeMotionAxisPosition or rather scComSAMLightClientCtrlDoubleValueTypeMotionAxisAngle according the motion settings. Before sending a new scComSAMLightClientCtrlExecCommandMotionGo command it is important to wait until the last drive has stopped. See example Motion Control in the Examples section.
Sends RS232 string to the port defined within motion settings. The string is empty by default and can be defined with scComSAMLightClientCtrlStringValueTypeMotionString.
| scComSAMLightClientCtrlExecCommandMotionUpdatePos | = 18 |
Asks motion drive for current stored position, motion number gets defined with scComSAMLightClientCtrlLongValueTypeMotionAxis.
| scComSAMLightClientCtrlExecCommandStopExecution | = 19 |
Stops execution: If scComSAMLightClientCtrlMarkFlagWaitForTrigger is set with ScSetMarkFlags and mark is called with ScMarkEntityByName, the trigger mark dialog opens. Stop execution closes the trigger mark dialog and disables trigger mode. This is necessary for example if job is edited and new data need to be given to scanner card, then the trigger mode needs to be stopped and mark started again.
| scComSAMLightClientCtrlExecCommandRedPointerStart | = 20 |
Starts red pointer with the settings set at Redpointer in the mark dialog.
| scComSAMLightClientCtrlExecCommandRedPointerStop | = 21 |
Stops red pointer.
| scComSAMLightClientCtrlExecCommandUpdateViewNow | = 22 |
Refreshes the view. Redraws all entities even if flag mode scComSAMLightClientCtrlModeFlagDontUpdateView is set.
| scComSAMLightClientCtrlExecCommandIncSerialNumber | = 23 |
Increment all serial numbers in the job.
| scComSAMLightClientCtrlExecCommandDecSerialNumber | = 24 |
Decrement all serial numbers in the job.
