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/classNLAIAGENT_1_1CFsmScript.html | 1029 ++++++++++++++++++++ 1 file changed, 1029 insertions(+) create mode 100644 docs/doxygen/nel/classNLAIAGENT_1_1CFsmScript.html (limited to 'docs/doxygen/nel/classNLAIAGENT_1_1CFsmScript.html') diff --git a/docs/doxygen/nel/classNLAIAGENT_1_1CFsmScript.html b/docs/doxygen/nel/classNLAIAGENT_1_1CFsmScript.html new file mode 100644 index 00000000..a4f73f21 --- /dev/null +++ b/docs/doxygen/nel/classNLAIAGENT_1_1CFsmScript.html @@ -0,0 +1,1029 @@ + + + + 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: +

+ + + + + + + + + + + + + + + + + + +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 (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 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
virtual sint32	getMethodIndexSize () const
	getMethodIndexSize define the nomber of method define in the class. More...
void	getFatherComponent (IVarName &)
virtual void	activate (IBasicAgent *)
virtual void	unactivate (IBasicAgent *)
virtual void	setTopLevel (NLAIAGENT::CAgentScript *)
Static Public Attributes
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 * ,
bool activated = false
)
+
+ + + + + +
+ + + +
+ +
+Definition at line 62 of file fsm_script.cpp. +
+Referenced by clone, and newInstance.
+

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

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

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

Member Function Documentation

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

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

+ + + + +
+ + + + + + + + + +
int NLAIAGENT::CFsmScript::getBaseMethodCount ( ) const [virtual]
+
+ + + + + +
+ + + +
+Priority of the operator. +
+ +
+Reimplemented from NLAIAGENT::CActorScript. +
+Definition at line 180 of file fsm_script.cpp. +
+Referenced by NLAIAGENT::CSeqFsmScript::runMethodBase, and runMethodBase.
+

+ + + + +
+ + + + + + + + + + +
void NLAIAGENT::CFsmScript::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::CActorScript. +
+Reimplemented in NLAIAGENT::CSeqFsmScript. +
+Definition at line 95 of file fsm_script.cpp. +
+References NLAIAGENT::CAgentScript::_AgentClass, NLAISCRIPT::CAgentClass::getDebugString, and t. +
+Referenced by runMethodBase.
+

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

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

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

+ + + + +
+ + + + + + + + + + +
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 107 of file fsm_script.cpp.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
tQueue NLAIAGENT::CFsmScript::isMember ( const NLAIAGENT::IVarName * ,
const NLAIAGENT::IVarName * ,
const IObjectIA &
) const [virtual]
+
+ + + + + +
+ + + +
+ +
+Reimplemented in NLAIAGENT::CSeqFsmScript. +
+Definition at line 186 of file fsm_script.cpp. +
+References param, NLAIAGENT::CActorScript::ParamFailureMsg, NLAIAGENT::CActorScript::ParamSuccessMsg, NLAIAGENT::tQueue, and NLAIC::CIdentType::VoidType.
+

+ + + + +
+ + + + + + + + + + +
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 123 of file fsm_script.cpp.
+

+ + + + +
+ + + + + + + + + +
const NLAIC::IBasicType * NLAIAGENT::CFsmScript::newInstance ( ) 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 81 of file fsm_script.cpp. +
+References NLAIAGENT::CAgentScript::_AgentClass, NLAISCRIPT::CAgentClass::buildNewInstance, and CFsmScript.
+

+ + + + +
+ + + + + + + + + +
const IObjectIA::CProcessResult & NLAIAGENT::CFsmScript::run ( ) [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 228 of file fsm_script.cpp.
+

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

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
IObjectIA::CProcessResult NLAIAGENT::CFsmScript::runMethodBase ( int index,
IObjectIA *
) [virtual]
+
+ + + + + +
+ + + +
+ +
+Reimplemented from NLAIAGENT::CActorScript. +
+Reimplemented in NLAIAGENT::CSeqFsmScript. +
+Definition at line 151 of file fsm_script.cpp. +
+References getBaseMethodCount, getDebugString, index, NLAIAGENT::CActorScript::onFailure, NLAIAGENT::CActorScript::onSuccess, params, and r.
+

+ + + + +
+ + + + + + + + + + +
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 117 of file fsm_script.cpp.
+

+ + + + +
+ + + + + + + + + + +
void NLAIAGENT::CFsmScript::setTopLevel ( NLAIAGENT::CAgentScript * ) [virtual]
+
+ + + + + +
+ + + +
+ +
+Reimplemented from NLAIAGENT::CActorScript. +
+Definition at line 283 of file fsm_script.cpp. +
+References NLAIAGENT::CAgentScript::_Components, NLAIAGENT::CAgentScript::_NbComponents, NLAIAGENT::CActorScript::_TopLevel, NLAIAGENT::CActorScript::CActorScript, and NLAIAGENT::CAgentScript::setTopLevel.
+

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

Member Data Documentation

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

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

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

+ + + + +
+ + +
const NLAIC::CIdentType CFsmScript::IdFsmScript [static] +
+
+ + + + + +
+ + + +
+ +
+Referenced by NLAISCRIPT::CFsmClass::CFsmClass, and getType.
+

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

+ + + +
+

+ + -- cgit v1.2.1

NLAIAGENT::CFsmScript Class Reference

Public Methods

Static Public Attributes

Private Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation