From 0ea5fc66924303d1bf73ba283a383e2aadee02f2 Mon Sep 17 00:00:00 2001 From: neodarz Date: Sat, 11 Aug 2018 20:21:34 +0200 Subject: Initial commit --- .../nel/class_NLAIAGENT__CSeqFsmScript.html | 988 +++++++++++++++++++++ 1 file changed, 988 insertions(+) create mode 100644 docs/doxygen/nel/class_NLAIAGENT__CSeqFsmScript.html (limited to 'docs/doxygen/nel/class_NLAIAGENT__CSeqFsmScript.html') diff --git a/docs/doxygen/nel/class_NLAIAGENT__CSeqFsmScript.html b/docs/doxygen/nel/class_NLAIAGENT__CSeqFsmScript.html new file mode 100644 index 00000000..5ea621a6 --- /dev/null +++ b/docs/doxygen/nel/class_NLAIAGENT__CSeqFsmScript.html @@ -0,0 +1,988 @@ + + + + nevrax.org : docs + + + + + + + + + + + + + + +

Home

nevrax.com

+ + + + +

+ + + + + + + + + + +

+ + +

+ Nevrax.org

+ + + + + + + +

	News
	Mailing-list
	Documentation
	CVS
	Bugs
	License

+ + +

+ + + + + + +

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

+ + + + + + + + + + + + + + + + + +[legend]Collaboration diagram for NLAIAGENT::CSeqFsmScript:

+ + + + + +[legend]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 (char *t) 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
	The method isMember(nameSubClass,methodName,param) return the best method correspondent to the search. More...
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 * manager, +
+bool stay_alive = false ) +
+
+ + + + + +
+ + + +
+ +
+Definition at line 31 of file fsm_seq_script.cpp.
+

+ + + + +
+ + + + + + +
+NLAIAGENT::CSeqFsmScript::CSeqFsmScript ( + +const CSeqFsmScript & a ) +
+
+ + + + + +
+ + + +
+ +
+Definition at line 15 of file fsm_seq_script.cpp.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + +
+NLAIAGENT::CSeqFsmScript::CSeqFsmScript ( + +IAgentManager * manager, +
+IBasicAgent * father, +
+std::list< IObjectIA *>& components, +
+NLAISCRIPT::CFsmClass * actor_class ) +
+
+ + + + + +
+ + + +
+ +
+Definition at line 21 of file fsm_seq_script.cpp.
+

+ + + + +
+ + + + + + +
+NLAIAGENT::CSeqFsmScript::~CSeqFsmScript ( + +) [virtual] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 37 of file fsm_seq_script.cpp.
+

Member Function Documentation

+ + + + +
+ + + + + + +
+void NLAIAGENT::CSeqFsmScript::activate ( + +sint32 no_child ) [virtual] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 194 of file fsm_seq_script.cpp.
+

+ + + + +
+ + + + + + +
+const NLAIC::IBasicType * NLAIAGENT::CSeqFsmScript::clone ( + +void ) const [virtual] +
+
+ + + + + +
+ + + +
+Inherited functions. +
+ +
+Reimplemented from NLAIAGENT::CFsmScript. +
+Definition at line 41 of file fsm_seq_script.cpp.
+

+ + + + +
+ + + + + + +
+void NLAIAGENT::CSeqFsmScript::getDebugString ( + +char * t ) 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 61 of file fsm_seq_script.cpp.
+

+ + + + +
+ + + + + + +
+void NLAIAGENT::CSeqFsmScript::getFatherComponent ( + +IVarName & ) +
+
+ + + + + +
+ + + +
+ +
+Reimplemented from NLAIAGENT::CFsmScript.
+

+ + + + +
+ + + + + + +
+const NLAIC::CIdentType & NLAIAGENT::CSeqFsmScript::getType ( + +void ) 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 78 of file fsm_seq_script.cpp.
+

+ + + + +
+ + + + + + +
+bool NLAIAGENT::CSeqFsmScript::isEqual ( + +const IBasicObjectIA & a ) const [virtual] +
+
+ + + + + +
+ + + +
+Implementation of the isEqual of the IBasicObjectIA. +
+ +
+Reimplemented from NLAIAGENT::CFsmScript. +
+Definition at line 73 of file fsm_seq_script.cpp.
+

+ + + + +
+ + + + + + + + + + + + + + +
+tQueue NLAIAGENT::CSeqFsmScript::isMember ( + +const IVarName * className, +
+const IVarName * name, +
+const IObjectIA & param ) const [virtual] +
+
+ + + + + +
+ + + +
+The method isMember(nameSubClass,methodName,param) return the best method correspondent to the search. +
+remember we use the overloadind method. +
+NameSubClass: if this pointer is not NULL then NameSubClass is the name of the base class were the method are defined. +
+methodName: is the name of the class. +
+param: is an IObjectIA where it defined the parametre of the method. lot of method use a IObjectIA vector object with an NLAIC::CIdentType as the the template argm. +
+Reimplemented from NLAIAGENT::CFsmScript. +
+Definition at line 170 of file fsm_seq_script.cpp.
+

+ + + + +
+ + + + + + +
+void NLAIAGENT::CSeqFsmScript::load ( + +NLMISC::IStream & is ) [virtual] +
+
+ + + + + +
+ + + +
+Load the class from a stream. +
+ +
+Reimplemented from NLAIAGENT::CFsmScript. +
+Definition at line 89 of file fsm_seq_script.cpp.
+

+ + + + +
+ + + + + + +
+const NLAIC::IBasicType * NLAIAGENT::CSeqFsmScript::newInstance ( + +void ) const [virtual] +
+
+ + + + + +
+ + + +
+This function allow a new instance, that mean that the class is a class factory. +
+ +
+Reimplemented from NLAIAGENT::CFsmScript. +
+Definition at line 47 of file fsm_seq_script.cpp.
+

+ + + + +
+ + + + + + +
+void NLAIAGENT::CSeqFsmScript::onFailure ( + +IObjectIA * ) [virtual] +
+
+ + + + + +
+ + + +
+ +
+Reimplemented from NLAIAGENT::CActorScript. +
+Definition at line 244 of file fsm_seq_script.cpp.
+

+ + + + +
+ + + + + + +
+void NLAIAGENT::CSeqFsmScript::onFailure ( + +) [virtual] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 235 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 239 of file fsm_seq_script.cpp.
+

+ + + + +
+ + + + + + +
+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 230 of file fsm_seq_script.cpp.
+

+ + + + +
+ + + + + + +
+void NLAIAGENT::CSeqFsmScript::runChildren ( + +) [virtual] +
+
+ + + + + +
+ + + +
+Run all child. +
+ +
+Reimplemented from NLAIAGENT::CFsmScript. +
+Definition at line 221 of file fsm_seq_script.cpp.
+

+ + + + +
+ + + + + + + + + + +
+IObjectIA::CProcessResult NLAIAGENT::CSeqFsmScript::runMethodBase ( + +int index, +
+IObjectIA * params ) [virtual] +
+
+ + + + + +
+ + + +
+ +
+Reimplemented from NLAIAGENT::CFsmScript. +
+Definition at line 126 of file fsm_seq_script.cpp.
+

+ + + + +
+ + + + + + + + + + + + + + +
+IObjectIA::CProcessResult NLAIAGENT::CSeqFsmScript::runMethodBase ( + +int index, +
+int heritance, +
+IObjectIA * params ) [virtual] +
+
+ + + + + +
+ + + +
+ +
+Reimplemented from NLAIAGENT::CActorScript. +
+Definition at line 101 of file fsm_seq_script.cpp.
+

+ + + + +
+ + + + + + +
+void NLAIAGENT::CSeqFsmScript::save ( + +NLMISC::IStream & os ) [virtual] +
+
+ + + + + +
+ + + +
+Save the class in a stream. +
+ +
+Reimplemented from NLAIAGENT::CFsmScript. +
+Definition at line 83 of file fsm_seq_script.cpp.
+

Member Data Documentation

+ + + + +
+ + + + + +
+const NLAIC::CIdentType NLAIAGENT::CSeqFsmScript::IdSeqFsmScript [static] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 79 of file fsm_seq_script.h.
+

+ + + + +
+ + + + + +
+IBasicAgent * NLAIAGENT::CSeqFsmScript::_ActiveChild [private] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 48 of file fsm_seq_script.h.
+

+ + + + +
+ + + + + +
+sint32 NLAIAGENT::CSeqFsmScript::_IdActiveChild [private] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 47 of file fsm_seq_script.h.
+

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

+ + + +
+

+ + -- cgit v1.2.1

NLAIAGENT::CSeqFsmScript Class Reference

Public Methods

Static Public Attributes

Private Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation