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

#include <agent_timer.h> +

Inheritance diagram for NLAIAGENT::CAgentTimerHandle: +

+ + + + + + + + + +List of all members. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Methods
	CAgentTimerHandle ()
	CAgentTimerHandle (CAgentWatchTimer *)
	CAgentTimerHandle (const CAgentTimerHandle &)
virtual	~CAgentTimerHandle ()
virtual const NLAIC::IBasicType *	clone () 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::IBasicType *	newInstance () const
	This function allow a new instance, that mean that the class is a class factory. 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	getDebugString (std::string &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 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 const NLAIAGENT::IObjectIA::CProcessResult &	run ()
	Some where Run method define the process of the agen. More...
virtual bool	isEqual (const NLAIAGENT::IBasicObjectIA &a) const
virtual IObjectIA::CProcessResult	sendMessage (IObjectIA *m)
	The method sendMessage(const IObjectIA &msg) allow us to achive a message defined in msg. More...
virtual sint32	getMethodIndexSize () const
	getMethodIndexSize define the nomber of method define in the class. More...
virtual tQueue	isMember (const IVarName h, const IVarName m, const IObjectIA &p) const
	The method isMember(nameSubClass,methodName,param) return the best method correspondent to the search. More...
virtual CProcessResult	runMethodeMember (sint32 h, sint32 m, IObjectIA *p)
	The methode runMethodeMember(sint32 heritance, sint32 index, IObjectIA param) allow us to run a member method.* More...
virtual CProcessResult	runMethodeMember (sint32 m, IObjectIA *p)
	The methode runMethodeMember(sint32 index,IObjectIA param) allow us to run a own member method.* More...
Static Public Methods
void	initClass ()
void	releaseClass ()
Static Public Attributes
const NLAIC::CIdentType *	IdAgentTimerHandle = NULL
Private Attributes
CAgentWatchTimer *	_Timer

Constructor & Destructor Documentation

+ + + + +
+ + + + + + + + + +
NLAIAGENT::CAgentTimerHandle::CAgentTimerHandle ( )
+
+ + + + + +
+ + + +
+ +
+Definition at line 672 of file agent_timer.cpp. +
+Referenced by clone, initClass, isEqual, and newInstance.
+

+ + + + +
+ + + + + + + + + + +
NLAIAGENT::CAgentTimerHandle::CAgentTimerHandle ( CAgentWatchTimer * )
+
+ + + + + +
+ + + +
+ +
+Definition at line 676 of file agent_timer.cpp. +
+References _Timer, and t.
+

+ + + + +
+ + + + + + + + + + +
NLAIAGENT::CAgentTimerHandle::CAgentTimerHandle ( const CAgentTimerHandle & )
+
+ + + + + +
+ + + +
+ +
+Definition at line 682 of file agent_timer.cpp. +
+References _Timer, and t.
+

+ + + + +
+ + + + + + + + + +
NLAIAGENT::CAgentTimerHandle::~CAgentTimerHandle ( ) [virtual]
+
+ + + + + +
+ + + +
+ +
+Definition at line 688 of file agent_timer.cpp. +
+References _Timer, r, and t.
+

Member Function Documentation

+ + + + +
+ + + + + + + + + +
const NLAIC::IBasicType * NLAIAGENT::CAgentTimerHandle::clone ( ) const [virtual]
+
+ + + + + +
+ + + +
+This function allow a pointer copy, that mean that the new class have the sam attributs caracteristics as the owne. +
+ +
+Implements NLAIC::IBasicType. +
+Definition at line 720 of file agent_timer.cpp. +
+References CAgentTimerHandle.
+

+ + + + +
+ + + + + + + + + + +
void NLAIAGENT::CAgentTimerHandle::getDebugString ( std::string & 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. +
+ +
+Implements NLAIC::IBasicType. +
+Definition at line 715 of file agent_timer.cpp. +
+References _Timer, and t.
+

+ + + + +
+ + + + + + + + + +
sint32 NLAIAGENT::CAgentTimerHandle::getMethodIndexSize ( ) const [virtual]
+
+ + + + + +
+ + + +
+getMethodIndexSize define the nomber of method define in the class. +
+ +
+Reimplemented from NLAIAGENT::IObjectIA. +
+Definition at line 754 of file agent_timer.cpp. +
+References _Timer.
+

+ + + + +
+ + + + + + + + + +
const NLAIC::CIdentType & NLAIAGENT::CAgentTimerHandle::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). +
+Implements NLAIC::IBasicType. +
+Definition at line 736 of file agent_timer.cpp. +
+References IdAgentTimerHandle.
+

+ + + + +
+ + + + + + + + + +
void NLAIAGENT::CAgentTimerHandle::initClass ( ) [static]
+
+ + + + + +
+ + + +
+ +
+Definition at line 792 of file agent_timer.cpp. +
+References CAgentTimerHandle, NLAIC::CTypeOfOperator::opNone, NLAIC::CTypeOfObject::tObject, and w.
+

+ + + + +
+ + + + + + + + + + +
bool NLAIAGENT::CAgentTimerHandle::isEqual ( const NLAIAGENT::IBasicObjectIA & a ) const [virtual]
+
+ + + + + +
+ + + +
+ +
+Definition at line 730 of file agent_timer.cpp. +
+References _Timer, and CAgentTimerHandle.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
tQueue NLAIAGENT::CAgentTimerHandle::isMember ( const IVarName * h,
const IVarName * m,
const IObjectIA & p
) 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::IObjectIA. +
+Definition at line 767 of file agent_timer.cpp. +
+References _Timer, and NLAIAGENT::tQueue.
+

+ + + + +
+ + + + + + + + + + +
void NLAIAGENT::CAgentTimerHandle::load ( NLMISC::IStream & is ) [virtual]
+
+ + + + + +
+ + + +
+Load the class from a stream. +
+ +
+Implements NLAIC::IBasicInterface. +
+Definition at line 790 of file agent_timer.cpp.
+

+ + + + +
+ + + + + + + + + +
const NLAIC::IBasicType * NLAIAGENT::CAgentTimerHandle::newInstance ( ) const [virtual]
+
+ + + + + +
+ + + +
+This function allow a new instance, that mean that the class is a class factory. +
+ +
+Implements NLAIC::IBasicType. +
+Definition at line 725 of file agent_timer.cpp. +
+References CAgentTimerHandle.
+

+ + + + +
+ + + + + + + + + +
void NLAIAGENT::CAgentTimerHandle::releaseClass ( ) [static]
+
+ + + + + +
+ + + +
+ +
+Definition at line 803 of file agent_timer.cpp.
+

+ + + + +
+ + + + + + + + + +
virtual const NLAIAGENT::IObjectIA::CProcessResult& NLAIAGENT::CAgentTimerHandle::run ( ) [inline, virtual]
+
+ + + + + +
+ + + +
+Some where Run method define the process of the agen. +
+ +
+Implements NLAIAGENT::IObjectIA. +
+Definition at line 292 of file agent_timer.h. +
+References NLAIAGENT::IObjectIA::ProcessRun.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
IObjectIA::CProcessResult NLAIAGENT::CAgentTimerHandle::runMethodeMember ( sint32 m,
IObjectIA * p
) [virtual]
+
+ + + + + +
+ + + +
+The methode runMethodeMember(sint32 index,IObjectIA *param) allow us to run a own member method. +
+index: is the method id return by the isMember(const IVarName *,const IVarName *,const IObjectIA &) const method. param: is the parametre for the method. +
+Reimplemented from NLAIAGENT::IObjectIA. +
+Definition at line 784 of file agent_timer.cpp. +
+References _Timer.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
IObjectIA::CProcessResult NLAIAGENT::CAgentTimerHandle::runMethodeMember ( sint32 h,
sint32 m,
IObjectIA * p
) [virtual]
+
+ + + + + +
+ + + +
+The methode runMethodeMember(sint32 heritance, sint32 index, IObjectIA *param) allow us to run a member method. +
+heritance: is the id returned by the methodisClassInheritedFrom(const IVarName &). index: is the method id return by the isMember(const IVarName *,const IVarName *,const IObjectIA &) const method. param: is the parametre for the method. +
+Reimplemented from NLAIAGENT::IObjectIA. +
+Definition at line 780 of file agent_timer.cpp.
+

+ + + + +
+ + + + + + + + + + +
void NLAIAGENT::CAgentTimerHandle::save ( NLMISC::IStream & os ) [virtual]
+
+ + + + + +
+ + + +
+Save the class in a stream. +
+ +
+Implements NLAIC::IBasicInterface. +
+Definition at line 789 of file agent_timer.cpp.
+

+ + + + +
+ + + + + + + + + + +
IObjectIA::CProcessResult NLAIAGENT::CAgentTimerHandle::sendMessage ( IObjectIA * m ) [virtual]
+
+ + + + + +
+ + + +
+The method sendMessage(const IObjectIA &msg) allow us to achive a message defined in msg. +
+ +
+Reimplemented from NLAIAGENT::IObjectIA. +
+Definition at line 741 of file agent_timer.cpp. +
+References _Timer.
+

Member Data Documentation

+ + + + +
+ + +
CAgentWatchTimer* NLAIAGENT::CAgentTimerHandle::_Timer [private] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 277 of file agent_timer.h. +
+Referenced by CAgentTimerHandle, getDebugString, getMethodIndexSize, isEqual, isMember, runMethodeMember, sendMessage, and ~CAgentTimerHandle.
+

+ + + + +
+ + +
const NLAIC::CIdentType * NLAIAGENT::CAgentTimerHandle::IdAgentTimerHandle = NULL [static] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 670 of file agent_timer.cpp. +
+Referenced by getType.
+

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

+ + + +
+

+ + -- cgit v1.2.1

NLAIAGENT::CAgentTimerHandle Class Reference

Public Methods

Static Public Methods

Static Public Attributes

Private Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation