Interface ICodeParametersOfCLDCommand
The list of parameters of the CLData command using which you can get the parameter value by its unique numerical code.
Namespace: DotnetPostprocessing.SDK
Assembly: DotnetPostprocessing.SDK.dll
Syntax
public interface ICodeParametersOfCLDCommandProperties
Bol
An indexer, which allows to get the value of the parameter of CLData command by its numerical code in the form of boolean.
Declaration
ICodeParametersOfCLDCommandBooleanIndexer Bol { get; }Property Value
| Type | Description |
|---|---|
| ICodeParametersOfCLDCommandBooleanIndexer |
Flt
An indexer, which allows to get the value of the parameter of CLData command by its numerical code in the form of floating point number.
Declaration
ICodeParametersOfCLDCommandFloatIndexer Flt { get; }Property Value
| Type | Description |
|---|---|
| ICodeParametersOfCLDCommandFloatIndexer |
Int
An indexer, which allows to get the value of the parameter of CLData command by its numerical code in the form of integer number.
Declaration
ICodeParametersOfCLDCommandIntegerIndexer Int { get; }Property Value
| Type | Description |
|---|---|
| ICodeParametersOfCLDCommandIntegerIndexer |
ParamCount
The count of parameters in the list.
Declaration
int ParamCount { get; }Property Value
| Type | Description |
|---|---|
| int |
Str
An indexer, which allows to get the value of the parameter of CLData command by its numerical code in the form of textual string.
Declaration
ICodeParametersOfCLDCommandStringIndexer Str { get; }Property Value
| Type | Description |
|---|---|
| ICodeParametersOfCLDCommandStringIndexer |
Methods
AsBoolean(int)
Allows to get the value of the parameter by its index in this local list in the form of boolean.
Declaration
bool AsBoolean(int paramIndex)Parameters
| Type | Name | Description |
|---|---|---|
| int | paramIndex | The index of parameter in the list [0..ParamCount-1]. |
Returns
| Type | Description |
|---|---|
| bool | Returns the boolean value of the parameter. |
AsFloat(int)
Allows to get the value of the parameter by its index in this local list in the form of floating point number.
Declaration
double AsFloat(int paramIndex)Parameters
| Type | Name | Description |
|---|---|---|
| int | paramIndex | The index of parameter in the list [0..ParamCount-1]. |
Returns
| Type | Description |
|---|---|
| double | Returns the numerical value of the parameter. |
AsInteger(int)
Allows to get the value of the parameter by its index in this local list in the form of integer number.
Declaration
int AsInteger(int paramIndex)Parameters
| Type | Name | Description |
|---|---|---|
| int | paramIndex | The index of parameter in the list [0..ParamCount-1]. |
Returns
| Type | Description |
|---|---|
| int | Returns the numerical value of the parameter. |
AsString(int)
Allows to get the value of the parameter by its index in this local list in the form of textual string.
Declaration
string AsString(int paramIndex)Parameters
| Type | Name | Description |
|---|---|---|
| int | paramIndex | The index of parameter in the list [0..ParamCount-1]. |
Returns
| Type | Description |
|---|---|
| string | Returns the string value of the parameter. |
Code(int)
Indicates the unique numerical code of the parameter with a given index. This code defines the meaning of the parameter.
Declaration
int Code(int paramIndex)Parameters
| Type | Name | Description |
|---|---|---|
| int | paramIndex | The index of parameter in the list [0..ParamCount-1]. |
Returns
| Type | Description |
|---|---|
| int | Returns the numerical code of parameter. |
IndexOfCode(int)
Returns the index in this list of a parameter with the given code. It returns "-1" if there is no parameter with the given code in this list.
Declaration
int IndexOfCode(int paramCode)Parameters
| Type | Name | Description |
|---|---|---|
| int | paramCode | Unique numerical code of the parameter you want to get. |
Returns
| Type | Description |
|---|---|
| int | Returns the index of parameter in this local list. |
ParamType(int)
The type of parameter with a given index (floating point number, integer number, boolean or string).
Declaration
CodeParamType ParamType(int paramIndex)Parameters
| Type | Name | Description |
|---|---|---|
| int | paramIndex | The index of parameter in the list [0..ParamCount-1]. |
Returns
| Type | Description |
|---|---|
| CodeParamType | Returns the type of parameter. |