|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--jade.wrapper.Agent
This class is a Proxy class, allowing access to a JADE agent.
Invoking methods on instances of this class, it is possible to
trigger state transition of the agent life cycle. This class must
not be instantiated by applications. Instead, use the
createAgent()
method in class
AgentContainer
.
NOT available in MIDP
AgentContainer.createNewAgent(String, String, Object[])
Field Summary | |
static boolean |
ASYNC
Constant representing an asynchronous rendez-vous policy. |
static boolean |
SYNC
Constant representing a synchronous rendez-vous policy. |
Constructor Summary | |
Agent(AID id,
Agent a)
Default constructor. |
Method Summary | |
void |
activate()
Triggers a state transition from SUSPENDED to ACTIVE. |
void |
clone(Location where,
java.lang.String newName)
Clones the current agent. |
java.lang.String |
getName()
Get the platforms name of the agent. |
State |
getState()
Read current agent state. |
void |
kill()
Triggers a state transition from ACTIVE to DELETED. |
void |
move(Location where)
Triggers a state transition from ACTIVE to TRANSIT. |
void |
putO2AObject(java.lang.Object o,
boolean blocking)
Passes an application-specific object to a local agent, created using JADE In-Process Interface. |
void |
start()
Triggers a state transition from INITIATED to ACTIVE. |
void |
suspend()
Triggers a state transition from ACTIVE to SUSPENDED. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final boolean ASYNC
putO2AObject(Object, boolean)
,
Constant Field Valuespublic static final boolean SYNC
putO2AObject(Object o, boolean blocking)
,
Constant Field ValuesConstructor Detail |
public Agent(AID id, Agent a)
AgentContainer.createAgent()
should
be used instead.
id
- The AID
of the agent to be wrapped by this proxy.a
- The real JADE agent, that will be wrapped by this proxy.AgentContainer.createNewAgent(String, String, Object[])
Method Detail |
public java.lang.String getName() throws StaleProxyException
getName
in interface AgentController
StaleProxyException
public void start() throws StaleProxyException
start
in interface AgentController
StaleProxyException
- If the underlying agent is dead or
gone.public void suspend() throws StaleProxyException
suspend
in interface AgentController
StaleProxyException
- If the underlying agent is dead or
gone.public void activate() throws StaleProxyException
activate
in interface AgentController
StaleProxyException
- If the underlying agent is dead or
gone.public void kill() throws StaleProxyException
kill
in interface AgentController
StaleProxyException
- If the underlying agent is dead or
gone.public void move(Location where) throws StaleProxyException
where
- A Location
object, representing the
container the agent should move to.
StaleProxyException
- If the underlying agent is dead or
gone.public void clone(Location where, java.lang.String newName) throws StaleProxyException
where
- The Location
object, representing the
container where the new agent copy will start.newName
- The new nickname to give to the copy.
StaleProxyException
- If the underlying agent is dead or
gone.public void putO2AObject(java.lang.Object o, boolean blocking) throws StaleProxyException
jade.core.Agent.getO2AObject()
method. The agent
must first declare its will to accept passed objects, using the
jade.core.Agent.setEnabledO2ACommunication()
method.
o
- The object to put in the private agent queue.blocking
- A flag, stating the desired rendez-vous policy;
it can be ASYNC
, for a non-blocking call, returning
right after putting the object in the quque, or
SYNC
, for a blocking call that does not return until
the agent picks the object from the private queue.
StaleProxyException
Agent.getO2AObject()
,
Agent.setEnabledO2ACommunication(boolean enabled, int queueSize)
public State getState() throws StaleProxyException
getState
in interface AgentController
StaleProxyException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |