Package mgui.models.environments

Class SimpleEnvironment<T extends MguiNumber>

java.lang.Object

mgui.interfaces.AbstractInterfaceObject

mgui.models.environments.SimpleEnvironment<T>

All Implemented Interfaces:

java.lang.Cloneable, InterfaceObject, NamedObject, TreeObject, CleanableObject, DynamicModelEnvironment<T>, TimeStepListener, Updateable

public class SimpleEnvironment<T extends MguiNumber>
extends AbstractInterfaceObject
implements DynamicModelEnvironment<T>, InterfaceObject, TreeObject

Represents a simple environment, with a set of named observable scalar state variables.

Since:

1.0

Version:

1.0

Author:

Andrew Reid

Field Summary

Fields

Modifier and Type	Field	Description
protected double	clock
protected SimpleEnvironmentInputDataSource<T>	input_data_source
protected NameMap	input_names
protected double[]	inputState
protected boolean	isDestroyed
int	mode
protected SimpleEnvironmentObservableDataSource<T>	observable_data_source
protected NameMap	observable_names
protected double[]	observableState
java.util.ArrayList<DynamicModelEnvironmentSensor>	sensors
protected java.util.ArrayList<InterfaceTreeNode>	treeNodes
boolean	updated
SimpleEnvironmentUpdater	updater

Fields inherited from class mgui.interfaces.AbstractInterfaceObject

tree_nodes

Constructor Summary

Constructors

Constructor	Description
SimpleEnvironment()
SimpleEnvironment(SimpleEnvironmentUpdater updater)	Creates an instance of SimpleEnvironment with the specified updater.

Method Summary

Modifier and Type	Method	Description
void	addListener(DynamicModelEnvironmentListener l)
void	addSensor(DynamicModelEnvironmentSensor s)
java.lang.Object	clone()
void	destroy()	Destroy this object (prepare it to be removed from memory)
protected void	fireListeners()
protected void	fireSensors()
double	getClock()
java.util.List<InterfaceDataSource<T>>	getDataSources()
double[]	getDeltas(double[] comp)	Returns the difference between this environment's current state and the given values.
AbstractEnvironmentDataSource<T>	getInputDataSource()
java.util.List<java.lang.String>	getInputNames()
double[]	getInputState()
double	getInputState(int i)
int	getMode()
AbstractEnvironmentDataSource<T>	getObservableDataSource()
java.util.ArrayList<java.lang.String>	getObservableNames()
int	getObservableSize()
double[]	getObservableState()
double	getObservableState(int i)
double[]	getSquaredDeltas(double[] comp)	Returns the squared difference between this environment's current state and the given values.
InterfaceTreeNode	getTreeNodeCopy()
void	handleOutputEvent(DynamicModelOutputEvent e)
boolean	hasSensor(DynamicModelEnvironmentSensor s)
boolean	isDestroyed()	Test whether this object has been destroyed
InterfaceTreeNode	issueTreeNode()	Issues a new tree node and sets it using AbstractInterfaceObject.setTreeNode(mgui.interfaces.trees.InterfaceTreeNode).
void	removeListener(DynamicModelEnvironmentListener l)
void	removeObservableName(int index)
void	removeObservableName(java.lang.String name)
void	removeSensor(DynamicModelEnvironmentSensor s)
void	reset()
void	resetInputDataSource()
protected void	resetInputNames()
protected void	resetInputState()
void	resetObservableDataSource()
protected void	resetObservableState()
void	setInputName(int index, java.lang.String name)
void	setInputNames(java.util.List<java.lang.String> names)
void	setInputSize(int s)
void	setInputState(double[] v)
void	setMode(int m)
void	setObservableName(int index, java.lang.String name)
void	setObservableNames(NameMap names)
void	setObservableSize(int s)
void	setObservableState(double[] values)
void	setObservableState(int index, double value)
void	setTreeNode()
void	setUpdater(DynamicModelUpdater updater)
void	timeElapsed(double time)
java.lang.String	toString()

Methods inherited from class mgui.interfaces.AbstractInterfaceObject

clean, getName, getTreeLabel, setName, setTreeNode, updateTreeNodes

Methods inherited from class java.lang.Object

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

Methods inherited from interface mgui.interfaces.util.CleanableObject

clean

Methods inherited from interface mgui.interfaces.NamedObject

getName, setName

Methods inherited from interface mgui.interfaces.trees.TreeObject

getTreeLabel, setTreeNode

Field Details

inputState

protected double[] inputState

observableState

protected double[] observableState

clock

protected double clock

updater

public SimpleEnvironmentUpdater updater

sensors

public java.util.ArrayList<DynamicModelEnvironmentSensor> sensors

updated

public boolean updated

mode

public int mode

observable_data_source

protected SimpleEnvironmentObservableDataSource<T extends MguiNumber> observable_data_source

input_data_source

protected SimpleEnvironmentInputDataSource<T extends MguiNumber> input_data_source

treeNodes

protected java.util.ArrayList<InterfaceTreeNode> treeNodes

observable_names

protected NameMap observable_names

input_names

protected NameMap input_names

isDestroyed

protected boolean isDestroyed

Constructor Details

SimpleEnvironment

public SimpleEnvironment()

SimpleEnvironment

public SimpleEnvironment(SimpleEnvironmentUpdater updater)

Creates an instance of SimpleEnvironment with the specified updater.

Parameters:

updater -

Method Details

getClock

public double getClock()

Specified by:

getClock in interface DynamicModelEnvironment<T extends MguiNumber>

addListener

public void addListener(DynamicModelEnvironmentListener l)

Specified by:

addListener in interface DynamicModelEnvironment<T extends MguiNumber>

removeListener

public void removeListener(DynamicModelEnvironmentListener l)

Specified by:

removeListener in interface DynamicModelEnvironment<T extends MguiNumber>

fireListeners

protected void fireListeners()

setUpdater

public void setUpdater(DynamicModelUpdater updater)
                throws DynamicModelException

Specified by:

setUpdater in interface DynamicModelEnvironment<T extends MguiNumber>

Throws:

DynamicModelException

getDataSources

public java.util.List<InterfaceDataSource<T>> getDataSources()

Specified by:

getDataSources in interface DynamicModelEnvironment<T extends MguiNumber>

setInputState

public void setInputState(double[] v)

getInputState

public double[] getInputState()

Specified by:

getInputState in interface DynamicModelEnvironment<T extends MguiNumber>

getInputState

public double getInputState(int i)

Specified by:

getInputState in interface DynamicModelEnvironment<T extends MguiNumber>

setInputName

public void setInputName(int index,
java.lang.String name)

Specified by:

setInputName in interface DynamicModelEnvironment<T extends MguiNumber>

setInputNames

public void setInputNames(java.util.List<java.lang.String> names)

Specified by:

setInputNames in interface DynamicModelEnvironment<T extends MguiNumber>

getInputNames

public java.util.List<java.lang.String> getInputNames()

Specified by:

getInputNames in interface DynamicModelEnvironment<T extends MguiNumber>

setObservableName

public void setObservableName(int index,
java.lang.String name)

Specified by:

setObservableName in interface DynamicModelEnvironment<T extends MguiNumber>

setObservableNames

public void setObservableNames(NameMap names)

Specified by:

setObservableNames in interface DynamicModelEnvironment<T extends MguiNumber>

getObservableNames

public java.util.ArrayList<java.lang.String> getObservableNames()

Specified by:

getObservableNames in interface DynamicModelEnvironment<T extends MguiNumber>

removeObservableName

public void removeObservableName(java.lang.String name)

Specified by:

removeObservableName in interface DynamicModelEnvironment<T extends MguiNumber>

removeObservableName

public void removeObservableName(int index)

Specified by:

removeObservableName in interface DynamicModelEnvironment<T extends MguiNumber>

setObservableState

public void setObservableState(double[] values)

Specified by:

setObservableState in interface DynamicModelEnvironment<T extends MguiNumber>

setObservableState

public void setObservableState(int index,
double value)

Specified by:

setObservableState in interface DynamicModelEnvironment<T extends MguiNumber>

getObservableState

public double getObservableState(int i)

Specified by:

getObservableState in interface DynamicModelEnvironment<T extends MguiNumber>

getObservableState

public double[] getObservableState()

Specified by:

getObservableState in interface DynamicModelEnvironment<T extends MguiNumber>

getObservableSize

public int getObservableSize()

Specified by:

getObservableSize in interface DynamicModelEnvironment<T extends MguiNumber>

getDeltas

public double[] getDeltas(double[] comp)

Returns the difference between this environment's current state and the given values. Calculated as delta[i] = env[i] - comp[i].

Parameters:

comp -

Returns:

getSquaredDeltas

public double[] getSquaredDeltas(double[] comp)

Returns the squared difference between this environment's current state and the given values.

Parameters:

comp -

Returns:

timeElapsed

public void timeElapsed(double time)

Specified by:

timeElapsed in interface TimeStepListener

setMode

public void setMode(int m)

getMode

public int getMode()

reset

public void reset()

Specified by:

reset in interface DynamicModelEnvironment<T extends MguiNumber>

resetInputState

protected void resetInputState()

resetObservableState

protected void resetObservableState()

fireSensors

protected void fireSensors()

handleOutputEvent

public void handleOutputEvent(DynamicModelOutputEvent e)

Specified by:

handleOutputEvent in interface DynamicModelEnvironment<T extends MguiNumber>

setObservableSize

public void setObservableSize(int s)

Specified by:

setObservableSize in interface DynamicModelEnvironment<T extends MguiNumber>

setInputSize

public void setInputSize(int s)

Specified by:

setInputSize in interface DynamicModelEnvironment<T extends MguiNumber>

addSensor

public void addSensor(DynamicModelEnvironmentSensor s)

Specified by:

addSensor in interface DynamicModelEnvironment<T extends MguiNumber>

removeSensor

public void removeSensor(DynamicModelEnvironmentSensor s)

Specified by:

removeSensor in interface DynamicModelEnvironment<T extends MguiNumber>

getObservableDataSource

public AbstractEnvironmentDataSource<T> getObservableDataSource()

Specified by:

getObservableDataSource in interface DynamicModelEnvironment<T extends MguiNumber>

resetObservableDataSource

public void resetObservableDataSource()

getInputDataSource

public AbstractEnvironmentDataSource<T> getInputDataSource()

Specified by:

getInputDataSource in interface DynamicModelEnvironment<T extends MguiNumber>

resetInputDataSource

public void resetInputDataSource()

resetInputNames

protected void resetInputNames()

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object

issueTreeNode

public InterfaceTreeNode issueTreeNode()

Description copied from class: AbstractInterfaceObject

Issues a new tree node and sets it using AbstractInterfaceObject.setTreeNode(mgui.interfaces.trees.InterfaceTreeNode). The tree node is stored in this object, which facilitates their destruction when necessary (e.g., when this object is destroyed). All issued tree nodes can informed of changes to their user object using the method AbstractInterfaceObject.updateTreeNodes().

Specified by:

issueTreeNode in interface TreeObject

Overrides:

issueTreeNode in class AbstractInterfaceObject

Returns:

a new InterfaceTreeNode

hasSensor

public boolean hasSensor(DynamicModelEnvironmentSensor s)

getTreeNodeCopy

public InterfaceTreeNode getTreeNodeCopy()

setTreeNode

public void setTreeNode()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

destroy

public void destroy()

Description copied from interface: InterfaceObject

Destroy this object (prepare it to be removed from memory)

Specified by:

destroy in interface InterfaceObject

Overrides:

destroy in class AbstractInterfaceObject

isDestroyed

public boolean isDestroyed()

Description copied from interface: InterfaceObject

Test whether this object has been destroyed

Specified by:

isDestroyed in interface InterfaceObject

Overrides:

isDestroyed in class AbstractInterfaceObject

Returns: