Method MatrixSetFollowMaster

Namespace

Skyline.DataMiner.Automation

Assembly

SLManagedAutomation.dll

MatrixSetFollowMaster(int, int, int)

Configures a slave output to follow a master output on the specified matrix.

public virtual void MatrixSetFollowMaster(int pid, int master, int slave)

Parameters

pid int

The ID of the matrix parameter.

master int

The index of the master output.

slave int

The index of the slave output.

Examples

var dummy = engine.GetDummy("dummy1");
dummy.MatrixSetFollowMaster(1000, 4, 6);

Remarks

master must be in the range 1..nrOfOutputs.

slave must be in the range 1..nrOfOutputs.

Exceptions

DataMinerException

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

MatrixSetFollowMaster(int, string, string)

Configures a slave output to follow a master output on the specified matrix.

public virtual void MatrixSetFollowMaster(int pid, string masterLabel, string slaveLabel)

Parameters

pid int

The ID of the matrix parameter.

masterLabel string

The label of the master output.

slaveLabel string

The label of the slave output.

Examples

var dummy = engine.GetDummy("dummy1");
dummy.MatrixSetFollowMaster(1000, "Output 4", "Output 6");

Exceptions

DataMinerException

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

MatrixSetFollowMaster(string, int, int)

Configures a slave output to follow a master output on the specified matrix.

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 MatrixSetFollowMaster(string parameterName, int master, int slave)

Parameters

parameterName string

The name of the matrix parameter.

master int

The index of the master output.

slave int

The index of the slave output.

Examples

var dummy = engine.GetDummy("dummy1");
dummy.MatrixSetFollowMaster("Example Matrix", 4, 6);

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.

master must be in the range 1..nrOfOutputs.

slave must be in the range 1..nrOfOutputs.

Exceptions

DataMinerException

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

MatrixSetFollowMaster(string, string, string)

Configures a slave output to follow a master output on the specified matrix.

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 MatrixSetFollowMaster(string parameterName, string masterLabel, string slaveLabel)

Parameters

parameterName string

The name of the matrix parameter.

masterLabel string

The label of the master output.

slaveLabel string

The label of the slave output.

Examples

var dummy = engine.GetDummy("dummy1");
dummy.MatrixSetFollowMaster("Example Matrix", "Output 4", "Output 6");

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