org.commonreality.agents

Class AbstractAgent

java.lang.Object

org.commonreality.participant.impl.AbstractParticipant

org.commonreality.agents.AbstractAgent

All Implemented Interfaces:

IAgent, IIdentifiable, IParticipant

Direct Known Subclasses:

ACTRAgent, DumbAgent

public abstract class AbstractAgent
extends AbstractParticipant
implements IAgent

Author:

developer

Nested Class Summary

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

IParticipant.State

Constructor Summary

Constructors

Constructor and Description
AbstractAgent()

Method Summary

Modifier and Type	Method and Description
void	connect() connect
protected IAgentObject	createAgent(IIdentifier identifier)
protected IEfferentCommandManager	createEfferentCommandManager() overriden to provide a RequestableEfferentCommandManager so that agents can create new IEfferentCommands on the fly.
protected ISensorObjectManager	createSensorObjectManager()
void	disconnect() disconnect, reverting to unknown
IAddressingInformation	getAddressingInformation() by default, we dont accept connections so return null
ICredentials	getCredentials()
abstract java.lang.String	getName()
protected void	sensorAdded(ISensorObject sensor) callback in response to a sensor change.
protected void	sensorRemoved(ISensorObject sensor) callback in response to a sensor change.
protected void	sensorUpdated(ISensorObject sensor) callback in response to a sensor change.
void	setCredentials(ICredentials credentials)
void	setIdentifier(IIdentifier identifier) called after the connection has been established..
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, createAfferentObjectManager, createAgentObjectManager, createEfferentObjectManager, createIOExecutorService, createIOHandler, createNotificationManager, createRealObjectManager, disconnect, getAfferentObjectManager, getAgentObjectManager, getCentralThreadFactory, getClock, getCommonRealityIdentifier, getEfferentCommandManager, getEfferentObjectManager, getIdentifier, getIOExecutor, getIOHandler, getIOThreadFactory, getNotificationManager, getPeriodicExecutor, getRealObjectManager, 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, getAfferentObjectManager, getAgentObjectManager, getClock, getEfferentCommandManager, getEfferentObjectManager, getNotificationManager, getRealObjectManager, getSensorObjectManager, getState, initialize, reset, resume, send, shutdown, start, stateMatches, stop, suspend, waitForState, waitForState

Methods inherited from interface org.commonreality.identifier.IIdentifiable

getIdentifier

Constructor Detail

AbstractAgent

public AbstractAgent()

Parameters:

type -

Method Detail

getCredentials

public ICredentials getCredentials()

Specified by:

getCredentials in class AbstractParticipant

See Also:

AbstractParticipant.getCredentials()

getName

public abstract java.lang.String getName()

Specified by:

getName in class AbstractParticipant

See Also:

AbstractParticipant.getName()

setCredentials

public void setCredentials(ICredentials credentials)

Specified by:

setCredentials in interface IAgent

See Also:

IAgent.setCredentials(org.commonreality.message.credentials.ICredentials)

getAddressingInformation

public IAddressingInformation getAddressingInformation()

by default, we dont accept connections so return null

Specified by:

getAddressingInformation in class AbstractParticipant

See Also:

AbstractParticipant.getAddressingInformation()

createAgent

protected IAgentObject createAgent(IIdentifier identifier)

createEfferentCommandManager

protected IEfferentCommandManager createEfferentCommandManager()

overriden to provide a RequestableEfferentCommandManager so that agents can create new IEfferentCommands on the fly.

Overrides:

createEfferentCommandManager in class AbstractParticipant

createSensorObjectManager

protected ISensorObjectManager createSensorObjectManager()

Overrides:

createSensorObjectManager in class AbstractParticipant

sensorAdded

protected void sensorAdded(ISensorObject sensor)

callback in response to a sensor change. This is called on the main IO thread, so there should be no blocking calls

Parameters:

sensor -

sensorRemoved

protected void sensorRemoved(ISensorObject sensor)

callback in response to a sensor change. This is called on the main IO thread, so there should be no blocking calls

Parameters:

sensor -

sensorUpdated

protected void sensorUpdated(ISensorObject sensor)

callback in response to a sensor change. This is called on the main IO thread, so there should be no blocking calls

Parameters:

sensor -

setIdentifier

public void setIdentifier(IIdentifier identifier)

Description copied from class: AbstractParticipant

called after the connection has been established..

Overrides:

setIdentifier in class AbstractParticipant

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()
                throws java.lang.Exception

Description copied from interface: IParticipant

disconnect, reverting to unknown

Specified by:

disconnect in interface IParticipant

Overrides:

disconnect in class AbstractParticipant

Throws:

java.lang.Exception