Method MatrixEnableOutputLine

Namespace

Skyline.DataMiner.Automation

Assembly

SLManagedAutomation.dll

MatrixEnableOutputLine(int, int, bool)

Enables or disables the specified matrix output.

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

Parameters

pid int

The ID of the matrix parameter.

index int

The index of the output.

state bool

true to enable the output; otherwise, false.

Examples

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

Remarks

index must be in the range 1..nrOfOutputs.

Exceptions

DataMinerException

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

MatrixEnableOutputLine(int, string, bool)

Enables or disables the specified matrix output.

public virtual void MatrixEnableOutputLine(int pid, string outputLineLabel, bool state)

Parameters

pid int

The ID of the matrix parameter.

outputLineLabel string

The label of the output.

state bool

true to enable the output; otherwise, false.

Examples

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

Exceptions

DataMinerException

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

MatrixEnableOutputLine(string, int, bool)

Enables or disables the specified matrix output.

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

Parameters

parameterName string

The name of the matrix parameter.

index int

The index of the output.

state bool

true to enable the output; otherwise, false.

Examples

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

index must be in the range 1..nrOfOutputs.

Exceptions

DataMinerException

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

MatrixEnableOutputLine(string, string, bool)

Enables or disables the specified matrix output.

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 MatrixEnableOutputLine(string parameterName, string outputLineLabel, bool state)

Parameters

parameterName string

The name of the matrix parameter.

outputLineLabel string

The label of the output.

state bool

true to enable the output; otherwise, false.

Examples

var dummy = engine.GetDummy("dummy1");
dummy.MatrixEnableOutputLine("Example Matrix", "Output 2", 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 output with the specified label.