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_1CSimpleLocalMailBox.html | 1253 ++++++++++++++++++++ 1 file changed, 1253 insertions(+) create mode 100644 docs/doxygen/nel/classNLAIAGENT_1_1CSimpleLocalMailBox.html (limited to 'docs/doxygen/nel/classNLAIAGENT_1_1CSimpleLocalMailBox.html') diff --git a/docs/doxygen/nel/classNLAIAGENT_1_1CSimpleLocalMailBox.html b/docs/doxygen/nel/classNLAIAGENT_1_1CSimpleLocalMailBox.html new file mode 100644 index 00000000..ff88c6c1 --- /dev/null +++ b/docs/doxygen/nel/classNLAIAGENT_1_1CSimpleLocalMailBox.html @@ -0,0 +1,1253 @@ + + + + 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: +

+ + + + + + + + + + + + + +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 bool	isEmpty () 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 (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 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 *)
virtual const tListMessage &	getMesseageListe () const
virtual sint	size () const
Static Public Attributes
const NLAIC::CIdentType	IdSimpleLocalMailBox
Protected Attributes
IMailBox::tListMessage	_ListMessage
IObjectIA::CProcessResult	_RunState
std::list< IBasicMessageGroup * >	_Msg_grps
sint	_Size
Private Methods
virtual IConnectIA &	getConnection (IConnectIA &r)

Constructor & Destructor Documentation

+ + + + +
+ + + + + + + + + + +
NLAIAGENT::CSimpleLocalMailBox::CSimpleLocalMailBox ( const IWordNumRef * parent )
+
+ + + + + +
+ + + +
+ +
+Definition at line 46 of file mailbox.cpp. +
+Referenced by clone, and newInstance.
+

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

+ + + + +
+ + + + + + + + + + +
NLAIAGENT::CSimpleLocalMailBox::CSimpleLocalMailBox ( const CSimpleLocalMailBox & a )
+
+ + + + + +
+ + + +
+ +
+Definition at line 56 of file mailbox.cpp. +
+References _ListMessage, _RunState, and _Size.
+

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

Member Function Documentation

+ + + + +
+ + + + + + + + + + +
void NLAIAGENT::CSimpleLocalMailBox::addMailBox ( IMailBox * ) [virtual]
+
+ + + + + +
+ + + +
+ +
+Implements NLAIAGENT::IMailBox. +
+Definition at line 84 of file mailbox.cpp.
+

+ + + + +
+ + + + + + + + + + +
void NLAIAGENT::CSimpleLocalMailBox::addMessage ( IMessageBase * msg ) [virtual]
+
+ + + + + +
+ + + +
+ +
+Implements NLAIAGENT::IMailBox. +
+Definition at line 78 of file mailbox.cpp. +
+References _ListMessage, and _Size.
+

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

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

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

+ + + + +
+ + + + + + + + + +
const IMessageBase & NLAIAGENT::CSimpleLocalMailBox::getMessage ( ) [virtual]
+
+ + + + + +
+ + + +
+ +
+Implements NLAIAGENT::IMailBox. +
+Definition at line 92 of file mailbox.cpp. +
+References _ListMessage.
+

+ + + + +
+ + + + + + + + + +
sint32 NLAIAGENT::CSimpleLocalMailBox::getMessageCount ( ) const [virtual]
+
+ + + + + +
+ + + +
+ +
+Implements NLAIAGENT::IMailBox. +
+Definition at line 104 of file mailbox.cpp. +
+References _ListMessage.
+

+ + + + +
+ + + + + + + + + +
virtual const tListMessage& NLAIAGENT::CSimpleLocalMailBox::getMesseageListe ( ) const [inline, virtual]
+
+ + + + + +
+ + + +
+ +
+Implements NLAIAGENT::IMailBox. +
+Definition at line 119 of file mailbox.h. +
+References _ListMessage, and NLAIAGENT::IMailBox::tListMessage.
+

+ + + + +
+ + + + + + + + + +
const IObjectIA::CProcessResult & NLAIAGENT::CSimpleLocalMailBox::getState ( ) const [virtual]
+
+ + + + + +
+ + + +
+ +
+Implements NLAIAGENT::IConnectIA. +
+Definition at line 140 of file mailbox.cpp. +
+References _RunState.
+

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

+ + + + +
+ + + + + + + + + +
bool NLAIAGENT::CSimpleLocalMailBox::isEmpty ( ) const [virtual]
+
+ + + + + +
+ + + +
+ +
+Implements NLAIAGENT::IMailBox. +
+Definition at line 108 of file mailbox.cpp. +
+References _Size.
+

+ + + + +
+ + + + + + + + + + +
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'. +
+ +
+Implements NLAIAGENT::IBasicObjectIA. +
+Definition at line 156 of file mailbox.cpp. +
+References NLAIAGENT::IMailBox::IMailBox.
+

+ + + + +
+ + + + + + + + + + +
void NLAIAGENT::CSimpleLocalMailBox::load ( NLMISC::IStream & is ) [virtual]
+
+ + + + + +
+ + + +
+Load the class from a stream. +
+ +
+Implements NLAIAGENT::IMailBox. +
+Definition at line 205 of file mailbox.cpp. +
+References _ListMessage, _Size, NLAIC::CIdentTypeAlloc::allocClass, id, and NLMISC::IStream::serial. +
+Referenced by NLAIAGENT::CScriptMailBox::CScriptMailBox, and CSimpleLocalMailBox.
+

+ + + + +
+ + + + + + + + + +
const NLAIC::IBasicType * NLAIAGENT::CSimpleLocalMailBox::newInstance ( ) const [virtual]
+
+ + + + + +
+ + + +
+This function allow a new instance, that mean that the class is a class factory. +
+ +
+Implements NLAIC::IBasicType. +
+Reimplemented in NLAIAGENT::CScriptMailBox. +
+Definition at line 168 of file mailbox.cpp. +
+References CSimpleLocalMailBox, and NLAIAGENT::IConnectIA::getParent.
+

+ + + + +
+ + + + + + + + + + +
void NLAIAGENT::CSimpleLocalMailBox::onKill ( IConnectIA * ) [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 231 of file mailbox.cpp.
+

+ + + + +
+ + + + + + + + + +
void NLAIAGENT::CSimpleLocalMailBox::popMessage ( ) [virtual]
+
+ + + + + +
+ + + +
+ +
+Implements NLAIAGENT::IMailBox. +
+Definition at line 97 of file mailbox.cpp. +
+References _ListMessage, and _Size.
+

+ + + + +
+ + + + + + + + + +
std::list< const IMessageBase * > * NLAIAGENT::CSimpleLocalMailBox::pumpMessages ( ) const [virtual]
+
+ + + + + +
+ + + +
+ +
+Implements NLAIAGENT::IMailBox. +
+Definition at line 113 of file mailbox.cpp. +
+References _ListMessage.
+

+ + + + +
+ + + + + + + + + + +
void NLAIAGENT::CSimpleLocalMailBox::removeMailBox ( IMailBox * ) [virtual]
+
+ + + + + +
+ + + +
+ +
+Implements NLAIAGENT::IMailBox. +
+Definition at line 88 of file mailbox.cpp.
+

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

+ + + + +
+ + + + + + + + + + +
void NLAIAGENT::CSimpleLocalMailBox::save ( NLMISC::IStream & os ) [virtual]
+
+ + + + + +
+ + + +
+Save the class in a stream. +
+ +
+Implements NLAIAGENT::IMailBox. +
+Definition at line 188 of file mailbox.cpp. +
+References _ListMessage, NLMISC::IStream::serial, and size.
+

+ + + + +
+ + + + + + + + + + +
IObjectIA::CProcessResult NLAIAGENT::CSimpleLocalMailBox::sendMessage ( IMessageBase * ) [virtual]
+
+ + + + + +
+ + + +
+ +
+Implements NLAIAGENT::IConnectIA. +
+Definition at line 235 of file mailbox.cpp.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
void NLAIAGENT::CSimpleLocalMailBox::setState ( TProcessStatement state,
IObjectIA * result
) [virtual]
+
+ + + + + +
+ + + +
+ +
+Implements NLAIAGENT::IConnectIA. +
+Definition at line 145 of file mailbox.cpp. +
+References _RunState, and NLAIAGENT::TProcessStatement.
+

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

+ + + + +
+ + + + + + + + + +
virtual sint NLAIAGENT::CSimpleLocalMailBox::size ( ) const [inline, virtual]
+
+ + + + + +
+ + + +
+ +
+Implements NLAIAGENT::IMailBox. +
+Definition at line 124 of file mailbox.h. +
+References _Size. +
+Referenced by save.
+

Member Data Documentation

+ + + + +
+ + +
IMailBox::tListMessage NLAIAGENT::CSimpleLocalMailBox::_ListMessage [protected] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 85 of file mailbox.h. +
+Referenced by addMessage, NLAIAGENT::CScriptMailBox::CScriptMailBox, CSimpleLocalMailBox, getMessage, getMessageCount, getMesseageListe, load, popMessage, pumpMessages, save, NLAIAGENT::CScriptMailBox::~CScriptMailBox, and ~CSimpleLocalMailBox.
+

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

+ + + + +
+ + +
IObjectIA::CProcessResult NLAIAGENT::CSimpleLocalMailBox::_RunState [protected] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 86 of file mailbox.h. +
+Referenced by NLAIAGENT::CScriptMailBox::CScriptMailBox, CSimpleLocalMailBox, getState, and setState.
+

+ + + + +
+ + +
sint NLAIAGENT::CSimpleLocalMailBox::_Size [protected] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 88 of file mailbox.h. +
+Referenced by addMessage, CSimpleLocalMailBox, isEmpty, load, popMessage, and size.
+

+ + + + +
+ + +
const NLAIC::CIdentType CSimpleLocalMailBox::IdSimpleLocalMailBox [static] +
+
+ + + + + +
+ + + +
+ +
+Referenced by getType.
+

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