Method ConnectMatrixCrosspoint

Namespace

Skyline.DataMiner.Automation

Assembly

SLManagedAutomation.dll

ConnectMatrixCrosspoint(int, int, int)

Connects the specified matrix crosspoint.

public virtual void ConnectMatrixCrosspoint(int pid, int input, int output)

Parameters

pid int

The ID of the matrix write parameter.

input int

The index of the matrix input.

output int

The index of the matrix output.

Examples

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

Remarks

The input must be in the range 1..nrOfInputs.

The output must be in the range 1..nrOfOutputs.

Exceptions

DataMinerException

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

ConnectMatrixCrosspoint(int, string, string)

Connects the specified matrix crosspoint.

public virtual void ConnectMatrixCrosspoint(int pid, string input, string output)

Parameters

pid int

The ID of the matrix write parameter.

input string

The label of the matrix input.

output string

The label of the matrix output.

Examples

var dummy = engine.GetDummy("dummy1");
dummy.ConnectMatrixCrosspoint(1000, "Input 1", "Output 10");

Exceptions

DataMinerException

The specified 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.

ConnectMatrixCrosspoint(string, int, int)

Connects the specified matrix crosspoint.

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 ConnectMatrixCrosspoint(string name, int input, int output)

Parameters

name string

The name of the matrix parameter.

input int

The index of the matrix input.

output int

The index of the matrix output.

Examples

var dummy = engine.GetDummy("dummy1");
dummy.ConnectMatrixCrosspoint("Example matrix", 1, 10);

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.

input must be in the range 1..nrOfInputs.

output must be in the range 1..nrOfOutputs.

Exceptions

DataMinerException

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

ConnectMatrixCrosspoint(string, string, string)

Connects the specified matrix crosspoint.

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 ConnectMatrixCrosspoint(string name, string input, string output)

Parameters

name string

The name of the matrix parameter.

input string

The label of the matrix input.

output string

The label of the matrix output.

Examples

var dummy = engine.GetDummy("dummy1");
dummy.ConnectMatrixCrosspoint("Example matrix", "Input 1", "Output 10");

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