ensemble

Class EnsembleAgent

java.lang.Object

jade.core.Agent

ensemble.EnsembleAgent

All Implemented Interfaces:

LifeCycle, RouterClient, jade.core.TimerListener, java.io.Serializable, java.lang.Runnable

Direct Known Subclasses:

EnvironmentAgent, MusicalAgent

public abstract class EnsembleAgent
extends jade.core.Agent
implements LifeCycle, RouterClient

The Class EnsembleAgent.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	EnsembleAgent.ReceiveCommand The Class ReceiveCommand.

Nested classes/interfaces inherited from class jade.core.Agent

jade.core.Agent.Interrupted

Field Summary

Fields

Modifier and Type	Field and Description
private VirtualClockHelper	clock Clock Service.
protected boolean	isBatch Router Service.
protected Parameters	parameters Agent Parameters.
private EnsembleAgent.ReceiveCommand	rcvCmdBehavior The rcv cmd behavior.
(package private) jade.core.behaviours.ThreadedBehaviourFactory	tbf The tbf.

Fields inherited from class jade.core.Agent

AP_ACTIVE, AP_DELETED, AP_IDLE, AP_INITIATED, AP_MAX, AP_MIN, AP_SUSPENDED, AP_WAITING, D_ACTIVE, D_MAX, D_MIN, D_RETIRED, D_SUSPENDED, D_UNKNOWN, MSG_QUEUE_CLASS

Constructor Summary

Constructors

Constructor and Description
EnsembleAgent()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	configure() User-implemented method that configures the component, setting up user parameters and essential properties.
boolean	finit() User-implemented finalization method, called by stop().
java.lang.String	getAddress() Returns this component framework address.
EnsembleAgent	getAgent() Gets agent's name.
java.lang.String	getAgentName() Gets agent's name.
VirtualClockHelper	getClock() Clock getter.
java.lang.String	getParameter(java.lang.String key) Gets the parameter.
java.lang.String	getParameter(java.lang.String key, java.lang.String defaultValue) Gets the parameter.
Parameters	getParameters() Parameters getter.
boolean	init() User-implemented initialization method, called by start().
boolean	parameterUpdate(java.lang.String name, java.lang.String newValue) User-implement method called when a parameter has been updated.
void	processCommand(Command cmd) An user-implemented method to process a received command.
void	sendCommand(Command cmd) A framework-implemented method that sends a command to its destination, via RouterAgent if the recipient is another agent.
void	setParameters(Parameters parameters) Parameters setter.
protected void	setup() Initialization method called by JADE.
protected void	takeDown() Finalization method called by JADE.

Methods inherited from class jade.core.Agent

addBehaviour, afterClone, afterMove, beforeClone, beforeMove, blockingReceive, blockingReceive, blockingReceive, blockingReceive, changeStateTo, clean, createMessageQueue, doActivate, doClone, doDelete, doMove, doSuspend, doTimeOut, doWait, doWait, doWake, getAgentState, getAID, getAMS, getArguments, getBootProperties, getContainerController, getContentManager, getCurQueueSize, getDefaultDF, getHap, getHelper, getLocalName, getName, getO2AObject, getProperty, getQueueSize, getState, here, isRestarting, join, notifyChangeBehaviourState, notifyRestarted, postMessage, putBack, putO2AObject, receive, receive, removeBehaviour, removeTimer, restartLater, restore, restoreBufferedState, run, send, setArguments, setEnabledO2ACommunication, setGenerateBehaviourEvents, setO2AManager, setQueueSize, waitUntilStarted, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ensemble.LifeCycle

start, stop

Methods inherited from interface ensemble.router.RouterClient

receiveCommand

Field Detail

tbf

jade.core.behaviours.ThreadedBehaviourFactory tbf

The tbf.

rcvCmdBehavior

private EnsembleAgent.ReceiveCommand rcvCmdBehavior

The rcv cmd behavior.

parameters

protected Parameters parameters

Agent Parameters.

clock

private VirtualClockHelper clock

Clock Service.

isBatch

protected boolean isBatch

Router Service.

Constructor Detail

EnsembleAgent

public EnsembleAgent()

Method Detail

getParameters

public final Parameters getParameters()

Parameters getter.

Specified by:

getParameters in interface LifeCycle

Returns:

initialized parameters

setParameters

public final void setParameters(Parameters parameters)

Parameters setter.

Specified by:

setParameters in interface LifeCycle

Parameters:

parameters - the new parameters

getParameter

public final java.lang.String getParameter(java.lang.String key)

Gets the parameter.

Parameters:

key - the key

Returns:

the parameter

getParameter

public final java.lang.String getParameter(java.lang.String key,
                            java.lang.String defaultValue)

Gets the parameter.

Parameters:

key - the key

defaultValue - the default value

Returns:

the parameter

getAgent

public final EnsembleAgent getAgent()

Gets agent's name.

Returns:

the agent

getAgentName

public final java.lang.String getAgentName()

Gets agent's name.

Returns:

the agent name

getClock

public final VirtualClockHelper getClock()

Clock getter.

Returns:

ensemble clock service

setup

protected void setup()

Initialization method called by JADE.

Overrides:

setup in class jade.core.Agent

takeDown

protected void takeDown()

Finalization method called by JADE.

Overrides:

takeDown in class jade.core.Agent

getAddress

public final java.lang.String getAddress()

Description copied from interface: RouterClient

Returns this component framework address.

Specified by:

getAddress in interface RouterClient

Returns:

the component address

sendCommand

public final void sendCommand(Command cmd)

Description copied from interface: RouterClient

A framework-implemented method that sends a command to its destination, via RouterAgent if the recipient is another agent.

Specified by:

sendCommand in interface RouterClient

Parameters:

cmd - the cmd

configure

public boolean configure()

Description copied from interface: LifeCycle

User-implemented method that configures the component, setting up user parameters and essential properties.

Specified by:

configure in interface LifeCycle

Returns:

true, if successful

init

public boolean init()

Description copied from interface: LifeCycle

User-implemented initialization method, called by start().

Specified by:

init in interface LifeCycle

Returns:

true, if successful

finit

public boolean finit()

Description copied from interface: LifeCycle

User-implemented finalization method, called by stop().

Specified by:

finit in interface LifeCycle

Returns:

true, if successful

parameterUpdate

public boolean parameterUpdate(java.lang.String name,
                      java.lang.String newValue)

Description copied from interface: LifeCycle

User-implement method called when a parameter has been updated.

Specified by:

parameterUpdate in interface LifeCycle

Parameters:

name - the name

newValue - the new value

Returns:

true, if successful

processCommand

public void processCommand(Command cmd)

Description copied from interface: RouterClient

An user-implemented method to process a received command.

Specified by:

processCommand in interface RouterClient

Parameters:

cmd - the cmd