Method MatrixEnableInputLine

Namespace

Skyline.DataMiner.Automation

Assembly

SLManagedAutomation.dll

MatrixEnableInputLine(int, string, bool)

Enables or disables the specified matrix input.

public virtual void MatrixEnableInputLine(int pid, string inputLineLabel, bool state)

Parameters

pid int

The ID of the matrix parameter.

inputLineLabel string

The label of the input.

state bool

true to enable the input; otherwise, false.

Examples

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

Exceptions

DataMinerException

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

MatrixEnableInputLine(int, int, bool)

Enables or disables the specified matrix input.

public virtual void MatrixEnableInputLine(int pid, int index, bool state)

Parameters

pid int

The ID of the matrix parameter.

index int

The index of the input.

state bool

true to enable the input; otherwise, false.

Examples

var dummy = engine.GetDummy("dummy1");
dummy.MatrixEnableInputLine(1000, 2, false);

Remarks

The 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.

MatrixEnableInputLine(string, int, bool)

Enables or disables the specified matrix input.

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 void MatrixEnableInputLine(string parameterName, int index, bool state)

Parameters

parameterName string

The name of the matrix parameter.

index int

The index of the input.

state bool

true to enable the input; otherwise, false.

Examples

var dummy = engine.GetDummy("dummy1");
dummy.MatrixEnableInputLine("Example Matrix", 2, false);

Remarks

The 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.

MatrixEnableInputLine(string, string, bool)

Enables or disables the specified matrix input.

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 void MatrixEnableInputLine(string parameterName, string inputLineLabel, bool state)

Parameters

parameterName string

The name of the matrix parameter.

inputLineLabel string

The label of the input.

state bool

true to enable the input; otherwise, false.

Examples

var dummy = engine.GetDummy("dummy1");
dummy.MatrixEnableInputLine("Example Matrix", "Input 4", false);

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.