org.commonreality.sensors.keyboard

Class DefaultKeyboardSensor

java.lang.Object

org.commonreality.participant.impl.AbstractParticipant

org.commonreality.sensors.AbstractSensor

org.commonreality.sensors.keyboard.DefaultKeyboardSensor

All Implemented Interfaces:

IIdentifiable, IParticipant, ISensor

public class DefaultKeyboardSensor
extends AbstractSensor

generic keyboard & mouse handler.

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	ACTUATOR_PARAM
static java.lang.String	DEVICE_MAP
static java.lang.String	DURATION_EQUATION

Constructor Summary

Constructors

Constructor and Description
DefaultKeyboardSensor()

Method Summary

Modifier and Type	Method and Description
protected void	agentAdded(IAgentObject agent) when we detect a new agent, queue up a request to add the muscles and devices for the hand, keyboard and mouse
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.
void	resume() resume a suspended participant and return state to started.
void	start() called to actually start this participant
void	stop() called when this participant needs to stop
void	suspend() suspend the participant if it is started.

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, shutdown

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, 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, waitForState, waitForState

Methods inherited from interface org.commonreality.identifier.IIdentifiable

getIdentifier

Field Detail

DEVICE_MAP

public static final java.lang.String DEVICE_MAP

See Also:

Constant Field Values

ACTUATOR_PARAM

public static final java.lang.String ACTUATOR_PARAM

See Also:

Constant Field Values

DURATION_EQUATION

public static final java.lang.String DURATION_EQUATION

See Also:

Constant Field Values

Constructor Detail

DefaultKeyboardSensor

public DefaultKeyboardSensor()

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in class AbstractParticipant

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

Description copied from class: AbstractParticipant

called to actually start this participant

Specified by:

start in interface IParticipant

Overrides:

start in class AbstractParticipant

Throws:

java.lang.Exception

stop

public void stop()
          throws java.lang.Exception

Description copied from class: AbstractParticipant

called when this participant needs to stop

Specified by:

stop in interface IParticipant

Overrides:

stop in class AbstractParticipant

Throws:

java.lang.Exception

suspend

public void suspend()
             throws java.lang.Exception

Description copied from interface: IParticipant

suspend the participant if it is started. if not, it will throw an IllegalStateException

Specified by:

suspend in interface IParticipant

Overrides:

suspend in class AbstractParticipant

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

agentAdded

protected void agentAdded(IAgentObject agent)

when we detect a new agent, queue up a request to add the muscles and devices for the hand, keyboard and mouse

Overrides:

agentAdded in class AbstractSensor

See Also:

AbstractSensor.agentAdded(org.commonreality.object.IAgentObject)