Method MatrixGetFollowMode

Namespace

Skyline.DataMiner.Automation

Assembly

SLManagedAutomation.dll

MatrixGetFollowMode(int, int)

Gets a value indicating whether "follow mode" is enabled on the specified matrix output.

public virtual bool MatrixGetFollowMode(int pid, int index)

Parameters

pid int

The ID of the matrix parameter.

index int

The index of the output.

Returns

bool

true if the "follow mode" is enabled on the specified matrix output; otherwise, false.

Examples

var dummy = engine.GetDummy("dummy1");
dummy.MatrixGetFollowMode(1000, 1);

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.

MatrixGetFollowMode(int, string)

Gets a value indicating whether "follow mode" is enabled on the specified matrix output.

public virtual bool MatrixGetFollowMode(int pid, string outputLabel)

Parameters

pid int

The ID of the matrix parameter.

outputLabel string

The label of the output.

Returns

bool

true if the "follow mode" is enabled on the specified matrix output; otherwise, false.

Examples

var dummy = engine.GetDummy("dummy1");
dummy.MatrixGetFollowMode(1000, "Output 1");

Exceptions

DataMinerException

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

MatrixGetFollowMode(string, int)

Gets a value indicating whether "follow mode" is enabled on 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 bool MatrixGetFollowMode(string parameterName, int index)

Parameters

parameterName string

The name of the matrix parameter.

index int

The index of the output.

Returns

bool

true if the "follow mode" is enabled on the specified matrix output; otherwise, false.

Examples

var dummy = engine.GetDummy("dummy1");
dummy.MatrixGetFollowMode("Example Matrix", 1);

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.

MatrixGetFollowMode(string, string)

Gets a value indicating whether "follow mode" is enabled on 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 bool MatrixGetFollowMode(string parameterName, string outputLabel)

Parameters

parameterName string

The name of the matrix parameter.

outputLabel string

The label of the output.

Returns

bool

true if the "follow mode" is enabled on the specified matrix output; otherwise, false.

Examples

var dummy = engine.GetDummy("dummy1");
dummy.MatrixGetFollowMode("Example Matrix", "Output 1");

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.