DLL Function

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

int Parameter = ScGetEntityLongData(string Entity_Name, int Data_ID)

ASCII Function

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

int Parameter = ScCciGetEntityLongData(string Entity_Name, int Data_ID)

Description

Set or get the corresponding ArrayCount and ArrayStep (Increment) at the EntityInfo property page for a soft array copy with virtual entities.

Entity_Name

Type: string

Unit: none

Enter the name of the entity, which should be copied virtual.

Data_ID

Type: int

ID:

Location: ScComSAMLightClientCtrlFlags

scComSAMLightClientCtrlLongDataIdEntityArrayCountX

4

Use this command to set or get Array Count X.

scComSAMLightClientCtrlLongDataIdEntityArrayCountY

5

Use this command to set or get Array Count Y.

scComSAMLightClientCtrlLongDataIdEntityArrayStepX

6

Use this command to set or get Array Step (Increment) X. Units: [µm]

scComSAMLightClientCtrlLongDataIdEntityArrayStepY

7

Use this command to set or get Array Step (Increment) Y. Units: [µm]

Parameter

Type: int

Unit: depends on constant

Set or get the new number for the array count or array step (increment).

CCI_Return

Type: int

CCI return number, see error list.

Notes

•Array step (increment) can also be negative.

C# Example: For a soft arraycopy set count X = 3:
 
int CCI_Return = cci.ScSetEntityLongData( "ArrayCopy Soft",( int ) ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdEntityArrayCountX, 3 );

C# Example: For soft arraycopy get arraycountX:

int array_count_x = 0;

array_count_x = cci.ScGetEntityLongData("ArrayCopy Soft",(int)ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdEntityArrayCountX);

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

Set or get the output order of a virtual array (virtual means that no new entities are generated in the entity list. The corresponding setup is in the EntityInfo property page at array). The corresponding flag is a bit field.

Entity_Name

Type: string

Unit: none

Specify the entity to be changed.

Data_ID

Type: int

ID:

Location: ScComSAMLightClientCtrlFlags

scComSAMLightClientCtrlLongDataIdEntityArrayOrderFlags

8

Flag

Type: int

Flag:

Location: ScComSAMLightClientCtrlFlags

scComSAMLightClientCtrlEntityArrayOrderFlagNegX

0x100

Direction from right to left in horizontal direction if this flag is set, else from left to right.

scComSAMLightClientCtrlEntityArrayOrderFlagNegY

0x200

Direction from top to bottom in vertical direction is this flag is set, else from bottom to top.

scComSAMLightClientCtrlEntityArrayOrderFlagMainDirX

0x400

Use X as the main direction for array copying, array copies would be marked column by column.

scComSAMLightClientCtrlEntityArrayOrderFlagBiDir

0x800

Use bidirectional mode (horizontal), which means the order of the array copy is serpentinous back and forth instead of using only one direction with back jumps.

CCI_Return

Type: int

CCI return number, see error list.

Notes

-

C# Example: Set NegX flag for entity "ArrayCopySoft":
 
int CCI_Return = cci.ScSetEntityLongData( "ArrayCopySoft", ( int )ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdEntityArrayOrderFlags,

( int )ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlEntityArrayOrderFlagNegX );

C# Example: Get current set flag for entity "ArrayCopySoft":
 
int Entity_Array_Order_Flags = cci.ScGetEntityLongData( "ArrayCopySoft", ( int )ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdEntityArrayOrderFlags );

DLL Function

int CCI_Return = ScSetEntityStringData(string Entity_Name, int Data_ID, string Copy_Name)

ASCII Function

int CCI_Return = ScCciSetEntityStringData(string Entity_Name, int Data_ID, string Copy_Name)

Description

This is used to execute the array copy.

Entity_Name

Type: string

Unit: none

Set the entity name.

Data_ID

Type: int

ID:

Location: ScComSAMLightClientCtrlFlags

scComSAMLightClientCtrlStringDataIdArrayCopyHard

28

Executes the ArrayCopyHard.

scComSAMLightClientCtrlStringDataIdArrayPolarCopyHard

39

Executes the ArrayPolarCopyHard.

Copy_Name

Type: string

Unit: none

Set the name for all copied entities.

CCI_Return

Type: int

CCI return number, see error list.

Notes

-

C# Example: Executes the ArrayCopyHard for Entity "Text1":

int CCI_Return = cci.ScSetEntityStringData("Text1", (int)ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlStringDataIdArrayCopyHard, "Clone");

DLL Function

int CCI_Return = ScSetLongValue(int Value_Type, int Copies)

ASCII Function

int CCI_Return = ScCciSetLongValue(int Value_Type, int Copies)

Description

Set the number of copies for Array polar copy.

Value_Type

Type: int

ID:

Location: ScComSAMLightClientCtrlValueTypes

scComSAMLightClientCtrlLongValueTypeEntityArrayPolarNumberOfCopies

151

Copies

Type: int

Unit: none

Set the number of copies.

CCI_Return

Type: int

CCI return number, see error list.

Notes

-

C# Example: Set the number of copies to 5:
 
int CCI_Return = cci.ScSetLongValue( ( int )ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlLongValueTypeEntityArrayPolarNumberOfCopies, 5 );

DLL Function

int CCI_Return = ScSetDoubleValue(int Value_Type, double Parameter)

ASCII Function

int CCI_Return = ScCciSetDoubleValue(int Value_Type, double Parameter)

Description

Set the various array polar copy parameters.

Value_Type

Type: int

ID:

Location: ScComSAMLightClientCtrlValueTypes

scComSAMLightClientCtrlDoubleValueTypeEntityArrayPolarRadius

159

Array Polar Copy Radius. [mm]

scComSAMLightClientCtrlDoubleValueTypeEntityArrayPolarXCenter

160

Array Polar Copy Center X. [mm].

scComSAMLightClientCtrlDoubleValueTypeEntityArrayPolarYCenter

161

Array Polar Copy Center Y.[mm]

scComSAMLightClientCtrlDoubleValueTypeEntityArrayPolarTotalAngle

162

Array Polar Copy Total Angle. [°]

scComSAMLightClientCtrlDoubleValueTypeEntityArrayPolarStartAngle

163

Array Polar Copy Start Angle [°]

Parameter

Type: int

Unit: depends on constant

The corresponding value.

CCI_Return

Type: int

CCI return number, see error list.

Notes

-

C# Example: Set radius for array polar copy to 25 mm:
 

int CCI_Return = cci.ScSetDoubleValue( ( int )ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlDoubleValueTypeEntityArrayPolarRadius, 25 );