Method IsMatrixCrosspointConnected

Namespace

Skyline.DataMiner.Automation

Assembly

SLManagedAutomation.dll

IsMatrixCrosspointConnected(int, string, string)

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

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

IsMatrixCrosspointConnected(int, int, int)

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

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.

Remarks

input must be in the range 1..nrOfInputs.

output must be 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.")]
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.

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.

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.")]
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.

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.