From 0ea5fc66924303d1bf73ba283a383e2aadee02f2 Mon Sep 17 00:00:00 2001 From: neodarz Date: Sat, 11 Aug 2018 20:21:34 +0200 Subject: Initial commit --- .../nel/classNLAIAGENT_1_1CSeqFsmScript.html | 1007 ++++++++++++++++++++ 1 file changed, 1007 insertions(+) create mode 100644 docs/doxygen/nel/classNLAIAGENT_1_1CSeqFsmScript.html (limited to 'docs/doxygen/nel/classNLAIAGENT_1_1CSeqFsmScript.html') diff --git a/docs/doxygen/nel/classNLAIAGENT_1_1CSeqFsmScript.html b/docs/doxygen/nel/classNLAIAGENT_1_1CSeqFsmScript.html new file mode 100644 index 00000000..e401adf7 --- /dev/null +++ b/docs/doxygen/nel/classNLAIAGENT_1_1CSeqFsmScript.html @@ -0,0 +1,1007 @@ + + + + nevrax.org : docs + + + + + + + + + + + + + + +
# Home   # nevrax.com   
+ + + + +
Nevrax
+ + + + + + + + + + +
+ + +
+ Nevrax.org
+ + + + + + + +
#News
#Mailing-list
#Documentation
#CVS
#Bugs
#License
+
+ + + 		+ + +
+Docs + +
+  + + + + + +
Documentation 
+ +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages   Search  
+

NLAIAGENT::CSeqFsmScript Class Reference

#include <fsm_seq_script.h> +

+

Inheritance diagram for NLAIAGENT::CSeqFsmScript: +

+ +NLAIAGENT::CFsmScript +NLAIAGENT::CActorScript +NLAIAGENT::CAgentScript +NLAIAGENT::IAgentManager +NLAIAGENT::IAgent +NLAIAGENT::IAgentComposite +NLAIAGENT::IBasicAgent +NLAIAGENT::IConnectIA +NLAIAGENT::IRefrence +NLAIAGENT::IObjectIA +NLAIAGENT::IBasicObjectIA +NLAIC::IBasicInterface +NLAIC::IBasicType +NLAIC::IPointerGestion +NLMISC::IStreamable +NLMISC::IClassable + +List of all members. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Methods

 CSeqFsmScript (IAgentManager *, bool activated=false)
 CSeqFsmScript (const CSeqFsmScript &)
 CSeqFsmScript (IAgentManager *, IBasicAgent *, std::list< IObjectIA * > &, NLAISCRIPT::CFsmClass *)
virtual ~CSeqFsmScript ()
virtual const NLAIC::IBasicType * clone () const
 Inherited functions. More...

virtual const NLAIC::IBasicType * newInstance () const
 This function allow a new instance, that mean that the class is a class factory. More...

virtual void getDebugString (std::string &) const
 This is a Debug function, text is an character pointer to receive the debug text output, the debug text containe all think sensible to interset user. More...

virtual bool isEqual (const IBasicObjectIA &a) const
 Implementation of the isEqual of the IBasicObjectIA. More...

virtual void runChildren ()
 Run all child. More...

virtual const NLAIC::CIdentType & getType () const
 getType return a unique string how represente the class, it can be the name of the class. More...

virtual void save (NLMISC::IStream &os)
 Save the class in a stream. More...

virtual void load (NLMISC::IStream &is)
 Load the class from a stream. More...

virtual IObjectIA::CProcessResult runMethodBase (int heritance, int index, IObjectIA *)
virtual IObjectIA::CProcessResult runMethodBase (int index, IObjectIA *)
virtual tQueue isMember (const NLAIAGENT::IVarName *, const NLAIAGENT::IVarName *, const IObjectIA &) const
void getFatherComponent (IVarName &)
virtual void activate (sint32)
virtual void onSuccess ()
 Own success and failure callbacks For sequential fsms, on success the next step is activated, on failure the whole fsm returns failure. More...

virtual void onFailure ()
virtual void onSuccess (IObjectIA *)
 Dependencies failure and success notification These functions are called by other operators or goals who failed or succeeded. More...

virtual void onFailure (IObjectIA *)

Static Public Attributes

const NLAIC::CIdentType IdSeqFsmScript

Private Attributes

sint32 _IdActiveChild
IBasicAgent * _ActiveChild
+

Constructor & Destructor Documentation

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
NLAIAGENT::CSeqFsmScript::CSeqFsmScript ( IAgentManager *  ,
bool   activated = false
) 
+
+ + + + + +
+   + + +

+ +

+Definition at line 30 of file fsm_seq_script.cpp. +

+References _ActiveChild, and _IdActiveChild. +

+Referenced by clone, and newInstance.

+

+ + + + +
+ + + + + + + + + + +
NLAIAGENT::CSeqFsmScript::CSeqFsmScript ( const CSeqFsmScript &   ) 
+
+ + + + + +
+   + + +

+ +

+Definition at line 14 of file fsm_seq_script.cpp. +

+References _ActiveChild, and _IdActiveChild.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NLAIAGENT::CSeqFsmScript::CSeqFsmScript ( IAgentManager *  ,
IBasicAgent *  ,
std::list< IObjectIA * > &  ,
NLAISCRIPT::CFsmClass *  
) 
+
+ + + + + +
+   + + +

+ +

+Definition at line 20 of file fsm_seq_script.cpp. +

+References _ActiveChild, _IdActiveChild, and components.

+

+ + + + +
+ + + + + + + + + +
NLAIAGENT::CSeqFsmScript::~CSeqFsmScript (   )  [virtual]
+
+ + + + + +
+   + + +

+ +

+Definition at line 36 of file fsm_seq_script.cpp.

+

Member Function Documentation

+

+ + + + +
+ + + + + + + + + + +
void NLAIAGENT::CSeqFsmScript::activate ( sint32   )  [virtual]
+
+ + + + + +
+   + + +

+ +

+Definition at line 174 of file fsm_seq_script.cpp. +

+References _ActiveChild, and _IdActiveChild.

+

+ + + + +
+ + + + + + + + + +
const NLAIC::IBasicType * NLAIAGENT::CSeqFsmScript::clone (   )  const [virtual]
+
+ + + + + +
+   + + +

+Inherited functions. +

+ +

+Reimplemented from NLAIAGENT::CFsmScript. +

+Definition at line 40 of file fsm_seq_script.cpp. +

+References CSeqFsmScript.

+

+ + + + +
+ + + + + + + + + + +
void NLAIAGENT::CSeqFsmScript::getDebugString ( std::string &   )  const [virtual]
+
+ + + + + +
+   + + +

+This is a Debug function, text is an character pointer to receive the debug text output, the debug text containe all think sensible to interset user. +

+ +

+Reimplemented from NLAIAGENT::CFsmScript. +

+Definition at line 60 of file fsm_seq_script.cpp. +

+References NLAIAGENT::CAgentScript::_AgentClass, NLAISCRIPT::CAgentClass::getDebugString, and t. +

+Referenced by runMethodBase.

+

+ + + + +
+ + + + + + + + + + +
void NLAIAGENT::CSeqFsmScript::getFatherComponent ( IVarName &   ) 
+
+ + + + + +
+   + + +

+ +

+Reimplemented from NLAIAGENT::CFsmScript.

+

+ + + + +
+ + + + + + + + + +
const NLAIC::CIdentType & NLAIAGENT::CSeqFsmScript::getType (   )  const [virtual]
+
+ + + + + +
+   + + +

+getType return a unique string how represente the class, it can be the name of the class. +

+This function is used for the sytem regstry class (see the definition of the template class Gen::CRegistry). +

+Reimplemented from NLAIAGENT::CFsmScript. +

+Definition at line 77 of file fsm_seq_script.cpp. +

+References IdSeqFsmScript. +

+Referenced by runChildren.

+

+ + + + +
+ + + + + + + + + + +
bool NLAIAGENT::CSeqFsmScript::isEqual ( const IBasicObjectIA &   a )  const [virtual]
+
+ + + + + +
+   + + +

+Implementation of the isEqual of the IBasicObjectIA. +

+ +

+Reimplemented from NLAIAGENT::CFsmScript. +

+Definition at line 72 of file fsm_seq_script.cpp.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
tQueue NLAIAGENT::CSeqFsmScript::isMember ( const NLAIAGENT::IVarName *  ,
const NLAIAGENT::IVarName *  ,
const IObjectIA &  
)  const [virtual]
+
+ + + + + +
+   + + +

+ +

+Reimplemented from NLAIAGENT::CFsmScript. +

+Definition at line 152 of file fsm_seq_script.cpp. +

+References param, NLAIAGENT::tQueue, and NLAIC::CIdentType::VoidType.

+

+ + + + +
+ + + + + + + + + + +
void NLAIAGENT::CSeqFsmScript::load ( NLMISC::IStream &   is )  [virtual]
+
+ + + + + +
+   + + +

+Load the class from a stream. +

+ +

+Reimplemented from NLAIAGENT::CFsmScript. +

+Definition at line 88 of file fsm_seq_script.cpp.

+

+ + + + +
+ + + + + + + + + +
const NLAIC::IBasicType * NLAIAGENT::CSeqFsmScript::newInstance (   )  const [virtual]
+
+ + + + + +
+   + + +

+This function allow a new instance, that mean that the class is a class factory. +

+ +

+Reimplemented from NLAIAGENT::CFsmScript. +

+Definition at line 46 of file fsm_seq_script.cpp. +

+References NLAIAGENT::CAgentScript::_AgentClass, NLAISCRIPT::CAgentClass::buildNewInstance, and CSeqFsmScript.

+

+ + + + +
+ + + + + + + + + + +
void NLAIAGENT::CSeqFsmScript::onFailure ( IObjectIA *   )  [virtual]
+
+ + + + + +
+   + + +

+ +

+Reimplemented from NLAIAGENT::CActorScript. +

+Definition at line 223 of file fsm_seq_script.cpp.

+

+ + + + +
+ + + + + + + + + +
void NLAIAGENT::CSeqFsmScript::onFailure (   )  [virtual]
+
+ + + + + +
+   + + +

+ +

+Definition at line 214 of file fsm_seq_script.cpp.

+

+ + + + +
+ + + + + + + + + + +
void NLAIAGENT::CSeqFsmScript::onSuccess ( IObjectIA *   )  [virtual]
+
+ + + + + +
+   + + +

+Dependencies failure and success notification These functions are called by other operators or goals who failed or succeeded. +

+ +

+Reimplemented from NLAIAGENT::CActorScript. +

+Definition at line 218 of file fsm_seq_script.cpp. +

+References _IdActiveChild, and NLAIAGENT::CActorScript::activate.

+

+ + + + +
+ + + + + + + + + +
void NLAIAGENT::CSeqFsmScript::onSuccess (   )  [virtual]
+
+ + + + + +
+   + + +

+Own success and failure callbacks For sequential fsms, on success the next step is activated, on failure the whole fsm returns failure. +

+ +

+Definition at line 209 of file fsm_seq_script.cpp.

+

+ + + + +
+ + + + + + + + + +
void NLAIAGENT::CSeqFsmScript::runChildren (   )  [virtual]
+
+ + + + + +
+   + + +

+Run all child. +

+ +

+Reimplemented from NLAIAGENT::CFsmScript. +

+Definition at line 200 of file fsm_seq_script.cpp. +

+References _ActiveChild, and getType.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
IObjectIA::CProcessResult NLAIAGENT::CSeqFsmScript::runMethodBase ( int   index,
IObjectIA *  
)  [virtual]
+
+ + + + + +
+   + + +

+ +

+Reimplemented from NLAIAGENT::CFsmScript. +

+Definition at line 106 of file fsm_seq_script.cpp. +

+References NLAIAGENT::CFsmScript::getBaseMethodCount, getDebugString, index, param, params, and r.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
IObjectIA::CProcessResult NLAIAGENT::CSeqFsmScript::runMethodBase ( int   heritance,
int   index,
IObjectIA *  
)  [virtual]
+
+ + + + + +
+   + + +

+ +

+Reimplemented from NLAIAGENT::CActorScript. +

+Definition at line 100 of file fsm_seq_script.cpp. +

+References index, and params.

+

+ + + + +
+ + + + + + + + + + +
void NLAIAGENT::CSeqFsmScript::save ( NLMISC::IStream &   os )  [virtual]
+
+ + + + + +
+   + + +

+Save the class in a stream. +

+ +

+Reimplemented from NLAIAGENT::CFsmScript. +

+Definition at line 82 of file fsm_seq_script.cpp.

+

Member Data Documentation

+

+ + + + +
+ + +
IBasicAgent* NLAIAGENT::CSeqFsmScript::_ActiveChild [private] +
+
+ + + + + +
+   + + +

+ +

+Definition at line 48 of file fsm_seq_script.h. +

+Referenced by activate, CSeqFsmScript, and runChildren.

+

+ + + + +
+ + +
sint32 NLAIAGENT::CSeqFsmScript::_IdActiveChild [private] +
+
+ + + + + +
+   + + +

+ +

+Definition at line 47 of file fsm_seq_script.h. +

+Referenced by activate, CSeqFsmScript, and onSuccess.

+

+ + + + +
+ + +
const NLAIC::CIdentType CSeqFsmScript::IdSeqFsmScript [static] +
+
+ + + + + +
+   + + +

+ +

+Referenced by NLAISCRIPT::CSeqFsmClass::CSeqFsmClass, and getType.

+

The documentation for this class was generated from the following files: + + + +
                                                                                                                                                                    +
+ + -- cgit v1.2.1