Package dataModelFX

Class ModuleNodeParams

java.lang.Object

PamController.UsedModuleInfo

dataModelFX.ModuleNodeParams

All Implemented Interfaces:

ConnectionNodeParams, Serializable, ManagedParameters

public class ModuleNodeParams
extends UsedModuleInfo
implements ConnectionNodeParams, Serializable, ManagedParameters

Holds seriliazbale informations on a ModuleConnectionNode.

Author:

Jamie Macaulay

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface dataModelFX.ConnectionNodeParams

ConnectionNodeParams.PAMConnectionNodeType

Field Summary

Fields

Modifier and Type	Field	Description
static final double[]	DEFAULT_COLOUR	The default colour of a module rectangle.
static final double	DEFAULT_HEIGHT
static final double	DEFAULT_WIDTH
static final double	DISABLED_OPACITY	The opacity to set disabled modules
double	prefHeight	The preferred height of the module connection node.
double	prefWidth	The preferred width of the module connection node

Fields inherited from class PamController.UsedModuleInfo

className, unitName

Constructor Summary

Constructors

Constructor	Description
ModuleNodeParams(ModuleConnectionNode moduleConnectionNode)
ModuleNodeParams(String className, String unitType, String unitName, javafx.geometry.Point2D location, boolean settingsShowing)

Method Summary

Modifier and Type	Method	Description
UUID	getID()	Get the unique ID for the node.
double	getLayoutX()	The x location of the module.
double	getLayoutY()	The y location of the module.
ConnectionNodeParams.PAMConnectionNodeType	getNodeType()	Get the node type.
PamParameterSet	getParameterSet()	Get a set of data that describes all of the parameters in a class
void	setLayoutX(double layoutX)
void	setLayoutY(double layoutY)
void	setNodeType(ConnectionNodeParams.PAMConnectionNodeType connectionnoNodeType)

Methods inherited from class PamController.UsedModuleInfo

getUnitName, getUnitType, setUnitType, toString

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_WIDTH

public static final double DEFAULT_WIDTH

See Also:

• Constant Field Values

DEFAULT_HEIGHT

public static final double DEFAULT_HEIGHT

See Also:

• Constant Field Values

DEFAULT_COLOUR

public static final double[] DEFAULT_COLOUR

The default colour of a module rectangle.

DISABLED_OPACITY

public static final double DISABLED_OPACITY

The opacity to set disabled modules

See Also:

• Constant Field Values

prefWidth

public double prefWidth

The preferred width of the module connection node

prefHeight

public double prefHeight

The preferred height of the module connection node.

Constructor Details

ModuleNodeParams

public ModuleNodeParams(ModuleConnectionNode moduleConnectionNode)

ModuleNodeParams

public ModuleNodeParams(String className,
 String unitType,
 String unitName,
 javafx.geometry.Point2D location,
 boolean settingsShowing)

Method Details

getLayoutX

public double getLayoutX()

Description copied from interface: ConnectionNodeParams

The x location of the module.

Specified by:

getLayoutX in interface ConnectionNodeParams

getLayoutY

public double getLayoutY()

Description copied from interface: ConnectionNodeParams

The y location of the module.

Specified by:

getLayoutY in interface ConnectionNodeParams

setLayoutX

public void setLayoutX(double layoutX)

setLayoutY

public void setLayoutY(double layoutY)

setNodeType

public void setNodeType(ConnectionNodeParams.PAMConnectionNodeType connectionnoNodeType)

getNodeType

public ConnectionNodeParams.PAMConnectionNodeType getNodeType()

Description copied from interface: ConnectionNodeParams

Get the node type. This indicates what type of conneciton node the parameter belong to.

Specified by:

getNodeType in interface ConnectionNodeParams

Returns:

the connection node type.

getID

public UUID getID()

Description copied from interface: ConnectionNodeParams

Get the unique ID for the node. This should eb the same after the node has been saved.

Specified by:

getID in interface ConnectionNodeParams

Returns:

the unique ID number.

getParameterSet

public PamParameterSet getParameterSet()

Description copied from interface: ManagedParameters

Get a set of data that describes all of the parameters in a class

Specified by:

getParameterSet in interface ManagedParameters

Overrides:

getParameterSet in class UsedModuleInfo

Returns:

description of the parameters in a class.