<< Click to Display Table of Contents > 

Client Control Interface Manual > Global Settings > Optic > Advanced > Head Optic Settings

Head Optic Settings
Previous pageReturn to chapter overviewNext page

Primary Head Parameter

Secondary Head Entity Parameter

Secondary Head Parameter

 

Primary Head Parameter
 

Set

Get

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 different primary head parameters.

Value_Type

Type: int

ID:

Location: ScComSAMLightClientCtrlValueTypes

scComSAMLightClientCtrlDoubleValueTypePrimaryHeadOffsetX

65546

The offset X correction factor of the primary head can be set or get. [mm]*

scComSAMLightClientCtrlDoubleValueTypePrimaryHeadOffsetY

65547

The offset Y correction factor of the primary head can be set or get. [mm]*

scComSAMLightClientCtrlDoubleValueTypePrimaryHeadGainX

65548

The gain X correction factor of the primary head can be edited. [mm]*

scComSAMLightClientCtrlDoubleValueTypePrimaryHeadGainY

65549

The gain Y correction factor of the primary head can be edited. [mm]*

scComSAMLightClientCtrlDoubleValueTypePrimaryHeadRotate

65550

Using this constant the rotational angle of the primary head can be set or get. [deg]

scComSAMLightClientCtrlDoubleValueTypePrimaryHeadEnable

65551

Using this constant the primary head can be activated or deactivated.

Parameter

Type: int

Unit: depends on constant

Set or get the required parameter.

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 gain X for primary head:
 
int CCI_Return = cci.ScSetDoubleValue((int)ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlDoubleValueTypePrimaryHeadGainX, 0.8);

C# Example: Head offset X for primary head:
 
double Parameter = cci.ScGetDoubleValue((int)ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlDoubleValueTypePrimaryHeadOffsetX);

Table 46: Primary Head Parameters

Secondary Head Entity Parameter
 

Set

Get

DLL Function

int CCI_Return = ScSetEntityDoubleData(string Entity_Name, int Data_ID, double Parameter)

int CCI_Return = ScGetEntityDoubleData(string Entity_Name, int Data_ID, ref double Parameter)

ASCII Function

int CCI_Return = ScCciSetEntityDoubleData(string Entity_Name, int Data_ID, double Parameter)

double Parameter = ScCciGetEntityDoubleData(string Entity_Name, int Data_ID)

Description

Set or get different secondary head entity parameters.

Value_Type

Type: int

ID:

Location: ScComSAMLightClientCtrlFlags

scComSAMLightClientCtrlDoubleDataIdSecondaryHeadTransformationOffsetX

88

The offset X correction factor for secondary head entities can be set or get. [mm]*

scComSAMLightClientCtrlDoubleDataIdSecondaryHeadTransformationOffsetY

89

The offset Y correction factor for secondary head entities can be set or get. [mm]*

scComSAMLightClientCtrlDoubleDataIdSecondaryHeadTransformationScaleX

90

The scale X correction factor for secondary head entities can be edited. [mm]*

scComSAMLightClientCtrlDoubleDataIdSecondaryHeadTransformationScaleY

91

The scale Y correction factor for secondary head entities can be edited. [mm]*

scComSAMLightClientCtrlDoubleDataIdSecondaryHeadTransformationRotation

92

The rotational angle of the secondary head can be set or get. [deg]

Parameter

Type: int

Unit: depends on constant

Set or get the required parameter.

CCI_Return

Type: int

CCI return number, see error list.

Notes

These secondary head  transformation commands are only available for USC-2/3

with license for Head2 and activated Head2.

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

C# Example: Set offset X for secondary head:
 
int CCI_Return = cci.ScSetEntityDoubleData("Entity_1", (int)ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlDoubleDataIdSecondaryHeadTransformationOffsetX, 2.55);

C# Example: Get head offset X for secondary head:
 
double Offset_X = 0.0;

int CCI_Return = cci.ScGetEntityDoubleData("Entity_1", (int)ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlDoubleDataIdSecondaryHeadTransformationOffsetX, ref Offset_X);

Table 47: Secondary Head Entity Parameters

Secondary Head Parameter
 

Set

Get

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 different secondary head parameters.

Value_Type

Type: int

ID:

Location: ScComSAMLightClientCtrlValueTypes

scComSAMLightClientCtrlDoubleValueTypeSecondaryHeadOffsetX

65552

The offset X correction factor of the secondary head can be set or get. [mm]*

scComSAMLightClientCtrlDoubleValueTypeSecondaryHeadOffsetY

65553

The offset Y correction factor of the secondary head can be set or get. [mm]*

scComSAMLightClientCtrlDoubleValueTypeSecondaryHeadGainX

65556

The gain X correction factor of the secondary head can be edited. [mm]*

scComSAMLightClientCtrlDoubleValueTypeSecondaryHeadGainY

65557

The gain Y correction factor of the secondary head can be edited. [mm]*

scComSAMLightClientCtrlDoubleValueTypeSecondaryHeadRotate

65558

The rotational angle of the secondary head can be set or get. [deg]

scComSAMLightClientCtrlDoubleValueTypeSecondaryHeadEnable

65559

Using this constant the secondary head can be activated or deactivated.

Parameter

Type: int

Unit: depends on constant

Set or get the required parameter.

CCI_Return

Type: int

CCI return number, see error list.

Notes

These secondary head transformation commands are only available for USC-2/3

with license for Head2 and activated Head2.

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

C# Example: Set gain X for secondary head:
 
int CCI_Return = cci.ScSetDoubleValue((int)ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlDoubleValueTypeSecondaryHeadGainX, 0.8);

C# Example: Head offset X for secondary head:
 
double Parameter = cci.ScGetDoubleValue((int)ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlDoubleValueTypeSecondaryHeadOffsetX);

Table 48: Secondary Head Parameters