Package cmion.level3.fatima

Class FAtiMARetainer

java.lang.Object

ion.Meta.Element

cmion.architecture.CmionComponent

cmion.level3.AgentMindConnector

cmion.level3.fatima.FAtiMARetainer

All Implemented Interfaces:

Migrating, MigrationAware

public class FAtiMARetainer
extends AgentMindConnector
implements Migrating, MigrationAware

in this class we pretend to be a fatima for the purpose of retaining the fatima state in a migration scenario. Specify it in your architecture configuration like so:

Field Summary

Fields inherited from class cmion.architecture.CmionComponent

architecture

Constructor Summary

Constructors

Constructor	Description
FAtiMARetainer(IArchitecture architecture)

Method Summary

Modifier and Type	Method	Description
protected void	architectureReady()	informs the mind that the architecture is ready for the mind executing actions
void	awakeMind()	sends a command to the mind telling it to resume decision making and action execution
String	getMessageTag()	This method returns a string that is used to identify the state that is encoded by the implementing class and to select the messages that will be delivered to it.
boolean	isMindSleeping()	returns whether the mind is sleeping or not
void	onMigrationFailure()
void	onMigrationIn()
void	onMigrationOut()
void	onMigrationSuccess()
protected void	processActionCancellation(MindAction a)	informs mind of the success of the cancellation of an executed action
protected void	processActionFailure(MindAction a)	Most of the methods do nothing, as there is no mind as-such present here
protected void	processActionSuccess(MindAction a)	informs mind of the success of a recently executed action
protected void	processEntityAdded(String entityName)	informs the mind that a new entity (agent or object) has been added to the world model
protected void	processEntityRemoved(String entityName)	informs the mind that an entity (agent or object) has been removed from the world model
protected void	processPropertyChanged(String entityName, String propertyName, String propertyValue, boolean persistent)	informs the mind that a property of an agent or object in the world model has changed
protected void	processPropertyRemoved(String entityName, String propertyName)	informs the mind that a property of an agent or object in the world model has been removed
protected void	processRawMessage(String message)	in this message a mind can parse raw messages containing specialised communication / perceptions / requests
protected void	processRemoteAction(MindAction remoteAction)	sends a remoteAction (an action that another agent/user has performed) to the mind
void	restoreState(Element message)	This method parses the XML element provided and restores the state of the object.
Element	saveState(Document doc)	This method encodes the current state of the object and other relevant information in an XML element in order to be migrated.
void	sendMindToSleep()	sends a command to the connected mind, making it pause any decision making processes and action execution, while the mind is paused it should not send any action

Methods inherited from class cmion.level3.AgentMindConnector

cancel, newAction, onDestroy, registerHandlers

Methods inherited from class cmion.architecture.CmionComponent

getArchitecture, isConnected, raise

Methods inherited from class ion.Meta.Element

destroy, getEventFilters, getEventHandlers, getRequestFilters, getRequestHandlers, getSimulation, getUID, schedule, wasDestroyed

Methods inherited from class java.lang.Object

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

Constructor Details

FAtiMARetainer

public FAtiMARetainer(IArchitecture architecture)

Method Details

processActionFailure

protected void processActionFailure(MindAction a)

Most of the methods do nothing, as there is no mind as-such present here

Specified by:

processActionFailure in class AgentMindConnector

processActionSuccess

protected void processActionSuccess(MindAction a)

Description copied from class: AgentMindConnector

informs mind of the success of a recently executed action

Specified by:

processActionSuccess in class AgentMindConnector

processActionCancellation

protected void processActionCancellation(MindAction a)

Description copied from class: AgentMindConnector

informs mind of the success of the cancellation of an executed action

Specified by:

processActionCancellation in class AgentMindConnector

processRemoteAction

protected void processRemoteAction(MindAction remoteAction)

Description copied from class: AgentMindConnector

sends a remoteAction (an action that another agent/user has performed) to the mind

Specified by:

processRemoteAction in class AgentMindConnector

sendMindToSleep

public void sendMindToSleep()

Description copied from class: AgentMindConnector

sends a command to the connected mind, making it pause any decision making processes and action execution, while the mind is paused it should not send any action

Specified by:

sendMindToSleep in class AgentMindConnector

processEntityAdded

protected void processEntityAdded(String entityName)

Description copied from class: AgentMindConnector

informs the mind that a new entity (agent or object) has been added to the world model

Specified by:

processEntityAdded in class AgentMindConnector

processEntityRemoved

protected void processEntityRemoved(String entityName)

Description copied from class: AgentMindConnector

informs the mind that an entity (agent or object) has been removed from the world model

Specified by:

processEntityRemoved in class AgentMindConnector

processPropertyChanged

protected void processPropertyChanged(String entityName,
 String propertyName,
 String propertyValue,
 boolean persistent)

Description copied from class: AgentMindConnector

informs the mind that a property of an agent or object in the world model has changed

Specified by:

processPropertyChanged in class AgentMindConnector

processPropertyRemoved

protected void processPropertyRemoved(String entityName,
 String propertyName)

Description copied from class: AgentMindConnector

informs the mind that a property of an agent or object in the world model has been removed

Specified by:

processPropertyRemoved in class AgentMindConnector

processRawMessage

protected void processRawMessage(String message)

Description copied from class: AgentMindConnector

in this message a mind can parse raw messages containing specialised communication / perceptions / requests

Specified by:

processRawMessage in class AgentMindConnector

architectureReady

protected void architectureReady()

Description copied from class: AgentMindConnector

informs the mind that the architecture is ready for the mind executing actions

Specified by:

architectureReady in class AgentMindConnector

getMessageTag

public String getMessageTag()

Description copied from interface: Migrating

This method returns a string that is used to identify the state that is encoded by the implementing class and to select the messages that will be delivered to it.

Specified by:

getMessageTag in interface Migrating

Returns:

the object signature.

onMigrationFailure

public void onMigrationFailure()

Specified by:

onMigrationFailure in interface MigrationAware

onMigrationIn

public void onMigrationIn()

Specified by:

onMigrationIn in interface MigrationAware

onMigrationOut

public void onMigrationOut()

Specified by:

onMigrationOut in interface MigrationAware

onMigrationSuccess

public void onMigrationSuccess()

Specified by:

onMigrationSuccess in interface MigrationAware

restoreState

public void restoreState(Element message)

Description copied from interface: Migrating

This method parses the XML element provided and restores the state of the object.

Specified by:

restoreState in interface Migrating

Parameters:

message - An XML element that contains the state to be parsed

saveState

public Element saveState(Document doc)

Description copied from interface: Migrating

This method encodes the current state of the object and other relevant information in an XML element in order to be migrated.

Specified by:

saveState in interface Migrating

isMindSleeping

public boolean isMindSleeping()

Description copied from class: AgentMindConnector

returns whether the mind is sleeping or not

Specified by:

isMindSleeping in class AgentMindConnector

awakeMind

public void awakeMind()

Description copied from class: AgentMindConnector

sends a command to the mind telling it to resume decision making and action execution

Specified by:

awakeMind in class AgentMindConnector