Class SimulationVariable

java.lang.Object

neqsim.process.automation.SimulationVariable

All Implemented Interfaces:

Serializable

public class SimulationVariable
extends Object
implements Serializable

Describes a single variable exposed by a unit operation in a process simulation. Each variable has a stable string address that can be used with ProcessAutomation.getVariableValue(String, String) and ProcessAutomation.setVariableValue(String, double, String).

Version:

1.0

Author:

Even Solbraa

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SimulationVariable.VariableType	Variable access type.

Field Summary

Fields

Modifier and Type	Field	Description
private final String	address
private final String	defaultUnit
private final String	description
private final String	name
private static final long	serialVersionUID	Serialization version UID.
private final SimulationVariable.VariableType	type

Constructor Summary

Constructors

Constructor	Description
SimulationVariable(String address, String name, SimulationVariable.VariableType type, String defaultUnit, String description)	Creates a new simulation variable descriptor.

Method Summary

Modifier and Type	Method	Description
String	getAddress()	Returns the stable dot-notation address for this variable.
String	getDefaultUnit()	Returns the default unit of measure.
String	getDescription()	Returns a human-readable description of the variable.
String	getName()	Returns the short property name.
SimulationVariable.VariableType	getType()	Returns whether this variable is an input or output.
String	toString()

Methods inherited from class Object

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

Field Details

serialVersionUID

private static final long serialVersionUID

Serialization version UID.

See Also:

• Constant Field Values

address

private final String address

name

private final String name

type

private final SimulationVariable.VariableType type

defaultUnit

private final String defaultUnit

description

private final String description

Constructor Details

SimulationVariable

public SimulationVariable(String address,
 String name,
 SimulationVariable.VariableType type,
 String defaultUnit,
 String description)

Creates a new simulation variable descriptor.

Parameters:

address - the stable dot-separated address, e.g. "separator-1.gasOutStream.temperature"

name - the short property name, e.g. "temperature"

type - whether the variable is INPUT (read-write) or OUTPUT (read-only)

defaultUnit - the default unit of measure, e.g. "K", "bara", "kg/hr"

description - a human-readable description

Method Details

getAddress

public String getAddress()

Returns the stable dot-notation address for this variable.

Returns:

the variable address

getName

public String getName()

Returns the short property name.

Returns:

the property name

getType

public SimulationVariable.VariableType getType()

Returns whether this variable is an input or output.

Returns:

the variable type

getDefaultUnit

public String getDefaultUnit()

Returns the default unit of measure.

Returns:

the default unit string

getDescription

public String getDescription()

Returns a human-readable description of the variable.

Returns:

the description

toString

public String toString()

Overrides:

toString in class Object