Method GetMatrixInputForOutput

Namespace

Skyline.DataMiner.Automation

Assembly

SLManagedAutomation.dll

GetMatrixInputForOutput(int, string)

Gets the input that is connected to the specified output.

public virtual int GetMatrixInputForOutput(int pid, string output)

Parameters

pid int

The ID of the matrix parameter.

output string

The output.

Returns

int

The connected input or 0 if the output is not connected.

Examples

var dummy = engine.GetDummy("dummy1");
int connectedInput = dummy.GetMatrixInputForOutput(1000, "Output 4");

Exceptions

DataMinerException

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

GetMatrixInputForOutput(int, int)

Gets the input that is connected to the specified output.

public virtual int GetMatrixInputForOutput(int pid, int output)

Parameters

pid int

The ID of the matrix parameter.

output int

The output.

Returns

int

The connected input or 0 if the output is not connected.

Examples

var dummy = engine.GetDummy("dummy1");
int connectedInput = dummy.GetMatrixInputForOutput(1000, 4);

Remarks

output must be in the range 1..nrOfOutputs.

Exceptions

DataMinerException

The specified matrix parameter was not found.
-or-
output is not in the range 1..nrOfOutputs.

GetMatrixInputForOutput(string, int)

Gets the input that is connected to the specified 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 int GetMatrixInputForOutput(string name, int output)

Parameters

name string

The name of the matrix parameter.

output int

The output.

Returns

int

The connected input or 0 if the output is not connected.

Examples

var dummy = engine.GetDummy("dummy1");
int connectedInput = dummy.GetMatrixInputForOutput("Example matrix", 4);

Remarks

The specified value for the name argument should be the value of the Description tag of the parameter and not the value of the Name tag.

output must be in the range 1..nrOfOutputs.

Exceptions

DataMinerException

The specified matrix parameter was not found.
-or-
output is not in the range 1..nrOfOutputs.

GetMatrixInputForOutput(string, string)

Gets the input that is connected to the specified 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 int GetMatrixInputForOutput(string name, string output)

Parameters

name string

The label of the matrix parameter.

output string

The output.

Returns

int

The connected input or 0 if the output is not connected.

Examples

var dummy = engine.GetDummy("dummy1");
int connectedInput = dummy.GetMatrixInputForOutput("Example matrix", "Output 4");

Remarks

The specified value for the name argument should be the value of the Description tag of the parameter and not the value of the Name tag.

Exceptions

DataMinerException

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