org.simbrain.world.oscworld

Class OscWorldComponent

java.lang.Object

org.simbrain.workspace.WorkspaceComponent

org.simbrain.world.oscworld.OscWorldComponent

public final class OscWorldComponent
extends WorkspaceComponent

OSC world component. TODO: For this and MIDI make sure to note that consumer, producer classes removed

Constructor Summary

Constructors

Constructor and Description
OscWorldComponent(java.lang.String name) Create a new OSC world component with the specified name.

Method Summary

Modifier and Type	Method and Description
void	addInMessage(java.lang.String address) Add a new OSC in message with the specified address.
void	addOutMessage(java.lang.String address) Add a new OSC out message with the specified address.
void	closing() Perform cleanup after closing.
(package private) java.lang.String	getOscInHost() Return the OSC in host name.
(package private) int	getOscInPort() Return the OSC in port number.
(package private) java.lang.String	getOscOutHost() Return the OSC out host name.
(package private) int	getOscOutPort() Return the OSC out port number.
void	save(java.io.OutputStream outputStream, 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, getKeyFromObject, getLocks, getLogger, getName, getObjectFromKey, getPotentialConsumers, getPotentialProducers, getProducerTypes, getSerializePriority, getSimpleName, getUpdateOn, getUpdateParts, getVisibleConsumerTypes, getVisibleProducerTypes, getWorkspace, getWorkspaceComponentListeners, getXML, 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

Constructor Detail

OscWorldComponent

public OscWorldComponent(java.lang.String name)

Create a new OSC world component with the specified name.

Parameters:

name - name of this OSC world component

Method Detail

closing

public void closing()

Perform cleanup after closing.

Specified by:

closing in class WorkspaceComponent

save

public void save(java.io.OutputStream outputStream,
                 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:

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

format - a key used to define the requested format.

update

public void update()

Called by Workspace to update the state of the component.

Overrides:

update in class WorkspaceComponent

getOscInHost

java.lang.String getOscInHost()

Return the OSC in host name.

Returns:

the OSC in host name

getOscOutHost

java.lang.String getOscOutHost()

Return the OSC out host name.

Returns:

the OSC out host name

getOscInPort

int getOscInPort()

Return the OSC in port number.

Returns:

the OSC in port number

getOscOutPort

int getOscOutPort()

Return the OSC out port number.

Returns:

the OSC out port number

addInMessage

public void addInMessage(java.lang.String address)

Add a new OSC in message with the specified address.

Parameters:

address - OSC in message address, must not be null and must start with '/' character

addOutMessage

public void addOutMessage(java.lang.String address)

Add a new OSC out message with the specified address.

Parameters:

address - OSC out message address, must not be null and must start with '/' character