Method MatrixGetLockMode

Namespace

Skyline.DataMiner.Automation

Assembly

SLManagedAutomation.dll

MatrixGetLockMode(int, bool, string)

Gets a value indicating whether the specified input or output is locked.

public virtual bool MatrixGetLockMode(int pid, bool input, string label)

Parameters

pid int

The ID of the matrix parameter.

input bool

true if the specified index is an input; otherwise, false.

label string

The label of the input or output.

Returns

bool

The label of the specified matrix input or output.

Examples

var dummy = engine.GetDummy("dummy1");
string label = dummy.MatrixGetLockMode(1000, true, "Input 10");

Exceptions

DataMinerException

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

MatrixGetLockMode(int, bool, int)

Gets a value indicating whether the specified input or output is locked.

public virtual bool MatrixGetLockMode(int pid, bool input, int index)

Parameters

pid int

The ID of the matrix parameter.

input bool

true if the specified index is an input; otherwise, false.

index int

The index of the input or output.

Returns

bool

The label of the specified matrix input or output.

Examples

var dummy = engine.GetDummy("dummy1");
string label = dummy.MatrixGetLockMode(1000, true, 10);

Remarks

index must be in the range 1..nrOfInputs if input is true.

index must be in the range 1..nrOfOutputs if input is false.

Exceptions

DataMinerException

The matrix parameter was not found.
-or-
index is not in the range 1..nrOfInputs and input is true.
-or-
index is not in the range 1..nrOfOutputs and input is false.

MatrixGetLockMode(string, bool, string)

Gets a value indicating whether the specified input or output is locked.

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 MatrixGetLockMode(string parameterName, bool input, string label)

Parameters

parameterName string

The name of the matrix parameter.

input bool

true if the specified index is an input; otherwise, false.

label string

The label of the input or output.

Returns

bool

The label of the specified matrix input or output.

Examples

var dummy = engine.GetDummy("dummy1");
string label = dummy.MatrixGetLockMode("Example Matrix", true, "Input 10");

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 input label.
-or-
There is no output with the specified output label.

MatrixGetLockMode(string, bool, int)

Gets a value indicating whether the specified input or output is locked.

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

Parameters

parameterName string

The name of the matrix parameter.

input bool

true if the specified index is an input; otherwise, false.

index int

The index of the input or output.

Returns

bool

The label of the specified matrix input or output.

Examples

var dummy = engine.GetDummy("dummy1");
string label = dummy.MatrixGetLockMode("Example Matrix", true, 10);

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..nrOfInputs if input is true.

index must be in the range 1..nrOfOutputs if input is false.

Exceptions

DataMinerException

The matrix parameter was not found.
-or-
index is not in the range 1..nrOfInputs and input is true.
-or-
index is not in the range 1..nrOfOutputs and input is false.