org.simbrain.world.odorworld

Class OdorWorldComponent

java.lang.Object

org.simbrain.workspace.WorkspaceComponent

org.simbrain.world.odorworld.OdorWorldComponent

public class OdorWorldComponent
extends WorkspaceComponent

WorldPanel is the container for the world component. Handles toolbar buttons, and serializing of world data. The main environment codes is in OdorWorldPanel.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) AttributeType	absoluteMovementType
(package private) AttributeType	hearingSensorType
(package private) AttributeType	smellSensorScalars
(package private) AttributeType	smellSensorVectors
(package private) AttributeType	speechEffectorType
(package private) AttributeType	straightMovementType
(package private) AttributeType	tileSensorType
(package private) AttributeType	turningType
(package private) AttributeType	xLocationType Attribute types.
(package private) AttributeType	yLocationType

Constructor Summary

Constructors

Constructor and Description
OdorWorldComponent(java.lang.String name) Default constructor.
OdorWorldComponent(java.lang.String name, OdorWorld world) Constructor used in deserializing.

Method Summary

Modifier and Type	Method and Description
void	closing() Perform cleanup after closing.
java.lang.String	getKeyFromObject(java.lang.Object object) Returns a unique key associated with an object.
java.lang.Object	getObjectFromKey(java.lang.String objectKey) Finds objects based on a key.
java.util.List<PotentialConsumer>	getPotentialConsumers() Return the potential consumers associated with this component.
java.util.List<PotentialProducer>	getPotentialProducers() Return the potential producers associated with this component.
OdorWorld	getWorld() Returns a reference to the odor world.
java.lang.String	getXML() Override for use with open service.
static OdorWorldComponent	open(java.io.InputStream input, java.lang.String name, java.lang.String format) Recreates an instance of this class from a saved component.
void	save(java.io.OutputStream output, java.lang.String format) Used when saving a workspace.
void	update() Called by Workspace to update the state of the component.

Methods inherited from class org.simbrain.workspace.WorkspaceComponent

addAttributeListener, addConsumerType, addProducerType, addWorkspaceComponentListener, close, couplingAdded, couplingRemoved, fireAttributeObjectRemoved, fireAttributeTypeVisibilityChanged, fireComponentToggleEvent, fireGuiToggleEvent, firePotentialAttributesChanged, fireUpdateEvent, getAttributeManager, getConsumerTypes, getCurrentFile, getDefaultFormat, getFormats, getLocks, getLogger, getName, getProducerTypes, getSerializePriority, getSimpleName, getUpdateOn, getUpdateParts, getVisibleConsumerTypes, getVisibleProducerTypes, getWorkspace, getWorkspaceComponentListeners, hasChangedSinceLastSave, isGuiOn, removeAttributeListener, removeWorkspaceComponentListener, setChangedSinceLastSave, setCurrentFile, setGuiOn, setLogger, setName, setSerializePriority, setUpdateOn, setWorkspace, stopped, toString

Methods inherited from class java.lang.Object

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

Field Detail

xLocationType

AttributeType xLocationType

Attribute types.

yLocationType

AttributeType yLocationType

turningType

AttributeType turningType

straightMovementType

AttributeType straightMovementType

absoluteMovementType

AttributeType absoluteMovementType

smellSensorScalars

AttributeType smellSensorScalars

smellSensorVectors

AttributeType smellSensorVectors

tileSensorType

AttributeType tileSensorType

speechEffectorType

AttributeType speechEffectorType

hearingSensorType

AttributeType hearingSensorType

Constructor Detail

OdorWorldComponent

public OdorWorldComponent(java.lang.String name)

Default constructor.

Parameters:

name -

OdorWorldComponent

public OdorWorldComponent(java.lang.String name,
                          OdorWorld world)

Constructor used in deserializing.

Parameters:

name - name of world

world - model world

Method Detail

getPotentialConsumers

public java.util.List<PotentialConsumer> getPotentialConsumers()

Description copied from class: WorkspaceComponent

Return the potential consumers associated with this component. Subclasses should override this to make their consumers available.

Overrides:

getPotentialConsumers in class WorkspaceComponent

Returns:

the consumer list.

getPotentialProducers

public java.util.List<PotentialProducer> getPotentialProducers()

Description copied from class: WorkspaceComponent

Return the potential producers associated with this component. Subclasses should override this to make their producers available.

Overrides:

getPotentialProducers in class WorkspaceComponent

Returns:

the producer list.

open

public static OdorWorldComponent open(java.io.InputStream input,
                                      java.lang.String name,
                                      java.lang.String format)

Recreates an instance of this class from a saved component.

Parameters:

input -

name -

format -

Returns:

getXML

public java.lang.String getXML()

Description copied from class: WorkspaceComponent

Override for use with open service.

Overrides:

getXML in class WorkspaceComponent

Returns:

xml string representing stored file.

save

public void save(java.io.OutputStream output,
                 java.lang.String format)

Used when saving a workspace. All changed workspace components are saved using this method.

Specified by:

save in class WorkspaceComponent

Parameters:

output - the stream of data to write the data to.

format - a key used to define the requested format.

getKeyFromObject

public java.lang.String getKeyFromObject(java.lang.Object object)

Description copied from class: WorkspaceComponent

Returns a unique key associated with an object. Used in serializing attributes. Any class that produces attributes should override this for serialization.

Overrides:

getKeyFromObject in class WorkspaceComponent

Parameters:

object - object which should be associated with a key

Returns:

the key

getObjectFromKey

public java.lang.Object getObjectFromKey(java.lang.String objectKey)

Description copied from class: WorkspaceComponent

Finds objects based on a key. Used in deserializing attributes. Any class that produces attributes should override this for serialization.

Overrides:

getObjectFromKey in class WorkspaceComponent

Parameters:

objectKey - String key

Returns:

the corresponding object

closing

public void closing()

Description copied from class: WorkspaceComponent

Perform cleanup after closing.

Specified by:

closing in class WorkspaceComponent

update

public void update()

Description copied from class: WorkspaceComponent

Called by Workspace to update the state of the component.

Overrides:

update in class WorkspaceComponent

getWorld

public OdorWorld getWorld()

Returns a reference to the odor world.

Returns:

the odor world object.