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

#include <agent_proxy_mailer.h> +

+Inheritance diagram for NLAIAGENT::CProxyAgentMail

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

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

Public Types
enum	TMethodNumDef { + TConstructor, + + TLastM + + }
Public Methods
	CProxyAgentMail ()
	CProxyAgentMail (const CAgentNumber &agentRef)
	CProxyAgentMail (const CProxyAgentMail &mailer)
virtual	~CProxyAgentMail ()
IBasicInterface method.
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 NLAIC::CIdentType&	getType () const
	getType return a unique string how represente the class, it can be the name of the class. 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::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 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...
IObjectIA method.
virtual const CProcessResult&	run ()
	The work of an agent. More...
virtual bool	isEqual (const IBasicObjectIA &a) const
	The bool operator==(const IBasicObjectIA &a) const member method call this function when class 'classType' have the same type of this class, programme have to assume the equality between the memebers of this class and the memeber of the class 'classType'. 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...
virtual sint32	getMethodIndexSize () const
	getMethodIndexSize define the nomber of external method. More...
IBasicAgent method.
virtual void	onKill (IConnectIA *a)
	When agent die and when he is in the Connectioned lis, he call this method to inform this state to the objects. More...
virtual std::list<IBasicAgent +*>::iterator	addChild (IBasicAgent *p)
	Add a child to the agent. More...
virtual void	removeChild (const IBasicAgent *p)
	Remove a child from the std::list<IBasicAgent > child list.* More...
virtual void	removeChild (std::list<IBasicAgent *>::iterator &iter)
	Remove a child from the std::list<IBasicAgent > child list.* More...
virtual void	runChildren ()
	Run all child. More...
virtual void	processMessages ()
	The processMessages method, process the loop/Run message. More...
virtual IObjectIA::CProcessResult	sendMessage (IObjectIA *msg)
	sendMessage allow agent to send a message to an ather agent.The message is a IMessageBase. More...
virtual IObjectIA::CProcessResult	runActivity ()
	Run the activity process an agent. More...
virtual bool	haveActivity () const
	allow to know if the agent have an activity process to run. More...
Static Public Methods
void	initClass ()
void	releaseClass ()
Static Public Attributes
const NLAIC::CIdentType	IdProxyAgentMail
IMainAgent*	MainAgent = NULL
CAgentScript::CMethodCall**	StaticMethod = NULL
Private Attributes
CAgentNumber*	_AgentRef

Member Enumeration Documentation

+ + + + +
+ + + + + +
+enum NLAIAGENT::CProxyAgentMail::TMethodNumDef +
+
+ + + + + +
+ + + +
+
+Enumeration values:
+ + + +
TConstructor + +
TLastM + +
+
+ +
+Definition at line 41 of file agent_proxy_mailer.h.
+

Constructor & Destructor Documentation

+ + + + +
+ + + + + + +
+NLAIAGENT::CProxyAgentMail::CProxyAgentMail ( + +) +
+
+ + + + + +
+ + + +
+ +
+Definition at line 68 of file agent_proxy_mailer.cpp.
+

+ + + + +
+ + + + + + +
+NLAIAGENT::CProxyAgentMail::CProxyAgentMail ( + +const CAgentNumber & agentRef ) +
+
+ + + + + +
+ + + +
+ +
+Definition at line 71 of file agent_proxy_mailer.cpp.
+

+ + + + +
+ + + + + + +
+NLAIAGENT::CProxyAgentMail::CProxyAgentMail ( + +const CProxyAgentMail & mailer ) +
+
+ + + + + +
+ + + +
+
+

+ + + + +
+ + + + + + +
+NLAIAGENT::CProxyAgentMail::~CProxyAgentMail ( + +) [virtual] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 74 of file agent_proxy_mailer.cpp.
+

Member Function Documentation

+ + + + +
+ + + + + + +
+std::list< IBasicAgent *>::iterator NLAIAGENT::CProxyAgentMail::addChild ( + +IBasicAgent * p ) [virtual] +
+
+ + + + + +
+ + + +
+Add a child to the agent. +
+Child is added in a std::list<IBasicAgent *>. The method return the range of the child in the list. +
+Reimplemented from NLAIAGENT::IBasicAgent. +
+Definition at line 84 of file agent_proxy_mailer.cpp.
+

+ + + + +
+ + + + + + +
+const NLAIC::IBasicType * NLAIAGENT::CProxyAgentMail::clone ( + +void ) const [inline, 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. +
+Definition at line 84 of file agent_proxy_mailer.h.
+

+ + + + +
+ + + + + + +
+void NLAIAGENT::CProxyAgentMail::getDebugString ( + +char * t ) const [inline, 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. +
+Definition at line 91 of file agent_proxy_mailer.h.
+

+ + + + +
+ + + + + + +
+sint32 NLAIAGENT::CProxyAgentMail::getMethodIndexSize ( + +) const [virtual] +
+
+ + + + + +
+ + + +
+getMethodIndexSize define the nomber of external method. +
+ +
+Reimplemented from NLAIAGENT::IBasicAgent. +
+Definition at line 211 of file agent_proxy_mailer.cpp.
+

+ + + + +
+ + + + + + +
+const NLAIC::CIdentType & NLAIAGENT::CProxyAgentMail::getType ( + +void ) const [inline, 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. +
+Definition at line 72 of file agent_proxy_mailer.h.
+

+ + + + +
+ + + + + + +
+bool NLAIAGENT::CProxyAgentMail::haveActivity ( + +) const [inline, virtual] +
+
+ + + + + +
+ + + +
+allow to know if the agent have an activity process to run. +
+ +
+Reimplemented from NLAIAGENT::IBasicAgent. +
+Definition at line 142 of file agent_proxy_mailer.h.
+

+ + + + +
+ + + + + + +
+void NLAIAGENT::CProxyAgentMail::initClass ( + +) [static] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 45 of file agent_proxy_mailer.cpp. +
+Referenced by NLAILINK::initIALib().
+

+ + + + +
+ + + + + + +
+bool NLAIAGENT::CProxyAgentMail::isEqual ( + +const IBasicObjectIA & a ) const [inline, virtual] +
+
+ + + + + +
+ + + +
+The bool operator==(const IBasicObjectIA &a) const member method call this function when class 'classType' have the same type of this class, programme have to assume the equality between the memebers of this class and the memeber of the class 'classType'. +
+ +
+Reimplemented from NLAIAGENT::IBasicObjectIA. +
+Definition at line 110 of file agent_proxy_mailer.h.
+

+ + + + +
+ + + + + + + + + + + + + + +
+tQueue NLAIAGENT::CProxyAgentMail::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::IBasicAgent. +
+Definition at line 124 of file agent_proxy_mailer.cpp.
+

+ + + + +
+ + + + + + +
+void NLAIAGENT::CProxyAgentMail::load ( + +NLMISC::IStream & is ) [inline, virtual] +
+
+ + + + + +
+ + + +
+Load the class from a stream. +
+ +
+Reimplemented from NLAIAGENT::IBasicAgent. +
+Definition at line 66 of file agent_proxy_mailer.h.
+

+ + + + +
+ + + + + + +
+const NLAIC::IBasicType * NLAIAGENT::CProxyAgentMail::newInstance ( + +void ) const [inline, virtual] +
+
+ + + + + +
+ + + +
+This function allow a new instance, that mean that the class is a class factory. +
+ +
+Reimplemented from NLAIC::IBasicType. +
+Definition at line 77 of file agent_proxy_mailer.h.
+

+ + + + +
+ + + + + + +
+void NLAIAGENT::CProxyAgentMail::onKill ( + +IConnectIA * a ) [virtual] +
+
+ + + + + +
+ + + +
+When agent die and when he is in the Connectioned lis, he call this method to inform this state to the objects. +
+ +
+Reimplemented from NLAIAGENT::IConnectIA. +
+Definition at line 79 of file agent_proxy_mailer.cpp.
+

+ + + + +
+ + + + + + +
+void NLAIAGENT::CProxyAgentMail::processMessages ( + +) [virtual] +
+
+ + + + + +
+ + + +
+The processMessages method, process the loop/Run message. +
+ +
+Reimplemented from NLAIAGENT::IBasicAgent. +
+Definition at line 100 of file agent_proxy_mailer.cpp.
+

+ + + + +
+ + + + + + +
+void NLAIAGENT::CProxyAgentMail::releaseClass ( + +) [static] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 58 of file agent_proxy_mailer.cpp. +
+Referenced by NLAILINK::releaseIALib().
+

+ + + + +
+ + + + + + +
+void NLAIAGENT::CProxyAgentMail::removeChild ( + +std::list< IBasicAgent *>::iterator & iter ) [virtual] +
+
+ + + + + +
+ + + +
+Remove a child from the std::list<IBasicAgent *> child list. +
+ +
+Reimplemented from NLAIAGENT::IBasicAgent. +
+Definition at line 93 of file agent_proxy_mailer.cpp.
+

+ + + + +
+ + + + + + +
+void NLAIAGENT::CProxyAgentMail::removeChild ( + +const IBasicAgent * p ) [virtual] +
+
+ + + + + +
+ + + +
+Remove a child from the std::list<IBasicAgent *> child list. +
+ +
+Reimplemented from NLAIAGENT::IBasicAgent. +
+Definition at line 89 of file agent_proxy_mailer.cpp.
+

+ + + + +
+ + + + + + +
+const CProcessResult & NLAIAGENT::CProxyAgentMail::run ( + +void ) [inline, virtual] +
+
+ + + + + +
+ + + +
+The work of an agent. +
+Typically agent process child message, process its message and run its activity. +
+Reimplemented from NLAIAGENT::IBasicAgent. +
+Definition at line 105 of file agent_proxy_mailer.h.
+

+ + + + +
+ + + + + + +
+IObjectIA::CProcessResult NLAIAGENT::CProxyAgentMail::runActivity ( + +) [inline, virtual] +
+
+ + + + + +
+ + + +
+Run the activity process an agent. +
+ +
+Reimplemented from NLAIAGENT::IBasicAgent. +
+Definition at line 138 of file agent_proxy_mailer.h.
+

+ + + + +
+ + + + + + +
+void NLAIAGENT::CProxyAgentMail::runChildren ( + +) [virtual] +
+
+ + + + + +
+ + + +
+Run all child. +
+ +
+Reimplemented from NLAIAGENT::IBasicAgent. +
+Definition at line 97 of file agent_proxy_mailer.cpp.
+

+ + + + +
+ + + + + + + + + + +
+IObjectIA::CProcessResult NLAIAGENT::CProxyAgentMail::runMethodeMember ( + +sint32 index, +
+IObjectIA * param ) [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::IBasicAgent. +
+Definition at line 197 of file agent_proxy_mailer.cpp.
+

+ + + + +
+ + + + + + + + + + + + + + +
+IObjectIA::CProcessResult NLAIAGENT::CProxyAgentMail::runMethodeMember ( + +sint32 heritance, +
+sint32 index, +
+IObjectIA * param ) [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::IBasicAgent. +
+Definition at line 193 of file agent_proxy_mailer.cpp.
+

+ + + + +
+ + + + + + +
+void NLAIAGENT::CProxyAgentMail::save ( + +NLMISC::IStream & os ) [inline, virtual] +
+
+ + + + + +
+ + + +
+Save the class in a stream. +
+ +
+Reimplemented from NLAIAGENT::IBasicAgent. +
+Definition at line 61 of file agent_proxy_mailer.h.
+

+ + + + +
+ + + + + + +
+IObjectIA::CProcessResult NLAIAGENT::CProxyAgentMail::sendMessage ( + +IObjectIA * m ) [virtual] +
+
+ + + + + +
+ + + +
+sendMessage allow agent to send a message to an ather agent.The message is a IMessageBase. +
+ +
+Reimplemented from NLAIAGENT::IConnectIA. +
+Definition at line 104 of file agent_proxy_mailer.cpp.
+

Member Data Documentation

+ + + + +
+ + + + + +
+const NLAIC::CIdentType CProxyAgentMail::IdProxyAgentMail [static] +
+
+ + + + + +
+ + + +
+Initializer:
NLAIC::CIdentType( "ProxyAgentMail", + NLAIC::CSelfClassFactory((const NLAIC::IBasicInterface &)CProxyAgentMail()), + NLAIC::CTypeOfObject::tAgent, + NLAIC::CTypeOfOperator(NLAIC::CTypeOfOperator::opNone) )
+
+Definition at line 425 of file static_def_init.cpp.
+

+ + + + +
+ + + + + +
+IMainAgent * NLAIAGENT::CProxyAgentMail::MainAgent = NULL [static] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 40 of file agent_proxy_mailer.cpp.
+

+ + + + +
+ + + + + +
+CAgentScript::CMethodCall ** NLAIAGENT::CProxyAgentMail::StaticMethod = NULL [static] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 42 of file agent_proxy_mailer.cpp.
+

+ + + + +
+ + + + + +
+CAgentNumber * NLAIAGENT::CProxyAgentMail::_AgentRef [private] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 52 of file agent_proxy_mailer.h.
+

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

+ + + +
+

+ + -- cgit v1.2.1

NLAIAGENT::CProxyAgentMail Class Reference

Public Types

Public Methods

Static Public Methods

Static Public Attributes

Private Attributes

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation