Interface ICLDCommand

Common ancestor for all CLData commands

Inherited Members

INamedProperty.FindChild(String)

INamedProperty.GetNextChild(INamedProperty)

INamedProperty.Parent

INamedProperty.Name

INamedProperty.SimpleType

INamedProperty.ValueAsString

INamedProperty.ValueAsDouble

INamedProperty.ValueAsInteger

INamedProperty.ValueAsBoolean

INamedProperty.Ptr

INamedProperty.Arr

INamedProperty.Str

INamedProperty.Int

INamedProperty.Flt

INamedProperty.Bol

Namespace: SprutTechnology.SCPostprocessor

Assembly: SCPostprocessor.dll

Syntax

public interface ICLDCommand : INamedProperty

Properties

Caption

The name of the CLData command that appears in windows

Declaration

string Caption { get; }

Property Value

Type	Description
System.String

CLD

CLD-array of the command parameters. The set depends on the type of command.

Declaration

CLDArray CLD { get; }

Property Value

Type	Description
CLDArray

CLDataS

Textual data of the command. The meaning of the data depend on the type of command.

Declaration

string CLDataS { get; }

Property Value

Type	Description
System.String

CLDFile

The CLData file in which this command is located.

Declaration

ICLDFile CLDFile { get; }

Property Value

Type	Description
ICLDFile

CLDSub

The CLDSub in which this command is located. Can be null if the command is a regular technological operation's command.

Declaration

ICLDSub CLDSub { get; }

Property Value

Type	Description
ICLDSub

CmdType

The type of the CLData command (feedrate, goto, circle, spindle etc.)

Declaration

CLDCmdType CmdType { get; }

Property Value

Type	Description
CLDCmdType

CmdTypeCode

The numeric type code of the CLData command. It is unique for each command type (feedrate, goto, circle, spindle etc.)

Declaration

int CmdTypeCode { get; }

Property Value

Type	Description
System.Int32

Index

The index of the CLData command in file of CLData

Declaration

int Index { get; }

Property Value

Type	Description
System.Int32

Next

The next CLData command from the same file. Null for the last command of a file.

Declaration

ICLDCommand Next { get; }

Property Value

Type	Description
ICLDCommand

NextMotion

The next motion CLData command from the same file. Null if there are no motion commands below.

Declaration

ICLDMotionCommand NextMotion { get; }

Property Value

Type	Description
ICLDMotionCommand

Prev

The previous CLData command from the same file. Null for the first command of a file.

Declaration

ICLDCommand Prev { get; }

Property Value

Type	Description
ICLDCommand

PrevMotion

The previous motion CLData command from the same file. Null if there are no motion commands above.

Declaration

ICLDMotionCommand PrevMotion { get; }

Property Value

Type	Description
ICLDMotionCommand

TechOperation

The technological operation in which this command is located. Can be null if the command is from a CLDSub.

Declaration

ICLDTechOperation TechOperation { get; }

Property Value

Type	Description
ICLDTechOperation

Methods

FindNextCommand(CLDCmdType)

Finds a nearest command of the given type in the same CLData file following after this command up to the end of the file.

Declaration

ICLDCommand FindNextCommand(CLDCmdType commandType)

Parameters

Type	Name	Description
CLDCmdType	commandType	The type of command to find.

Returns

Type	Description
ICLDCommand	If the search is successful, it returns the found command, otherwise it returns "Null".

FindNextCommand(CLDCmdType, Int32)

Finds a nearest command of the given type in the same CLData file following after this command by the specified offset up to the end of the file.

Declaration

ICLDCommand FindNextCommand(CLDCmdType commandType, int offset)

Parameters

Type	Name	Description
CLDCmdType	commandType	The type of command to find.
System.Int32	offset	Offset for the index in file of the command to start searching. Zero means start from this command, one - from the next command etc.

Returns

Type	Description
ICLDCommand	If the search is successful, it returns the found command, otherwise it returns "Null".

FindNextCommand(CLDCmdType, Int32, Int32)

Finds a nearest command of the given type in the same CLData file following after this command by the specified offset.

Declaration

ICLDCommand FindNextCommand(CLDCmdType commandType, int offset, int commandCount)

Parameters

Type	Name	Description
CLDCmdType	commandType	The type of command to find.
System.Int32	offset	Offset for the index in file of the command to start searching. Zero means start from this command, one - from the next command etc.
System.Int32	commandCount	Maximal count of commands to check.

Returns

Type	Description
ICLDCommand	If the search is successful, it returns the found command, otherwise it returns "Null".

FindNextCommandOfProject(CLDCmdType)

Finds a nearest command of the given type in the all CLData files following after this command.

Declaration

ICLDCommand FindNextCommandOfProject(CLDCmdType commandType)

Parameters

Type	Name	Description
CLDCmdType	commandType	The type of command to find.

Returns

Type	Description
ICLDCommand	If the search is successful, it returns the found command, otherwise it returns "Null".

FindNextCommandOfProject(CLDCmdType, Int32)

Finds a nearest command of the given type in the all CLData files following after this command by the specified offset.

Declaration

ICLDCommand FindNextCommandOfProject(CLDCmdType commandType, int offset)

Parameters

Type	Name	Description
CLDCmdType	commandType	The type of command to find.
System.Int32	offset	Offset for the index in file of the command to start searching. Zero means start from this command, one - from the next command etc.

Returns

Type	Description
ICLDCommand	If the search is successful, it returns the found command, otherwise it returns "Null".

FindNextCommandOfProject(CLDCmdType, Int32, Int32)

Finds a nearest command of the given type in the all CLData files following after this command by the specified offset.

Declaration

ICLDCommand FindNextCommandOfProject(CLDCmdType commandType, int offset, int commandCount)

Parameters

Type	Name	Description
CLDCmdType	commandType	The type of command to find.
System.Int32	offset	Offset for the index in file of the command to start searching. Zero means start from this command, one - from the next command etc.
System.Int32	commandCount	Maximal count of commands to check.

Returns

Type	Description
ICLDCommand	If the search is successful, it returns the found command, otherwise it returns "Null".

FindNextCommandOfProject(CLDCmdType, Int32, Int32, Int32)

Finds a nearest command of the given type in the all CLData files following after this command by the specified offsets.

Declaration

ICLDCommand FindNextCommandOfProject(CLDCmdType commandType, int fileOffset, int cmdOffset, int commandCount)

Parameters

Type	Name	Description
CLDCmdType	commandType	The type of command to find.
System.Int32	fileOffset	Offset for the index of file in the project's files list to start searching. Zero means start from the file of this command, one - from the next file etc.
System.Int32	cmdOffset	Offset for the index in file of the command to start searching. If the fileOffset is zero then cmdOffset zero means start from this command, one - from the next command etc. If the fileOffset is greater than zero then cmdOffset zero means start from the first command in file, one - from the second command etc.
System.Int32	commandCount	Maximal count of commands to check.

Returns

Type	Description
ICLDCommand	If the search is successful, it returns the found command, otherwise it returns "Null".