org.commonreality.sensors

Class AbstractSensor

java.lang.Object

org.commonreality.participant.impl.AbstractParticipant

org.commonreality.sensors.AbstractSensor

All Implemented Interfaces:

IIdentifiable, IParticipant, ISensor

Direct Known Subclasses:

BaseSensor, DefaultAuralSensor, DefaultKeyboardSensor, DefaultSpeechSensor, XMLSensor

public abstract class AbstractSensor
extends AbstractParticipant
implements ISensor

Author:

developer

Nested Class Summary

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

IParticipant.State

Constructor Summary

Constructors

Constructor and Description
AbstractSensor()

Method Summary

Modifier and Type	Method and Description
protected void	agentAdded(IAgentObject agent) callback when a new agent is added to te simulation (will only receive is shouldInterface(IAgentObject) is true).
protected void	agentRemoved(IAgentObject agent) callback when an interfaced agent is removed from the simulation This is called on the IO thread, you should not make any blocking calls here
protected void	agentUpdated(IAgentObject agent) callback for when an actively interfaced agent is updated This is called on the IO thread, you should not make any blocking calls here
void	connect() connect
protected IAfferentObjectManager	createAfferentObjectManager()
protected IAgentObjectManager	createAgentObjectManager()
protected IEfferentObjectManager	createEfferentObjectManager()
protected IRealObjectManager	createRealObjectManager()
protected ISensorObject	createSensor(IIdentifier identifier)
void	disconnect(boolean force) force the system to disconnect, regardless of its current state
IAddressingInformation	getAddressingInformation() by default, we dont open any listeners, so we return null
IRequestableAfferentObjectManager	getAfferentObjectManager()
ICredentials	getCredentials()
IRequestableEfferentObjectManager	getEfferentObjectManager()
java.util.Collection<IIdentifier>	getInterfacedAgents()
IRequestableRealObjectManager	getRealObjectManager()
protected boolean	isInterfacedAgent(IIdentifier identifier) are we currently interfaced with this agent
void	setCredentials(ICredentials credentials)
void	setIdentifier(IIdentifier identifier) called after the connection has been established..
protected boolean	shouldInterface(IAgentObject agent) should we provide afferent/efferent objects to this agent default returns true
void	shutdown() shutdown the participant if it is stopped and disconnect

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

addClientService, addServerService, checkState, clearObjectManagers, configure, createEfferentCommandManager, createIOExecutorService, createIOHandler, createNotificationManager, createSensorObjectManager, disconnect, getAgentObjectManager, getCentralThreadFactory, getClock, getCommonRealityIdentifier, getEfferentCommandManager, getIdentifier, getIOExecutor, getIOHandler, getIOThreadFactory, getName, getNotificationManager, getPeriodicExecutor, getSensorObjectManager, getServerAddressInformation, getState, initialize, reset, resume, send, setClock, setCommonRealityIdentifier, shutdown, start, 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

configure, disconnect, getAgentObjectManager, getClock, getEfferentCommandManager, getNotificationManager, getSensorObjectManager, getState, initialize, reset, resume, send, shutdown, start, stateMatches, stop, suspend, waitForState, waitForState

Methods inherited from interface org.commonreality.identifier.IIdentifiable

getIdentifier

Constructor Detail

AbstractSensor

public AbstractSensor()

Parameters:

type -

Method Detail

setCredentials

public void setCredentials(ICredentials credentials)

Specified by:

setCredentials in interface ISensor

isInterfacedAgent

protected boolean isInterfacedAgent(IIdentifier identifier)

are we currently interfaced with this agent

Parameters:

identifier -

Returns:

getInterfacedAgents

public java.util.Collection<IIdentifier> getInterfacedAgents()

shouldInterface

protected boolean shouldInterface(IAgentObject agent)

should we provide afferent/efferent objects to this agent default returns true

Parameters:

agent -

Returns:

true

agentAdded

protected void agentAdded(IAgentObject agent)

callback when a new agent is added to te simulation (will only receive is shouldInterface(IAgentObject) is true). This is called on the IO thread, you should not make any blocking calls here

Parameters:

agent -

agentRemoved

protected void agentRemoved(IAgentObject agent)

callback when an interfaced agent is removed from the simulation This is called on the IO thread, you should not make any blocking calls here

Parameters:

agent -

agentUpdated

protected void agentUpdated(IAgentObject agent)

callback for when an actively interfaced agent is updated This is called on the IO thread, you should not make any blocking calls here

Parameters:

agent -

createAgentObjectManager

protected IAgentObjectManager createAgentObjectManager()

Overrides:

createAgentObjectManager in class AbstractParticipant

createAfferentObjectManager

protected IAfferentObjectManager createAfferentObjectManager()

Overrides:

createAfferentObjectManager in class AbstractParticipant

createEfferentObjectManager

protected IEfferentObjectManager createEfferentObjectManager()

Overrides:

createEfferentObjectManager in class AbstractParticipant

createRealObjectManager

protected IRealObjectManager createRealObjectManager()

Overrides:

createRealObjectManager in class AbstractParticipant

createSensor

protected ISensorObject createSensor(IIdentifier identifier)

setIdentifier

public void setIdentifier(IIdentifier identifier)

Description copied from class: AbstractParticipant

called after the connection has been established..

Overrides:

setIdentifier in class AbstractParticipant

getEfferentObjectManager

public IRequestableEfferentObjectManager getEfferentObjectManager()

Specified by:

getEfferentObjectManager in interface IParticipant

Specified by:

getEfferentObjectManager in interface ISensor

Overrides:

getEfferentObjectManager in class AbstractParticipant

getAfferentObjectManager

public IRequestableAfferentObjectManager getAfferentObjectManager()

Specified by:

getAfferentObjectManager in interface IParticipant

Specified by:

getAfferentObjectManager in interface ISensor

Overrides:

getAfferentObjectManager in class AbstractParticipant

getRealObjectManager

public IRequestableRealObjectManager getRealObjectManager()

Specified by:

getRealObjectManager in interface IParticipant

Overrides:

getRealObjectManager in class AbstractParticipant

getCredentials

public ICredentials getCredentials()

Specified by:

getCredentials in class AbstractParticipant

getAddressingInformation

public IAddressingInformation getAddressingInformation()

by default, we dont open any listeners, so we return null

Specified by:

getAddressingInformation in class AbstractParticipant

See Also:

AbstractParticipant.getAddressingInformation()

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 AbstractParticipant

Throws:

java.lang.Exception

connect

public void connect()
             throws java.lang.Exception

Description copied from interface: IParticipant

connect

Specified by:

connect in interface IParticipant

Overrides:

connect in class AbstractParticipant

Throws:

java.lang.Exception

See Also:

IParticipant.connect()

disconnect

public void disconnect(boolean force)
                throws java.lang.Exception

Description copied from interface: IParticipant

force the system to disconnect, regardless of its current state

Specified by:

disconnect in interface IParticipant

Overrides:

disconnect in class AbstractParticipant

Throws:

java.lang.Exception