DLL Function

int CCI_Return = ScSetStringValue(int Value_Type, string Path)

int CCI_Return = ScGetStringValue(int Value_Type, ref string Path)

ASCII Function

int CCI_Return = ScCciSetStringValue(int Value_Type, string Path)

string Path = ScCciGetStringValue(int Value_Type)

Description

Set or get the path of the required correction file.

Value_Type

Type: int

ID:

Location: ScComSAMLightClientCtrlValueTypes

scComSAMLightClientCtrlStringValueTypeCorrectionFile

13

Set a new correction file or get the path of the current correction file.

scComSAMLightClientCtrlStringValueTypeCorrectionFileHead2

23

Set a new correction file or get the path of the current correction file on Head 2.

scComSAMLightClientCtrlStringValueTypeCorrectionFileLcf

29

Using this constant a new correction file can be set or the current path of the correction file can be get. If a *.lcf file exists with the same name and in the same folder as the *.ucf file the lens parameters will be applied as well. If more than one scanhead is to be operated, the head number has to be specified with ScSetHead first. It is not possible to call this constant during marking.

scComSAMLightClientCtrlStringValueTypeCorrectionFileLcfLensInit

30

Using this constant a new correction file can be set or the current path of the correction file can be get. If a *.lcf file exists with the same name and in the same folder as the *.ucf file the lens parameters will be applied as well. If a *.sjf file exists with the same name and in the same folder as the *.ucf file the Lens Init Job will be executed as well. If more than one scanhead is to be operated, the head number has to be specified with ScSetHead first. It is not possible to call this constant during marking.

Path

Type: string

Unit: none

The directory path of the correction file.

CCI_Return

Type: int

CCI error number, see error list.

Notes

-

C# Example: Set correction file:

int CCI_Return = cci.ScSetStringValue((int)ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlStringValueTypeCorrectionFile, "C:\\correctionfile.ucf");

C# Example: Get path of correction file:

string Corr_File = "";

int CCI_Return = cci.ScGetStringValue((int)ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlStringValueTypeCorrectionFile, ref Corr_File);

DLL Function

double Parameter = ScGetDoubleValue(int Value_Type)

ASCII Function

double Parameter = ScGetDoubleValue(int Value_Type)

Description

Get the field size in sc_setup.exe.

Value_Type

Type: int

ID:

Location: ScComSAMLightClientCtrlValueTypes

scComSAMLightClientCtrlDoubleValueTypeFieldMinX

119

Set Minimum fieldsize in x direction.

scComSAMLightClientCtrlDoubleValueTypeFieldMinY

120

Set Minimum fieldsize in y direction.

scComSAMLightClientCtrlDoubleValueTypeFieldMaxX

121

Set Maximum fieldsize in x direction.

scComSAMLightClientCtrlDoubleValueTypeFieldMaxY

122

Set Maximum fieldsize in y direction.

Parameter

Type: int

Unit: none

Set fieldsize parameter value.

CCI_Return

Type: int

CCI return number, see error list.

Notes

•The field size can be set via ScSetFieldSizeAndWorkingArea.

C# Example: Get min Y field size:

 
double Field_Min_Y = cci.ScGetDoubleValue((int)ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlDoubleValueTypeFieldMinY);

DLL Function

int CCI_Return = ScSetFieldSizeAndWorkingArea(double Field_Size, double Field_Size_Center_X, double Field_Size_Center_Y, double Working_Area_Min_X, double Working_Area_Min_Y, double Working_Area_Max_X, double Working_Area_Max_Y)

ASCII Function

int CCI_Return = ScSetFieldSizeAndWorkingArea(double Field_Size, double Field_Size_CenterX, double Field_Size_CenterY, double Working_Area_MinX, double Working_Area_MinY, double Working_Area_MaxX, double Working_Area_MaxY)

Description

Set the field size and working area.

Field_Size

Type: double

Unit: [mm]*

Set field size diameter.

Field_Size_Center_X

Type: double

Unit: [mm]*

Set field size center x coordinate.

Field_Size_Center_Y

Type: double

Unit: [mm]*

Set field size center y coordinate.

Working_Area_Min_X

Type: double

Unit: [mm]*

Set working area minimum x coordinate.

Working_Area_Min_Y

Type: double

Unit: [mm]*

Set working area minimum y coordinate.

Working_Area_Max_X

Type: double

Unit: [mm]*

Set working area maximum x coordinate.

Working_Area_Max_Y

Type: double

Unit: [mm]*

Set working area maximum y coordinate.

CCI_Return

Type: int

CCI return number, see error list.

Notes

•The default unit is mm, but the user can select a different unit.

C# Example: Set field size and working area:

int CCI_Return = cci.ScSetFieldSizeAndWorkingArea(200, 100, 100, 0, 0, 200, 200);

DLL Function

int CCI_Return = ScSetDoubleValue(int Value_Type, double Gain)

double Gain = ScGetDoubleValue(int Value_Type)

ASCII Function

int CCI_Return = ScCciSetDoubleValue(int Value_Type, double Gain)

double Gain = ScCciGetDoubleValue(int Value_Type)

Description

Set or get the gain x/y correction factor of the optic.

Value_Type

Type: int

ID:

Location: ScComSAMLightClientCtrlValueTypes

scComSAMLightClientCtrlDoubleValueTypeGainX

46

Set or get the gain x correction factor of the optic.

scComSAMLightClientCtrlDoubleValueTypeGainY

47

Set or get the gain y correction factor of the optic.

Gain

Type: double

Unit: none

Set or get the gain factor for x or y.

CCI_Return

Type: int

CCI return number, see error list.

Notes

-

C# Example: Set gain X:
 
int CCI_Return = cci.ScSetDoubleValue((int)ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlDoubleValueTypeGainX, 0.95);

C# Example: Get gain Y:

 
double Gain = cci.ScGetDoubleValue((int)ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlDoubleValueTypeGainX);

DLL Function

int CCI_Return = ScSetDoubleValue(int Value_Type, double Home_Position)

double Home_Position = ScGetDoubleValue(int Value_Type)

ASCII Function

int CCI_Return = ScCciSetDoubleValue(int Value_Type, double Home_Position)

double Home_Position = ScCciGetDoubleValue(int Value_Type)

Description

Set or get the home position.

Value_Type

Type: int

ID:

Location: ScComSAMLightClientCtrlValueTypes

scComSAMLightClientCtrlDoubleValueTypeHomePosX

23

Set or get the home position x.

scComSAMLightClientCtrlDoubleValueTypeHomePosY

24

Set or get the home position y.

scComSAMLightClientCtrlDoubleValueTypeHomePosZ

25

Set or get the home position z.

Home_Position

Type: double

Unit: [mm]*

Set or get the home position coordinate x/y/z.

CCI_Return

Type: int

CCI return number, see error list.

Notes

•The default unit is mm, but the user can select a different unit.

C# Example: Set home Ppsition X:
 
int CCI_Return = cci.ScSetDoubleValue((int)ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlDoubleValueTypeHomePosX, 50.0);

C# Example: Get home position Z:
 
double Home_Postion = cci.ScGetDoubleValue((int)ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlDoubleValueTypeHomePosZ);

DLL Function

int CCI_Return = ScSetDoubleValue(int Value_Type, double Offset)

double Offset = ScGetDoubleValue(int Value_Type)

ASCII Function

int CCI_Return = ScCciSetDoubleValue(int Value_Type, double Offset)

double Offset = ScCciGetDoubleValue(int Value_Type)

Description

Set or get the Offset x/y correction factor of the optic.

Value_Type

Type: int

ID:

Location: ScComSAMLightClientCtrlValueTypes

scComSAMLightClientCtrlDoubleValueTypeOffsetX

58

Set or get the offset x correction factor of the optic.

scComSAMLightClientCtrlDoubleValueTypeOffsetY

59

Set or get the offset y correction factor of the optic.

scComSAMLightClientCtrlDoubleValueTypeOffsetZ

90

Only for RTC cards. Set or get the offset z correction factor of the optic in sc_setup.exe. Requires Optic3D license.

Offset

Type: double

Unit: [mm]*

Set offset factor for x/y/z.

CCI_Return

Type: int

CCI return number, see error list.

Notes

•Z Offset can only be set in sc_setup.

•The default unit is mm, but the user can select a different unit.

C# Example: Set offset X:
 
int CCI_Return = cci.ScSetDoubleValue((int)ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlDoubleValueTypeOffsetX, 10.0);

C# Example: Get offset X:

 
double Offset_X = cci.ScGetDoubleValue((int)ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlDoubleValueTypeOffsetX);

DLL Function

int CCI_Return = ScSetLongValue(int Value_Type, int Axis_State)

int Axis_State = ScGetLongValue(int Value_Type)

ASCII Function

int CCI_Return = ScCciSetLongValue(int Value_Type, int Axis_State)

int Axis_State = ScCciGetLongValue(int Value_Type)

Description

Set or get the current state of the optical axis, whether inverted or not.

Value_Type

Type: int

ID:

Location: ScComSAMLightClientCtrlValueTypes

scComSAMLightClientCtrlLongValueTypeOpticAxisState

110

Axis_State

Type: int

Index:

Location: None

All axes are normal & XY-axis also normal

0

X-axis inverted

1

Y-axis inverted

2

X- & Y-axes inverted

3

XY-axis flipped

4

X-axis inverted & XY-axis flipped

5

Y-axis inverted & XY-axis flipped

6

X- & Y-axis inverted & XY-axis flipped

7

Z-axis inverted

8

X- & Z-axes inverted

9

Y- & Z-axes inverted

10

X-, Y- & Z-axes inverted

11

Z-axis inverted & XY-axis flipped

12

X- & Z-axes inverted & XY-axis flipped

13

Y- & Z-axes inverted & XY-axis flipped

14

X-, Y- & Z-axes inverted & XY-axis flipped

15

CCI_Return

Type: int

CCI return number, see error list.

Notes

-

C# Example: Invert X axis:
 

int CCI_Return = cci.ScSetLongValue((int)ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlLongValueTypeOpticAxisState, 1);

C# Example: Get optic axis state:

 
int Axis_State = cci.ScGetLongValue((int)ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlLongValueTypeOpticAxisState);

DLL Function

int CCI_Return = ScSetDoubleValue(int Value_Type, double Rotation_Angle)

double Rotation_Angle = ScGetDoubleValue(int Value_Type)

ASCII Function

int CCI_Return = ScCciSetDoubleValue(int Value_Type, double Rotation_Angle)

double Rotation_Angle = ScCciGetDoubleValue(int Value_Type)

Description

Set or get the rotation value of the optic.

Value_Type

Type: int

ID:

Location: ScComSAMLightClientCtrlValueTypes

scComSAMLightClientCtrlDoubleValueTypeOpticRotation

111

Rotation_Angle

Type: double

Unit: [deg]

Set or get the rotation angle.

CCI_Return

Type: int

CCI return number, see error list.

Notes

-

C# Example: Set optic rotation to 45 deg:
 
int CCI_Return = cci.ScSetDoubleValue((int)ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlDoubleValueTypeOpticRotation, 45.0);

C# Example: Get optic rotation:

 
double Rotation_Angle = cci.ScGetDoubleValue((int)ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlDoubleValueTypeOpticRotation);

DLL Function

int CCI_Return = ScSetDoubleValue(int Value_Type, double Parameter)

double Parameter = ScGetDoubleValue(int Value_Type)

ASCII Function

int CCI_Return = ScCciSetDoubleValue(int Value_Type, double Parameter)

double Parameter = ScCciGetDoubleValue(int Value_Type)

Description

Set or get the Red Pointer Parameters Offset and Wavelength Factor.

Value_Type

Type: int

ID:

Location: ScComSAMLightClientCtrlValueTypes

scComSAMLightClientCtrlDoubleValueTypeRedPointerOffsetX

154

Red Pointer Offset in X direction. [mm]

scComSAMLightClientCtrlDoubleValueTypeRedPointerOffsetY

155

Red Pointer Offset in Y direction. [mm]

scComSAMLightClientCtrlDoubleValueTypeRedPointerFactorX

156

Wavelength factor in X direction.

scComSAMLightClientCtrlDoubleValueTypeRedPointerFactorY

157

Wavelength factor in Y direction.

Parameter

Type: double

Unit: Depends on constant

Set or get the desired parameter value.

CCI_Return

Type: int

CCI return number, see error list.

Notes

-

C# Example: Set Offset X:
 
int CCI_Return = cci.ScSetDoubleValue((int)ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlDoubleValueTypeRedPointerOffsetX, 1.10);

C# Example: Get Wavelength Factor Y:

 
double Factor = cci.ScGetDoubleValue((int)ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlDoubleValueTypeRedPointerFactorY);

DLL Function

int CCI_Return = ScExecCommand(int Cmd_ID)

ASCII Function

int CCI_Return = ScCciExecCommand(int Cmd_ID)

Description

Saves the current pens to the settings file.

Cmd_ID

Type: int

ID:

Location: ScComSAMLightClientCtrlExecCommandConstants

scComSAMLightClientCtrlExecCommandSaveLcfFile

79

CCI_Return

Type: int

CCI return number, see error list.

Notes

-

C# Example: Save Lens Settings:
 
int CCI_Return = cci.ScExecCommand((int)ScComSAMLightClientCtrlExecCommandConstants.scComSAMLightClientCtrlExecCommandSaveLcfFile);