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/classNLAISCRIPT_1_1CParam.html | 1183 +++++++++++++++++++++++ 1 file changed, 1183 insertions(+) create mode 100644 docs/doxygen/nel/classNLAISCRIPT_1_1CParam.html (limited to 'docs/doxygen/nel/classNLAISCRIPT_1_1CParam.html') diff --git a/docs/doxygen/nel/classNLAISCRIPT_1_1CParam.html b/docs/doxygen/nel/classNLAISCRIPT_1_1CParam.html new file mode 100644 index 00000000..f5d0f5c5 --- /dev/null +++ b/docs/doxygen/nel/classNLAISCRIPT_1_1CParam.html @@ -0,0 +1,1183 @@ + + + + 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 +

NLAISCRIPT::CParam Class Reference

Class CParam. +More... +

+#include <interpret_methodes.h> +

Inheritance diagram for NLAISCRIPT::CParam: +

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

Public Methods
	CParam ()
	CParam (const CParam &)
	CParam (int count,...)
virtual	~CParam ()
bool	operator== (const CParam &p) const
	Need to know if a CParam is equal as an ather. More...
double	eval (const CParam &p) const
	Return the distance between to arguments. More...
void	operator= (const CParam &p)
	Make equality. More...
const IOpType *	operator[] (sint32 i) const
	get a parameter in the vector. More...
void	push (const NLAIAGENT::IBaseGroupType &)
	Push new parameter type define in a list define by an NLAIAGENT::IBaseGroupType object. More...
void	push (const IOpType &)
	Push new parameter type. Here we clone the arguments. More...
void	push (IOpType *i)
	Push new parameter type. User have to make an incRef(). More...
const IOpType &	get () const
	get the last parameter added. More...
void	pop ()
	pop the last parameter added. More...
void	clear ()
	Clear the vector containt. More...
sint32	size () const
	get vector size. More...
const NLAIAGENT::IBaseGroupType *	getInfo () const
void	setInfo (NLAIAGENT::IBaseGroupType *)
void	getString (std::string &txt) const
NLAIC::IBasicInterface and NLAIAGENT::IObjectIA method.
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 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 &) 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 bool	isEqual (const NLAIAGENT::IBasicObjectIA &) const
void	load (NLMISC::IStream &)
	Load the class from a stream. More...
void	save (NLMISC::IStream &)
	Save the class in a stream. More...
virtual const NLAIAGENT::IObjectIA::CProcessResult &	run ()
	Some where Run method define the process of the agen. More...
Static Public Attributes
const NLAIC::CIdentType	IdParam
Private Types
typedef std::vector< IOpType * >	tParam
Private Attributes
tParam	_Param
	Vector that is contain a IOpType argument type. More...
NLAIAGENT::IBaseGroupType *	_ParamInfo

Detailed Description

+Class CParam. +

+This class is an type container who's strored the arguments type of a given method. +

+Author:: +Chafik sameh , Nevrax France

+Date:: +2000

+ +

+Definition at line 46 of file interpret_methodes.h.

Member Typedef Documentation

+ + + + +
+ + +
typedef std::vector<IOpType *> NLAISCRIPT::CParam::tParam [private] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 49 of file interpret_methodes.h.
+

Constructor & Destructor Documentation

+ + + + +
+ + + + + + + + + +
NLAISCRIPT::CParam::CParam ( )
+
+ + + + + +
+ + + +
+ +
+Definition at line 34 of file interpret_methodes.cpp. +
+Referenced by clone, isEqual, and newInstance.
+

+ + + + +
+ + + + + + + + + + +
NLAISCRIPT::CParam::CParam ( const CParam & )
+
+ + + + + +
+ + + +
+ +
+Definition at line 35 of file interpret_methodes.cpp. +
+References _Param.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
NLAISCRIPT::CParam::CParam ( int count,
...
)
+
+ + + + + +
+ + + +
+ +
+Definition at line 43 of file interpret_methodes.cpp. +
+References _Param.
+

+ + + + +
+ + + + + + + + + +
NLAISCRIPT::CParam::~CParam ( ) [virtual]
+
+ + + + + +
+ + + +
+ +
+Definition at line 205 of file interpret_methodes.cpp. +
+References _Param.
+

Member Function Documentation

+ + + + +
+ + + + + + + + + +
void NLAISCRIPT::CParam::clear ( )
+
+ + + + + +
+ + + +
+Clear the vector containt. +
+ +
+Definition at line 185 of file interpret_methodes.cpp. +
+References _Param, and pop.
+

+ + + + +
+ + + + + + + + + +
const NLAIC::IBasicType * NLAISCRIPT::CParam::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 136 of file interpret_methodes.cpp. +
+References CParam. +
+Referenced by operator=.
+

+ + + + +
+ + + + + + + + + + +
double NLAISCRIPT::CParam::eval ( const CParam & p ) const
+
+ + + + + +
+ + + +
+Return the distance between to arguments. +
+An infinite result is defined by a negative value and represent an unequal argument. 0.0 value mean that the two arguments is equal. A positive value mean that some of parameter is unequal but have the same based class, in this configuration the return value represent how far the two class was between the base class. More the value is more far the class is. +
+Definition at line 68 of file interpret_methodes.cpp. +
+References _Param, NLAISCRIPT::l, and r. +
+Referenced by NLAIAGENT::IBasicAgent::isMember, and NLAIAGENT::IVector::isMember.
+

+ + + + +
+ + + + + + + + + +
const IOpType & NLAISCRIPT::CParam::get ( ) const
+
+ + + + + +
+ + + +
+get the last parameter added. +
+ +
+Definition at line 175 of file interpret_methodes.cpp. +
+References _Param.
+

+ + + + +
+ + + + + + + + + + +
void NLAISCRIPT::CParam::getDebugString ( std::string & ) 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 213 of file interpret_methodes.cpp. +
+References getString, and t.
+

+ + + + +
+ + + + + + + + + +
const NLAIAGENT::IBaseGroupType* NLAISCRIPT::CParam::getInfo ( ) const [inline]
+
+ + + + + +
+ + + +
+ +
+Definition at line 117 of file interpret_methodes.h.
+

+ + + + +
+ + + + + + + + + + +
void NLAISCRIPT::CParam::getString ( std::string & txt ) const
+
+ + + + + +
+ + + +
+ +
+Definition at line 257 of file interpret_methodes.cpp. +
+References _Param, id, and size. +
+Referenced by getDebugString.
+

+ + + + +
+ + + + + + + + + +
const NLAIC::CIdentType & NLAISCRIPT::CParam::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 252 of file interpret_methodes.cpp. +
+References IdParam.
+

+ + + + +
+ + + + + + + + + + +
bool NLAISCRIPT::CParam::isEqual ( const NLAIAGENT::IBasicObjectIA & ) const [virtual]
+
+ + + + + +
+ + + +
+ +
+Definition at line 245 of file interpret_methodes.cpp. +
+References CParam.
+

+ + + + +
+ + + + + + + + + + +
void NLAISCRIPT::CParam::load ( NLMISC::IStream & ) [virtual]
+
+ + + + + +
+ + + +
+Load the class from a stream. +
+ +
+Implements NLAIC::IBasicInterface. +
+Definition at line 218 of file interpret_methodes.cpp. +
+References _Param, and NLMISC::IStream::serial.
+

+ + + + +
+ + + + + + + + + +
const NLAIC::IBasicType * NLAISCRIPT::CParam::newInstance ( ) const [virtual]
+
+ + + + + +
+ + + +
+This function allow a new instance, that mean that the class is a class factory. +
+ +
+Implements NLAIC::IBasicType. +
+Definition at line 142 of file interpret_methodes.cpp. +
+References CParam.
+

+ + + + +
+ + + + + + + + + + +
void NLAISCRIPT::CParam::operator= ( const CParam & p )
+
+ + + + + +
+ + + +
+Make equality. +
+ +
+Definition at line 128 of file interpret_methodes.cpp. +
+References _Param, and clone.
+

+ + + + +
+ + + + + + + + + + +
bool NLAISCRIPT::CParam::operator== ( const CParam & p ) const
+
+ + + + + +
+ + + +
+Need to know if a CParam is equal as an ather. +
+ +
+Definition at line 55 of file interpret_methodes.cpp. +
+References _Param, and NLAISCRIPT::l.
+

+ + + + +
+ + + + + + + + + + +
const IOpType * NLAISCRIPT::CParam::operator[] ( sint32 i ) const
+
+ + + + + +
+ + + +
+get a parameter in the vector. +
+ +
+Definition at line 149 of file interpret_methodes.cpp. +
+References _Param.
+

+ + + + +
+ + + + + + + + + +
void NLAISCRIPT::CParam::pop ( )
+
+ + + + + +
+ + + +
+pop the last parameter added. +
+ +
+Definition at line 180 of file interpret_methodes.cpp. +
+References _Param. +
+Referenced by clear.
+

+ + + + +
+ + + + + + + + + + +
void NLAISCRIPT::CParam::push ( IOpType * i )
+
+ + + + + +
+ + + +
+Push new parameter type. User have to make an incRef(). +
+ +
+Definition at line 170 of file interpret_methodes.cpp. +
+References _Param.
+

+ + + + +
+ + + + + + + + + + +
void NLAISCRIPT::CParam::push ( const IOpType & )
+
+ + + + + +
+ + + +
+Push new parameter type. Here we clone the arguments. +
+ +
+Definition at line 165 of file interpret_methodes.cpp. +
+References _Param.
+

+ + + + +
+ + + + + + + + + + +
void NLAISCRIPT::CParam::push ( const NLAIAGENT::IBaseGroupType & )
+
+ + + + + +
+ + + +
+Push new parameter type define in a list define by an NLAIAGENT::IBaseGroupType object. +
+ +
+Definition at line 154 of file interpret_methodes.cpp. +
+References NLAIAGENT::IBaseGroupType::getConstIterator, NLAIC::IBasicType::getType, and NLAIAGENT::CConstIteratorContener::isInEnd. +
+Referenced by NLAIAGENT::IVector::isMember.
+

+ + + + +
+ + + + + + + + + +
const NLAIAGENT::IObjectIA::CProcessResult & NLAISCRIPT::CParam::run ( ) [virtual]
+
+ + + + + +
+ + + +
+Some where Run method define the process of the agen. +
+ +
+Implements NLAIAGENT::IObjectIA. +
+Definition at line 200 of file interpret_methodes.cpp. +
+References NLAIAGENT::IObjectIA::ProcessRun.
+

+ + + + +
+ + + + + + + + + + +
void NLAISCRIPT::CParam::save ( NLMISC::IStream & ) [virtual]
+
+ + + + + +
+ + + +
+Save the class in a stream. +
+ +
+Implements NLAIC::IBasicInterface. +
+Definition at line 235 of file interpret_methodes.cpp. +
+References _Param, and NLMISC::IStream::serial.
+

+ + + + +
+ + + + + + + + + + +
void NLAISCRIPT::CParam::setInfo ( NLAIAGENT::IBaseGroupType * )
+
+ + + + + +
+ + + +
+ +
+Definition at line 278 of file interpret_methodes.cpp. +
+References _ParamInfo, and NLAIC::IPointerGestion::release.
+

+ + + + +
+ + + + + + + + + +
sint32 NLAISCRIPT::CParam::size ( ) const
+
+ + + + + +
+ + + +
+get vector size. +
+ +
+Definition at line 195 of file interpret_methodes.cpp. +
+References _Param. +
+Referenced by getString, NLAIAGENT::CVectorGroupType::isMember, and NLAIAGENT::IVector::isMember.
+

Member Data Documentation

+ + + + +
+ + +
tParam NLAISCRIPT::CParam::_Param [private] +
+
+ + + + + +
+ + + +
+Vector that is contain a IOpType argument type. +
+ +
+Definition at line 52 of file interpret_methodes.h. +
+Referenced by clear, CParam, eval, get, getString, load, operator=, operator==, operator[], pop, push, save, size, and ~CParam.
+

+ + + + +
+ + +
NLAIAGENT::IBaseGroupType* NLAISCRIPT::CParam::_ParamInfo [private] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 53 of file interpret_methodes.h. +
+Referenced by setInfo.
+

+ + + + +
+ + +
const NLAIC::CIdentType NLAISCRIPT::CParam::IdParam [static] +
+
+ + + + + +
+ + + +
+ +
+Referenced by getType.
+

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

+ + + +
+

+ + -- cgit v1.2.1

NLAISCRIPT::CParam Class Reference

Public Methods

Static Public Attributes

Private Types

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation