Method IsMatrixCrosspointConnected

Namespace

Skyline.DataMiner.Automation

Assembly

SLManagedAutomation.dll

IsMatrixCrosspointConnected(int, string, string)

Returns a value indicating whether the specified matrix crosspoint is connected.

public virtual bool IsMatrixCrosspointConnected(int pid, string input, string output)

Parameters

pid int

The ID of the matrix parameter.

input string

The matrix input.

output string

The matrix output.

Returns

bool

true if the specified matrix crosspoint is connected; otherwise, false.

Examples

var dummy = engine.GetDummy("dummy1");
bool isConnected = dummy.IsMatrixCrosspointConnected(1000, "Input 1", "Output 7");

Exceptions

DataMinerException

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

IsMatrixCrosspointConnected(int, int, int)

Returns a value indicating whether the specified matrix crosspoint is connected.

public virtual bool IsMatrixCrosspointConnected(int pid, int input, int output)

Parameters

pid int

The ID of the matrix parameter.

input int

The matrix input.

output int

The matrix output.

Returns

bool

true if the specified matrix crosspoint is connected; otherwise, false.

Examples

var dummy = engine.GetDummy("dummy1");
bool isConnected = dummy.IsMatrixCrosspointConnected(1000, 1, 7);

Remarks

input must be in the range 1..nrOfInputs.

output must be in the range 1..nrOfOutputs.

Exceptions

DataMinerException

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

IsMatrixCrosspointConnected(string, int, int)

Returns a value indicating whether the specified matrix crosspoint is connected.

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

Parameters

name string

The name of the matrix parameter.

input int

The matrix input.

output int

The matrix output.

Returns

bool

true if the specified matrix crosspoint is connected; otherwise, false.

Examples

var dummy = engine.GetDummy("dummy1");
bool isConnected = dummy.IsMatrixCrosspointConnected("Example matrix", 1, 7);

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 matrix parameter was not found.
-or-
input is not in the range 1..nrOfInputs.
-or-
output is not in the range 1..nrOfOutputs.

IsMatrixCrosspointConnected(string, string, string)

Returns a value indicating whether the specified matrix crosspoint is connected.

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

Parameters

name string

The name of the matrix parameter.

input string

The matrix input.

output string

The matrix output.

Returns

bool

true if the specified matrix crosspoint is connected; otherwise, false.

Examples

var dummy = engine.GetDummy("dummy1");
bool isConnected = dummy.IsMatrixCrosspointConnected("Example matrix", "Input 1", "Output 7");

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 matrix parameter was not found.
-or-
There is no matrix input with the specified input label..
-or-
There is no matrix output with the specified output label.