Class Index - Presage2

A B C D E F G H I L M N O P R S T U W

A

AbstractEnvironment	General implementation of an environment.
AbstractEnvironmentModule
AbstractParticipant	This implements the core of a `Participant` to manage the majority of the mundane functions allowing the user to start writing the agent's behaviours sooner.
AbstractParticipant.State<T>
Action	An Action is something an agent performs on the environment.
Action	An FSM Action is something which is executed when a transition is taken.
ActionHandler	An ActionHandler processes an `Action` in the environment.
ActionHandlingException
Agent
AgentStateFact
AgentStateTranslator
AndCondition	`TransitionCondition` which does a boolean AND of all the conditions given to it and returns that result.
Area	Represents the simulation area.
Area.Bind	Provides various AbstractModules to bind different types of `Area`.
Area.Edge
AreaService	Global environment service to get the simulation `Area` as defined by the environment and provided through `HasArea`.

B

BasicNetworkConnector	Basic implementation of a network connector.
BroadcastMessage	This is a basic broadcast message to be sent between agents.

C

CannotSeeAgent	Exception thrown when an agent requests directly for the `Location` of another but the request agent is further away then the maximum distance the former can perceive (as defined by `HasPerceptionRange`).
Cell
CellMove
CommunicationRangeService	An `EnvironmentService` to retrieve agents' communication ranges.
CompositeServiceProvider
ConstrainedNetworkController	A `NetworkController` which allows the use of `NetworkConstraint` s.
Conversation	A Conversation is a stateful exchange of messages between 2 or more agents.
ConversationCondition	A FSM `TransitionCondition` which ensures that the message passed in the `event` matches the conversation in the `FSMConversation`.
ConversationSpawnEvent	Event to spawn a new conversation and initialise it with recipients.

D

DatabaseModule
DatabaseService	This is a generic description of a Database service in presage.

E

EdgeException
EnvironmentConnector	This interface gives the API for basic access to the Environment, allowing Participants to register, deregister and act on the environment.
EnvironmentMembersService	This service provides access to the UUIDs of all the participants in the simulation.
EnvironmentRegistrationRequest	A request to register with the environment.
EnvironmentRegistrationResponse	The response to a `EnvironmentRegistrationRequest`.
EnvironmentService	An EnvironmentService provides a high level service to a Participant and/or the NetworkController by accessing the raw data in the environment shared state.
EnvironmentServiceProvider	A class implementing this can provide `EnvironmentService`s
EnvironmentSharedStateAccess	This is the access layer to the shared state of the environment.
Event	An event is simply an object which is publish to other objects who are listening for an object of it's type (or a supertype thereof).
EventBus	The EventBus manages the distribution of events to `EventListener`s who listen for them.
EventBusModule
EventListener
EventTypeCondition	`TransitionCondition` which returns true iff the java class type of the event is the same as the type this class is instaniated with.
ExceptionEdgeHandler	EdgeHandler which simply throws an exception when invoked.
ExecutorManager	Manages a set of `SimulationExecutor`s and a queue of Simulations to be run on them.
ExecutorModule	This AbstractModule binds a set of `SimulationExecutor`s which can be used by an `ExecutorManager`.
Experiment

F

Finalisor	Method annotation to mark that a method should be called when the declaring object is removed from the simulation (i.e.
FinishCondition	Method annotation to mark that a method specifies a finish condition for the simulation.
FinishTime	Binding annotation for the finish time of a simulation.
FSM	Instance of a Finite State Machine.
FSMConversation
FSMDescription	A description of an `FSM`.
FSMException
FSMProtocol	`Protocol` implementation using an `FSM` to control state changes and actions.

G

GenericAgentStateTranslator
GenericGlobalStateTranslator

H

HasArea
HasCommunicationRange
HasLocation
HasPerceptionRange

I

InitialiseConversationAction	An implementation of a `MessageAction` designed to initialise the conversation on first message receipt.
Initialisor	Method annotation to mark that a method should be called to initialise this object.
Input	An input is something which can be queued at an agent's input queue and processed by the agent.
InputHandler	An InputHandler processes `Input`s.
InsufficientResourcesException
IntegerTime
InvalidAuthkeyException
InvalidParametersException

L

LocalSubProcessExecutor	A `SubProcessExecutor` which runs each simulation process on the local machine.
Location
Location	This represents a location in the environment space as defined by a 3D vector.
LocationService	An `EnvironmentService` to provide information on the locations of agents.
LocationStoragePlugin
LocationTranslator

M

MappedSharedState
Message	This is a basic message to be sent between agents.
MessageAction	Wraps an FSM `Action` to correctly cast event and entity to a `Message` and `FSMConversation` respectively, and provide the #processMessage(Message, FSMConversation) method to perform the required actions with these objects.
MessageBlockedEvent
MessageDeliveryEvent	Event trigger when a message is successfully delivered.
MessagesToRuleEngine
MessageTypeAndContentsCondition	FSM `TransitionCondition` to check the `type` and `data` properties of a received message matches a given value.
MessageTypeCondition	FSM `TransitionCondition` to check the `type` property of a received message matches a given value.
Move	An Action which represents a change in `Location`.
MoveHandler
MulticastMessage	This is a basic multicast message to be sent between agents.
MultiExperiment
MultiThreadedSchedule

N

NetworkAdaptor	A network adaptor is a participant's perception of it's communication channel to the outside world.
NetworkAddress	An address of a device in the network.
NetworkAddressFactory
NetworkChannel	This interface represents a channel over which communication can take place in the network.
NetworkConnector	The NetworkConnector passes messages between a participant and the Network controller
NetworkConnectorFactory
NetworkConnectorWithNodeDiscovery	A `NetworkConnector` which implements `getConnectedNodes()`.
NetworkConstraint
NetworkController	This is a central controller through which all messages go.
NetworkGuiceModule
NetworkMessageMonitor
NetworkModule	Static factory for AbstractModules which bind network interfaces.
NetworkRangeConstraint
NetworkRegistrationRequest	Object to pass parameters to the NetworkController when registering with the network.
NotCondition	`TransitionCondition` which returns the opposite of the condition given to it.

O

OrCondition TransitionCondition which does a boolean OR of all the conditions given to it and returns that result.

P

Parameter
ParameterSweep	Describes a set of simulation parameters permutations.
Participant	This is the interface used by the simulator to interact with agents.
ParticipantException	Parent of all exceptions thrown by a participant.
ParticipantFactory
ParticipantInitialisationException	Exception thrown during participant initialisation.
ParticipantLocationService	This is an extension of the `LocationService` to provide tools specifically for `Participant`s.
ParticipantRunTimeException
ParticipantSharedState
Performative	Enumerated type of all FIPA Performatives as given here: http://jmvidal.cse.sc.edu/talks/agentcommunication/performatives.xml
PersistentAgent	Persistent store for an agent.
PersistentEnvironment
PersistentSimulation
Plugin
PluginModule	Binds an array of plugin classes.
Presage2CLI
Presage2CLI.Command
Protocol	An `InputHandler` which manages a set of `Conversation`s which produce and consume `Message`s of this protocol.

R

Random	This is a wrapper for java.util.Random to provide static access to most of it's methods via a singleton, and to control the initial random seed.
RandomSeed
RealNetworkConnectorFactory
RemoteSubProcessExecutor	Runs a simulation on a remote machine via ssh.
RequiresRegistration	An interface for a network component which requires registration.
Role
RuleModule	Binds `RuleStorage` with a set of DRL files to initially load into the engine as well as `StateTranslator`s and `AgentStateTranslator`s to use for shared state.
Rules
RuleStorage	Implementation of `SharedStateStorage` using a drools StatefulKnowledgeSession.
RunnableSimulation	Implements the Presage2 simulation loop.

S

Scenario	The scenario defines the entities to be run by the scheduler.
ScheduleExecutor	Wrapper for an ExecutorService.
ScheduleExecutor.WaitCondition	Conditions specifying a simulation schedule over a timestep.
ServiceDependencies	A description of the `EnvironmentService` this class depends on.
SharedState	General shared state in the environment.
SharedStateAccessException
SharedStateStorage	Classes implementing this can act as a storage layer for the shared state of a simulation.
SimArea
SimArea.x
SimArea.y
SimArea.z
SimParticipantsTranslator
Simulation
SimulationExecutor	A `SimulationExecutor` is capable of executing simulations from their ID.
SpawnAction	Wraps an FSM `Action` to cast the event and entity to a `ConversationSpawnEvent` and `FSMConversation` respectively and provide the `processSpawn(ConversationSpawnEvent, FSMConversation, Transition)` method to perform actions required when the conversation is spawned.
State
StateAccessor
StateChangeListener	Listener for state change events.
StateFact
StateTransformer	A state transformer changes a `SharedState`'s value to a new one.
StateTranslator
StateType	Defines the different types a state may be.
Step	Method annotation to mark that a method should be called each timestep by the scheduler.
StopEdgeHandler	An EdgeHandler which modifies `Move`s so the agent stops at the extreme edge of the simulation `Area`.
StorageService	A service to provide storage of simulation data.
StreamGobbler	StreamGobbler: Consumes an InputStream and redirects it to a given OutputStream or discards it.
SubProcessExecutor	A `SimulationExecutor` which has a set of sub processes which each runs a simulation.

T

Time	This is a generic representation of a time within the simulation.
Time.Bind	Provides various AbstractModules to bind different types of `Time`.
TimeDriven	Interface for any element in the simulation which wants to be informed of increments in the global clock.
TimeoutCondition	Guard which allows a transition when a Timeout event is passed and the last action of this fsm was older than the timeout.
TransientAgentState
Transition
TransitionCondition	Decides whether a transition may be made from a state given an event.
TupleStorageService

U

UnavailableServiceException	Thrown when a requested `EnvironmentService` is not available.
UnicastMessage	This is a basic unicast message to be sent between agents.
UnknownMessageTypeException
UnreachableRecipientException
UnregisteredParticipantException

W

WrapEdgeHandler An EdgeHandler which wraps the simulation Area so an agent moving through an edge simply appears at the opposite edge.