Method MatrixIsInputLineEnabled

Namespace

Skyline.DataMiner.Automation

Assembly

SLManagedAutomation.dll

MatrixIsInputLineEnabled(int, int)

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

public virtual bool MatrixIsInputLineEnabled(int pid, int index)

Parameters

pid int

The ID of the matrix parameter.

index int

The index of the matrix input.

Returns

bool

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

Examples

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

Remarks

The specified input index must be in the range 1..nrOfInputs.

Exceptions

DataMinerException

The matrix parameter was not found.
-or-
index is not in the range 1..nrOfInputs.

MatrixIsInputLineEnabled(int, string)

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

public virtual bool MatrixIsInputLineEnabled(int pid, string lineLabel)

Parameters

pid int

The ID of the matrix parameter.

lineLabel string

The label of the matrix input.

Returns

bool

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

Examples

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

Exceptions

DataMinerException

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

MatrixIsInputLineEnabled(string, int)

Gets a value indicating whether the specified matrix input 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 MatrixIsInputLineEnabled(string parameterName, int index)

Parameters

parameterName string

The name of the matrix parameter.

index int

The index of the matrix input.

Returns

bool

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

Examples

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

Remarks

The specified input index must be in the range 1..nrOfInputs.

Exceptions

DataMinerException

The matrix parameter was not found.
-or-
index is not in the range 1..nrOfInputs.

MatrixIsInputLineEnabled(string, string)

Gets a value indicating whether the specified matrix input 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 MatrixIsInputLineEnabled(string parameterName, string lineLabel)

Parameters

parameterName string

The name of the matrix parameter.

lineLabel string

The label of the matrix input.

Returns

bool

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

Examples

var dummy = engine.GetDummy("dummy1");
bool isInputEnabled = dummy.MatrixIsInputLineEnabled("Example Matrix", "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.