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

#include <agent.h> +

+Inheritance diagram for NLAIAGENT::IAgent

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

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

Public Methods

 IAgent (IBasicAgent *parent)
 Contruct agent with an parent. More...

 IAgent (IBasicAgent *parent,IMailBox *m)
 Contruct agent with an parent and an mail box. More...

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

virtual void Kill ()
 Call this function to destroy an agent including its referneces in other agents and its childs. More...

virtual void onKill (IConnectIA *A)
 Called by an agent who's destroyed te remove its references. More...

virtual bool haveActivity () const
 allow to know if the agent have an activity process to run. More...

virtual IObjectIA::CProcessResult runActivity ()
 Mailer do'nt have own activity. More...

Some IBasicAgent method.
virtual const NLAIC::IBasicTypeclone () const
 This function allow a pointer copy, that mean that the new class have the sam attributs caracteristics as the owne. More...

virtual const NLAIC::IBasicTypenewInstance () 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 const NLAIC::CIdentTypegetType () 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...

Some IBasicAgent method.
virtual void processMessages ()
 The processMessages method, process the loop/Run message. More...

virtual const CProcessResult& run ()
 The work of an agent. More...


Static Public Attributes

const NLAIC::CIdentTypeIdAgent = NULL

Protected Methods

 IAgent (const IAgent &a)
Some IBasicAgent method.
virtual void runChildren ()
 Run all child. More...

+

Constructor & Destructor Documentation

+

+ + + + +
+ + + + + + +
+NLAIAGENT::IAgent::IAgent ( + +const IAgent & a ) [protected] +
+
+ + + + + +
+   + + +

+ +

+Definition at line 38 of file agents.cpp.

+

+ + + + +
+ + + + + + +
+NLAIAGENT::IAgent::IAgent ( + +IBasicAgent * parent ) +
+
+ + + + + +
+   + + +

+Contruct agent with an parent. +

+ +

+Definition at line 42 of file agents.cpp.

+

+ + + + +
+ + + + + + + + + + +
+NLAIAGENT::IAgent::IAgent ( + +IBasicAgent * parent, +
+IMailBox * m ) +
+
+ + + + + +
+   + + +

+Contruct agent with an parent and an mail box. +

+ +

+Definition at line 46 of file agents.cpp.

+

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

+ +

+Definition at line 100 of file agents.cpp.

+


Member Function Documentation

+

+ + + + +
+ + + + + + +
+void NLAIAGENT::IAgent::Kill ( + +) [virtual] +
+
+ + + + + +
+   + + +

+Call this function to destroy an agent including its referneces in other agents and its childs. +

+ +

+Reimplemented from NLAIAGENT::IConnectIA. +

+Definition at line 54 of file agents.cpp.

+

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

+This function allow a pointer copy, that mean that the new class have the sam attributs caracteristics as the owne. +

+ +

+Reimplemented from NLAIC::IBasicType. +

+Reimplemented in NLAIAGENT::CActor, NLAIAGENT::CActorScript, NLAIAGENT::CLocalAgentMail, NLAIAGENT::CAgentScript, NLAIAGENT::CAgentManagerTimer, NLAIAGENT::CAgentWatchTimer, NLAIAGENT::CAgentClockTimer, NLAIAGENT::CGDAgentScript, NLAIAGENT::CMainAgentScript, NLAIAGENT::CFsmScript, NLAIAGENT::CSeqFsmScript, and NLAIAGENT::COperatorScript. +

+Definition at line 72 of file agents.cpp.

+

+ + + + +
+ + + + + + +
+void NLAIAGENT::IAgent::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 NLAIC::IBasicType. +

+Reimplemented in NLAIAGENT::CActor, NLAIAGENT::CActorScript, NLAIAGENT::CLocalAgentMail, NLAIAGENT::CAgentScript, NLAIAGENT::CAgentManagerTimer, NLAIAGENT::CAgentWatchTimer, NLAIAGENT::CGDAgentScript, NLAIAGENT::CFsmScript, NLAIAGENT::CSeqFsmScript, and NLAIAGENT::COperatorScript. +

+Definition at line 86 of file agents.cpp.

+

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

+Reimplemented in NLAIAGENT::CActor, NLAIAGENT::CActorScript, NLAIAGENT::CLocalAgentMail, NLAIAGENT::CAgentScript, NLAIAGENT::CAgentManagerTimer, NLAIAGENT::CAgentWatchTimer, NLAIAGENT::CAgentClockTimer, NLAIAGENT::CGDAgentScript, NLAIAGENT::CMainAgentScript, NLAIAGENT::CFsmScript, NLAIAGENT::CSeqFsmScript, and NLAIAGENT::COperatorScript. +

+Definition at line 191 of file agents.cpp.

+

+ + + + +
+ + + + + + +
+bool NLAIAGENT::IAgent::haveActivity ( + +) const [inline, virtual] +
+
+ + + + + +
+   + + +

+allow to know if the agent have an activity process to run. +

+ +

+Reimplemented from NLAIAGENT::IBasicAgent. +

+Reimplemented in NLAIAGENT::CLocalAgentMail, NLAIAGENT::CAgentScript, NLAIAGENT::CAgentManagerTimer, and NLAIAGENT::CAgentWatchTimer. +

+Definition at line 347 of file agent.h.

+

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

+Implementation of the isEqual of the IBasicObjectIA. +

+ +

+Reimplemented from NLAIAGENT::IBasicObjectIA. +

+Reimplemented in NLAIAGENT::CActor, NLAIAGENT::CActorScript, NLAIAGENT::CLocalAgentMail, NLAIAGENT::CAgentScript, NLAIAGENT::CGDAgentScript, NLAIAGENT::CFsmScript, NLAIAGENT::CSeqFsmScript, and NLAIAGENT::COperatorScript. +

+Definition at line 91 of file agents.cpp.

+

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

+Load the class from a stream. +

+ +

+Reimplemented from NLAIAGENT::IAgentComposite. +

+Reimplemented in NLAIAGENT::CActor, NLAIAGENT::CActorScript, NLAIAGENT::CLocalAgentMail, NLAIAGENT::CAgentScript, NLAIAGENT::CAgentManagerTimer, NLAIAGENT::CGDAgentScript, NLAIAGENT::CFsmScript, NLAIAGENT::CSeqFsmScript, and NLAIAGENT::COperatorScript. +

+Definition at line 111 of file agents.cpp.

+

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

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

+ +

+Reimplemented from NLAIC::IBasicType. +

+Reimplemented in NLAIAGENT::CActor, NLAIAGENT::CActorScript, NLAIAGENT::CLocalAgentMail, NLAIAGENT::CAgentScript, NLAIAGENT::CAgentManagerTimer, NLAIAGENT::CAgentWatchTimer, NLAIAGENT::CAgentClockTimer, NLAIAGENT::CGDAgentScript, NLAIAGENT::CMainAgentScript, NLAIAGENT::CFsmScript, NLAIAGENT::CSeqFsmScript, and NLAIAGENT::COperatorScript. +

+Definition at line 78 of file agents.cpp.

+

+ + + + +
+ + + + + + +
+void NLAIAGENT::IAgent::onKill ( + +IConnectIA * a ) [virtual] +
+
+ + + + + +
+   + + +

+Called by an agent who's destroyed te remove its references. +

+ +

+Reimplemented from NLAIAGENT::IConnectIA. +

+Reimplemented in NLAIAGENT::CLocalAgentMail, NLAIAGENT::CAgentScript, and NLAIAGENT::CAgentWatchTimer. +

+Definition at line 66 of file agents.cpp.

+

+ + + + +
+ + + + + + +
+void NLAIAGENT::IAgent::processMessages ( + +) [virtual] +
+
+ + + + + +
+   + + +

+The processMessages method, process the loop/Run message. +

+ +

+Reimplemented from NLAIAGENT::IBasicAgent. +

+Reimplemented in NLAIAGENT::CActor, NLAIAGENT::CActorScript, NLAIAGENT::CLocalAgentMail, NLAIAGENT::CAgentScript, and NLAIAGENT::CMainAgentScript. +

+Definition at line 134 of file agents.cpp.

+

+ + + + +
+ + + + + + +
+const IObjectIA::CProcessResult & NLAIAGENT::IAgent::run ( + +void ) [virtual] +
+
+ + + + + +
+   + + +

+The work of an agent. +

+Typically agent process child message, process its message and run its activity. +

+Reimplemented from NLAIAGENT::IBasicAgent. +

+Reimplemented in NLAIAGENT::CActor, NLAIAGENT::CActorScript, NLAIAGENT::CLocalAgentMail, NLAIAGENT::CAgentScript, NLAIAGENT::CGDAgentScript, NLAIAGENT::CMainAgentScript, NLAIAGENT::CFsmScript, and NLAIAGENT::COperatorScript. +

+Definition at line 163 of file agents.cpp.

+

+ + + + +
+ + + + + + +
+IObjectIA::CProcessResult NLAIAGENT::IAgent::runActivity ( + +) [inline, virtual] +
+
+ + + + + +
+   + + +

+Mailer do'nt have own activity. +

+ +

+Reimplemented from NLAIAGENT::IBasicAgent. +

+Reimplemented in NLAIAGENT::CLocalAgentMail, NLAIAGENT::CAgentScript, NLAIAGENT::CAgentManagerTimer, NLAIAGENT::CAgentWatchTimer, and NLAIAGENT::CAgentClockTimer. +

+Definition at line 353 of file agent.h.

+

+ + + + +
+ + + + + + +
+void NLAIAGENT::IAgent::runChildren ( + +) [protected, virtual] +
+
+ + + + + +
+   + + +

+Run all child. +

+ +

+Reimplemented from NLAIAGENT::IBasicAgent. +

+Reimplemented in NLAIAGENT::CLocalAgentMail, NLAIAGENT::CAgentScript, NLAIAGENT::CFsmScript, and NLAIAGENT::CSeqFsmScript. +

+Definition at line 117 of file agents.cpp.

+

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

+Save the class in a stream. +

+ +

+Reimplemented from NLAIAGENT::IAgentComposite. +

+Reimplemented in NLAIAGENT::CActor, NLAIAGENT::CActorScript, NLAIAGENT::CLocalAgentMail, NLAIAGENT::CAgentScript, NLAIAGENT::CAgentManagerTimer, NLAIAGENT::CGDAgentScript, NLAIAGENT::CFsmScript, NLAIAGENT::CSeqFsmScript, and NLAIAGENT::COperatorScript. +

+Definition at line 105 of file agents.cpp.

+


Member Data Documentation

+

+ + + + +
+ + + + + +
+const NLAIC::CIdentType * IAgent::IdAgent = NULL [static] +
+
+ + + + + +
+   + + +

+ +

+Definition at line 64 of file static_def_init.cpp.

+


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