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

#include <operator_script.h> +

+Inheritance diagram for NLAIAGENT::COperatorScript

Inheritance graph
+ + + + + + + + + + + + + + + + + +
[legend]
Collaboration diagram for NLAIAGENT::COperatorScript:

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

Public Methods

 COperatorScript (IAgentManager *, bool activated = false)
 COperatorScript (const COperatorScript &)
 COperatorScript (IAgentManager *, IBasicAgent *, std::list<IObjectIA *> &, NLAISCRIPT::COperatorClass *)
virtual ~COperatorScript ()
virtual float priority () 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 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...

void getFatherComponent (IVarName &)
void instanciateGoalArgs (NLAILOGIC::CGoal *)
 Binds the goal args to the variables of the operator (defined by the "Goal:" field in the script). More...

virtual void cancel ()

Static Public Attributes

const NLAIC::CIdentType IdOperatorScript

Private Attributes

std::vector<NLAIAGENT::IObjectIA *> _VarValues
NLAILOGIC::CFactBase* _FactBase
NLAILOGIC::CGoal* _CurrentGoal
+

Constructor & Destructor Documentation

+

+ + + + +
+ + + + + + + + + + +
+NLAIAGENT::COperatorScript::COperatorScript ( + +IAgentManager * manager, +
+bool stay_alive = false ) +
+
+ + + + + +
+   + + +

+ +

+Definition at line 30 of file operator_script.cpp.

+

+ + + + +
+ + + + + + +
+NLAIAGENT::COperatorScript::COperatorScript ( + +const COperatorScript & a ) +
+
+ + + + + +
+   + + +

+ +

+Definition at line 16 of file operator_script.cpp.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + +
+NLAIAGENT::COperatorScript::COperatorScript ( + +IAgentManager * manager, +
+IBasicAgent * father, +
+std::list< IObjectIA *>& components, +
+NLAISCRIPT::COperatorClass * actor_class ) +
+
+ + + + + +
+   + + +

+ +

+Definition at line 21 of file operator_script.cpp.

+

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

+ +

+Definition at line 35 of file operator_script.cpp.

+

Member Function Documentation

+

+ + + + +
+ + + + + + +
+void NLAIAGENT::COperatorScript::cancel ( + +) [virtual] +
+
+ + + + + +
+   + + +

+ +

+Reimplemented from NLAIAGENT::CActorScript. +

+Definition at line 314 of file operator_script.cpp.

+

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

+Inherited functions. +

+ +

+Reimplemented from NLAIAGENT::CActorScript. +

+Definition at line 39 of file operator_script.cpp.

+

+ + + + +
+ + + + + + +
+void NLAIAGENT::COperatorScript::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. +

+Definition at line 59 of file operator_script.cpp.

+

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

+ +

+Reimplemented from NLAIAGENT::CActorScript.

+

+ + + + +
+ + + + + + +
+const NLAIC::CIdentType & NLAIAGENT::COperatorScript::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. +

+Definition at line 87 of file operator_script.cpp.

+

+ + + + +
+ + + + + + +
+void NLAIAGENT::COperatorScript::instanciateGoalArgs ( + +NLAILOGIC::CGoal * goal ) +
+
+ + + + + +
+   + + +

+Binds the goal args to the variables of the operator (defined by the "Goal:" field in the script). +

+ +

+Definition at line 209 of file operator_script.cpp.

+

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

+Implementation of the isEqual of the IBasicObjectIA. +

+ +

+Reimplemented from NLAIAGENT::CActorScript. +

+Definition at line 82 of file operator_script.cpp.

+

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

+Load the class from a stream. +

+ +

+Reimplemented from NLAIAGENT::CActorScript. +

+Definition at line 101 of file operator_script.cpp.

+

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

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

+ +

+Reimplemented from NLAIAGENT::CActorScript. +

+Definition at line 45 of file operator_script.cpp.

+

+ + + + +
+ + + + + + +
+float NLAIAGENT::COperatorScript::priority ( + +) const [virtual] +
+
+ + + + + +
+   + + +

+Priority of the operator. +

+ +

+Reimplemented from NLAIAGENT::CActorScript. +

+Definition at line 319 of file operator_script.cpp.

+

+ + + + +
+ + + + + + +
+const IObjectIA::CProcessResult & NLAIAGENT::COperatorScript::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 223 of file operator_script.cpp.

+

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

+Save the class in a stream. +

+ +

+Reimplemented from NLAIAGENT::CActorScript. +

+Definition at line 95 of file operator_script.cpp.

+

Member Data Documentation

+

+ + + + +
+ + + + + +
+const NLAIC::CIdentType NLAIAGENT::COperatorScript::IdOperatorScript [static] +
+
+ + + + + +
+   + + +

+ +

+Definition at line 71 of file operator_script.h.

+

+ + + + +
+ + + + + +
+NLAILOGIC::CGoal * NLAIAGENT::COperatorScript::_CurrentGoal [private] +
+
+ + + + + +
+   + + +

+ +

+Definition at line 45 of file operator_script.h.

+

+ + + + +
+ + + + + +
+NLAILOGIC::CFactBase * NLAIAGENT::COperatorScript::_FactBase [private] +
+
+ + + + + +
+   + + +

+ +

+Definition at line 44 of file operator_script.h.

+

+ + + + +
+ + + + + +
+std::vector< NLAIAGENT::IObjectIA *> NLAIAGENT::COperatorScript::_VarValues [private] +
+
+ + + + + +
+   + + +

+ +

+Definition at line 43 of file operator_script.h.

+

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