Method MatrixIsLineEnabled

Namespace

Skyline.DataMiner.Automation

Assembly

SLManagedAutomation.dll

MatrixIsLineEnabled(int, bool, string)

Gets a value indicating whether the specified matrix input or output is enabled.

public virtual bool MatrixIsLineEnabled(int pid, bool input, string lineLabel)

Parameters

pid int

The ID of the matrix parameter.

input bool

true if the specified index is an input; otherwise, false.

lineLabel string

The label of the matrix input or output.

Returns

bool

true if the specified matrix input or output is enabled; otherwise, false.

Examples

var dummy = engine.GetDummy("dummy1");
bool isInputEnabled = dummy.MatrixIsLineEnabled(1000, true, "Input 4");

Exceptions

DataMinerException

The matrix parameter was not found.
-or-
There is no input with the specified label and input is true.
-or-
There is no output with the specified label and input is false.

MatrixIsLineEnabled(int, bool, int)

Gets a value indicating whether the specified matrix input or output is enabled.

public virtual bool MatrixIsLineEnabled(int pid, bool input, int index)

Parameters

pid int

The ID of the matrix parameter.

input bool

true if the specified index is an input; otherwise, false.

index int

The index of the matrix input or output.

Returns

bool

true if the specified matrix input or output is enabled; otherwise, false.

Examples

var dummy = engine.GetDummy("dummy1");
bool isInputEnabled = dummy.MatrixIsLineEnabled(1000, true, 4);

Remarks

index must be in the range 1..nrOfInputs if input is true.

index must be in the range 1..nrOfOutputs if input is false.

Exceptions

DataMinerException

The matrix parameter was not found.
-or-
index is not in the range 1..nrOfInputs and input is true.
-or-
index is not in the range 1..nrOfOutputs and input is false.

MatrixIsLineEnabled(string, bool, int)

Gets a value indicating whether the specified matrix input or output is enabled.

note

Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

[Obsolete("Use overloads with parameter ID instead of name.")]
public virtual bool MatrixIsLineEnabled(string parameterName, bool input, int index)

Parameters

parameterName string

The name of the matrix parameter.

input bool

true if the specified index is an input; otherwise, false.

index int

The index of the matrix input or output.

Returns

bool

true if the specified matrix input or output is enabled; otherwise, false.

Examples

var dummy = engine.GetDummy("dummy1");
bool isInputEnabled = dummy.MatrixIsLineEnabled("Example Matrix", true, 4);

Remarks

The specified value for the parameterName argument should be the value of the Description tag of the parameter and not the value of the Name tag.

index must be in the range 1..nrOfInputs if input is true.

index must be in the range 1..nrOfOutputs if input is false.

Exceptions

DataMinerException

The matrix parameter was not found.
-or-
index is not in the range 1..nrOfInputs and input is true.
-or-
index is not in the range 1..nrOfOutputs and input is false.

MatrixIsLineEnabled(string, bool, string)

Gets a value indicating whether the specified matrix input or output is enabled.

note

Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

[Obsolete("Use overloads with parameter ID instead of name.")]
public virtual bool MatrixIsLineEnabled(string parameterName, bool input, string lineLabel)

Parameters

parameterName string

The name of the matrix parameter.

input bool

true if the specified index is an input; otherwise, false.

lineLabel string

The label of the matrix input or output.

Returns

bool

true if the specified matrix input or output is enabled; otherwise, false.

Examples

var dummy = engine.GetDummy("dummy1");
bool isInputEnabled = dummy.MatrixIsLineEnabled("Example Matrix", true, "Input 4");

Remarks

The specified value for the parameterName argument should be the value of the Description tag of the parameter and not the value of the Name tag.

Exceptions

DataMinerException

The matrix parameter was not found.
-or-
There is no input with the specified label and input is true.
-or-
There is no output with the specified label and input is false.