Interface ICLDSub

CLD subroutine - the list of CLData commands which is not called (translate) by the translating system directly, but it can be called for translation by the postprocessor developer using special "Translate" method from any other handler inside postprocessor. Usually you need to convert it into subroutine of format that the controller understands.

Namespace: DotnetPostprocessing.SDK

Assembly: DotnetPostprocessing.SDK.dll

Syntax

public interface ICLDSub

Properties

CLDFile

Reference to the CLData file of this CLD subroutine.

Declaration

ICLDFile CLDFile { get; }

Property Value

Type	Description
ICLDFile

Data

Auxiliary object type property that can be associated with the CLDSub and can be used by the postprocessor developer for his own purposes. For example, you can write here the link to the resulting NCFile or link to any custom object with an information about the subroutine.

Declaration

object Data { get; set; }

Property Value

Type	Description
object

EndCaption

Auxiliary textual property that can be used by the postprocessor developer for his own purposes. For example, you can write here an output line number where the subroutine ends.

Declaration

string EndCaption { get; set; }

Property Value

Type	Description
string

EndLabel

Special INCLabel object that can be used to remember position in the output file in which the subroutine ends. Later you can return to this position to add some additional data to it.

Declaration

INCLabel EndLabel { get; set; }

Property Value

Type	Description
INCLabel

Name

The name of the subroutine that is generated by CAM or specified by the user.

Declaration

string Name { get; set; }

Property Value

Type	Description
string

StartCaption

Auxiliary textual property that can be used by the postprocessor developer for his own purposes. For example, you can write here an output line number where the subroutine starts.

Declaration

string StartCaption { get; set; }

Property Value

Type	Description
string

StartLabel

Special INCLabel object that can be used to remember position in the output file in which the subroutine starts. Later you can return to this position to add some additional data to it.

Declaration

INCLabel StartLabel { get; set; }

Property Value

Type	Description
INCLabel

SubCode

Unique numerical identifier of the subroutine in the project's list of subroutines.

Declaration

int SubCode { get; }

Property Value

Type	Description
int

Tag

Auxiliary numerical tag that can be used by the postprocessor developer for his own purposes. For example, you can write here the resulting subroutine number or a line number where it starts.

Declaration

int Tag { get; set; }

Property Value

Type	Description
int

Translated

This flag is "true" only if the subroutine has already been translated.

Declaration

bool Translated { get; }

Property Value

Type	Description
bool

Methods

Translate()

This method can be called by the postprocessor developer to start translation of commands inside this subroutine. Usually you should do it inside OnCallNCSub, OnStartProject, OnFinishProject or OnExtCycle handlers. After translation the subroutine will be marked as Translated.

Declaration

void Translate()

Translate(bool)

This method can be called by the postprocessor developer to start translation of commands inside this subroutine. Usually you should do it inside OnCallNCSub, OnStartProject, OnFinishProject or OnExtCycle handlers.

Declaration

void Translate(bool markTranslated)

Parameters

Type	Name	Description
bool	markTranslated	With this parameter, you must explicitly indicate whether the subroutine should be marked as Translated.