org.commonreality.participant

Interface IParticipant

All Superinterfaces:

IIdentifiable

All Known Subinterfaces:

IAgent, IReality, ISensor

All Known Implementing Classes:

AbstractAgent, AbstractParticipant, AbstractSensor, ACTRAgent, BaseSensor, DefaultAuralSensor, DefaultKeyboardSensor, DefaultReality, DefaultSpeechSensor, DumbAgent, XMLSensor

public interface IParticipant
extends IIdentifiable

Someone who is participating in the simulation.

execution sequence:

configure()
initialize()
start()
suspend() & resume()
stop()
reset()
start()
suspend() & resume()
stop()
shutdown()

Author:

developer

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IParticipant.State

Method Summary

Modifier and Type	Method and Description
void	configure(java.util.Map<java.lang.String,java.lang.String> options) configure the participant.
void	connect() connect
void	disconnect() disconnect, reverting to unknown
void	disconnect(boolean force) force the system to disconnect, regardless of its current state
IAfferentObjectManager	getAfferentObjectManager()
IAgentObjectManager	getAgentObjectManager()
IClock	getClock()
IEfferentCommandManager	getEfferentCommandManager()
IEfferentObjectManager	getEfferentObjectManager()
INotificationManager	getNotificationManager()
IRealObjectManager	getRealObjectManager()
ISensorObjectManager	getSensorObjectManager()
IParticipant.State	getState() return the current state of the participant, and, if initialized, the state of the simulation
void	initialize() initialize this participant.
void	reset(boolean clockWillBeReset) reset a stopped participant, reverting to initialized
void	resume() resume a suspended participant and return state to started.
java.util.concurrent.Future<IAcknowledgement>	send(IMessage message) send a message to common reality.
void	shutdown() shutdown the participant if it is stopped and disconnect
void	shutdown(boolean force) shutdown, disconnect, without checking states
void	start() start the participant, if the participant is not initialized, it will throw an IllegalStateException
boolean	stateMatches(IParticipant.State... states)
void	stop() stop the participant if it is started or suspended
void	suspend() suspend the participant if it is started.
IParticipant.State	waitForState(IParticipant.State... states) wait until the participant's state is one of these.
IParticipant.State	waitForState(long waitTime, IParticipant.State... states)

Methods inherited from interface org.commonreality.identifier.IIdentifiable

getIdentifier

Method Detail

getState

IParticipant.State getState()

return the current state of the participant, and, if initialized, the state of the simulation

Returns:

stateMatches

boolean stateMatches(IParticipant.State... states)

waitForState

IParticipant.State waitForState(IParticipant.State... states)
                         throws java.lang.InterruptedException

wait until the participant's state is one of these.

Parameters:

states -

Returns:

Throws:

java.lang.InterruptedException

waitForState

IParticipant.State waitForState(long waitTime,
                                IParticipant.State... states)
                         throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException

configure

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

configure the participant. this may be called at while UNKNOWN, CONNECTED, INITIALIZED, or STOPPED

Parameters:

options -

Throws:

java.lang.Exception

initialize

void initialize()
         throws java.lang.Exception

initialize this participant. this is called after the participant has successfully connected to common reality. If the state isnt connected, this will throw an IllegalStateException

Throws:

java.lang.Exception

start

void start()
    throws java.lang.Exception

start the participant, if the participant is not initialized, it will throw an IllegalStateException

Throws:

java.lang.Exception

suspend

void suspend()
      throws java.lang.Exception

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

Throws:

java.lang.Exception

resume

void resume()
     throws java.lang.Exception

resume a suspended participant and return state to started.

Throws:

java.lang.Exception

stop

void stop()
   throws java.lang.Exception

stop the participant if it is started or suspended

Throws:

java.lang.Exception

shutdown

void shutdown()
       throws java.lang.Exception

shutdown the participant if it is stopped and disconnect

Throws:

java.lang.Exception

shutdown

void shutdown(boolean force)
       throws java.lang.Exception

shutdown, disconnect, without checking states

Parameters:

force -

Throws:

java.lang.Exception

reset

void reset(boolean clockWillBeReset)
    throws java.lang.Exception

reset a stopped participant, reverting to initialized

Parameters:

clockWillBeReset -

Throws:

java.lang.Exception

connect

void connect()
      throws java.lang.Exception

connect

Throws:

java.lang.Exception

disconnect

void disconnect()
         throws java.lang.Exception

disconnect, reverting to unknown

Throws:

java.lang.Exception

disconnect

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

force the system to disconnect, regardless of its current state

Parameters:

force -

Throws:

java.lang.Exception

send

java.util.concurrent.Future<IAcknowledgement> send(IMessage message)

send a message to common reality. If the message is an IRequest the Future will contain the IAcknowledgement message. If the message is not an IRequest, the Future will contain null
This is usually used to send object data and commands. The typical pattern is to send the ObjectDataRequest followed by the ObjectCommandRequest to commit the new data. While the underlying communications will ensure in order delivery, that delivery is dependent not upon the order of send commands, rather the order in which the messages are transformed to a sendable representation (i.e. stream of bytes). This is not usually an issue unless you send the data request on one thread and the command request on another. Since the encoding of the data will typically take longer, the command may arrive before the data. If you use this model, you should probably wait for the acknowledgment of the data transmission before sending the command.

Parameters:

message -

Returns:

getClock

IClock getClock()

getSensorObjectManager

ISensorObjectManager getSensorObjectManager()

getAfferentObjectManager

IAfferentObjectManager getAfferentObjectManager()

getEfferentObjectManager

IEfferentObjectManager getEfferentObjectManager()

getAgentObjectManager

IAgentObjectManager getAgentObjectManager()

getRealObjectManager

IRealObjectManager getRealObjectManager()

getEfferentCommandManager

IEfferentCommandManager getEfferentCommandManager()

Returns:

getNotificationManager

INotificationManager getNotificationManager()