Package cmion.level3.fatima

Class FAtiMARetainer

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      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
      java.lang.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​(java.lang.String entityName)
      informs the mind that a new entity (agent or object) has been added to the world model
      protected void processEntityRemoved​(java.lang.String entityName)
      informs the mind that an entity (agent or object) has been removed from the world model
      protected void processPropertyChanged​(java.lang.String entityName, java.lang.String propertyName, java.lang.String propertyValue, boolean persistent)
      informs the mind that a property of an agent or object in the world model has changed
      protected void processPropertyRemoved​(java.lang.String entityName, java.lang.String propertyName)
      informs the mind that a property of an agent or object in the world model has been removed
      protected void processRawMessage​(java.lang.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​(org.w3c.dom.Element message)
      This method parses the XML element provided and restores the state of the object.
      org.w3c.dom.Element saveState​(org.w3c.dom.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 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 Detail

      • FAtiMARetainer

        public FAtiMARetainer​(IArchitecture architecture)

    • Method Detail

      • 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​(java.lang.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​(java.lang.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​(java.lang.String entityName,
                                      java.lang.String propertyName,
                                      java.lang.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​(java.lang.String entityName,
                                      java.lang.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​(java.lang.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

      • getMessageTag

        public java.lang.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.

      • restoreState

        public void restoreState​(org.w3c.dom.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 org.w3c.dom.Element saveState​(org.w3c.dom.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

      • 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