Method MatrixIsOutputLineEnabled

Namespace

Skyline.DataMiner.Automation

Assembly

SLManagedAutomation.dll

MatrixIsOutputLineEnabled(int, int)

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

public virtual bool MatrixIsOutputLineEnabled(int pid, int index)

Parameters

pid int

The ID of the matrix parameter.

index int

The index of the matrix output.

Returns

bool

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

Examples

var dummy = engine.GetDummy("dummy1");
bool isOutputEnabled = dummy.MatrixIsOutputLineEnabled(1000, 4);

Remarks

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

MatrixIsOutputLineEnabled(int, string)

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

public virtual bool MatrixIsOutputLineEnabled(int pid, string lineLabel)

Parameters

pid int

The ID of the matrix parameter.

lineLabel string

The label of the matrix output.

Returns

bool

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

Examples

var dummy = engine.GetDummy("dummy1");
bool isOutputEnabled = dummy.MatrixIsOutputLineEnabled(1000, "Output 4");

Exceptions

DataMinerException

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

MatrixIsOutputLineEnabled(string, int)

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

Parameters

parameterName string

The name of the matrix parameter.

index int

The index of the matrix output.

Returns

bool

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

Examples

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

Remarks

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

MatrixIsOutputLineEnabled(string, string)

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

Parameters

parameterName string

The name of the matrix parameter.

lineLabel string

The label of the matrix output.

Returns

bool

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

Examples

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