Method MatrixGetOutputIndexFromOutputLabel

Namespace

Skyline.DataMiner.Automation

Assembly

SLManagedAutomation.dll

MatrixGetOutputIndexFromOutputLabel(int, string)

Gets the index of the output that corresponds with the specified output label.

public virtual int MatrixGetOutputIndexFromOutputLabel(int pid, string outputLabel)

Parameters

pid int

The ID of the matrix parameter.

outputLabel string

The label of the output.

Returns

int

The corresponding output index.

Examples

var dummy = engine.GetDummy("dummy1");
int index = dummy.MatrixGetOutputIndexFromOutputLabel(1000, "Output 10");

Remarks

The returned output is in the range 1..nrOfOutputs.

Exceptions

DataMinerException

The matrix parameter is not found.

DataMinerException

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

MatrixGetOutputIndexFromOutputLabel(string, string)

Gets the index of the output that corresponds with the specified output label.

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 int MatrixGetOutputIndexFromOutputLabel(string parameterName, string outputLabel)

Parameters

parameterName string

The name of the matrix parameter.

outputLabel string

The label of the output.

Returns

int

The corresponding output index.

Examples

var dummy = engine.GetDummy("dummy1");
int index = dummy.MatrixGetOutputIndexFromOutputLabel("Example matrix", "Output 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.

The returned output is in the range 1..nrOfOutputs.

Exceptions

DataMinerException

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