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

#include <mailbox.h> +

+Inheritance diagram for NLAIAGENT::CLocalMailBox

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

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

Public Types

typedef std::list<const IMessageBase
+*>::iterator 		tListMessageIter
typedef std::list<const IMessageBase
+*>::const_iterator 		tListMessageCstIter
typedef std::list<IMailBox
+*>::iterator 		tListMailBoxIter
typedef std::list<IMailBox
+*>::const_iterator 		tListMailBoxCstIter

Public Methods

 CLocalMailBox (const IWordNumRef *parent)
 CLocalMailBox (NLMISC::IStream &is)
 CLocalMailBox (const CLocalMailBox &A)
virtual ~CLocalMailBox ()
virtual const IMessageBase& getMessage ()
virtual void shareMessage ()
virtual void popMessage ()
virtual sint32 getMessageCount () const
virtual IObjectIA::CProcessResult sendMessage (IMessageBase *)
virtual void addMessage (IMessageBase *msg)
virtual void addMailBox (IMailBox *mail)
virtual void removeMailBox (IMailBox *mail)
virtual void setName (const IVarName &)
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 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 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 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 CProcessResult& getState () const
virtual void setState (TProcessStatement state, IObjectIA *result)
virtual std::list<const IMessageBase *>* pumpMessages () const
virtual const IObjectIA::CProcessResult& run ()
 Some where Run method define the process of the agen. 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...


Static Public Attributes

const NLAIC::CIdentType IdLocalMailBox

Private Methods

void fillMailBox ()

Private Attributes

IObjectIA::CProcessResult _RunState
tListMessage _ListMessageIn
tListMessage _ListSharedMessage
tListMailBox _ListMailBox
+

Member Typedef Documentation

+

+ + + + +
+ + + + + +
+typedef std::list<IMailBox *>::const_iterator NLAIAGENT::CLocalMailBox::tListMailBoxCstIter +
+
+ + + + + +
+   + + +

+ +

+Definition at line 127 of file mailbox.h.

+

+ + + + +
+ + + + + +
+typedef std::list<IMailBox *>::iterator NLAIAGENT::CLocalMailBox::tListMailBoxIter +
+
+ + + + + +
+   + + +

+ +

+Definition at line 126 of file mailbox.h.

+

+ + + + +
+ + + + + +
+typedef std::list<const IMessageBase *>::const_iterator NLAIAGENT::CLocalMailBox::tListMessageCstIter +
+
+ + + + + +
+   + + +

+ +

+Definition at line 124 of file mailbox.h.

+

+ + + + +
+ + + + + +
+typedef std::list<const IMessageBase *>::iterator NLAIAGENT::CLocalMailBox::tListMessageIter +
+
+ + + + + +
+   + + +

+ +

+Definition at line 123 of file mailbox.h.

+

Constructor & Destructor Documentation

+

+ + + + +
+ + + + + + +
+NLAIAGENT::CLocalMailBox::CLocalMailBox ( + +const IWordNumRef * parent ) +
+
+ + + + + +
+   + + +

+ +

+Definition at line 238 of file mailbox.cpp.

+

+ + + + +
+ + + + + + +
+NLAIAGENT::CLocalMailBox::CLocalMailBox ( + +NLMISC::IStream & is ) +
+
+ + + + + +
+   + + +

+ +

+Definition at line 242 of file mailbox.cpp.

+

+ + + + +
+ + + + + + +
+NLAIAGENT::CLocalMailBox::CLocalMailBox ( + +const CLocalMailBox & A ) +
+
+ + + + + +
+   + + +

+ +

+Definition at line 248 of file mailbox.cpp.

+

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

+ +

+Definition at line 257 of file mailbox.cpp.

+

Member Function Documentation

+

+ + + + +
+ + + + + + +
+void NLAIAGENT::CLocalMailBox::addMailBox ( + +IMailBox * mail ) [virtual] +
+
+ + + + + +
+   + + +

+ +

+Reimplemented from NLAIAGENT::IMailBox. +

+Definition at line 309 of file mailbox.cpp.

+

+ + + + +
+ + + + + + +
+void NLAIAGENT::CLocalMailBox::addMessage ( + +IMessageBase * msg ) [virtual] +
+
+ + + + + +
+   + + +

+ +

+Reimplemented from NLAIAGENT::IMailBox. +

+Definition at line 303 of file mailbox.cpp.

+

+ + + + +
+ + + + + + +
+const NLAIC::IBasicType * NLAIAGENT::CLocalMailBox::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. +

+Definition at line 334 of file mailbox.cpp.

+

+ + + + +
+ + + + + + +
+void NLAIAGENT::CLocalMailBox::fillMailBox ( + +) [private] +
+
+ + + + + +
+   + + +

+ +

+Definition at line 467 of file mailbox.cpp.

+

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

+

+ + + + +
+ + + + + + +
+const IMessageBase & NLAIAGENT::CLocalMailBox::getMessage ( + +) [virtual] +
+
+ + + + + +
+   + + +

+ +

+Reimplemented from NLAIAGENT::IMailBox. +

+Definition at line 268 of file mailbox.cpp.

+

+ + + + +
+ + + + + + +
+sint32 NLAIAGENT::CLocalMailBox::getMessageCount ( + +) const [virtual] +
+
+ + + + + +
+   + + +

+ +

+Reimplemented from NLAIAGENT::IMailBox. +

+Definition at line 288 of file mailbox.cpp.

+

+ + + + +
+ + + + + + +
+const IObjectIA::CProcessResult & NLAIAGENT::CLocalMailBox::getState ( + +) const [virtual] +
+
+ + + + + +
+   + + +

+ +

+Reimplemented from NLAIAGENT::IConnectIA. +

+Definition at line 421 of file mailbox.cpp.

+

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

+Definition at line 350 of file mailbox.cpp.

+

+ + + + +
+ + + + + + +
+bool NLAIAGENT::CLocalMailBox::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 360 of file mailbox.cpp.

+

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

+Load the class from a stream. +

+ +

+Reimplemented from NLAIAGENT::IMailBox. +

+Definition at line 400 of file mailbox.cpp.

+

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

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

+ +

+Reimplemented from NLAIC::IBasicType. +

+Definition at line 340 of file mailbox.cpp.

+

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

+

+ + + + +
+ + + + + + +
+void NLAIAGENT::CLocalMailBox::popMessage ( + +) [virtual] +
+
+ + + + + +
+   + + +

+ +

+Reimplemented from NLAIAGENT::IMailBox. +

+Definition at line 273 of file mailbox.cpp.

+

+ + + + +
+ + + + + + +
+std::list< const IMessageBase *>* NLAIAGENT::CLocalMailBox::pumpMessages ( + +) const [virtual] +
+
+ + + + + +
+   + + +

+ +

+Reimplemented from NLAIAGENT::IMailBox. +

+Definition at line 432 of file mailbox.cpp.

+

+ + + + +
+ + + + + + +
+void NLAIAGENT::CLocalMailBox::removeMailBox ( + +IMailBox * mail ) [virtual] +
+
+ + + + + +
+   + + +

+ +

+Reimplemented from NLAIAGENT::IMailBox. +

+Definition at line 324 of file mailbox.cpp.

+

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

+Some where Run method define the process of the agen. +

+ +

+Reimplemented from NLAIAGENT::IObjectIA. +

+Definition at line 449 of file mailbox.cpp.

+

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

+Save the class in a stream. +

+ +

+Reimplemented from NLAIAGENT::IMailBox. +

+Definition at line 366 of file mailbox.cpp.

+

+ + + + +
+ + + + + + +
+IObjectIA::CProcessResult NLAIAGENT::CLocalMailBox::sendMessage ( + +IMessageBase * msg ) [virtual] +
+
+ + + + + +
+   + + +

+ +

+Reimplemented from NLAIAGENT::IConnectIA. +

+Definition at line 297 of file mailbox.cpp.

+

+ + + + +
+ + + + + + +
+void NLAIAGENT::CLocalMailBox::setName ( + +const IVarName & ) [virtual] +
+
+ + + + + +
+   + + +

+ +

+Definition at line 330 of file mailbox.cpp.

+

+ + + + +
+ + + + + + + + + + +
+void NLAIAGENT::CLocalMailBox::setState ( + +TProcessStatement state, +
+IObjectIA * result ) [virtual] +
+
+ + + + + +
+   + + +

+ +

+Reimplemented from NLAIAGENT::IConnectIA. +

+Definition at line 426 of file mailbox.cpp.

+

+ + + + +
+ + + + + + +
+void NLAIAGENT::CLocalMailBox::shareMessage ( + +) [virtual] +
+
+ + + + + +
+   + + +

+ +

+Reimplemented from NLAIAGENT::IMailBox. +

+Definition at line 261 of file mailbox.cpp.

+

Member Data Documentation

+

+ + + + +
+ + + + + +
+const NLAIC::CIdentType NLAIAGENT::CLocalMailBox::IdLocalMailBox [static] +
+
+ + + + + +
+   + + +

+ +

+Definition at line 121 of file mailbox.h.

+

+ + + + +
+ + + + + +
+tListMailBox NLAIAGENT::CLocalMailBox::_ListMailBox [private] +
+
+ + + + + +
+   + + +

+ +

+Definition at line 133 of file mailbox.h.

+

+ + + + +
+ + + + + +
+tListMessage NLAIAGENT::CLocalMailBox::_ListMessageIn [private] +
+
+ + + + + +
+   + + +

+ +

+Definition at line 131 of file mailbox.h.

+

+ + + + +
+ + + + + +
+tListMessage NLAIAGENT::CLocalMailBox::_ListSharedMessage [private] +
+
+ + + + + +
+   + + +

+ +

+Definition at line 132 of file mailbox.h.

+

+ + + + +
+ + + + + +
+IObjectIA::CProcessResult NLAIAGENT::CLocalMailBox::_RunState [private] +
+
+ + + + + +
+   + + +

+ +

+Definition at line 130 of file mailbox.h.

+

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