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

Class CVarPStackParam. +More... +

+#include <varstack.h> +

Inheritance diagram for NLAISCRIPT::CVarPStackParam: +

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

Public Methods
	CVarPStackParam (sint32 val)
	CVarPStackParam (const CVarPStackParam &v)
const NLAIAGENT::IObjectIA *	getObjectIAClone () const
	Clone the object stored in the heap. More...
const NLAIC::CIdentType &	getVarType (void) const
	get the type of the object stored in the heap. More...
const NLAIAGENT::IObjectIA *	getObject (void) const
	get the object stored in the heap. More...
sint32	getIndex () const
	get index of the object. More...
virtual	~CVarPStackParam ()
Base class method.
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...
const NLAIC::IBasicType *	newInstance () const
	This function allow a new instance, that mean that the class is a class factory. More...
void	save (NLMISC::IStream &os)
	Save the class in a stream. More...
void	load (NLMISC::IStream &is)
	Load the class from a stream. More...
const NLAIC::CIdentType &	getType (void) const
	getType return a unique string how represente the class, it can be the name of the class. More...
void	getDebugString (std::string &text) 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...
bool	isEqual (const NLAIAGENT::IBasicObjectIA &a) const
const NLAIAGENT::IObjectIA::CProcessResult &	run ()
	Some where Run method define the process of the agen. More...
virtual NLAIAGENT::IObjetOp &	neg ()
	throw (NLAIE::CExceptionNotImplemented). More...
NLAIAGENT::IObjetOp &	operator+= (const NLAIAGENT::IObjetOp &a)
NLAIAGENT::IObjetOp &	operator-= (const NLAIAGENT::IObjetOp &a)
NLAIAGENT::IObjetOp &	operator *= (const NLAIAGENT::IObjetOp &a)
NLAIAGENT::IObjetOp &	operator/= (const NLAIAGENT::IObjetOp &a)
NLAIAGENT::IObjetOp *	operator+ (const NLAIAGENT::IObjetOp &a)
NLAIAGENT::IObjetOp *	operator- (const NLAIAGENT::IObjetOp &a)
NLAIAGENT::IObjetOp *	operator * (const NLAIAGENT::IObjetOp &a)
NLAIAGENT::IObjetOp *	operator/ (const NLAIAGENT::IObjetOp &a)
NLAIAGENT::IObjetOp *	operator< (NLAIAGENT::IObjetOp &a) const
	throw (NLAIE::CExceptionNotImplemented). More...
NLAIAGENT::IObjetOp *	operator> (NLAIAGENT::IObjetOp &a) const
	throw (NLAIE::CExceptionNotImplemented). More...
NLAIAGENT::IObjetOp *	operator<= (NLAIAGENT::IObjetOp &a) const
	throw (NLAIE::CExceptionNotImplemented). More...
NLAIAGENT::IObjetOp *	operator>= (NLAIAGENT::IObjetOp &a) const
	throw (NLAIE::CExceptionNotImplemented). More...
NLAIAGENT::IObjetOp *	operator! () const
	throw (NLAIE::CExceptionNotImplemented). More...
NLAIAGENT::IObjetOp *	operator!= (NLAIAGENT::IObjetOp &a) const
	throw (NLAIE::CExceptionNotImplemented). More...
NLAIAGENT::IObjetOp *	operator== (NLAIAGENT::IObjetOp &a) const
	throw (NLAIE::CExceptionNotImplemented). More...
bool	isTrue () const
	throw (NLAIE::CExceptionNotImplemented). More...
Static Public Attributes
NLAIC::CIdentType	IdVarPStackParam
sint32	_Shift = 0
Private Attributes
sint32	_Val

Detailed Description

+Class CVarPStackParam. +

+This class define the same this as the CVarPStack but here we can define an shift on the heap and work with a relative index. That is very useful when we have to declare method argument because if we want to call the script method MyMethod(Digital x,y); Then we'll find x at the position -2 on the heap an y at the position -1. +

+Author:: +Chafik sameh , Nevrax France

+Date:: +2000

+ +

+Definition at line 252 of file varstack.h.

Constructor & Destructor Documentation

+ + + + +
+ + + + + + + + + + +
NLAISCRIPT::CVarPStackParam::CVarPStackParam ( sint32 val ) [inline]
+
+ + + + + +
+ + + +
+ +
+Definition at line 275 of file varstack.h. +
+References _Val. +
+Referenced by clone, CVarPStackParam, isEqual, and newInstance.
+

+ + + + +
+ + + + + + + + + + +
NLAISCRIPT::CVarPStackParam::CVarPStackParam ( const CVarPStackParam & v ) [inline]
+
+ + + + + +
+ + + +
+ +
+Definition at line 279 of file varstack.h. +
+References _Val, CVarPStackParam, NLAIAGENT::IObjetOp::IObjetOp, and v.
+

+ + + + +
+ + + + + + + + + +
virtual NLAISCRIPT::CVarPStackParam::~CVarPStackParam ( ) [inline, virtual]
+
+ + + + + +
+ + + +
+ +
+Definition at line 459 of file varstack.h. +
+References NLAIC::IPointerGestion::release.
+

Member Function Documentation

+ + + + +
+ + + + + + + + + +
const NLAIC::IBasicType* NLAISCRIPT::CVarPStackParam::clone ( ) const [inline, 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 311 of file varstack.h. +
+References CVarPStackParam, and x.
+

+ + + + +
+ + + + + + + + + + +
void NLAISCRIPT::CVarPStackParam::getDebugString ( std::string & text ) const [inline, 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 347 of file varstack.h. +
+References _Shift, _Val, NLAIAGENT::IVarName::getString, and NLAIC::stringGetBuild.
+

+ + + + +
+ + + + + + + + + +
sint32 NLAISCRIPT::CVarPStackParam::getIndex ( ) const [inline]
+
+ + + + + +
+ + + +
+get index of the object. +
+ +
+Definition at line 304 of file varstack.h. +
+References _Val.
+

+ + + + +
+ + + + + + + + + + +
const NLAIAGENT::IObjectIA* NLAISCRIPT::CVarPStackParam::getObject ( void ) const [inline]
+
+ + + + + +
+ + + +
+get the object stored in the heap. +
+ +
+Definition at line 298 of file varstack.h. +
+References _Shift, and _Val.
+

+ + + + +
+ + + + + + + + + +
const NLAIAGENT::IObjectIA* NLAISCRIPT::CVarPStackParam::getObjectIAClone ( ) const [inline]
+
+ + + + + +
+ + + +
+Clone the object stored in the heap. +
+ +
+Definition at line 286 of file varstack.h. +
+References _Shift, and _Val.
+

+ + + + +
+ + + + + + + + + + +
const NLAIC::CIdentType& NLAISCRIPT::CVarPStackParam::getType ( void ) const [inline, 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 342 of file varstack.h.
+

+ + + + +
+ + + + + + + + + + +
const NLAIC::CIdentType& NLAISCRIPT::CVarPStackParam::getVarType ( void ) const [inline]
+
+ + + + + +
+ + + +
+get the type of the object stored in the heap. +
+ +
+Definition at line 292 of file varstack.h. +
+References _Shift, and _Val.
+

+ + + + +
+ + + + + + + + + + +
bool NLAISCRIPT::CVarPStackParam::isEqual ( const NLAIAGENT::IBasicObjectIA & a ) const [inline]
+
+ + + + + +
+ + + +
+ +
+Definition at line 358 of file varstack.h. +
+References _Val, CVarPStackParam, and t.
+

+ + + + +
+ + + + + + + + + +
bool NLAISCRIPT::CVarPStackParam::isTrue ( ) const [inline, virtual]
+
+ + + + + +
+ + + +
+throw (NLAIE::CExceptionNotImplemented). +
+ +
+Implements NLAIAGENT::IObjetOp. +
+Definition at line 454 of file varstack.h. +
+References _Shift, and _Val.
+

+ + + + +
+ + + + + + + + + + +
void NLAISCRIPT::CVarPStackParam::load ( NLMISC::IStream & is ) [inline, virtual]
+
+ + + + + +
+ + + +
+Load the class from a stream. +
+ +
+Implements NLAIC::IBasicInterface. +
+Definition at line 332 of file varstack.h. +
+References _Shift, _Val, and NLMISC::IStream::serial.
+

+ + + + +
+ + + + + + + + + +
virtual NLAIAGENT::IObjetOp& NLAISCRIPT::CVarPStackParam::neg ( ) [inline, virtual]
+
+ + + + + +
+ + + +
+throw (NLAIE::CExceptionNotImplemented). +
+ +
+Reimplemented from NLAIAGENT::IObjetOp. +
+Definition at line 369 of file varstack.h. +
+References _Shift, _Val, and NLAIAGENT::IObjetOp::neg.
+

+ + + + +
+ + + + + + + + + +
const NLAIC::IBasicType* NLAISCRIPT::CVarPStackParam::newInstance ( ) const [inline, virtual]
+
+ + + + + +
+ + + +
+This function allow a new instance, that mean that the class is a class factory. +
+ +
+Implements NLAIC::IBasicType. +
+Definition at line 318 of file varstack.h. +
+References CVarPStackParam, and x.
+

+ + + + +
+ + + + + + + + + + +
NLAIAGENT::IObjetOp* NLAISCRIPT::CVarPStackParam::operator * ( const NLAIAGENT::IObjetOp & a ) [inline]
+
+ + + + + +
+ + + +
+ +
+Definition at line 409 of file varstack.h. +
+References _Shift, and _Val.
+

+ + + + +
+ + + + + + + + + + +
NLAIAGENT::IObjetOp& NLAISCRIPT::CVarPStackParam::operator *= ( const NLAIAGENT::IObjetOp & a ) [inline]
+
+ + + + + +
+ + + +
+ +
+Definition at line 387 of file varstack.h. +
+References _Shift, and _Val.
+

+ + + + +
+ + + + + + + + + +
NLAIAGENT::IObjetOp* NLAISCRIPT::CVarPStackParam::operator! ( ) const [inline, virtual]
+
+ + + + + +
+ + + +
+throw (NLAIE::CExceptionNotImplemented). +
+ +
+Reimplemented from NLAIAGENT::IObjetOp. +
+Definition at line 439 of file varstack.h. +
+References _Shift, and _Val.
+

+ + + + +
+ + + + + + + + + + +
NLAIAGENT::IObjetOp* NLAISCRIPT::CVarPStackParam::operator!= ( NLAIAGENT::IObjetOp & a ) const [inline, virtual]
+
+ + + + + +
+ + + +
+throw (NLAIE::CExceptionNotImplemented). +
+ +
+Reimplemented from NLAIAGENT::IObjetOp. +
+Definition at line 444 of file varstack.h. +
+References _Shift, and _Val.
+

+ + + + +
+ + + + + + + + + + +
NLAIAGENT::IObjetOp* NLAISCRIPT::CVarPStackParam::operator+ ( const NLAIAGENT::IObjetOp & a ) [inline]
+
+ + + + + +
+ + + +
+ +
+Definition at line 398 of file varstack.h. +
+References _Shift, and _Val.
+

+ + + + +
+ + + + + + + + + + +
NLAIAGENT::IObjetOp& NLAISCRIPT::CVarPStackParam::operator+= ( const NLAIAGENT::IObjetOp & a ) [inline]
+
+ + + + + +
+ + + +
+ +
+Definition at line 375 of file varstack.h. +
+References _Shift, and _Val.
+

+ + + + +
+ + + + + + + + + + +
NLAIAGENT::IObjetOp* NLAISCRIPT::CVarPStackParam::operator- ( const NLAIAGENT::IObjetOp & a ) [inline]
+
+ + + + + +
+ + + +
+ +
+Definition at line 404 of file varstack.h. +
+References _Shift, and _Val.
+

+ + + + +
+ + + + + + + + + + +
NLAIAGENT::IObjetOp& NLAISCRIPT::CVarPStackParam::operator-= ( const NLAIAGENT::IObjetOp & a ) [inline]
+
+ + + + + +
+ + + +
+ +
+Definition at line 381 of file varstack.h. +
+References _Shift, and _Val.
+

+ + + + +
+ + + + + + + + + + +
NLAIAGENT::IObjetOp* NLAISCRIPT::CVarPStackParam::operator/ ( const NLAIAGENT::IObjetOp & a ) [inline]
+
+ + + + + +
+ + + +
+ +
+Definition at line 414 of file varstack.h. +
+References _Shift, and _Val.
+

+ + + + +
+ + + + + + + + + + +
NLAIAGENT::IObjetOp& NLAISCRIPT::CVarPStackParam::operator/= ( const NLAIAGENT::IObjetOp & a ) [inline]
+
+ + + + + +
+ + + +
+ +
+Definition at line 392 of file varstack.h. +
+References _Shift, and _Val.
+

+ + + + +
+ + + + + + + + + + +
NLAIAGENT::IObjetOp* NLAISCRIPT::CVarPStackParam::operator< ( NLAIAGENT::IObjetOp & a ) const [inline, virtual]
+
+ + + + + +
+ + + +
+throw (NLAIE::CExceptionNotImplemented). +
+ +
+Reimplemented from NLAIAGENT::IObjetOp. +
+Definition at line 420 of file varstack.h. +
+References _Shift, and _Val.
+

+ + + + +
+ + + + + + + + + + +
NLAIAGENT::IObjetOp* NLAISCRIPT::CVarPStackParam::operator<= ( NLAIAGENT::IObjetOp & a ) const [inline, virtual]
+
+ + + + + +
+ + + +
+throw (NLAIE::CExceptionNotImplemented). +
+ +
+Reimplemented from NLAIAGENT::IObjetOp. +
+Definition at line 429 of file varstack.h. +
+References _Shift, and _Val.
+

+ + + + +
+ + + + + + + + + + +
NLAIAGENT::IObjetOp* NLAISCRIPT::CVarPStackParam::operator== ( NLAIAGENT::IObjetOp & a ) const [inline, virtual]
+
+ + + + + +
+ + + +
+throw (NLAIE::CExceptionNotImplemented). +
+ +
+Reimplemented from NLAIAGENT::IObjetOp. +
+Definition at line 449 of file varstack.h. +
+References _Shift, and _Val.
+

+ + + + +
+ + + + + + + + + + +
NLAIAGENT::IObjetOp* NLAISCRIPT::CVarPStackParam::operator> ( NLAIAGENT::IObjetOp & a ) const [inline, virtual]
+
+ + + + + +
+ + + +
+throw (NLAIE::CExceptionNotImplemented). +
+ +
+Reimplemented from NLAIAGENT::IObjetOp. +
+Definition at line 424 of file varstack.h. +
+References _Shift, and _Val.
+

+ + + + +
+ + + + + + + + + + +
NLAIAGENT::IObjetOp* NLAISCRIPT::CVarPStackParam::operator>= ( NLAIAGENT::IObjetOp & a ) const [inline, virtual]
+
+ + + + + +
+ + + +
+throw (NLAIE::CExceptionNotImplemented). +
+ +
+Reimplemented from NLAIAGENT::IObjetOp. +
+Definition at line 434 of file varstack.h. +
+References _Shift, and _Val.
+

+ + + + +
+ + + + + + + + + +
const NLAIAGENT::IObjectIA::CProcessResult& NLAISCRIPT::CVarPStackParam::run ( ) [inline, virtual]
+
+ + + + + +
+ + + +
+Some where Run method define the process of the agen. +
+ +
+Implements NLAIAGENT::IObjectIA. +
+Definition at line 364 of file varstack.h. +
+References NLAIAGENT::IObjectIA::ProcessRun.
+

+ + + + +
+ + + + + + + + + + +
void NLAISCRIPT::CVarPStackParam::save ( NLMISC::IStream & os ) [inline, virtual]
+
+ + + + + +
+ + + +
+Save the class in a stream. +
+ +
+Implements NLAIC::IBasicInterface. +
+Definition at line 324 of file varstack.h. +
+References _Shift, _Val, and NLMISC::IStream::serial.
+

Member Data Documentation

+ + + + +
+ + +
sint32 NLAISCRIPT::CVarPStackParam::_Shift = 0 [static] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 667 of file static_def_init.cpp. +
+Referenced by getDebugString, getObject, getObjectIAClone, getVarType, isTrue, load, neg, operator *, operator *=, operator!, operator!=, operator+, operator+=, operator-, operator-=, operator/, operator/=, operator<, operator<=, operator==, operator>, operator>=, and save.
+

+ + + + +
+ + +
sint32 NLAISCRIPT::CVarPStackParam::_Val [private] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 259 of file varstack.h. +
+Referenced by CVarPStackParam, getDebugString, getIndex, getObject, getObjectIAClone, getVarType, isEqual, isTrue, load, neg, operator *, operator *=, operator!, operator!=, operator+, operator+=, operator-, operator-=, operator/, operator/=, operator<, operator<=, operator==, operator>, operator>=, and save.
+

+ + + + +
+ + +
NLAIC::CIdentType NLAISCRIPT::CVarPStackParam::IdVarPStackParam [static] +
+
+ + + + + +
+ + + +
+
+

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

+ + + +
+

+ + -- cgit v1.2.1

NLAISCRIPT::CVarPStackParam Class Reference

Public Methods

Static Public Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation