Interface ICLDSubList
The list of CLD subroutines with auxiliary helper methods.
Namespace: SprutTechnology.SCPostprocessor
Assembly: SCPostprocessor.dll
Syntax
public interface ICLDSubListProperties
Item[Int32]
Returns the CLD subroutine by it's SubCode - unique numerical identifier in the project's subroutine list.
Declaration
ICLDSub this[int cldSubCode] { get; }Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | cldSubCode | Subcode of the CLD subroutine to get. |
Property Value
| Type | Description |
|---|---|
| ICLDSub | Returns the CLD subroutine with the given SubCode. If the SubCode is missing it returns "Null". |
SubCount
Count of CLD subroutines in the list.
Declaration
int SubCount { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
Methods
GetSubByCLDFileIndex(Int32)
Finds the CLD subroutine by it's file index in the project's CLD files list.
Declaration
ICLDSub GetSubByCLDFileIndex(int cldFileIndex)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | cldFileIndex | CLD file index of the subroutine to get. |
Returns
| Type | Description |
|---|---|
| ICLDSub | Returns the CLD subroutine with the given file index. If the index is incorrect it returns "Null". |
GetSubByIndex(Int32)
Returns the CLD subroutine by it's index in this list [0 .. SubCount-1].
Declaration
ICLDSub GetSubByIndex(int index)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | index | Index of the CLD subroutine to get [0 .. SubCount-1]. |
Returns
| Type | Description |
|---|---|
| ICLDSub | Returns the CLD subroutine with the given index. If the index is incorrect it returns "Null". |
Translate()
Using this method you can start translation of the all subroutines in the list. If any of the subroutines in this list has already been translated earlier, then the re-translation for this subroutine will not be started and it just will be skipped.
Declaration
void Translate()Translate(Int32)
This method can be called by the postprocessor developer to start translation of commands inside the subroutine with the given cldSubCode. Usually you should do it inside OnCallNCSub, OnStartProject, OnFinishProject or OnExtCycle handlers. This method does not take into account the fact whether the subroutine has already been translated previously, so translation will be called anyway. After translation the subroutine with specified cldSubCode will be marked as Translated.
Declaration
void Translate(int cldSubCode)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | cldSubCode | Subcode of the CLD subroutine to translate. |
Translate(Int32, Boolean)
This method can be called by the postprocessor developer to start translation of commands inside the subroutine with the given cldSubCode. Usually you should do it inside OnCallNCSub, OnStartProject, OnFinishProject or OnExtCycle handlers. This method does not take into account the fact whether the subroutine has already been translated previously, so translation will be called anyway.
Declaration
void Translate(int cldSubCode, bool markTranslated)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | cldSubCode | Subcode of the CLD subroutine to translate. |
| System.Boolean | markTranslated | With this parameter, you must explicitly indicate whether the subroutine should be marked as Translated. |