org.commonreality.sensors.aural

Class DefaultAuralSensor

java.lang.Object

org.commonreality.participant.impl.AbstractParticipant

org.commonreality.sensors.AbstractSensor

org.commonreality.sensors.aural.DefaultAuralSensor

All Implemented Interfaces:

IIdentifiable, IParticipant, ISensor

public class DefaultAuralSensor
extends AbstractSensor

quick and easy way to get sounds out to the system is to extend this sensor and use queueSound(IRealObject) with the results from newSound(String[], String, double, double) or newVocalization(String, double, double, IIdentifier). This will create IRealObjects representing the sounds, which will be detected by the GeneralAuralProcessor which transforms them into IAfferentObjects for each of the registered IAgents. Further customization of the sounds can be done using GeneralAuralProcessor.IAuralMutator, which can be added to the sensor with a prefixed classname property "IAuralMutator."

Author:

harrison

Nested Class Summary

Nested classes/interfaces inherited from interface org.commonreality.participant.IParticipant

IParticipant.State

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MUTATOR_PREFIX

Constructor Summary

Constructors

Constructor and Description
DefaultAuralSensor()

Method Summary

Modifier and Type	Method and Description
void	configure(java.util.Map<java.lang.String,java.lang.String> options) configure the participant.
java.lang.String	getName()
void	initialize() called in response to a command from Reality to get everything ready to run.
IRealObject	newSound(java.lang.String[] types, java.lang.String content, double onset, double duration)
IRealObject	newVocalization(java.lang.String content, double onset, double duration, IIdentifier agent)
void	queueSound(IRealObject aural)
void	resume() resume a suspended participant and return state to started.
void	shutdown() shutdown the participant if it is stopped and disconnect
void	start() Start it up by queueing the Runnable _cycle on the Executor

Methods inherited from class org.commonreality.sensors.AbstractSensor

agentAdded, agentRemoved, agentUpdated, connect, createAfferentObjectManager, createAgentObjectManager, createEfferentObjectManager, createRealObjectManager, createSensor, disconnect, getAddressingInformation, getAfferentObjectManager, getCredentials, getEfferentObjectManager, getInterfacedAgents, getRealObjectManager, isInterfacedAgent, setCredentials, setIdentifier, shouldInterface

Methods inherited from class org.commonreality.participant.impl.AbstractParticipant

addClientService, addServerService, checkState, clearObjectManagers, createEfferentCommandManager, createIOExecutorService, createIOHandler, createNotificationManager, createSensorObjectManager, disconnect, getAgentObjectManager, getCentralThreadFactory, getClock, getCommonRealityIdentifier, getEfferentCommandManager, getIdentifier, getIOExecutor, getIOHandler, getIOThreadFactory, getNotificationManager, getPeriodicExecutor, getSensorObjectManager, getServerAddressInformation, getState, reset, send, setClock, setCommonRealityIdentifier, shutdown, stateMatches, stop, suspend, waitForState, waitForState

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.commonreality.participant.IParticipant

disconnect, getAgentObjectManager, getClock, getEfferentCommandManager, getNotificationManager, getSensorObjectManager, getState, reset, send, shutdown, stateMatches, stop, suspend, waitForState, waitForState

Methods inherited from interface org.commonreality.identifier.IIdentifiable

getIdentifier

Field Detail

MUTATOR_PREFIX

public static final java.lang.String MUTATOR_PREFIX

See Also:

Constant Field Values

Constructor Detail

DefaultAuralSensor

public DefaultAuralSensor()

Method Detail

configure

public void configure(java.util.Map<java.lang.String,java.lang.String> options)
               throws java.lang.Exception

Description copied from interface: IParticipant

configure the participant. this may be called at while UNKNOWN, CONNECTED, INITIALIZED, or STOPPED

Specified by:

configure in interface IParticipant

Overrides:

configure in class AbstractParticipant

Throws:

java.lang.Exception

initialize

public void initialize()
                throws java.lang.Exception

Description copied from class: AbstractParticipant

called in response to a command from Reality to get everything ready to run. we must be connected first.

Specified by:

initialize in interface IParticipant

Overrides:

initialize in class AbstractParticipant

Throws:

java.lang.Exception

start

public void start()
           throws java.lang.Exception

Start it up by queueing the Runnable _cycle on the Executor

Specified by:

start in interface IParticipant

Overrides:

start in class AbstractParticipant

Throws:

java.lang.Exception

See Also:

AbstractParticipant.start()

shutdown

public void shutdown()
              throws java.lang.Exception

Description copied from interface: IParticipant

shutdown the participant if it is stopped and disconnect

Specified by:

shutdown in interface IParticipant

Overrides:

shutdown in class AbstractSensor

Throws:

java.lang.Exception

resume

public void resume()
            throws java.lang.Exception

Description copied from interface: IParticipant

resume a suspended participant and return state to started.

Specified by:

resume in interface IParticipant

Overrides:

resume in class AbstractParticipant

Throws:

java.lang.Exception

getName

public java.lang.String getName()

Specified by:

getName in class AbstractParticipant

newSound

public IRealObject newSound(java.lang.String[] types,
                            java.lang.String content,
                            double onset,
                            double duration)

newVocalization

public IRealObject newVocalization(java.lang.String content,
                                   double onset,
                                   double duration,
                                   IIdentifier agent)

queueSound

public void queueSound(IRealObject aural)