org.commonreality.sensors.keyboard
Class DefaultKeyboardSensor

java.lang.Object
  extended by org.commonreality.participant.impl.AbstractParticipant
      extended by org.commonreality.sensors.AbstractSensor
          extended by org.commonreality.sensors.keyboard.DefaultKeyboardSensor
All Implemented Interfaces:
java.io.Serializable, IIdentifiable, IParticipant, ISensor

public class DefaultKeyboardSensor
extends AbstractSensor

generic keyboard & mouse handler.

Author:
harrison
See Also:
Serialized Form

Field Summary
static java.lang.String DEVICE_MAP
           
static java.lang.String DURATION_EQUATION
           
static java.lang.String USE_ROBOT
           
 
Constructor Summary
DefaultKeyboardSensor()
           
 
Method Summary
 void configure(java.util.Map<java.lang.String,java.lang.String> options)
           
 java.lang.String getName()
           
 void initialize()
          called in response to a command from Reality to get everything ready to run.
 void resume()
           
 void start()
          called to actually start this participant
 void stop()
          called when this participant needs to stop
 void suspend()
           
 
Methods inherited from class org.commonreality.sensors.AbstractSensor
connect, disconnect, getAddressingInformation, getAfferentObjectManager, getCredentials, getEfferentObjectManager, getInterfacedAgents, getRealObjectManager, setCredentials, setIdentifier
 
Methods inherited from class org.commonreality.participant.impl.AbstractParticipant
addClientService, addServerService, getAgentObjectManager, getClock, getEfferentCommandManager, getIdentifier, getSensorObjectManager, isConnected, isInitialized, isStarted, isSuspended, reset, send, shutdown, waitForConnection, waitForInitialization, waitForResumption, waitForStart, waitForStop, waitForSuspension
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.commonreality.participant.IParticipant
getAgentObjectManager, getClock, getEfferentCommandManager, getSensorObjectManager, isConnected, isInitialized, isStarted, isSuspended, reset, send, shutdown, waitForConnection, waitForResumption, waitForStart, waitForStop, waitForSuspension
 
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

USE_ROBOT

public static final java.lang.String USE_ROBOT
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
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.

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
Specified by:
suspend in interface IParticipant
Overrides:
suspend in class AbstractParticipant
Throws:
java.lang.Exception

resume

public void resume()
            throws java.lang.Exception
Specified by:
resume in interface IParticipant
Overrides:
resume in class AbstractParticipant
Throws:
java.lang.Exception