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

Class for managing script agent. +More... +

+#include <agent_script.h> +

+Inheritance diagram for NLAIAGENT::CAgentScript

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

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

Public Types
enum	TMethodNumDef { + TSend, + + TSendComponent, + + TGetChildTag, + + TAddChildTag, + + TRemoveChild, + + TFather, + + TSelf, + + TGetName, + + TRunAskParentNotify, + + TRunTellParentNotify, + + TLastM + + }
	This enum define ident for hard coded method that we have to import its under the script. More...
enum	TTypeCheck { + CheckAll, + + CheckCount, + + DoNotCheck + + }
Public Methods
	CAgentScript (const CAgentScript &)
	Construct with copy constructor. More...
	CAgentScript (IAgentManager *)
	Build with an knowning manager. More...
	CAgentScript (IAgentManager , IBasicAgent , std::list<IObjectIA > &, NLAISCRIPT::CAgentClass )
	Build with an knowning manager and a list of static compoment. More...
virtual	~CAgentScript ()
const NLAISCRIPT::CAgentClass*	getClass ()
CAgentScript member methods.
virtual void	addOperator (NLAILOGIC::IBaseOperator *)
	Method for adding operator. More...
virtual void	remOperator (NLAILOGIC::IBaseOperator *p)
	Removing operator from th agent. More...
virtual IObjectIA::CProcessResult	addDynamicAgent (NLAIAGENT::IBaseGroupType *g)
	Add an agent to the dynamic agent child. More...
virtual IObjectIA::CProcessResult	getDynamicAgent (NLAIAGENT::IBaseGroupType *g)
	Get agent from the dynamic agent child. More...
virtual IObjectIA::CProcessResult	getDynamicName (NLAIAGENT::IBaseGroupType *g)
	Get the instance name of the agent in its manager. More...
virtual IObjectIA::CProcessResult	removeDynamic (NLAIAGENT::IBaseGroupType *g)
	remove an agent from the manager. More...
virtual IObjectIA::CProcessResult	runAskParentNotify (IBaseGroupType *)
	This function process the message CNotifyParentScript for the runAsk. More...
virtual IObjectIA::CProcessResult	runTellParentNotify (IBaseGroupType *)
	This function process the message CNotifyParentScript for the runTell. More...
NLAISCRIPT::IOpCode*	getMethode (sint32 inheritance,sint32 index)
	get the closure correspondent of the method indexed by index in the base class inheritance. More...
NLAISCRIPT::IOpCode*	getMethode (sint32 index)
	get the closure correspondent of the method indexed by index. More...
const IAgentManager*	getAgentManager () const
	Get the manager of the instance. More...
const NLAISCRIPT::CAgentClass*	getFactoryClass () const
	Get the creator of this instance. More...
virtual sint32	getChildMessageIndex (const IMessageBase *, sint32 )
	get the mail boxe for scripted message. More...
void	setAgentManager (IAgentManager *manager)
	Set the manager for this instance. More...
IAgentManager member method.
virtual int	getBaseMethodCount () const
	Return the nomber of internal C++ hard coded method that the class can process. More...
virtual const IObjectIA*	getAgentContext () const
	Get an valid context for this instance. More...
Base class member method.
virtual void	runChildren ()
	Run all child. More...
virtual void	onKill (IConnectIA *A)
	Called by an agent who's destroyed te remove its references. More...
virtual void	processMessages ()
	The processMessages method, process the loop/Run message. More...
virtual void	processMessages (IMessageBase ,IObjectIA )
virtual void	processContinuation (IMessageBase , IMessageBase )
virtual IObjectIA::CProcessResult	runActivity ()
	Mailer do'nt have own activity. More...
virtual bool	isEqual (const IBasicObjectIA &a) const
	Implementation of the isEqual of the IBasicObjectIA. More...
virtual bool	haveActivity () const
	allow to know if the agent have an activity process to run. More...
IObjectIA::CProcessResult	sendMethod (IObjectIA *)
IObjectIA::CProcessResult	sendMethodCompoment (IObjectIA *)
virtual IObjectIA::CProcessResult	runMethodBase (int heritance, int index,IObjectIA *)
virtual IObjectIA::CProcessResult	runMethodBase (int index,IObjectIA *)
virtual sint32	getStaticMemberSize () const
	Static member is the component that the agent is create and die with. More...
virtual sint32	getStaticMemberIndex (const IVarName &) const
	to get the index of a given components name. More...
virtual const IObjectIA*	getStaticMember (sint32) const
	to get the pointer of a given components referened by an index. More...
virtual void	setStaticMember (sint32,IObjectIA *)
	to cahnge a given components given by a string. More...
virtual tQueue	getPrivateMember (const IVarName ,const NLAIAGENT::IVarName ,const IObjectIA &) const
virtual tQueue	isMember (const IVarName ,const NLAIAGENT::IVarName ,const IObjectIA &) const
	The method isMember(nameSubClass,methodName,param) return the best method correspondent to the search. More...
virtual sint32	isClassInheritedFrom (const NLAIAGENT::IVarName &) const
	isClassInheritedFrom(className) allow us to known if this class have a base class with the name className. More...
virtual sint32	getMethodIndexSize () const
	getMethodIndexSize define the nomber of external method. More...
virtual IObjectIA::CProcessResult	runMethodeMember (sint32 heritance, sint32 index,IObjectIA *)
	The methode runMethodeMember(sint32 heritance, sint32 index, IObjectIA param) allow us to run a member method.* More...
virtual IObjectIA::CProcessResult	runMethodeMember (sint32 index,IObjectIA *)
	The methode runMethodeMember(sint32 index,IObjectIA param) allow us to run a own member method.* More...
virtual CProcessResult	sendMessage (IObjectIA *)
	sendMessage allow agent to send a message to an ather agent.The message is a IMessageBase. More...
virtual CProcessResult	sendMessage (const IVarName &,IObjectIA *)
	This method allow to send a message to an compoment given by an string IVarName. More...
CProcessResult	sendMessageToDynmaicChild (const IVarName &,IObjectIA *)
virtual const IObjectIA::CProcessResult&	run ()
	The work of an agent. More...
NLAIC::IBasicInterface base class method.
virtual void	load (NLMISC::IStream &is)
	Load the class from a stream. More...
virtual void	save (NLMISC::IStream &os)
	Save the class in a stream. 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 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 const NLAIC::CIdentType&	getType () const
	getType return a unique string how represente the class, it can be the name of the class. More...
Static Public Methods
void	initAgentScript ()
void	releaseAgentScript ()
Static Public Attributes
CMethodCall**	StaticMethod = NULL
NLAISCRIPT::COperandSimpleListOr*	msgType = NULL
NLAISCRIPT::COperandSimpleListOr*	msgPerf = NULL
NLAISCRIPT::CParam*	SendParamMessageScript = NULL
NLAISCRIPT::CParam*	SendCompParamMessageScript = NULL
NLAISCRIPT::COperandSimple*	IdMsgNotifyParentClass = NULL
NLAISCRIPT::COperandSimpleListOr*	IdMsgNotifyParent = NULL
NLAISCRIPT::CParam*	ParamRunParentNotify = NULL
const NLAIC::CIdentType	IdAgentScript
Protected Attributes
IObjectIA**	_Components
	Table of static compoments. More...
int	_NbComponents
	Nomber of static compoment. More...
IAgentManager*	_AgentManager
	The manager where the agent is run this manager have the agent script context. More...
tsetDefNameAgent	_DynamicAgentName
	Map for store agent added in the dynamic child container. More...
NLAISCRIPT::CAgentClass*	_AgentClass
	The creator of this instance. This useful for find scripted method entry point. More...
Private Types
typedef std::multiset<CKeyAgent>	tsetDefNameAgent
	Type def for the map witch store the name of dynamic agent store in the agent. More...

Detailed Description

+Class for managing script agent. +

+Author(s):: + Chafik sameh , Nevrax France

+Date:: + 2000

+ +

+Definition at line 63 of file agent_script.h.

Member Typedef Documentation

+ + + + +
+ + + + + +
+typedef std::multiset<CKeyAgent> NLAIAGENT::CAgentScript::tsetDefNameAgent [private] +
+
+ + + + + +
+ + + +
+Type def for the map witch store the name of dynamic agent store in the agent. +
+ +
+Definition at line 138 of file agent_script.h.
+

Member Enumeration Documentation

+ + + + +
+ + + + + +
+enum NLAIAGENT::CAgentScript::TMethodNumDef +
+
+ + + + + +
+ + + +
+This enum define ident for hard coded method that we have to import its under the script. +
+
+Enumeration values:
+ + + + + + + + + + + + +
TSend + +
TSendComponent + +Index of the send method.
TGetChildTag + +Index of the send with continuation method.
TAddChildTag + +Index of the getChild method.
TRemoveChild + +Index of the addChild method.
TFather + +Index of the removeDynamic method.
TSelf + +Get the father of the agent.
TGetName + +Get The self pointer.
TRunAskParentNotify + +Get the name of the agent in the manager child list.
TRunTellParentNotify + +the offest of the runAskParentNotify method.
TLastM + +The count of export method.
+
+ +
+Definition at line 68 of file agent_script.h.
+

+ + + + +
+ + + + + +
+enum NLAIAGENT::CAgentScript::TTypeCheck +
+
+ + + + + +
+ + + +
+
+Enumeration values:
+ + + + +
CheckAll + +
CheckCount + +
DoNotCheck + +
+
+ +
+Definition at line 88 of file agent_script.h.
+

Constructor & Destructor Documentation

+ + + + +
+ + + + + + +
+NLAIAGENT::CAgentScript::CAgentScript ( + +const CAgentScript & a ) +
+
+ + + + + +
+ + + +
+Construct with copy constructor. +
+ +
+Definition at line 227 of file agent_script.cpp.
+

+ + + + +
+ + + + + + +
+NLAIAGENT::CAgentScript::CAgentScript ( + +IAgentManager * manager ) +
+
+ + + + + +
+ + + +
+Build with an knowning manager. +
+ +
+Definition at line 265 of file agent_script.cpp.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + +
+NLAIAGENT::CAgentScript::CAgentScript ( + +IAgentManager * manager, +
+IBasicAgent * father, +
+std::list< IObjectIA *>& components, +
+NLAISCRIPT::CAgentClass * agent_class ) +
+
+ + + + + +
+ + + +
+Build with an knowning manager and a list of static compoment. +
+ +
+Definition at line 272 of file agent_script.cpp.
+

+ + + + +
+ + + + + + +
+NLAIAGENT::CAgentScript::~CAgentScript ( + +) [virtual] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 308 of file agent_script.cpp.
+

Member Function Documentation

+ + + + +
+ + + + + + +
+IObjectIA::CProcessResult NLAIAGENT::CAgentScript::addDynamicAgent ( + +NLAIAGENT::IBaseGroupType * g ) [virtual] +
+
+ + + + + +
+ + + +
+Add an agent to the dynamic agent child. +
+Method have an IBaseGroupType argument, this argument must store an CStringType first and an IObjectIA pointer memory next. The CStringType is the name of the agent. The IObjectIA pointer memory is the agent. +
+Reimplemented in NLAIAGENT::CMainAgentScript. +
+Definition at line 525 of file agent_script.cpp.
+

+ + + + +
+ + + + + + +
+void NLAIAGENT::CAgentScript::addOperator ( + +NLAILOGIC::IBaseOperator * op ) [virtual] +
+
+ + + + + +
+ + + +
+Method for adding operator. +
+ +
+Definition at line 1006 of file agent_script.cpp.
+

+ + + + +
+ + + + + + +
+const NLAIC::IBasicType * NLAIAGENT::CAgentScript::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 NLAIAGENT::IAgent. +
+Reimplemented in NLAIAGENT::CActorScript, NLAIAGENT::CAgentManagerTimer, NLAIAGENT::CAgentWatchTimer, NLAIAGENT::CAgentClockTimer, NLAIAGENT::CGDAgentScript, NLAIAGENT::CMainAgentScript, NLAIAGENT::CFsmScript, NLAIAGENT::CSeqFsmScript, and NLAIAGENT::COperatorScript. +
+Definition at line 457 of file agent_script.cpp.
+

+ + + + +
+ + + + + + +
+const IObjectIA * NLAIAGENT::CAgentScript::getAgentContext ( + +) const [inline, virtual] +
+
+ + + + + +
+ + + +
+Get an valid context for this instance. +
+ +
+Reimplemented from NLAIAGENT::IAgentManager. +
+Reimplemented in NLAIAGENT::CMainAgentScript. +
+Definition at line 243 of file agent_script.h.
+

+ + + + +
+ + + + + + +
+const IAgentManager * NLAIAGENT::CAgentScript::getAgentManager ( + +) const [inline] +
+
+ + + + + +
+ + + +
+Get the manager of the instance. +
+ +
+Definition at line 218 of file agent_script.h.
+

+ + + + +
+ + + + + + +
+int NLAIAGENT::CAgentScript::getBaseMethodCount ( + +) const [virtual] +
+
+ + + + + +
+ + + +
+Return the nomber of internal C++ hard coded method that the class can process. +
+ +
+Reimplemented from NLAIAGENT::IAgentManager. +
+Reimplemented in NLAIAGENT::CActorScript, NLAIAGENT::CAgentWatchTimer, NLAIAGENT::CMainAgentScript, and NLAIAGENT::CFsmScript. +
+Definition at line 1160 of file agent_script.cpp.
+

+ + + + +
+ + + + + + + + + + +
+sint32 NLAIAGENT::CAgentScript::getChildMessageIndex ( + +const IMessageBase * msg, +
+sint32 child_index ) [virtual] +
+
+ + + + + +
+ + + +
+get the mail boxe for scripted message. +
+ +
+Definition at line 336 of file agent_script.cpp.
+

+ + + + +
+ + + + + + +
+const NLAISCRIPT::CAgentClass * NLAIAGENT::CAgentScript::getClass ( + +) [inline] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 324 of file agent_script.h.
+

+ + + + +
+ + + + + + +
+void NLAIAGENT::CAgentScript::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 NLAIAGENT::IAgent. +
+Reimplemented in NLAIAGENT::CActorScript, NLAIAGENT::CAgentManagerTimer, NLAIAGENT::CAgentWatchTimer, NLAIAGENT::CGDAgentScript, NLAIAGENT::CFsmScript, NLAIAGENT::CSeqFsmScript, and NLAIAGENT::COperatorScript. +
+Definition at line 477 of file agent_script.cpp.
+

+ + + + +
+ + + + + + +
+IObjectIA::CProcessResult NLAIAGENT::CAgentScript::getDynamicAgent ( + +NLAIAGENT::IBaseGroupType * g ) [virtual] +
+
+ + + + + +
+ + + +
+Get agent from the dynamic agent child. +
+Method have an IBaseGroupType argument where he must store an CStringType representative of the name of the agent. +
+Definition at line 577 of file agent_script.cpp.
+

+ + + + +
+ + + + + + +
+IObjectIA::CProcessResult NLAIAGENT::CAgentScript::getDynamicName ( + +NLAIAGENT::IBaseGroupType * g ) [virtual] +
+
+ + + + + +
+ + + +
+Get the instance name of the agent in its manager. +
+ +
+Definition at line 644 of file agent_script.cpp.
+

+ + + + +
+ + + + + + +
+const NLAISCRIPT::CAgentClass * NLAIAGENT::CAgentScript::getFactoryClass ( + +) const [inline] +
+
+ + + + + +
+ + + +
+Get the creator of this instance. +
+ +
+Definition at line 224 of file agent_script.h.
+

+ + + + +
+ + + + + + +
+sint32 NLAIAGENT::CAgentScript::getMethodIndexSize ( + +) const [virtual] +
+
+ + + + + +
+ + + +
+getMethodIndexSize define the nomber of external method. +
+ +
+Reimplemented from NLAIAGENT::IBasicAgent. +
+Reimplemented in NLAIAGENT::CActorScript, NLAIAGENT::CAgentWatchTimer, and NLAIAGENT::CFsmScript. +
+Definition at line 445 of file agent_script.cpp.
+

+ + + + +
+ + + + + + +
+NLAISCRIPT::IOpCode * NLAIAGENT::CAgentScript::getMethode ( + +sint32 index ) +
+
+ + + + + +
+ + + +
+get the closure correspondent of the method indexed by index. +
+ +
+Definition at line 392 of file agent_script.cpp.
+

+ + + + +
+ + + + + + + + + + +
+NLAISCRIPT::IOpCode * NLAIAGENT::CAgentScript::getMethode ( + +sint32 inheritance, +
+sint32 index ) +
+
+ + + + + +
+ + + +
+get the closure correspondent of the method indexed by index in the base class inheritance. +
+ +
+Definition at line 376 of file agent_script.cpp.
+

+ + + + +
+ + + + + + + + + + + + + + +
+tQueue NLAIAGENT::CAgentScript::getPrivateMember ( + +const IVarName * className, +
+const IVarName * methodName, +
+const IObjectIA & param ) const [virtual] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 1283 of file agent_script.cpp.
+

+ + + + +
+ + + + + + +
+const IObjectIA * NLAIAGENT::CAgentScript::getStaticMember ( + +sint32 index ) const [virtual] +
+
+ + + + + +
+ + + +
+to get the pointer of a given components referened by an index. +
+ +
+Reimplemented from NLAIAGENT::IObjectIA. +
+Definition at line 365 of file agent_script.cpp.
+

+ + + + +
+ + + + + + +
+sint32 NLAIAGENT::CAgentScript::getStaticMemberIndex ( + +const IVarName & name ) const [virtual] +
+
+ + + + + +
+ + + +
+to get the index of a given components name. +
+ +
+Reimplemented from NLAIAGENT::IObjectIA. +
+Definition at line 1415 of file agent_script.cpp.
+

+ + + + +
+ + + + + + +
+sint32 NLAIAGENT::CAgentScript::getStaticMemberSize ( + +) const [virtual] +
+
+ + + + + +
+ + + +
+Static member is the component that the agent is create and die with. +
+getStaticMemberSize to get the size of the static member components +
+Reimplemented from NLAIAGENT::IObjectIA. +
+Definition at line 359 of file agent_script.cpp.
+

+ + + + +
+ + + + + + +
+const NLAIC::CIdentType & NLAIAGENT::CAgentScript::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 NLAIAGENT::IAgent. +
+Reimplemented in NLAIAGENT::CActorScript, NLAIAGENT::CAgentManagerTimer, NLAIAGENT::CAgentWatchTimer, NLAIAGENT::CAgentClockTimer, NLAIAGENT::CGDAgentScript, NLAIAGENT::CMainAgentScript, NLAIAGENT::CFsmScript, NLAIAGENT::CSeqFsmScript, and NLAIAGENT::COperatorScript. +
+Definition at line 1029 of file agent_script.cpp.
+

+ + + + +
+ + + + + + +
+bool NLAIAGENT::CAgentScript::haveActivity ( + +) const [virtual] +
+
+ + + + + +
+ + + +
+allow to know if the agent have an activity process to run. +
+ +
+Reimplemented from NLAIAGENT::IAgent. +
+Reimplemented in NLAIAGENT::CAgentManagerTimer, and NLAIAGENT::CAgentWatchTimer. +
+Definition at line 983 of file agent_script.cpp.
+

+ + + + +
+ + + + + + +
+void NLAIAGENT::CAgentScript::initAgentScript ( + +) [static] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 63 of file agent_script.cpp. +
+Referenced by NLAILINK::initIALib().
+

+ + + + +
+ + + + + + +
+sint32 NLAIAGENT::CAgentScript::isClassInheritedFrom ( + +const IVarName & name ) const [virtual] +
+
+ + + + + +
+ + + +
+isClassInheritedFrom(className) allow us to known if this class have a base class with the name className. +
+If true the method return the range of the base class, this range is an arbitrary reference id define by the programmer or bay the scrypt. the false return is define by -1. +
+Reimplemented from NLAIAGENT::IObjectIA. +
+Definition at line 1410 of file agent_script.cpp.
+

+ + + + +
+ + + + + + +
+bool NLAIAGENT::CAgentScript::isEqual ( + +const IBasicObjectIA & a ) const [virtual] +
+
+ + + + + +
+ + + +
+Implementation of the isEqual of the IBasicObjectIA. +
+ +
+Reimplemented from NLAIAGENT::IAgent. +
+Reimplemented in NLAIAGENT::CActorScript, NLAIAGENT::CGDAgentScript, NLAIAGENT::CFsmScript, NLAIAGENT::CSeqFsmScript, and NLAIAGENT::COperatorScript. +
+Definition at line 505 of file agent_script.cpp.
+

+ + + + +
+ + + + + + + + + + + + + + +
+tQueue NLAIAGENT::CAgentScript::isMember ( + +const IVarName * className, +
+const IVarName * name, +
+const IObjectIA & param ) const [virtual] +
+
+ + + + + +
+ + + +
+The method isMember(nameSubClass,methodName,param) return the best method correspondent to the search. +
+remember we use the overloadind method. +
+NameSubClass: if this pointer is not NULL then NameSubClass is the name of the base class were the method are defined. +
+methodName: is the name of the class. +
+param: is an IObjectIA where it defined the parametre of the method. lot of method use a IObjectIA vector object with an NLAIC::CIdentType as the the template argm. +
+Reimplemented from NLAIAGENT::IBasicAgent. +
+Reimplemented in NLAIAGENT::CActorScript, NLAIAGENT::CFsmScript, and NLAIAGENT::CSeqFsmScript. +
+Definition at line 1351 of file agent_script.cpp.
+

+ + + + +
+ + + + + + +
+void NLAIAGENT::CAgentScript::load ( + +NLMISC::IStream & is ) [virtual] +
+
+ + + + + +
+ + + +
+Load the class from a stream. +
+ +
+Reimplemented from NLAIAGENT::IAgent. +
+Reimplemented in NLAIAGENT::CActorScript, NLAIAGENT::CAgentManagerTimer, NLAIAGENT::CGDAgentScript, NLAIAGENT::CFsmScript, NLAIAGENT::CSeqFsmScript, and NLAIAGENT::COperatorScript. +
+Definition at line 418 of file agent_script.cpp.
+

+ + + + +
+ + + + + + +
+const NLAIC::IBasicType * NLAIAGENT::CAgentScript::newInstance ( + +void ) const [virtual] +
+
+ + + + + +
+ + + +
+This function allow a new instance, that mean that the class is a class factory. +
+ +
+Reimplemented from NLAIAGENT::IAgent. +
+Reimplemented in NLAIAGENT::CActorScript, NLAIAGENT::CAgentManagerTimer, NLAIAGENT::CAgentWatchTimer, NLAIAGENT::CAgentClockTimer, NLAIAGENT::CGDAgentScript, NLAIAGENT::CMainAgentScript, NLAIAGENT::CFsmScript, NLAIAGENT::CSeqFsmScript, and NLAIAGENT::COperatorScript. +
+Definition at line 463 of file agent_script.cpp.
+

+ + + + +
+ + + + + + +
+void NLAIAGENT::CAgentScript::onKill ( + +IConnectIA * a ) [virtual] +
+
+ + + + + +
+ + + +
+Called by an agent who's destroyed te remove its references. +
+ +
+Reimplemented from NLAIAGENT::IAgent. +
+Reimplemented in NLAIAGENT::CAgentWatchTimer. +
+Definition at line 510 of file agent_script.cpp.
+

+ + + + +
+ + + + + + + + + + +
+void NLAIAGENT::CAgentScript::processContinuation ( + +IMessageBase * msg, +
+IMessageBase * returnMsg ) [virtual] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 859 of file agent_script.cpp.
+

+ + + + +
+ + + + + + + + + + +
+void NLAIAGENT::CAgentScript::processMessages ( + +IMessageBase * msg, +
+IObjectIA * c ) [virtual] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 811 of file agent_script.cpp.
+

+ + + + +
+ + + + + + +
+void NLAIAGENT::CAgentScript::processMessages ( + +) [virtual] +
+
+ + + + + +
+ + + +
+The processMessages method, process the loop/Run message. +
+ +
+Reimplemented from NLAIAGENT::IAgent. +
+Reimplemented in NLAIAGENT::CActorScript, and NLAIAGENT::CMainAgentScript. +
+Definition at line 952 of file agent_script.cpp.
+

+ + + + +
+ + + + + + +
+void NLAIAGENT::CAgentScript::releaseAgentScript ( + +) [static] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 205 of file agent_script.cpp. +
+Referenced by NLAILINK::releaseIALib().
+

+ + + + +
+ + + + + + +
+void NLAIAGENT::CAgentScript::remOperator ( + +NLAILOGIC::IBaseOperator * op ) [virtual] +
+
+ + + + + +
+ + + +
+Removing operator from th agent. +
+ +
+Definition at line 1011 of file agent_script.cpp.
+

+ + + + +
+ + + + + + +
+IObjectIA::CProcessResult NLAIAGENT::CAgentScript::removeDynamic ( + +NLAIAGENT::IBaseGroupType * g ) [virtual] +
+
+ + + + + +
+ + + +
+remove an agent from the manager. +
+The rgument g must store an CStringType. This string is the name of the agent to remove. The methode return the state of the operation, an digital at 1.0 if the remove is done an digital at 0.0 is the method did'nt find the agent. +
+Definition at line 553 of file agent_script.cpp.
+

+ + + + +
+ + + + + + +
+const IObjectIA::CProcessResult & NLAIAGENT::CAgentScript::run ( + +void ) [virtual] +
+
+ + + + + +
+ + + +
+The work of an agent. +
+Typically agent process child message, process its message and run its activity. +
+Reimplemented from NLAIAGENT::IAgent. +
+Reimplemented in NLAIAGENT::CActorScript, NLAIAGENT::CGDAgentScript, NLAIAGENT::CMainAgentScript, NLAIAGENT::CFsmScript, and NLAIAGENT::COperatorScript. +
+Definition at line 988 of file agent_script.cpp.
+

+ + + + +
+ + + + + + +
+IObjectIA::CProcessResult NLAIAGENT::CAgentScript::runActivity ( + +) [virtual] +
+
+ + + + + +
+ + + +
+Mailer do'nt have own activity. +
+ +
+Reimplemented from NLAIAGENT::IAgent. +
+Reimplemented in NLAIAGENT::CAgentManagerTimer, NLAIAGENT::CAgentWatchTimer, and NLAIAGENT::CAgentClockTimer. +
+Definition at line 973 of file agent_script.cpp.
+

+ + + + +
+ + + + + + +
+IObjectIA::CProcessResult NLAIAGENT::CAgentScript::runAskParentNotify ( + +IBaseGroupType * g ) [virtual] +
+
+ + + + + +
+ + + +
+This function process the message CNotifyParentScript for the runAsk. +
+ +
+Definition at line 604 of file agent_script.cpp.
+

+ + + + +
+ + + + + + +
+void NLAIAGENT::CAgentScript::runChildren ( + +) [virtual] +
+
+ + + + + +
+ + + +
+Run all child. +
+ +
+Reimplemented from NLAIAGENT::IAgent. +
+Reimplemented in NLAIAGENT::CFsmScript, and NLAIAGENT::CSeqFsmScript. +
+Definition at line 795 of file agent_script.cpp.
+

+ + + + +
+ + + + + + + + + + +
+IObjectIA::CProcessResult NLAIAGENT::CAgentScript::runMethodBase ( + +int index, +
+IObjectIA * params ) [virtual] +
+
+ + + + + +
+ + + +
+ +
+Reimplemented in NLAIAGENT::CActorScript, NLAIAGENT::CAgentWatchTimer, NLAIAGENT::CFsmScript, and NLAIAGENT::CSeqFsmScript. +
+Definition at line 1102 of file agent_script.cpp.
+

+ + + + +
+ + + + + + + + + + + + + + +
+IObjectIA::CProcessResult NLAIAGENT::CAgentScript::runMethodBase ( + +int index, +
+int heritance, +
+IObjectIA * params ) [virtual] +
+
+ + + + + +
+ + + +
+ +
+Reimplemented in NLAIAGENT::CActorScript, NLAIAGENT::CAgentWatchTimer, and NLAIAGENT::CSeqFsmScript. +
+Definition at line 1037 of file agent_script.cpp.
+

+ + + + +
+ + + + + + + + + + +
+IObjectIA::CProcessResult NLAIAGENT::CAgentScript::runMethodeMember ( + +sint32 index, +
+IObjectIA * param ) [virtual] +
+
+ + + + + +
+ + + +
+The methode runMethodeMember(sint32 index,IObjectIA *param) allow us to run a own member method. +
+index: is the method id return by the isMember(const IVarName *,const IVarName *,const IObjectIA &) const method. param: is the parametre for the method. +
+Reimplemented from NLAIAGENT::IBasicAgent. +
+Reimplemented in NLAIAGENT::CAgentWatchTimer. +
+Definition at line 1220 of file agent_script.cpp.
+

+ + + + +
+ + + + + + + + + + + + + + +
+IObjectIA::CProcessResult NLAIAGENT::CAgentScript::runMethodeMember ( + +sint32 heritance, +
+sint32 index, +
+IObjectIA * param ) [virtual] +
+
+ + + + + +
+ + + +
+The methode runMethodeMember(sint32 heritance, sint32 index, IObjectIA *param) allow us to run a member method. +
+heritance: is the id returned by the methodisClassInheritedFrom(const IVarName &). index: is the method id return by the isMember(const IVarName *,const IVarName *,const IObjectIA &) const method. param: is the parametre for the method. +
+Reimplemented from NLAIAGENT::IBasicAgent. +
+Definition at line 1165 of file agent_script.cpp.
+

+ + + + +
+ + + + + + +
+IObjectIA::CProcessResult NLAIAGENT::CAgentScript::runTellParentNotify ( + +IBaseGroupType * g ) [virtual] +
+
+ + + + + +
+ + + +
+This function process the message CNotifyParentScript for the runTell. +
+ +
+Definition at line 615 of file agent_script.cpp.
+

+ + + + +
+ + + + + + +
+void NLAIAGENT::CAgentScript::save ( + +NLMISC::IStream & os ) [virtual] +
+
+ + + + + +
+ + + +
+Save the class in a stream. +
+ +
+Reimplemented from NLAIAGENT::IAgent. +
+Reimplemented in NLAIAGENT::CActorScript, NLAIAGENT::CAgentManagerTimer, NLAIAGENT::CGDAgentScript, NLAIAGENT::CFsmScript, NLAIAGENT::CSeqFsmScript, and NLAIAGENT::COperatorScript. +
+Definition at line 406 of file agent_script.cpp.
+

+ + + + +
+ + + + + + + + + + +
+IObjectIA::CProcessResult NLAIAGENT::CAgentScript::sendMessage ( + +const IVarName & compName, +
+IObjectIA * msg ) [virtual] +
+
+ + + + + +
+ + + +
+This method allow to send a message to an compoment given by an string IVarName. +
+ +
+Reimplemented from NLAIAGENT::IObjectIA. +
+Definition at line 703 of file agent_script.cpp.
+

+ + + + +
+ + + + + + +
+IObjectIA::CProcessResult NLAIAGENT::CAgentScript::sendMessage ( + +IObjectIA * m ) [virtual] +
+
+ + + + + +
+ + + +
+sendMessage allow agent to send a message to an ather agent.The message is a IMessageBase. +
+ +
+Reimplemented from NLAIAGENT::IConnectIA. +
+Reimplemented in NLAIAGENT::CActorScript, and NLAIAGENT::CMainAgentScript. +
+Definition at line 732 of file agent_script.cpp.
+

+ + + + +
+ + + + + + + + + + +
+IObjectIA::CProcessResult NLAIAGENT::CAgentScript::sendMessageToDynmaicChild ( + +const IVarName & compName, +
+IObjectIA * msg ) +
+
+ + + + + +
+ + + +
+ +
+Definition at line 690 of file agent_script.cpp.
+

+ + + + +
+ + + + + + +
+IObjectIA::CProcessResult NLAIAGENT::CAgentScript::sendMethod ( + +IObjectIA * param ) +
+
+ + + + + +
+ + + +
+ +
+Definition at line 670 of file agent_script.cpp.
+

+ + + + +
+ + + + + + +
+IObjectIA::CProcessResult NLAIAGENT::CAgentScript::sendMethodCompoment ( + +IObjectIA * param ) +
+
+ + + + + +
+ + + +
+ +
+Definition at line 679 of file agent_script.cpp.
+

+ + + + +
+ + + + + + +
+void NLAIAGENT::CAgentScript::setAgentManager ( + +IAgentManager * manager ) +
+
+ + + + + +
+ + + +
+Set the manager for this instance. +
+ +
+Definition at line 322 of file agent_script.cpp.
+

+ + + + +
+ + + + + + + + + + +
+void NLAIAGENT::CAgentScript::setStaticMember ( + +sint32 index, +
+IObjectIA * op ) [virtual] +
+
+ + + + + +
+ + + +
+to cahnge a given components given by a string. +
+ +
+Reimplemented from NLAIAGENT::IObjectIA. +
+Definition at line 341 of file agent_script.cpp.
+

Member Data Documentation

+ + + + +
+ + + + + +
+const NLAIC::CIdentType NLAIAGENT::CAgentScript::IdAgentScript [static] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 162 of file agent_script.h.
+

+ + + + +
+ + + + + +
+NLAISCRIPT::COperandSimpleListOr * NLAIAGENT::CAgentScript::IdMsgNotifyParent = NULL [static] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 58 of file agent_script.cpp.
+

+ + + + +
+ + + + + +
+NLAISCRIPT::COperandSimple * NLAIAGENT::CAgentScript::IdMsgNotifyParentClass = NULL [static] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 57 of file agent_script.cpp.
+

+ + + + +
+ + + + + +
+NLAISCRIPT::CParam * NLAIAGENT::CAgentScript::ParamRunParentNotify = NULL [static] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 59 of file agent_script.cpp.
+

+ + + + +
+ + + + + +
+NLAISCRIPT::CParam * NLAIAGENT::CAgentScript::SendCompParamMessageScript = NULL [static] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 56 of file agent_script.cpp.
+

+ + + + +
+ + + + + +
+NLAISCRIPT::CParam * NLAIAGENT::CAgentScript::SendParamMessageScript = NULL [static] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 55 of file agent_script.cpp.
+

+ + + + +
+ + + + + +
+CAgentScript::CMethodCall ** NLAIAGENT::CAgentScript::StaticMethod = NULL [static] +
+
+ + + + + +
+ + + +
+ +
+Reimplemented in NLAIAGENT::CAgentWatchTimer. +
+Definition at line 60 of file agent_script.cpp.
+

+ + + + +
+ + + + + +
+NLAISCRIPT::CAgentClass * NLAIAGENT::CAgentScript::_AgentClass [protected] +
+
+ + + + + +
+ + + +
+The creator of this instance. This useful for find scripted method entry point. +
+ +
+Definition at line 159 of file agent_script.h.
+

+ + + + +
+ + + + + +
+IAgentManager * NLAIAGENT::CAgentScript::_AgentManager [protected] +
+
+ + + + + +
+ + + +
+The manager where the agent is run this manager have the agent script context. +
+ +
+Definition at line 148 of file agent_script.h.
+

+ + + + +
+ + + + + +
+IObjectIA ** NLAIAGENT::CAgentScript::_Components [protected] +
+
+ + + + + +
+ + + +
+Table of static compoments. +
+ +
+Definition at line 142 of file agent_script.h.
+

+ + + + +
+ + + + + +
+tsetDefNameAgent NLAIAGENT::CAgentScript::_DynamicAgentName [protected] +
+
+ + + + + +
+ + + +
+Map for store agent added in the dynamic child container. +
+Note that if message have a run message for prossing message, this message is achieve in this mail box, else he is achive in the base class mail box. +
+Definition at line 155 of file agent_script.h.
+

+ + + + +
+ + + + + +
+int NLAIAGENT::CAgentScript::_NbComponents [protected] +
+
+ + + + + +
+ + + +
+Nomber of static compoment. +
+ +
+Definition at line 144 of file agent_script.h.
+

+ + + + +
+ + + + + +
+NLAISCRIPT::COperandSimpleListOr * NLAIAGENT::CAgentScript::msgPerf = NULL [static] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 54 of file agent_script.cpp.
+

+ + + + +
+ + + + + +
+NLAISCRIPT::COperandSimpleListOr * NLAIAGENT::CAgentScript::msgType = NULL [static] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 53 of file agent_script.cpp.
+

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

+ + + +
+

+ + -- cgit v1.2.1

NLAIAGENT::CAgentScript Class Reference

Public Types

Public Methods

Static Public Methods

Static Public Attributes