fipa_acl  1.4
Public Member Functions | List of all members
fipa::acl::default_state::ConversationCancelling Class Reference

#include <state.h>

Inherits fipa::acl::State.

Public Member Functions

 ConversationCancelling ()
 
- Public Member Functions inherited from fipa::acl::State
 State ()
 empty constructor initializes default fields More...
 
 State (const StateId &id)
 constructor taking the unique name(id) of the state as arguement More...
 
Transition addTransition (const Transition &t)
 
const TransitiongetTransition (const ACLMessage &msg, const MessageArchive &archive, const RoleMapping &roleMapping) const
 Check whether the received message triggers a transition. More...
 
void consumeSubStateMachineMessage (const ACLMessage &msg, const fipa::acl::StateMachine &stateMachine, const fipa::acl::RoleMapping &roleMapping, int numberOfSubConversations)
 
const TransitiongetSubstateMachineProxiedTransition (const ACLMessage &msg, const MessageArchive &archive, const RoleMapping &roleMapping)
 Check whether the received message triggers a substatemachine proxied transition. This method is not const, as the generated transitions will be added when they trigger successfully. More...
 
void generateDefaultTransitions ()
 method that generates implicit generic transitions applicable to all states, that may or may not be speciffied in the configuration file such as not-understood transition (if it is specified it is not doubled); this method is to be called after all states specified in the configuration have been added to the state machine, preferably after all generic transition have been added as well More...
 
bool isFinal () const
 
bool isFinished () const
 method that returns whether the state is a finished state or not. In the case of a state with embedded state machines, this is a bit more coplex, see the implementation More...
 
bool isDefaultState () const
 Test if state belongs to the default state or not. More...
 
void setId (const StateId &id)
 setter method for the uid field of the state NOTE: maybe should be taken out and name only be allowed to be set on More...
 
std::string getId () const
 getter method for the uid field of the class More...
 
const std::vector< Transition > & getTransitions () const
 
const std::vector
< EmbeddedStateMachine > & 
getEmbeddedStatemachines () const
 
void addEmbeddedStateMachine (fipa::acl::EmbeddedStateMachine embeddedStateMachine)
 
std::string toString () const
 
std::string toXML () const
 

Additional Inherited Members

- Static Public Attributes inherited from fipa::acl::State
static const StateId UNDEFINED_ID = "__undefined__"
 
static const StateId NOT_UNDERSTOOD = "__internal_state:not_understood__"
 
static const StateId CONVERSATION_CANCELLING = "__internal_state:conversation_cancelling__"
 
static const StateId CONVERSATION_CANCEL_SUCCESS = "__internal_state:conversation_cancel_success__"
 
static const StateId CONVERSATION_CANCEL_FAILURE = "__internal_state:conversation_cancel_failure__"
 
static const StateId GENERAL_FAILURE_STATE = "__internal_state:general_failure__"
 
- Protected Member Functions inherited from fipa::acl::State
void setFinal (bool final)
 setter method for the final field of the class When changing the final state flag make sure you either remove existing transitions or create the default transition if needed More...
 

Detailed Description

Default state for conversation cancel

Definition at line 239 of file state.h.

Constructor & Destructor Documentation

fipa::acl::default_state::ConversationCancelling::ConversationCancelling ( )

Definition at line 414 of file state.cpp.

416 {
417  // Add the cancel transitions -> success or failure
418  default_transition::ConversationCancelSuccess transitionSuccess;
419  addTransition(*dynamic_cast<Transition*>(&transitionSuccess));
420 
421  default_transition::ConversationCancelFailure transitionFailure;
422  addTransition(*dynamic_cast<Transition*>(&transitionFailure));
423 }
static const StateId CONVERSATION_CANCELLING
Definition: state.h:105
State()
empty constructor initializes default fields
Definition: state.cpp:33
Transition addTransition(const Transition &t)
Definition: state.cpp:45

The documentation for this class was generated from the following files: