From 0ea5fc66924303d1bf73ba283a383e2aadee02f2 Mon Sep 17 00:00:00 2001 From: neodarz Date: Sat, 11 Aug 2018 20:21:34 +0200 Subject: Initial commit --- docs/doxygen/nel/classNLAIAGENT_1_1IConnectIA.html | 1091 ++++++++++++++++++++ 1 file changed, 1091 insertions(+) create mode 100644 docs/doxygen/nel/classNLAIAGENT_1_1IConnectIA.html (limited to 'docs/doxygen/nel/classNLAIAGENT_1_1IConnectIA.html') diff --git a/docs/doxygen/nel/classNLAIAGENT_1_1IConnectIA.html b/docs/doxygen/nel/classNLAIAGENT_1_1IConnectIA.html new file mode 100644 index 00000000..320c5e89 --- /dev/null +++ b/docs/doxygen/nel/classNLAIAGENT_1_1IConnectIA.html @@ -0,0 +1,1091 @@ + + + + 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::IConnectIA Class Reference

In general agents create a lot of connection with ather agent and for exemple when he die, he have to close all this connections. +More... +

+#include <baseai.h> +

Inheritance diagram for NLAIAGENT::IConnectIA: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +List of all members. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Methods
	IConnectIA ()
	IConnectIA (const IWordNumRef *parent)
	IConnectIA (NLMISC::IStream &is)
IConnectIA *	getParent () const
	to get the agent parents. 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 (IObjectIA *m)
	sendMessage allow agent to send a message to an ather agent.The message is a IMessageBase. More...
virtual IObjectIA::CProcessResult	sendMessage (IMessageBase *msg)=0
void	connect (IConnectIA *b)
	When agent want to make connection he have to call this method to connect to an agent.When it call the B object is added in the connection list. More...
void	removeConnection (IConnectIA *Agent)
	To release a connection. More...
virtual void	setParent (const IWordNumRef *parent)
	to set the parent of the agents. More...
virtual void	Kill ()
	this method define wat agent have to whene he die. More...
virtual	~IConnectIA ()
State of agent.
virtual const CProcessResult &	getState () const=0
virtual void	setState (TProcessStatement s, IObjectIA *result)=0
IBasicInterface method.
virtual void	save (NLMISC::IStream &os)=0
	Save the class in a stream. More...
virtual void	load (NLMISC::IStream &is)=0
	Load the class from a stream. More...
Protected Methods
	IConnectIA (const IConnectIA &A)
void	connectLoadStream (NLMISC::IStream &is)
list manipulation method.
void	addInConnectionList (const IConnectIA *a)
void	removeInConnectionList (IConnectIA *a)
void	addInConnectedList (const IConnectIA *a)
void	removeInConnectedList (const IConnectIA *a)
Protected Attributes
tListiBasic	_Connection
tListiBasic	_Connected
Private Types
typedef std::set< const IConnectIA * >	tListiBasic
typedef std::set< const IConnectIA +* >::iterator	tListiBasicItr
typedef std::set< const IConnectIA +* >::const_iterator	tListiBasicCstItr

Detailed Description

+In general agents create a lot of connection with ather agent and for exemple when he die, he have to close all this connections. +

+IConnectIA allow programmer to manage connection. the IConnectIA class work with tow list the connection list and the connected list. Connection list: is the list of agent connected to this object. Connectioned list: is the list of objects where this agent is connected to. +

+Author:: +Chafik sameh , Portier Pierre , Nevrax France

+Date:: +2000

+ +

+Definition at line 418 of file baseai.h.

Member Typedef Documentation

+ + + + +
+ + +
typedef std::set<const IConnectIA *> NLAIAGENT::IConnectIA::tListiBasic [private] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 421 of file baseai.h.
+

+ + + + +
+ + +
typedef std::set<const IConnectIA *>::const_iterator NLAIAGENT::IConnectIA::tListiBasicCstItr [private] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 423 of file baseai.h. +
+Referenced by Kill, and save.
+

+ + + + +
+ + +
typedef std::set<const IConnectIA *>::iterator NLAIAGENT::IConnectIA::tListiBasicItr [private] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 422 of file baseai.h. +
+Referenced by removeInConnectedList, and removeInConnectionList.
+

Constructor & Destructor Documentation

+ + + + +
+ + + + + + + + + + +
NLAIAGENT::IConnectIA::IConnectIA ( const IConnectIA & A ) [protected]
+
+ + + + + +
+ + + +
+ +
+Definition at line 494 of file baseai.cpp. +
+Referenced by NLAIAGENT::CAgentWatchTimer::addAttrib, connectLoadStream, NLAIAGENT::CAgentOperation::connectOnChange, getParent, Kill, NLAIAGENT::IAgent::Kill, NLAIAGENT::CHashTimerManager::onKill, onKill, NLAIAGENT::CAgentOperation::runMethodBase, NLAIAGENT::CAgentWatchTimer::runMethodBase, save, NLAIAGENT::CLocalAgentMail::save, and setParent.
+

+ + + + +
+ + + + + + + + + +
NLAIAGENT::IConnectIA::IConnectIA ( )
+
+ + + + + +
+ + + +
+ +
+Definition at line 498 of file baseai.cpp.
+

+ + + + +
+ + + + + + + + + + +
NLAIAGENT::IConnectIA::IConnectIA ( const IWordNumRef * parent )
+
+ + + + + +
+ + + +
+ +
+Definition at line 502 of file baseai.cpp.
+

+ + + + +
+ + + + + + + + + + +
NLAIAGENT::IConnectIA::IConnectIA ( NLMISC::IStream & is )
+
+ + + + + +
+ + + +
+ +
+Definition at line 506 of file baseai.cpp. +
+References connectLoadStream.
+

+ + + + +
+ + + + + + + + + +
NLAIAGENT::IConnectIA::~IConnectIA ( ) [virtual]
+
+ + + + + +
+ + + +
+ +
+Definition at line 567 of file baseai.cpp. +
+References Kill.
+

Member Function Documentation

+ + + + +
+ + + + + + + + + + +
void NLAIAGENT::IConnectIA::addInConnectedList ( const IConnectIA * a ) [protected]
+
+ + + + + +
+ + + +
+ +
+Definition at line 595 of file baseai.cpp. +
+References _Connected. +
+Referenced by connectLoadStream, and NLAIAGENT::CSimpleLocalMailBox::getConnection.
+

+ + + + +
+ + + + + + + + + + +
void NLAIAGENT::IConnectIA::addInConnectionList ( const IConnectIA * a ) [protected]
+
+ + + + + +
+ + + +
+ +
+Definition at line 572 of file baseai.cpp. +
+References _Connection. +
+Referenced by connect, and connectLoadStream.
+

+ + + + +
+ + + + + + + + + + +
void NLAIAGENT::IConnectIA::connect ( IConnectIA * b )
+
+ + + + + +
+ + + +
+When agent want to make connection he have to call this method to connect to an agent.When it call the B object is added in the connection list. +
+ +
+Definition at line 555 of file baseai.cpp. +
+References addInConnectionList. +
+Referenced by NLAIAGENT::CAgentWatchTimer::addAttrib, NLAIAGENT::IAgentInput::addInputConnection, NLAIAGENT::CLocalMailBox::addMailBox, NLAIAGENT::CAgentWatchTimer::CAgentWatchTimer, NLAIAGENT::CLocalAgentMail::CLocalAgentMail, and setParent.
+

+ + + + +
+ + + + + + + + + + +
void NLAIAGENT::IConnectIA::connectLoadStream ( NLMISC::IStream & is ) [protected]
+
+ + + + + +
+ + + +
+ +
+Definition at line 521 of file baseai.cpp. +
+References addInConnectedList, addInConnectionList, NLAIC::CIdentTypeAlloc::allocClass, IConnectIA, id, NLAIAGENT::IRefrence::IRefrence, num, and NLMISC::IStream::serial. +
+Referenced by IConnectIA, and load.
+

+ + + + +
+ + + + + + + + + +
IConnectIA * NLAIAGENT::IConnectIA::getParent ( ) const
+
+ + + + + +
+ + + +
+to get the agent parents. +
+ +
+Reimplemented from NLAIAGENT::IRefrence. +
+Definition at line 511 of file baseai.cpp. +
+References IConnectIA. +
+Referenced by NLAIAGENT::CActorScript::activate, NLAIAGENT::COperatorScript::calcPriority, NLAIAGENT::COperatorScript::checkTrigMsg, Kill, NLAIAGENT::COperatorScript::lookForGoals, NLAIAGENT::CScriptMailBox::newInstance, NLAIAGENT::CLocalMailBox::newInstance, NLAIAGENT::CSimpleLocalMailBox::newInstance, NLAIAGENT::IAgent::newInstance, NLAIAGENT::CActor::newInstance, onKill, NLAIAGENT::IBasicAgent::runAsk, NLAIAGENT::CAgentScript::runAskParentNotify, NLAIAGENT::CAgentScript::runMethodBase, NLAIAGENT::CActorScript::runMethodBase, NLAIAGENT::IBasicAgent::runMethodeMember, NLAIAGENT::CAgentScript::runTellParentNotify, setParent, NLAIAGENT::CScriptMailBox::translateMsg, and NLAIAGENT::CActorScript::unActivate.
+

+ + + + +
+ + + + + + + + + +
virtual const CProcessResult& NLAIAGENT::IConnectIA::getState ( ) const [pure virtual]
+
+ + + + + +
+ + + +
+ +
+Implemented in NLAIAGENT::IBasicAgent.
+

+ + + + +
+ + + + + + + + + +
void NLAIAGENT::IConnectIA::Kill ( ) [virtual]
+
+ + + + + +
+ + + +
+this method define wat agent have to whene he die. +
+ +
+Reimplemented in NLAIAGENT::IAgent. +
+Definition at line 618 of file baseai.cpp. +
+References _Connected, _Connection, getParent, IConnectIA, and tListiBasicCstItr. +
+Referenced by ~IConnectIA.
+

+ + + + +
+ + + + + + + + + + +
void NLAIAGENT::IConnectIA::load ( NLMISC::IStream & is ) [pure virtual]
+
+ + + + + +
+ + + +
+Load the class from a stream. +
+ +
+Implements NLAIAGENT::IRefrence. +
+Implemented in NLAIAGENT::CActor. +
+Definition at line 516 of file baseai.cpp. +
+References connectLoadStream.
+

+ + + + +
+ + + + + + + + + + +
void NLAIAGENT::IConnectIA::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 in NLAIAGENT::IBasicAgent. +
+Definition at line 651 of file baseai.cpp. +
+References getParent, IConnectIA, and setParent.
+

+ + + + +
+ + + + + + + + + + +
void NLAIAGENT::IConnectIA::removeConnection ( IConnectIA * Agent )
+
+ + + + + +
+ + + +
+To release a connection. +
+ +
+Definition at line 561 of file baseai.cpp. +
+References removeInConnectionList. +
+Referenced by NLAIAGENT::CAgentWatchTimer::detach, NLAIAGENT::IAgent::onKill, NLAIAGENT::IAgentInput::releaseInputConnexion, and NLAIAGENT::CLocalMailBox::removeMailBox.
+

+ + + + +
+ + + + + + + + + + +
void NLAIAGENT::IConnectIA::removeInConnectedList ( const IConnectIA * a ) [protected]
+
+ + + + + +
+ + + +
+ +
+Definition at line 600 of file baseai.cpp. +
+References _Connected, and tListiBasicItr.
+

+ + + + +
+ + + + + + + + + + +
void NLAIAGENT::IConnectIA::removeInConnectionList ( IConnectIA * a ) [protected]
+
+ + + + + +
+ + + +
+ +
+Definition at line 577 of file baseai.cpp. +
+References _Connection, and tListiBasicItr. +
+Referenced by removeConnection.
+

+ + + + +
+ + + + + + + + + + +
void NLAIAGENT::IConnectIA::save ( NLMISC::IStream & os ) [pure virtual]
+
+ + + + + +
+ + + +
+Save the class in a stream. +
+ +
+Implements NLAIAGENT::IRefrence. +
+Implemented in NLAIAGENT::CActor. +
+Definition at line 36 of file baseai.cpp. +
+References _Connected, _Connection, IConnectIA, r, NLMISC::IStream::serial, and tListiBasicCstItr.
+

+ + + + +
+ + + + + + + + + + +
virtual IObjectIA::CProcessResult NLAIAGENT::IConnectIA::sendMessage ( IMessageBase * msg ) [pure virtual]
+
+ + + + + +
+ + + +
+ +
+Implemented in NLAIAGENT::IBasicAgent.
+

+ + + + +
+ + + + + + + + + + +
virtual IObjectIA::CProcessResult NLAIAGENT::IConnectIA::sendMessage ( IObjectIA * m ) [inline, virtual]
+
+ + + + + +
+ + + +
+sendMessage allow agent to send a message to an ather agent.The message is a IMessageBase. +
+ +
+Reimplemented from NLAIAGENT::IObjectIA. +
+Reimplemented in NLAIAGENT::CActorScript. +
+Definition at line 451 of file baseai.h. +
+References NLAIAGENT::IObjectIA::IObjectIA.
+

+ + + + +
+ + + + + + + + + + +
void NLAIAGENT::IConnectIA::setParent ( const IWordNumRef * parent ) [virtual]
+
+ + + + + +
+ + + +
+to set the parent of the agents. +
+ +
+Reimplemented from NLAIAGENT::IRefrence. +
+Definition at line 661 of file baseai.cpp. +
+References connect, getParent, and IConnectIA. +
+Referenced by onKill, NLAIAGENT::CProxyAgentMail::sendMessage, and NLAIAGENT::CLocalAgentMail::sendMessage.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
virtual void NLAIAGENT::IConnectIA::setState ( TProcessStatement s,
IObjectIA * result
) [pure virtual]
+
+ + + + + +
+ + + +
+ +
+Implemented in NLAIAGENT::IBasicAgent.
+

Member Data Documentation

+ + + + +
+ + +
tListiBasic NLAIAGENT::IConnectIA::_Connected [protected] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 427 of file baseai.h. +
+Referenced by addInConnectedList, Kill, removeInConnectedList, and save.
+

+ + + + +
+ + +
tListiBasic NLAIAGENT::IConnectIA::_Connection [protected] +
+
+ + + + + +
+ + + +
+ +
+Reimplemented in NLAIAGENT::CAgentOperation. +
+Definition at line 426 of file baseai.h. +
+Referenced by addInConnectionList, Kill, removeInConnectionList, and save.
+

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

+ + + +
+

+ + -- cgit v1.2.1

NLAIAGENT::IConnectIA Class Reference

Public Methods

Protected Methods

Protected Attributes

Private Types

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation