Method MatrixSetLabel

Namespace

Skyline.DataMiner.Automation

Assembly

SLManagedAutomation.dll

MatrixSetLabel(int, bool, int, string)

Sets the label of the specified matrix input or output.

public virtual void MatrixSetLabel(int pid, bool input, int index, string newName)

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.

newName string

The new label.

Examples

var dummy = engine.GetDummy("dummy1");
dummy.MatrixSetLabel(1000, true, 4, "Main");

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.

MatrixSetLabel(int, bool, string, string)

Sets the label of the specified matrix input or output.

public virtual void MatrixSetLabel(int pid, bool input, string oldName, string newName)

Parameters

pid int

The ID of the matrix parameter.

input bool

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

oldName string

The label of the input or output.

newName string

The new label.

Examples

var dummy = engine.GetDummy("dummy1");
dummy.MatrixSetLabel(1000, true, "Input 1", "Main");

Exceptions

DataMinerException

The matrix parameter was not found.
-or-
input is true and there is no input with the specified label.
-or-
input is false and there is no output with the specified label.

MatrixSetLabel(string, bool, int, string)

Sets the label of the specified matrix input or 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 MatrixSetLabel(string parameterName, bool input, int index, string newName)

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.

newName string

The new label.

Examples

var dummy = engine.GetDummy("dummy1");
dummy.MatrixSetLabel("Example Matrix", true, 4, "Main");

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.

MatrixSetLabel(string, bool, string, string)

Sets the label of the specified matrix input or 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 MatrixSetLabel(string parameterName, bool input, string oldName, string newName)

Parameters

parameterName string

The name of the matrix parameter.

input bool

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

oldName string

The label of the input or output.

newName string

The new label.

Examples

var dummy = engine.GetDummy("dummy1");
dummy.MatrixSetLabel("Example Matrix", true, "Input 1", "Main");

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-
input is true and there is no input with the specified label.
-or-
input is false and there is no output with the specified label.