From 0ea5fc66924303d1bf73ba283a383e2aadee02f2 Mon Sep 17 00:00:00 2001 From: neodarz Date: Sat, 11 Aug 2018 20:21:34 +0200 Subject: Initial commit --- docs/doxygen/nel/class_NLAIAGENT__CFsmScript.html | 1187 +++++++++++++++++++++ 1 file changed, 1187 insertions(+) create mode 100644 docs/doxygen/nel/class_NLAIAGENT__CFsmScript.html (limited to 'docs/doxygen/nel/class_NLAIAGENT__CFsmScript.html') diff --git a/docs/doxygen/nel/class_NLAIAGENT__CFsmScript.html b/docs/doxygen/nel/class_NLAIAGENT__CFsmScript.html new file mode 100644 index 00000000..2ecfa1fb --- /dev/null +++ b/docs/doxygen/nel/class_NLAIAGENT__CFsmScript.html @@ -0,0 +1,1187 @@ + + + + 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::CFsmScript Class Reference

#include <fsm_script.h> +

+Inheritance diagram for NLAIAGENT::CFsmScript

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

+ + + + + + + + + +[legend]List of all members. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Methods
	CFsmScript (IAgentManager *, bool activated = false)
	CFsmScript (const CFsmScript &)
	CFsmScript (IAgentManager , IBasicAgent , std::list<IObjectIA > &, NLAISCRIPT::CFsmClass )
virtual	~CFsmScript ()
virtual int	getBaseMethodCount () const
	Priority of the operator. More...
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 const CProcessResult&	run ()
	The work of an agent. 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 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...
virtual sint32	getMethodIndexSize () const
	getMethodIndexSize define the nomber of external method. More...
void	getFatherComponent (IVarName &)
virtual void	activate (IBasicAgent *)
virtual void	unactivate (IBasicAgent *)
Static Public Methods
void	initClass ()
void	releaseClass ()
Static Public Attributes
NLAISCRIPT::COperandSimpleListOr*	ParamIdSuccessMsg = NULL
NLAISCRIPT::CParam*	ParamSuccessMsg = NULL
NLAISCRIPT::COperandSimpleListOr*	ParamIdFailureMsg = NULL
NLAISCRIPT::CParam*	ParamFailureMsg = NULL
const NLAIC::CIdentType	IdFsmScript
Private Attributes
std::vector<NLAIAGENT::IObjectIA *>	_VarValues
NLAILOGIC::CFactBase*	_FactBase
std::vector<IBasicAgent *>	_ActiveChilds

Constructor & Destructor Documentation

+ + + + +
+ + + + + + + + + + +
+NLAIAGENT::CFsmScript::CFsmScript ( + +IAgentManager * manager, +
+bool stay_alive = false ) +
+
+ + + + + +
+ + + +
+ +
+Definition at line 63 of file fsm_script.cpp.
+

+ + + + +
+ + + + + + +
+NLAIAGENT::CFsmScript::CFsmScript ( + +const CFsmScript & a ) +
+
+ + + + + +
+ + + +
+ +
+Definition at line 44 of file fsm_script.cpp.
+

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

+ + + + +
+ + + + + + +
+NLAIAGENT::CFsmScript::~CFsmScript ( + +) [virtual] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 67 of file fsm_script.cpp.
+

Member Function Documentation

+ + + + +
+ + + + + + +
+void NLAIAGENT::CFsmScript::activate ( + +IBasicAgent * child ) [virtual] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 232 of file fsm_script.cpp.
+

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

+ + + + +
+ + + + + + +
+int NLAIAGENT::CFsmScript::getBaseMethodCount ( + +) const [virtual] +
+
+ + + + + +
+ + + +
+Priority of the operator. +
+ +
+Reimplemented from NLAIAGENT::CActorScript. +
+Definition at line 181 of file fsm_script.cpp.
+

+ + + + +
+ + + + + + +
+void NLAIAGENT::CFsmScript::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::CActorScript. +
+Reimplemented in NLAIAGENT::CSeqFsmScript. +
+Definition at line 96 of file fsm_script.cpp.
+

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

+ + + + +
+ + + + + + +
+sint32 NLAIAGENT::CFsmScript::getMethodIndexSize ( + +) const [virtual] +
+
+ + + + + +
+ + + +
+getMethodIndexSize define the nomber of external method. +
+ +
+Reimplemented from NLAIAGENT::CActorScript. +
+Definition at line 130 of file fsm_script.cpp.
+

+ + + + +
+ + + + + + +
+const NLAIC::CIdentType & NLAIAGENT::CFsmScript::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::CActorScript. +
+Reimplemented in NLAIAGENT::CSeqFsmScript. +
+Definition at line 113 of file fsm_script.cpp.
+

+ + + + +
+ + + + + + +
+void NLAIAGENT::CFsmScript::initClass ( + +) [static] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 23 of file fsm_script.cpp. +
+Referenced by NLAILINK::initIALib().
+

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

+ + + + +
+ + + + + + + + + + + + + + +
+tQueue NLAIAGENT::CFsmScript::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::CActorScript. +
+Reimplemented in NLAIAGENT::CSeqFsmScript. +
+Definition at line 187 of file fsm_script.cpp.
+

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

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

+ + + + +
+ + + + + + +
+void NLAIAGENT::CFsmScript::releaseClass ( + +) [static] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 35 of file fsm_script.cpp. +
+Referenced by NLAILINK::releaseIALib().
+

+ + + + +
+ + + + + + +
+const IObjectIA::CProcessResult & NLAIAGENT::CFsmScript::run ( + +void ) [virtual] +
+
+ + + + + +
+ + + +
+The work of an agent. +
+Typically agent process child message, process its message and run its activity. +
+Reimplemented from NLAIAGENT::CActorScript. +
+Definition at line 227 of file fsm_script.cpp.
+

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

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

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

+ + + + +
+ + + + + + +
+void NLAIAGENT::CFsmScript::unactivate ( + +IBasicAgent * child ) [virtual] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 237 of file fsm_script.cpp.
+

Member Data Documentation

+ + + + +
+ + + + + +
+const NLAIC::CIdentType NLAIAGENT::CFsmScript::IdFsmScript [static] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 82 of file fsm_script.h.
+

+ + + + +
+ + + + + +
+NLAISCRIPT::CParam * NLAIAGENT::CFsmScript::ParamFailureMsg = NULL [static] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 21 of file fsm_script.cpp.
+

+ + + + +
+ + + + + +
+NLAISCRIPT::COperandSimpleListOr * NLAIAGENT::CFsmScript::ParamIdFailureMsg = NULL [static] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 20 of file fsm_script.cpp.
+

+ + + + +
+ + + + + +
+NLAISCRIPT::COperandSimpleListOr * NLAIAGENT::CFsmScript::ParamIdSuccessMsg = NULL [static] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 18 of file fsm_script.cpp.
+

+ + + + +
+ + + + + +
+NLAISCRIPT::CParam * NLAIAGENT::CFsmScript::ParamSuccessMsg = NULL [static] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 19 of file fsm_script.cpp.
+

+ + + + +
+ + + + + +
+std::vector< IBasicAgent *> NLAIAGENT::CFsmScript::_ActiveChilds [private] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 53 of file fsm_script.h.
+

+ + + + +
+ + + + + +
+NLAILOGIC::CFactBase * NLAIAGENT::CFsmScript::_FactBase [private] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 51 of file fsm_script.h.
+

+ + + + +
+ + + + + +
+std::vector< NLAIAGENT::IObjectIA *> NLAIAGENT::CFsmScript::_VarValues [private] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 50 of file fsm_script.h.
+

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

+ + + +
+

+ + -- cgit v1.2.1

NLAIAGENT::CFsmScript Class Reference

Public Methods

Static Public Methods

Static Public Attributes

Private Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation