# 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:

NLAIAGENT::IMailBox NLAIAGENT::IConnectIA NLAIAGENT::IRefrence NLAIAGENT::IObjectIA NLAIAGENT::IBasicObjectIA NLAIC::IBasicInterface NLAIC::IBasicType NLAIC::IPointerGestion NLMISC::IStreamable NLMISC::IClassable 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 bool isEmpty () 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 (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 const tListMessage & getMesseageListe () const
virtual sint size () const

Static Public Attributes

const NLAIC::CIdentType IdLocalMailBox

Private Methods

void fillMailBox ()

Private Attributes

IObjectIA::CProcessResult _RunState
tListMessage _ListMessageIn
tListMessage _ListSharedMessage
tListMailBox _ListMailBox
sint _Size

Member Typedef Documentation

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

Definition at line 142 of file mailbox.h.

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

Definition at line 141 of file mailbox.h.

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

Definition at line 139 of file mailbox.h.

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

Definition at line 138 of file mailbox.h.

Constructor & Destructor Documentation

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

Definition at line 247 of file mailbox.cpp.

Referenced by clone, and newInstance.

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

Definition at line 251 of file mailbox.cpp.

References load.

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

Definition at line 257 of file mailbox.cpp.

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

Definition at line 267 of file mailbox.cpp.

References _ListMessageIn, and _ListSharedMessage.

Member Function Documentation

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

Implements NLAIAGENT::IMailBox.

Definition at line 346 of file mailbox.cpp.

References _ListMailBox, NLAIAGENT::IConnectIA::connect, and NLAIAGENT::IMailBox::IMailBox.

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

Implements NLAIAGENT::IMailBox.

Definition at line 339 of file mailbox.cpp.

References _ListMessageIn, and _Size.

const NLAIC::IBasicType * NLAIAGENT::CLocalMailBox::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 371 of file mailbox.cpp.

References CLocalMailBox.

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

Definition at line 531 of file mailbox.cpp.

References _ListMailBox, _ListMessageIn, NLAIAGENT::IMailBox::IMailBox, and s.

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

References t.

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

Implements NLAIAGENT::IMailBox.

Definition at line 295 of file mailbox.cpp.

References _ListMessageIn.

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

Implements NLAIAGENT::IMailBox.

Definition at line 318 of file mailbox.cpp.

References _Size.

virtual const tListMessage& NLAIAGENT::CLocalMailBox::getMesseageListe (    )  const [inline, virtual]
 

Implements NLAIAGENT::IMailBox.

Definition at line 182 of file mailbox.h.

References _ListMessageIn, and NLAIAGENT::IMailBox::tListMessage.

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

Implements NLAIAGENT::IConnectIA.

Definition at line 476 of file mailbox.cpp.

References _RunState.

Referenced by run.

const NLAIC::CIdentType & NLAIAGENT::CLocalMailBox::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 387 of file mailbox.cpp.

References IdLocalMailBox.

bool NLAIAGENT::CLocalMailBox::isEmpty (    )  const [virtual]
 

Implements NLAIAGENT::IMailBox.

Definition at line 323 of file mailbox.cpp.

References _Size.

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'.

Implements NLAIAGENT::IBasicObjectIA.

Definition at line 413 of file mailbox.cpp.

References NLAIAGENT::IMailBox::IMailBox.

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

Load the class from a stream.

Implements NLAIAGENT::IMailBox.

Definition at line 453 of file mailbox.cpp.

References _ListMailBox, _Size, NLAIC::CIdentTypeAlloc::allocClass, id, NLAIAGENT::IMailBox::IMailBox, NLAIAGENT::IRefrence::IRefrence, num, and NLMISC::IStream::serial.

Referenced by CLocalMailBox.

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

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

Implements NLAIC::IBasicType.

Definition at line 377 of file mailbox.cpp.

References CLocalMailBox, and NLAIAGENT::IConnectIA::getParent.

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 392 of file mailbox.cpp.

References _ListMailBox, _ListMessageIn, _Size, and NLAIAGENT::IMailBox::IMailBox.

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

Implements NLAIAGENT::IMailBox.

Definition at line 300 of file mailbox.cpp.

References _ListMessageIn, and _Size.

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

Implements NLAIAGENT::IMailBox.

Definition at line 487 of file mailbox.cpp.

References _ListSharedMessage, NLAISCRIPT::l, and NLAIAGENT::IMailBox::tListMessage.

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

Implements NLAIAGENT::IMailBox.

Definition at line 361 of file mailbox.cpp.

References _ListMailBox, and NLAIAGENT::IConnectIA::removeConnection.

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

Some where Run method define the process of the agen.

Implements NLAIAGENT::IObjectIA.

Definition at line 504 of file mailbox.cpp.

References getState.

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

Save the class in a stream.

Implements NLAIAGENT::IMailBox.

Definition at line 419 of file mailbox.cpp.

References _ListMailBox, _ListMessageIn, _ListSharedMessage, NLAIAGENT::IMailBox::IMailBox, NLMISC::IStream::serial, and size.

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

Implements NLAIAGENT::IConnectIA.

Definition at line 332 of file mailbox.cpp.

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

Definition at line 367 of file mailbox.cpp.

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

Implements NLAIAGENT::IConnectIA.

Definition at line 481 of file mailbox.cpp.

References _RunState, and NLAIAGENT::TProcessStatement.

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

Implements NLAIAGENT::IMailBox.

Definition at line 288 of file mailbox.cpp.

References _ListMessageIn, and _ListSharedMessage.

virtual sint NLAIAGENT::CLocalMailBox::size (    )  const [inline, virtual]
 

Implements NLAIAGENT::IMailBox.

Definition at line 186 of file mailbox.h.

References _Size.

Referenced by save.

Member Data Documentation

tListMailBox NLAIAGENT::CLocalMailBox::_ListMailBox [private]
 

Definition at line 148 of file mailbox.h.

Referenced by addMailBox, fillMailBox, load, onKill, removeMailBox, and save.

tListMessage NLAIAGENT::CLocalMailBox::_ListMessageIn [private]
 

Definition at line 146 of file mailbox.h.

Referenced by addMessage, fillMailBox, getMessage, getMesseageListe, onKill, popMessage, save, shareMessage, and ~CLocalMailBox.

tListMessage NLAIAGENT::CLocalMailBox::_ListSharedMessage [private]
 

Definition at line 147 of file mailbox.h.

Referenced by pumpMessages, save, shareMessage, and ~CLocalMailBox.

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

Definition at line 145 of file mailbox.h.

Referenced by getState, and setState.

sint NLAIAGENT::CLocalMailBox::_Size [private]
 

Definition at line 149 of file mailbox.h.

Referenced by addMessage, getMessageCount, isEmpty, load, onKill, popMessage, and size.

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

Referenced by getType.

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