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__CSimpleLocalMailBox.html | 1105 ++++++++++++++++++++ 1 file changed, 1105 insertions(+) create mode 100644 docs/doxygen/nel/class_NLAIAGENT__CSimpleLocalMailBox.html (limited to 'docs/doxygen/nel/class_NLAIAGENT__CSimpleLocalMailBox.html') diff --git a/docs/doxygen/nel/class_NLAIAGENT__CSimpleLocalMailBox.html b/docs/doxygen/nel/class_NLAIAGENT__CSimpleLocalMailBox.html new file mode 100644 index 00000000..0104c699 --- /dev/null +++ b/docs/doxygen/nel/class_NLAIAGENT__CSimpleLocalMailBox.html @@ -0,0 +1,1105 @@ + + + + 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::CSimpleLocalMailBox Class Reference

#include <mailbox.h> +

+Inheritance diagram for NLAIAGENT::CSimpleLocalMailBox

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

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

Public Methods
	CSimpleLocalMailBox (const IWordNumRef *parent)
	CSimpleLocalMailBox (NLMISC::IStream &is)
	CSimpleLocalMailBox (const CSimpleLocalMailBox &a)
virtual	~CSimpleLocalMailBox ()
virtual void	addMessage (IMessageBase *msg)
virtual void	addMailBox (IMailBox *)
virtual void	removeMailBox (IMailBox *)
virtual void	shareMessage ()
virtual const IMessageBase&	getMessage ()
virtual void	popMessage ()
virtual sint32	getMessageCount () const
virtual std::list<const IMessageBase >	pumpMessages () const
virtual const CProcessResult&	getState () const
virtual void	setState (TProcessStatement state, IObjectIA *result)
virtual const IObjectIA::CProcessResult&	run ()
	Some where Run method define the process of the agen. 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 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 (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 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 void	onKill (IConnectIA *)
	When agent die and when he is in the Connectioned lis, he call this method to inform this state to the objects. More...
virtual IObjectIA::CProcessResult	sendMessage (IMessageBase *)
Static Public Attributes
const NLAIC::CIdentType	IdSimpleLocalMailBox
Protected Attributes
IMailBox::tListMessage	_ListMessage
IObjectIA::CProcessResult	_RunState
std::list<IBasicMessageGroup *>	_Msg_grps
Private Methods
virtual IConnectIA&	getConnection (IConnectIA &r)

Constructor & Destructor Documentation

+ + + + +
+ + + + + + +
+NLAIAGENT::CSimpleLocalMailBox::CSimpleLocalMailBox ( + +const IWordNumRef * parent ) +
+
+ + + + + +
+ + + +
+ +
+Definition at line 46 of file mailbox.cpp.
+

+ + + + +
+ + + + + + +
+NLAIAGENT::CSimpleLocalMailBox::CSimpleLocalMailBox ( + +NLMISC::IStream & is ) +
+
+ + + + + +
+ + + +
+ +
+Definition at line 50 of file mailbox.cpp.
+

+ + + + +
+ + + + + + +
+NLAIAGENT::CSimpleLocalMailBox::CSimpleLocalMailBox ( + +const CSimpleLocalMailBox & a ) +
+
+ + + + + +
+ + + +
+ +
+Definition at line 56 of file mailbox.cpp.
+

+ + + + +
+ + + + + + +
+NLAIAGENT::CSimpleLocalMailBox::~CSimpleLocalMailBox ( + +) [virtual] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 67 of file mailbox.cpp.
+

Member Function Documentation

+ + + + +
+ + + + + + +
+void NLAIAGENT::CSimpleLocalMailBox::addMailBox ( + +IMailBox * mail ) [virtual] +
+
+ + + + + +
+ + + +
+ +
+Reimplemented from NLAIAGENT::IMailBox. +
+Definition at line 82 of file mailbox.cpp.
+

+ + + + +
+ + + + + + +
+void NLAIAGENT::CSimpleLocalMailBox::addMessage ( + +IMessageBase * msg ) [virtual] +
+
+ + + + + +
+ + + +
+ +
+Reimplemented from NLAIAGENT::IMailBox. +
+Definition at line 77 of file mailbox.cpp.
+

+ + + + +
+ + + + + + +
+const NLAIC::IBasicType * NLAIAGENT::CSimpleLocalMailBox::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::CScriptMailBox. +
+Definition at line 156 of file mailbox.cpp.
+

+ + + + +
+ + + + + + +
+IConnectIA & NLAIAGENT::CSimpleLocalMailBox::getConnection ( + +IConnectIA & r ) [private, virtual] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 232 of file mailbox.cpp.
+

+ + + + +
+ + + + + + +
+void NLAIAGENT::CSimpleLocalMailBox::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. +
+Definition at line 177 of file mailbox.cpp.
+

+ + + + +
+ + + + + + +
+const IMessageBase & NLAIAGENT::CSimpleLocalMailBox::getMessage ( + +) [virtual] +
+
+ + + + + +
+ + + +
+ +
+Reimplemented from NLAIAGENT::IMailBox. +
+Definition at line 90 of file mailbox.cpp.
+

+ + + + +
+ + + + + + +
+sint32 NLAIAGENT::CSimpleLocalMailBox::getMessageCount ( + +) const [virtual] +
+
+ + + + + +
+ + + +
+ +
+Reimplemented from NLAIAGENT::IMailBox. +
+Definition at line 102 of file mailbox.cpp.
+

+ + + + +
+ + + + + + +
+const IObjectIA::CProcessResult & NLAIAGENT::CSimpleLocalMailBox::getState ( + +) const [virtual] +
+
+ + + + + +
+ + + +
+ +
+Reimplemented from NLAIAGENT::IConnectIA. +
+Definition at line 134 of file mailbox.cpp.
+

+ + + + +
+ + + + + + +
+const NLAIC::CIdentType & NLAIAGENT::CSimpleLocalMailBox::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::CScriptMailBox. +
+Definition at line 172 of file mailbox.cpp.
+

+ + + + +
+ + + + + + +
+bool NLAIAGENT::CSimpleLocalMailBox::isEqual ( + +const IBasicObjectIA & a ) const [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 150 of file mailbox.cpp.
+

+ + + + +
+ + + + + + +
+void NLAIAGENT::CSimpleLocalMailBox::load ( + +NLMISC::IStream & is ) [virtual] +
+
+ + + + + +
+ + + +
+Load the class from a stream. +
+ +
+Reimplemented from NLAIAGENT::IMailBox. +
+Definition at line 199 of file mailbox.cpp.
+

+ + + + +
+ + + + + + +
+const NLAIC::IBasicType * NLAIAGENT::CSimpleLocalMailBox::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::CScriptMailBox. +
+Definition at line 162 of file mailbox.cpp.
+

+ + + + +
+ + + + + + +
+void NLAIAGENT::CSimpleLocalMailBox::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 223 of file mailbox.cpp.
+

+ + + + +
+ + + + + + +
+void NLAIAGENT::CSimpleLocalMailBox::popMessage ( + +) [virtual] +
+
+ + + + + +
+ + + +
+ +
+Reimplemented from NLAIAGENT::IMailBox. +
+Definition at line 95 of file mailbox.cpp.
+

+ + + + +
+ + + + + + +
+std::list< const IMessageBase *>* NLAIAGENT::CSimpleLocalMailBox::pumpMessages ( + +) const [virtual] +
+
+ + + + + +
+ + + +
+ +
+Reimplemented from NLAIAGENT::IMailBox. +
+Definition at line 107 of file mailbox.cpp.
+

+ + + + +
+ + + + + + +
+void NLAIAGENT::CSimpleLocalMailBox::removeMailBox ( + +IMailBox * mail ) [virtual] +
+
+ + + + + +
+ + + +
+ +
+Reimplemented from NLAIAGENT::IMailBox. +
+Definition at line 86 of file mailbox.cpp.
+

+ + + + +
+ + + + + + +
+const IObjectIA::CProcessResult & NLAIAGENT::CSimpleLocalMailBox::run ( + +void ) [virtual] +
+
+ + + + + +
+ + + +
+Some where Run method define the process of the agen. +
+ +
+Reimplemented from NLAIAGENT::IObjectIA. +
+Reimplemented in NLAIAGENT::CScriptMailBox. +
+Definition at line 145 of file mailbox.cpp.
+

+ + + + +
+ + + + + + +
+void NLAIAGENT::CSimpleLocalMailBox::save ( + +NLMISC::IStream & os ) [virtual] +
+
+ + + + + +
+ + + +
+Save the class in a stream. +
+ +
+Reimplemented from NLAIAGENT::IMailBox. +
+Definition at line 182 of file mailbox.cpp.
+

+ + + + +
+ + + + + + +
+IObjectIA::CProcessResult NLAIAGENT::CSimpleLocalMailBox::sendMessage ( + +IMessageBase * msg ) [virtual] +
+
+ + + + + +
+ + + +
+ +
+Reimplemented from NLAIAGENT::IConnectIA. +
+Definition at line 227 of file mailbox.cpp.
+

+ + + + +
+ + + + + + + + + + +
+void NLAIAGENT::CSimpleLocalMailBox::setState ( + +TProcessStatement state, +
+IObjectIA * result ) [virtual] +
+
+ + + + + +
+ + + +
+ +
+Reimplemented from NLAIAGENT::IConnectIA. +
+Definition at line 139 of file mailbox.cpp.
+

+ + + + +
+ + + + + + +
+void NLAIAGENT::CSimpleLocalMailBox::shareMessage ( + +) [inline, virtual] +
+
+ + + + + +
+ + + +
+ +
+Reimplemented from NLAIAGENT::IMailBox. +
+Definition at line 95 of file mailbox.h.
+

Member Data Documentation

+ + + + +
+ + + + + +
+const NLAIC::CIdentType NLAIAGENT::CSimpleLocalMailBox::IdSimpleLocalMailBox [static] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 86 of file mailbox.h.
+

+ + + + +
+ + + + + +
+IMailBox::tListMessage NLAIAGENT::CSimpleLocalMailBox::_ListMessage [protected] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 81 of file mailbox.h.
+

+ + + + +
+ + + + + +
+std::list< IBasicMessageGroup *> NLAIAGENT::CSimpleLocalMailBox::_Msg_grps [protected] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 83 of file mailbox.h.
+

+ + + + +
+ + + + + +
+IObjectIA::CProcessResult NLAIAGENT::CSimpleLocalMailBox::_RunState [protected] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 82 of file mailbox.h.
+

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

+ + + +
+

+ + -- cgit v1.2.1

NLAIAGENT::CSimpleLocalMailBox Class Reference

Public Methods

Static Public Attributes

Protected Attributes

Private Methods

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation