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

+ + + + + + + + + + + + + + + + + + + + + + + + +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
virtual void	setAgentManager (IAgentManager *)
IObjectIA member class.
virtual sint32	getMethodIndexSize () const
	getMethodIndexSize define the nomber of method define in the class. 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 bool	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 (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 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:: +Chafik sameh , Nevrax France

+Date:: +2000

+ +

+Definition at line 48 of file message_script.h.

Constructor & Destructor Documentation

+ + + + +
+ + + + + + + + + + +
NLAIAGENT::CMessageScript::CMessageScript ( const CMessageScript & )
+
+ + + + + +
+ + + +
+ +
+Definition at line 36 of file message_script.cpp. +
+References _MessageClass. +
+Referenced by clone, and newInstance.
+

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

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
NLAIAGENT::CMessageScript::CMessageScript ( std::list< IObjectIA * > & ,
NLAISCRIPT::CMessageClass *
)
+
+ + + + + +
+ + + +
+ +
+Definition at line 50 of file message_script.cpp. +
+References components, NLAIAGENT::IMessageBase::setGroup, NLAIAGENT::IMessageBase::setMessageGroup, and x.
+

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

Member Function Documentation

+ + + + +
+ + + + + + + + + +
const NLAIC::IBasicType * NLAIAGENT::CMessageScript::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. +
+Reimplemented in NLAIAGENT::CSuccessMsg. +
+Definition at line 333 of file message_script.cpp. +
+References CMessageScript.
+

+ + + + +
+ + + + + + + + + +
sint32 NLAIAGENT::CMessageScript::getBaseMethodCount ( ) const [virtual]
+
+ + + + + +
+ + + +
+Return the nomber of internal C++ hard coded method that the class can process. +
+ +
+Reimplemented in NLAIAGENT::CSuccessMsg. +
+Definition at line 83 of file message_script.cpp. +
+Referenced by runMethodeMember.
+

+ + + + +
+ + + + + + + + + + +
void NLAIAGENT::CMessageScript::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. +
+ +
+Reimplemented from NLAIAGENT::IMessageBase. +
+Reimplemented in NLAIAGENT::CSuccessMsg. +
+Definition at line 354 of file message_script.cpp. +
+References _MessageClass, NLAISCRIPT::CAgentClass::getComponent, NLAISCRIPT::CAgentClass::getComponentName, NLAISCRIPT::CMessageClass::getType, NLAIAGENT::IListBasicManager::size, NLAIC::stringGetBuild, and t.
+

+ + + + +
+ + + + + + + + + + +
NLAISCRIPT::IOpCode * NLAIAGENT::CMessageScript::getMethode ( sint32 index )
+
+ + + + + +
+ + + +
+get the closure correspondent of the method indexed by index. +
+ +
+Definition at line 105 of file message_script.cpp. +
+References _MessageClass, NLAISCRIPT::CAgentClass::getBrancheCode, NLAISCRIPT::CAgentClass::getMethodIndexSize, and index.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
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 89 of file message_script.cpp. +
+References _MessageClass, NLAISCRIPT::CAgentClass::getBrancheCode, NLAISCRIPT::CAgentClass::getMethodIndexSize, index, and NLAISCRIPT::CAgentClass::sizeVTable. +
+Referenced by runMethodeMember.
+

+ + + + +
+ + + + + + + + + +
sint32 NLAIAGENT::CMessageScript::getMethodIndexSize ( ) const [virtual]
+
+ + + + + +
+ + + +
+getMethodIndexSize define the nomber of method define in the class. +
+ +
+Reimplemented from NLAIAGENT::IMessageBase. +
+Definition at line 78 of file message_script.cpp. +
+References _MessageClass, and NLAISCRIPT::CAgentClass::getMethodIndexSize.
+

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

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

+ + + + +
+ + + + + + + + + +
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 296 of file message_script.cpp.
+

+ + + + +
+ + + + + + + + + +
const NLAIC::CIdentType & NLAIAGENT::CMessageScript::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. +
+Reimplemented in NLAIAGENT::CSuccessMsg. +
+Definition at line 385 of file message_script.cpp. +
+References _MessageClass, NLAISCRIPT::CMessageClass::getType, and IdMessageScript.
+

+ + + + +
+ + + + + + + + + + +
sint32 NLAIAGENT::CMessageScript::isClassInheritedFrom ( const IVarName & ) 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 259 of file message_script.cpp. +
+References _MessageClass, and NLAISCRIPT::CAgentClass::isClassInheritedFrom.
+

+ + + + +
+ + + + + + + + + + +
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 380 of file message_script.cpp. +
+References isEqual.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
tQueue NLAIAGENT::CMessageScript::isMember ( const IVarName * ,
const IVarName * ,
const IObjectIA &
) 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. +
+Definition at line 301 of file message_script.cpp. +
+References NLAISCRIPT::COperandVoid::clone, param, r, t, and NLAIAGENT::tQueue.
+

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

+ + + + +
+ + + + + + + + + +
const NLAIC::IBasicType * NLAIAGENT::CMessageScript::newInstance ( ) const [virtual]
+
+ + + + + +
+ + + +
+This function allow a new instance, that mean that the class is a class factory. +
+ +
+Implements NLAIC::IBasicType. +
+Reimplemented in NLAIAGENT::CSuccessMsg. +
+Definition at line 340 of file message_script.cpp. +
+References _MessageClass, NLAISCRIPT::CMessageClass::buildNewInstance, and CMessageScript.
+

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

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
IObjectIA::CProcessResult NLAIAGENT::CMessageScript::runMethodeMember ( sint32 index,
IObjectIA *
) [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. +
+Definition at line 188 of file message_script.cpp. +
+References NLAISCRIPT::CCodeContext::Code, NLAISCRIPT::CCodeContext::ContextDebug, getBaseMethodCount, getMethode, NLAISCRIPT::CCodeContext::IdCodeContext, index, NLAIAGENT::IObjectIA::IObjectIA, NLAISCRIPT::CCodeContext::Param, r, and NLAISCRIPT::CCodeContext::Stack.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
IObjectIA::CProcessResult NLAIAGENT::CMessageScript::runMethodeMember ( sint32 ,
sint32 ,
IObjectIA *
) [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. +
+Definition at line 117 of file message_script.cpp. +
+References NLAISCRIPT::CCodeContext::Code, NLAISCRIPT::CCodeContext::ContextDebug, getBaseMethodCount, getMethode, NLAISCRIPT::CCodeContext::IdCodeContext, index, NLAIAGENT::IObjectIA::IObjectIA, NLAISCRIPT::CCodeContext::Param, r, and NLAISCRIPT::CCodeContext::Stack.
+

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

+ + + + +
+ + + + + + + + + + +
virtual void NLAIAGENT::CMessageScript::setAgentManager ( IAgentManager * ) [inline, virtual]
+
+ + + + + +
+ + + +
+ +
+Definition at line 107 of file message_script.h.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
bool NLAIAGENT::CMessageScript::setStaticMember ( sint32 ,
IObjectIA *
) [virtual]
+
+ + + + + +
+ + + +
+to cahnge a given components given by a string. +
+ +
+Reimplemented from NLAIAGENT::IObjectIA. +
+Definition at line 264 of file message_script.cpp. +
+References NLAIAGENT::IMessageBase::getMessageGroup, index, NLAIAGENT::IObjectIA::IObjectIA, and NLAIAGENT::IListBasicManager::size.
+

Member Data Documentation

+ + + + +
+ + +
NLAISCRIPT::CMessageClass* NLAIAGENT::CMessageScript::_MessageClass [protected] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 53 of file message_script.h. +
+Referenced by CMessageScript, getDebugString, getMethode, getMethodIndexSize, getStaticMemberIndex, getType, isClassInheritedFrom, and newInstance.
+

+ + + + +
+ + +
const NLAIC::CIdentType CMessageScript::IdMessageScript [static] +
+
+ + + + + +
+ + + +
+ +
+Referenced by NLAISCRIPT::CMessageClass::CMessageClass, and getType.
+

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