org.commonreality.sensors.speech

Class DefaultSpeechSensor

java.lang.Object

org.commonreality.participant.impl.AbstractParticipant

org.commonreality.sensors.AbstractSensor

org.commonreality.sensors.speech.DefaultSpeechSensor

All Implemented Interfaces:

IIdentifiable, IParticipant, ISensor, ISpeaker

public class DefaultSpeechSensor
extends AbstractSensor
implements ISpeaker

Default speech generation sensor. For all connected agents, it creates an IEfferentObject that corresponds to the agent's mouth. That IEfferentObject contains at least one IEfferentCommandTemplate that is a VocalizationCommandTemplate which can be used to instantiate a specific IEfferentCommand, that is a VocalizationCommand. This sensor will process all such commands, execute them, and place an IRealObject into the simulation which will likely be picked up by an aural sensor to make the percept available.

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	SPEAKER
static java.lang.String	VOCALIZATION_DURATION_EQUATION

Constructor Summary

Constructors

Constructor and Description
DefaultSpeechSensor()

Method Summary

Modifier and Type	Method and Description
protected void	agentAdded(IAgentObject agent) when we get a new agent, immediately given them a mouth
void	configure(DefaultSpeechSensor sensor, java.util.Map<java.lang.String,java.lang.String> options) allow the speaker to be configured.
void	configure(java.util.Map<java.lang.String,java.lang.String> options) we can accept only a very basic configuration option.
java.lang.String	getName() default name for the speech sensor
void	initialize() let's initialize.
void	resume() resume a suspended participant and return state to started.
void	shutdown() shutdown the participant if it is stopped and disconnect
void	speak(IAgentObject speaker, VocalizationCommand vocalCommand) actually speak by creating a new aural event, and posting it.
void	start() Start it up by queueing the Runnable _cycle on the Executor

Methods inherited from class org.commonreality.sensors.AbstractSensor

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

VOCALIZATION_DURATION_EQUATION

public static final java.lang.String VOCALIZATION_DURATION_EQUATION

See Also:

Constant Field Values

SPEAKER

public static final java.lang.String SPEAKER

See Also:

Constant Field Values

Constructor Detail

DefaultSpeechSensor

public DefaultSpeechSensor()

Method Detail

getName

public java.lang.String getName()

default name for the speech sensor

Specified by:

getName in class AbstractParticipant

configure

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

we can accept only a very basic configuration option. The "DurationEquation" computes how long it will take to speak a string. If none is provided, a default instance is created that looks for a parameter CharactersPerSecond which will be used to compue duration times

Specified by:

configure in interface IParticipant

Overrides:

configure in class AbstractParticipant

Throws:

java.lang.Exception

initialize

public void initialize()
                throws java.lang.Exception

let's initialize. this is called before start but after configure. here we create the executor that handles the asynchronous aspects (runs the Runnable _cycle). We also create the default EfferentCommandHandler here.

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

speak

public void speak(IAgentObject speaker,
                  VocalizationCommand vocalCommand)

actually speak by creating a new aural event, and posting it. The aural sensor (if installed) will catch the event and create the appropriate IAfferentObject for the connecte agents

Specified by:

speak in interface ISpeaker

Parameters:

vocalCommand -

agentAdded

protected void agentAdded(IAgentObject agent)

when we get a new agent, immediately given them a mouth

Overrides:

agentAdded in class AbstractSensor

configure

public void configure(DefaultSpeechSensor sensor,
                      java.util.Map<java.lang.String,java.lang.String> options)

Description copied from interface: ISpeaker

allow the speaker to be configured.

Specified by:

configure in interface ISpeaker

options - configuration map provided to speech sensor