Class ControllerDataExchange.ControllerOutput

java.lang.Object

neqsim.process.mpc.ControllerDataExchange.ControllerOutput

All Implemented Interfaces:

Serializable

Enclosing class:

ControllerDataExchange

public static class ControllerDataExchange.ControllerOutput
extends Object
implements Serializable

Container for controller output data.

Since:

3.0

Version:

1.0

Author:

Even Solbraa

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private final double[][]	cvPredictions
private final String	message
private final double[]	mvTargets
private static final long	serialVersionUID
private final ControllerDataExchange.ExecutionStatus	status
private final Instant	timestamp

Constructor Summary

Constructors

Constructor	Description
ControllerOutput(double[] mvTargets, double[][] cvPredictions, ControllerDataExchange.ExecutionStatus status, String message, Instant timestamp)	Construct a controller output.

Method Summary

Modifier and Type	Method	Description
double[][]	getCvPredictions()	Get CV predictions.
String	getMessage()	Get execution message.
double[]	getMvTargets()	Get MV target values.
ControllerDataExchange.ExecutionStatus	getStatus()	Get execution status.
Instant	getTimestamp()	Get execution timestamp.
boolean	isSuccess()	Check if execution was successful.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

mvTargets

private final double[] mvTargets

cvPredictions

private final double[][] cvPredictions

status

private final ControllerDataExchange.ExecutionStatus status

message

private final String message

timestamp

private final Instant timestamp

Constructor Details

ControllerOutput

public ControllerOutput(double[] mvTargets,
 double[][] cvPredictions,
 ControllerDataExchange.ExecutionStatus status,
 String message,
 Instant timestamp)

Construct a controller output.

Parameters:

mvTargets - the MV target values

cvPredictions - the CV prediction trajectories

status - the execution status

message - the execution message

timestamp - the execution timestamp

Method Details

getMvTargets

public double[] getMvTargets()

Get MV target values.

Returns:

copy of MV targets

getCvPredictions

public double[][] getCvPredictions()

Get CV predictions.

Returns:

copy of CV predictions

getStatus

public ControllerDataExchange.ExecutionStatus getStatus()

Get execution status.

Returns:

the status

getMessage

public String getMessage()

Get execution message.

Returns:

the message

getTimestamp

public Instant getTimestamp()

Get execution timestamp.

Returns:

the timestamp

isSuccess

public boolean isSuccess()

Check if execution was successful.

Returns:

true if status is SUCCESS