Method MatrixStopBeingMaster

Namespace

Skyline.DataMiner.Automation

Assembly

SLManagedAutomation.dll

MatrixStopBeingMaster(int, string)

Stops the specified matrix output from being a master output.

public virtual void MatrixStopBeingMaster(int pid, string masterLabel)

Parameters

pid int

The ID of the matrix parameter.

masterLabel string

The label of the master output.

Examples

var dummy = engine.GetDummy("dummy1");
dummy.MatrixStopBeingMaster(1000, "Output 1");

Exceptions

DataMinerException

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

MatrixStopBeingMaster(int, int)

Stops the specified matrix output from being a master output.

public virtual void MatrixStopBeingMaster(int pid, int master)

Parameters

pid int

The ID of the matrix parameter.

master int

The index of the master output.

Examples

master must be in the range 1..nrOfOutputs.

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

Exceptions

DataMinerException

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

MatrixStopBeingMaster(string, string)

Stops the specified matrix output from being a master 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 void MatrixStopBeingMaster(string parameterName, string masterLabel)

Parameters

parameterName string

The name of the matrix parameter.

masterLabel string

The label of the master output.

Examples

var dummy = engine.GetDummy("dummy1");
dummy.MatrixStopBeingMaster("Example Matrix", "Output 1");

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.

Exceptions

DataMinerException

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

MatrixStopBeingMaster(string, int)

Stops the specified matrix output from being a master 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 void MatrixStopBeingMaster(string parameterName, int master)

Parameters

parameterName string

The name of the matrix parameter.

master int

The index of the master output.

Examples

master must be in the range 1..nrOfOutputs.

var dummy = engine.GetDummy("dummy1");
dummy.MatrixStopBeingMaster("Example Matrix", 1);

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.

Exceptions

DataMinerException

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