DLL Function

int CCI_Return = ScSetEntityLongData(string Entity_Name, int Data_ID, int Flag)

int Flag = ScGetEntityLongData(string Entity_Name, int Data_ID)

ASCII Function

int CCI_Return = ScCciSetEntityLongData(string Entity_Name, int Data_ID, int Flag)

int Flag = ScCciGetEntityLongData(string Entity_Name, int Data_ID)

Description

Enable/disable the checkboxes in the Spiral Entity Settings.

Entity_Name

Type: string

Unit: none

Enter the name of the entity to be changed.

Data_ID

Type: int

ID:

Location: ScComSAMLightClientCtrlFlags

scComSAMLightClientCtrlLongDataIdSpiralFlags

116

Flag

Type: int

Flag:

Location: None

Clockwise

0x1

Start from outer

0x2

Set return path

0x4

Use NumSeg for every rotation

0x8

CCI_Return

Type: int

CCI return number, see error list.

Notes

-

C# Example: Check the checkbox Clockwise and Set Return Path:
 

string Entity_Name = "SpiralEntity";

int Flags = 0X1 |= 0X4;

int CCI_Return = cci.ScSetEntityLongData(Entity_Name, (int)ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdSpiralFlags, Flags);

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 the inner and outer Radius as well a the Rise Parameter of the Spiral.

Entity_Name

Type: string

Unit: none

Enter the name of the entity to be changed.

Data_ID

Type: int

ID:

Location: ScComSAMLightClientCtrlFlags

scComSAMLightClientCtrlDoubleDataIdSpiral2DInnerRadius

74

The inner radius of the spiral.

scComSAMLightClientCtrlDoubleDataIdSpiral2DOuterRadius

75

The outer radius of the spiral.

scComSAMLightClientCtrlDoubleDataIdSpiral2DRise

76

The Rise Radius value of the spiral.

Parameter

Type: double

Unit: [mm]*

The corresponding value.

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 the outer radius value to 15.5:
 
string Entity_Name = "SpiralEntity";

int CCI_Return = cci.ScSetEntityDoubleData(Entity_Name, (int)ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlDoubleDataIdSpiral2DInnerRadius, 15.5);

C# Example: Get the outer radius value:
 
string Entity_Name = "";

int CCI_Return = cci.ScGetEntityDoubleData(Entity_Name, (int)ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlDoubleDataIdSpiral2DInnerRadius, ref Entity_Name);

DLL Function

int CCI_Return = ScSetEntityLongData(string Entity_Name, int Data_ID, int Spiral_Num)

int Spiral_Num = ScGetEntityLongData(string Entity_Name, int Data_ID)

ASCII Function

int CCI_Return = ScCciSetEntityLongData(string Entity_Name, int Data_ID, int Spiral_Num)

int Spiral_Num = ScCciGetEntityLongData(string Entity_Name, int Data_ID)

Description

Set or get inner, outer rotations and segments of the spiral object.

Entity_Name

Type: string

Unit: none

Enter the name of the entity to be changed.

Data_ID

Type: int

ID:

Location: ScComSAMLightClientCtrlFlags

scComSAMLightClientCtrlLongDataIdSpiralNumInnerRotations

113

The number of inner rotations.

scComSAMLightClientCtrlLongDataIdSpiralNumOuterRotations

114

The number of outer rotations.

scComSAMLightClientCtrlLongDataIdSpiralNumOuterSegments

115

The number of outer segments.

Spiral_Num

Type: int

Unit: none

The corresponding value.

CCI_Return

Type: int

CCI return number, see error list.

Notes

-

C# Example: Change the number of inner and outer rotations:
 
string Entity_Name = "SpiralEntity";

int CCI_Return_01 = cci.ScSetEntityLongData(Entity_Name,(int)ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdSpiralNumInnerRotations, 10);

int CCI_Return_02 = cci.ScSetEntityLongData(Entity_Name, (int)ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdSpiralNumOuterRotations, 20);