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

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

+#include <message_script.h> +

+Inheritance diagram for NLAIAGENT::CMessageScript

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

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

Public Methods
	CMessageScript (const CMessageScript &)
	CMessageScript (NLAISCRIPT::CMessageClass *b = NULL)
	CMessageScript ( std::list<IObjectIA > &, NLAISCRIPT::CMessageClass )
virtual	~CMessageScript ()
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...
virtual sint32	getBaseMethodCount () const
	Return the nomber of internal C++ hard coded method that the class can process. More...
const NLAISCRIPT::CMessageClass*	getCreatorClass () const
IObjectIA member class.
virtual sint32	getMethodIndexSize () const
	getMethodIndexSize define the nomber of external method. More...
virtual tQueue	isMember (const IVarName ,const IVarName ,const IObjectIA &) const
	The method isMember(nameSubClass,methodName,param) return the best method correspondent to the search. More...
virtual sint32	isClassInheritedFrom (const IVarName &) const
	isClassInheritedFrom(className) allow us to known if this class have a base class with the name className. More...
virtual IObjectIA::CProcessResult	runMethodeMember (sint32, sint32, 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 void	setStaticMember (sint32,IObjectIA *)
	to cahnge a given components given by a string. More...
virtual const IObjectIA*	getStaticMember (sint32) const
	to get the pointer of a given components referened by an index. More...
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 CProcessResult&	run ()
	Some where Run method define the process of the agen. More...
IBasicObjectIA member class.
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...
NLAIC::IBasicInterface member class.
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 Attributes
const NLAIC::CIdentType	IdMessageScript
Protected Attributes
NLAISCRIPT::CMessageClass*	_MessageClass

Detailed Description

+Class for managing message agent script. +

+Note that it is write with the same model of CAgentScript but don't have the same base class, because message is not an agent and message must be very light. Remember agent have connection list, child list and a mail boxe, this is incompatible with spirit of message. +

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

+Date:: + 2000

+ +

+Definition at line 47 of file message_script.h.

Constructor & Destructor Documentation

+ + + + +
+ + + + + + +
+NLAIAGENT::CMessageScript::CMessageScript ( + +const CMessageScript & m ) +
+
+ + + + + +
+ + + +
+ +
+Definition at line 36 of file message_script.cpp.
+

+ + + + +
+ + + + + + +
+NLAIAGENT::CMessageScript::CMessageScript ( + +NLAISCRIPT::CMessageClass * b = NULL ) +
+
+ + + + + +
+ + + +
+ +
+Definition at line 44 of file message_script.cpp.
+

+ + + + +
+ + + + + + + + + + +
+NLAIAGENT::CMessageScript::CMessageScript ( + +std::list< IObjectIA *>& components, +
+NLAISCRIPT::CMessageClass * message_class ) +
+
+ + + + + +
+ + + +
+ +
+Definition at line 50 of file message_script.cpp.
+

+ + + + +
+ + + + + + +
+NLAIAGENT::CMessageScript::~CMessageScript ( + +) [virtual] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 69 of file message_script.cpp.
+

Member Function Documentation

+ + + + +
+ + + + + + +
+const NLAIC::IBasicType * NLAIAGENT::CMessageScript::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. +
+Reimplemented in NLAIAGENT::CSuccessMsg, NLAIAGENT::CFailureMsg, NLAIAGENT::CMsgDebug, NLAIAGENT::CFactMsg, NLAIAGENT::CGoalMsg, NLAIAGENT::CCancelGoalMsg, NLAIAGENT::CNotifyParentScript, and NLAIAGENT::COnChangeMsg. +
+Definition at line 327 of file message_script.cpp.
+

+ + + + +
+ + + + + + +
+sint32 NLAIAGENT::CMessageScript::getBaseMethodCount ( + +) const [virtual] +
+
+ + + + + +
+ + + +
+Return the nomber of internal C++ hard coded method that the class can process. +
+ +
+Reimplemented in NLAIAGENT::CSuccessMsg, NLAIAGENT::CFailureMsg, NLAIAGENT::CFactMsg, NLAIAGENT::CGoalMsg, NLAIAGENT::CCancelGoalMsg, and NLAIAGENT::COnChangeMsg. +
+Definition at line 80 of file message_script.cpp.
+

+ + + + +
+ + + + + + +
+const NLAISCRIPT::CMessageClass * NLAIAGENT::CMessageScript::getCreatorClass ( + +) const [inline] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 101 of file message_script.h.
+

+ + + + +
+ + + + + + +
+void NLAIAGENT::CMessageScript::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::IMessageBase. +
+Reimplemented in NLAIAGENT::CSuccessMsg, NLAIAGENT::CFailureMsg, NLAIAGENT::CMsgDebug, NLAIAGENT::CFactMsg, NLAIAGENT::CGoalMsg, NLAIAGENT::CCancelGoalMsg, NLAIAGENT::CNotifyParentScript, and NLAIAGENT::COnChangeMsg. +
+Definition at line 347 of file message_script.cpp.
+

+ + + + +
+ + + + + + +
+sint32 NLAIAGENT::CMessageScript::getMethodIndexSize ( + +) const [virtual] +
+
+ + + + + +
+ + + +
+getMethodIndexSize define the nomber of external method. +
+ +
+Reimplemented from NLAIAGENT::IMessageBase. +
+Definition at line 75 of file message_script.cpp.
+

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

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

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

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

+ + + + +
+ + + + + + +
+sint32 NLAIAGENT::CMessageScript::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 291 of file message_script.cpp.
+

+ + + + +
+ + + + + + +
+const NLAIC::CIdentType & NLAIAGENT::CMessageScript::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. +
+Reimplemented in NLAIAGENT::CSuccessMsg, NLAIAGENT::CFailureMsg, NLAIAGENT::CMsgDebug, NLAIAGENT::CFactMsg, NLAIAGENT::CGoalMsg, NLAIAGENT::CCancelGoalMsg, NLAIAGENT::CNotifyParentScript, and NLAIAGENT::COnChangeMsg. +
+Definition at line 377 of file message_script.cpp.
+

+ + + + +
+ + + + + + +
+sint32 NLAIAGENT::CMessageScript::isClassInheritedFrom ( + +const IVarName & class_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::IBaseGroupType. +
+Definition at line 256 of file message_script.cpp.
+

+ + + + +
+ + + + + + +
+bool NLAIAGENT::CMessageScript::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::IMessageBase. +
+Definition at line 372 of file message_script.cpp.
+

+ + + + +
+ + + + + + + + + + + + + + +
+tQueue NLAIAGENT::CMessageScript::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::IMessageBase. +
+Reimplemented in NLAIAGENT::CSuccessMsg, NLAIAGENT::CFailureMsg, NLAIAGENT::CFactMsg, NLAIAGENT::CGoalMsg, NLAIAGENT::CCancelGoalMsg, and NLAIAGENT::COnChangeMsg. +
+Definition at line 296 of file message_script.cpp.
+

+ + + + +
+ + + + + + +
+void NLAIAGENT::CMessageScript::load ( + +NLMISC::IStream & is ) [virtual] +
+
+ + + + + +
+ + + +
+Load the class from a stream. +
+ +
+Reimplemented from NLAIAGENT::IMessageBase. +
+Definition at line 322 of file message_script.cpp.
+

+ + + + +
+ + + + + + +
+const NLAIC::IBasicType * NLAIAGENT::CMessageScript::newInstance ( + +void ) const [virtual] +
+
+ + + + + +
+ + + +
+This function allow a new instance, that mean that the class is a class factory. +
+ +
+Reimplemented from NLAIC::IBasicType. +
+Reimplemented in NLAIAGENT::CSuccessMsg, NLAIAGENT::CFailureMsg, NLAIAGENT::CMsgDebug, NLAIAGENT::CFactMsg, NLAIAGENT::CGoalMsg, NLAIAGENT::CCancelGoalMsg, NLAIAGENT::CNotifyParentScript, and NLAIAGENT::COnChangeMsg. +
+Definition at line 333 of file message_script.cpp.
+

+ + + + +
+ + + + + + +
+const IObjectIA::CProcessResult & NLAIAGENT::CMessageScript::run ( + +void ) [virtual] +
+
+ + + + + +
+ + + +
+Some where Run method define the process of the agen. +
+ +
+Reimplemented from NLAIAGENT::IListBasicManager. +
+Definition at line 385 of file message_script.cpp.
+

+ + + + +
+ + + + + + + + + + +
+IObjectIA::CProcessResult NLAIAGENT::CMessageScript::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::IMessageBase. +
+Reimplemented in NLAIAGENT::CSuccessMsg, NLAIAGENT::CFailureMsg, NLAIAGENT::CFactMsg, NLAIAGENT::CGoalMsg, NLAIAGENT::CCancelGoalMsg, and NLAIAGENT::COnChangeMsg. +
+Definition at line 185 of file message_script.cpp.
+

+ + + + +
+ + + + + + + + + + + + + + +
+IObjectIA::CProcessResult NLAIAGENT::CMessageScript::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::IMessageBase. +
+Reimplemented in NLAIAGENT::CSuccessMsg, NLAIAGENT::CFailureMsg, NLAIAGENT::CFactMsg, NLAIAGENT::CGoalMsg, NLAIAGENT::CCancelGoalMsg, and NLAIAGENT::COnChangeMsg. +
+Definition at line 114 of file message_script.cpp.
+

+ + + + +
+ + + + + + +
+void NLAIAGENT::CMessageScript::save ( + +NLMISC::IStream & os ) [virtual] +
+
+ + + + + +
+ + + +
+Save the class in a stream. +
+ +
+Reimplemented from NLAIAGENT::IMessageBase. +
+Definition at line 317 of file message_script.cpp.
+

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

Member Data Documentation

+ + + + +
+ + + + + +
+const NLAIC::CIdentType NLAIAGENT::CMessageScript::IdMessageScript [static] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 50 of file message_script.h.
+

+ + + + +
+ + + + + +
+NLAISCRIPT::CMessageClass * NLAIAGENT::CMessageScript::_MessageClass [protected] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 52 of file message_script.h.
+

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

+ + + +
+

+ + -- cgit v1.2.1

NLAIAGENT::CMessageScript Class Reference

Public Methods

Static Public Attributes

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation