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/classNLAILOGIC_1_1CGoal.html | 1253 +++++++++++++++++++++++++ 1 file changed, 1253 insertions(+) create mode 100644 docs/doxygen/nel/classNLAILOGIC_1_1CGoal.html (limited to 'docs/doxygen/nel/classNLAILOGIC_1_1CGoal.html') diff --git a/docs/doxygen/nel/classNLAILOGIC_1_1CGoal.html b/docs/doxygen/nel/classNLAILOGIC_1_1CGoal.html new file mode 100644 index 00000000..0550d45c --- /dev/null +++ b/docs/doxygen/nel/classNLAILOGIC_1_1CGoal.html @@ -0,0 +1,1253 @@ + + + + nevrax.org : docs + + + + + + + + + + + + + + +
# Home   # nevrax.com   
+ + + + +
Nevrax
+ + + + + + + + + + +
+ + +
+ Nevrax.org
+ + + + + + + +
#News
#Mailing-list
#Documentation
#CVS
#Bugs
#License
+
+ + +
+ + +
+Docs + +
+  + + + + + +
Documentation 
+ +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages   Search  
+

NLAILOGIC::CGoal Class Reference

#include <goal.h> +

+

Inheritance diagram for NLAILOGIC::CGoal: +

+ +NLAILOGIC::IGoal +NLAILOGIC::IBaseBoolType +NLAIAGENT::IObjetOp +NLAIAGENT::IObjectIA +NLAIAGENT::IBasicObjectIA +NLAIC::IBasicInterface +NLAIC::IBasicType +NLAIC::IPointerGestion +NLMISC::IStreamable +NLMISC::IClassable + +List of all members. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Methods

 CGoal ()
 CGoal (const NLAIAGENT::IVarName &, TTypeOfGoal mode=achieveOnce)
 CGoal (const NLAIAGENT::IVarName &, std::list< const NLAIAGENT::IObjectIA * > &, TTypeOfGoal mode=achieveOnce)
 CGoal (const CGoal &)
virtual ~CGoal ()
void setArgs (std::list< NLAIAGENT::IObjectIA * > &)
const std::vector< NLAIAGENT::IObjectIA * > & getArgs ()
void addSuccessor (NLAIAGENT::IBasicAgent *)
void addPredecessor (NLAIAGENT::IBasicAgent *)
virtual void operatorSuccess (NLAIAGENT::IBasicAgent *)
virtual void operatorFailure (NLAIAGENT::IBasicAgent *)
const std::vector< IBaseOperator * > getOperators ()
const NLAIC::IBasicTypeclone () const
 This function allow a pointer copy, that mean that the new class have the sam attributs caracteristics as the owne. More...

const NLAIC::IBasicTypenewInstance () 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...

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...

bool isTrue () const
 throw (NLAIE::CExceptionNotImplemented). More...

float truthValue () const
 Returns a value in [0,1]. More...

const IObjectIA::CProcessResult & run ()
 Some where Run method define the process of the agen. More...

bool isEqual (const CGoal &a) const
bool isEqual (const NLAIAGENT::IBasicObjectIA &a) const
const NLAIC::CIdentTypegetType () const
 getType return a unique string how represente the class, it can be the name of the class. More...

virtual NLAIAGENT::tQueue isMember (const NLAIAGENT::IVarName *, const NLAIAGENT::IVarName *, const NLAIAGENT::IObjectIA &) const
virtual bool operator== (const CGoal &)
virtual void cancel ()
virtual float priority () const
Some IObjectIA method definition.
virtual NLAIAGENT::IObjectIA::CProcessResult runMethodeMember (sint32, sint32, NLAIAGENT::IObjectIA *)
 The methode runMethodeMember(sint32 heritance, sint32 index, IObjectIA *param) allow us to run a member method. More...

virtual NLAIAGENT::IObjectIA::CProcessResult runMethodeMember (sint32 index, NLAIAGENT::IObjectIA *p)
 The methode runMethodeMember(sint32 index,IObjectIA *param) allow us to run a own member method. More...

sint32 getMethodIndexSize () const
 getMethodIndexSize define the nomber of method define in the class. More...


Static Public Attributes

const NLAIC::CIdentType IdGoal
+

Constructor & Destructor Documentation

+

+ + + + +
+ + + + + + + + + +
NLAILOGIC::CGoal::CGoal  
+
+ + + + + +
+   + + +

+ +

+Definition at line 205 of file goal.cpp. +

+Referenced by clone.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
NLAILOGIC::CGoal::CGoal const NLAIAGENT::IVarName ,
TTypeOfGoal   mode = achieveOnce
+
+ + + + + +
+   + + +

+ +

+Definition at line 209 of file goal.cpp.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
NLAILOGIC::CGoal::CGoal const NLAIAGENT::IVarName ,
std::list< const NLAIAGENT::IObjectIA * > &  ,
TTypeOfGoal   mode = achieveOnce
+
+ + + + + +
+   + + +

+ +

+Definition at line 213 of file goal.cpp.

+

+ + + + +
+ + + + + + + + + + +
NLAILOGIC::CGoal::CGoal const CGoal &  
+
+ + + + + +
+   + + +

+ +

+Definition at line 217 of file goal.cpp.

+

+ + + + +
+ + + + + + + + + +
NLAILOGIC::CGoal::~CGoal   [virtual]
+
+ + + + + +
+   + + +

+ +

+Definition at line 221 of file goal.cpp.

+


Member Function Documentation

+

+ + + + +
+ + + + + + + + + + +
void NLAILOGIC::CGoal::addPredecessor NLAIAGENT::IBasicAgent 
+
+ + + + + +
+   + + +

+ +

+Definition at line 502 of file goal.cpp. +

+References NLAILOGIC::IGoal::_Predecessors, and NLAIC::IPointerGestion::incRef.

+

+ + + + +
+ + + + + + + + + + +
void NLAILOGIC::CGoal::addSuccessor NLAIAGENT::IBasicAgent 
+
+ + + + + +
+   + + +

+ +

+Definition at line 495 of file goal.cpp. +

+References NLAILOGIC::IGoal::_Successors, NLAIC::IPointerGestion::incRef, and s. +

+Referenced by NLAIAGENT::COperatorScript::run.

+

+ + + + +
+ + + + + + + + + +
void NLAILOGIC::CGoal::cancel   [virtual]
+
+ + + + + +
+   + + +

+ +

+Definition at line 516 of file goal.cpp. +

+References NLAILOGIC::IGoal::_Successors.

+

+ + + + +
+ + + + + + + + + +
const NLAIC::IBasicType * NLAILOGIC::CGoal::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 286 of file goal.cpp. +

+References CGoal. +

+Referenced by NLAISCRIPT::COperatorClass::COperatorClass, and newInstance.

+

+ + + + +
+ + + + + + + + + +
const std::vector< NLAIAGENT::IObjectIA * > & NLAILOGIC::CGoal::getArgs  
+
+ + + + + +
+   + + +

+ +

+Definition at line 363 of file goal.cpp. +

+References NLAILOGIC::IGoal::_Args. +

+Referenced by NLAIAGENT::COperatorScript::linkGoalArgs.

+

+ + + + +
+ + + + + + + + + + +
void NLAILOGIC::CGoal::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 307 of file goal.cpp. +

+References NLAILOGIC::IGoal::_Args, NLAILOGIC::IGoal::_Name, NLAILOGIC::IGoal::_Predecessors, NLAILOGIC::IGoal::_Successors, NLAIAGENT::IVarName::getString, priority, and NLAIC::stringGetBuild. +

+Referenced by NLAIAGENT::CCancelGoalMsg::runMethodeMember, and NLAIAGENT::CGoalMsg::runMethodeMember.

+

+ + + + +
+ + + + + + + + + +
sint32 NLAILOGIC::CGoal::getMethodIndexSize   const [virtual]
+
+ + + + + +
+   + + +

+getMethodIndexSize define the nomber of method define in the class. +

+ +

+Reimplemented from NLAIAGENT::IObjetOp. +

+Definition at line 489 of file goal.cpp.

+

+ + + + +
+ + + + + + + + + +
const std::vector<IBaseOperator *> NLAILOGIC::CGoal::getOperators  
+
+ + + + + +
+   + + +

+

+

+ + + + +
+ + + + + + + + + +
const NLAIC::CIdentType & NLAILOGIC::CGoal::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 368 of file goal.cpp. +

+References IdGoal. +

+Referenced by isMember.

+

+ + + + +
+ + + + + + + + + + +
bool NLAILOGIC::CGoal::isEqual const NLAIAGENT::IBasicObjectIA  a const
+
+ + + + + +
+   + + +

+ +

+Definition at line 358 of file goal.cpp.

+

+ + + + +
+ + + + + + + + + + +
bool NLAILOGIC::CGoal::isEqual const CGoal &   a const
+
+ + + + + +
+   + + +

+ +

+Definition at line 353 of file goal.cpp.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
NLAIAGENT::tQueue NLAILOGIC::CGoal::isMember const NLAIAGENT::IVarName ,
const NLAIAGENT::IVarName ,
const NLAIAGENT::IObjectIA 
const [virtual]
+
+ + + + + +
+   + + +

+ +

+Definition at line 383 of file goal.cpp. +

+References NLAIC::IBasicType::getDebugString, getType, params, and r.

+

+ + + + +
+ + + + + + + + + +
bool NLAILOGIC::CGoal::isTrue   const [virtual]
+
+ + + + + +
+   + + +

+throw (NLAIE::CExceptionNotImplemented). +

+ +

+Implements NLAIAGENT::IObjetOp. +

+Definition at line 338 of file goal.cpp.

+

+ + + + +
+ + + + + + + + + + +
void NLAILOGIC::CGoal::load NLMISC::IStream  is [virtual]
+
+ + + + + +
+   + + +

+Load the class from a stream. +

+ +

+Implements NLAIC::IBasicInterface. +

+Definition at line 302 of file goal.cpp.

+

+ + + + +
+ + + + + + + + + +
const NLAIC::IBasicType * NLAILOGIC::CGoal::newInstance   const [virtual]
+
+ + + + + +
+   + + +

+This function allow a new instance, that mean that the class is a class factory. +

+ +

+Implements NLAIC::IBasicType. +

+Definition at line 292 of file goal.cpp. +

+References clone.

+

+ + + + +
+ + + + + + + + + + +
bool NLAILOGIC::CGoal::operator== const CGoal &   [virtual]
+
+ + + + + +
+   + + +

+ +

+Definition at line 508 of file goal.cpp. +

+References NLAILOGIC::IGoal::_Args.

+

+ + + + +
+ + + + + + + + + + +
void NLAILOGIC::CGoal::operatorFailure NLAIAGENT::IBasicAgent  [virtual]
+
+ + + + + +
+   + + +

+ +

+Reimplemented from NLAILOGIC::IGoal. +

+Definition at line 260 of file goal.cpp. +

+References NLAILOGIC::IGoal::_Receiver, NLAILOGIC::IGoal::_Successors, NLAILOGIC::IGoal::achieveForever, NLAILOGIC::IGoal::achieveOnce, and NLAILOGIC::IGoal::failure. +

+Referenced by NLAIAGENT::COperatorScript::onFailure.

+

+ + + + +
+ + + + + + + + + + +
void NLAILOGIC::CGoal::operatorSuccess NLAIAGENT::IBasicAgent  [virtual]
+
+ + + + + +
+   + + +

+ +

+Reimplemented from NLAILOGIC::IGoal. +

+Definition at line 225 of file goal.cpp. +

+References NLAILOGIC::IGoal::_Receiver, NLAILOGIC::IGoal::_Successors, NLAILOGIC::IGoal::achieveForever, NLAILOGIC::IGoal::achieveOnce, NLAIAGENT::CAgentScript::removeGoal, and NLAILOGIC::IGoal::success. +

+Referenced by NLAIAGENT::COperatorScript::onSuccess.

+

+ + + + +
+ + + + + + + + + +
float NLAILOGIC::CGoal::priority   const [virtual]
+
+ + + + + +
+   + + +

+ +

+Definition at line 525 of file goal.cpp. +

+References NLAILOGIC::IGoal::_Successors. +

+Referenced by getDebugString.

+

+ + + + +
+ + + + + + + + + +
const NLAIAGENT::IObjectIA::CProcessResult & NLAILOGIC::CGoal::run   [virtual]
+
+ + + + + +
+   + + +

+Some where Run method define the process of the agen. +

+ +

+Implements NLAILOGIC::IBaseBoolType. +

+Definition at line 348 of file goal.cpp.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
NLAIAGENT::IObjectIA::CProcessResult NLAILOGIC::CGoal::runMethodeMember sint32   index,
NLAIAGENT::IObjectIA  p
[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::IObjectIA. +

+Definition at line 439 of file goal.cpp. +

+References NLAILOGIC::IGoal::_Args, NLAILOGIC::IGoal::_Mode, NLAILOGIC::IGoal::_Name, NLAILOGIC::IGoal::_Sender, NLAILOGIC::IGoal::achieveForever, NLAILOGIC::IGoal::achieveOnce, NLAIAGENT::IBaseGroupType::getFront, NLAIAGENT::CStringType::getStr, index, param, NLAIAGENT::IBaseGroupType::popFront, NLAIC::IPointerGestion::release, and NLAIAGENT::IBaseGroupType::size.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
NLAIAGENT::IObjectIA::CProcessResult NLAILOGIC::CGoal::runMethodeMember sint32  ,
sint32  ,
NLAIAGENT::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::IObjectIA. +

+Definition at line 434 of file goal.cpp.

+

+ + + + +
+ + + + + + + + + + +
void NLAILOGIC::CGoal::save NLMISC::IStream  os [virtual]
+
+ + + + + +
+   + + +

+Save the class in a stream. +

+ +

+Implements NLAIC::IBasicInterface. +

+Definition at line 298 of file goal.cpp.

+

+ + + + +
+ + + + + + + + + + +
void NLAILOGIC::CGoal::setArgs std::list< NLAIAGENT::IObjectIA * > &  
+
+ + + + + +
+   + + +

+ +

+Definition at line 373 of file goal.cpp. +

+References NLAILOGIC::IGoal::_Args. +

+Referenced by NLAISCRIPT::COperatorClass::setGoal.

+

+ + + + +
+ + + + + + + + + +
float NLAILOGIC::CGoal::truthValue   const [virtual]
+
+ + + + + +
+   + + +

+Returns a value in [0,1]. +

+ +

+Implements NLAILOGIC::IBaseBoolType. +

+Definition at line 343 of file goal.cpp.

+


Member Data Documentation

+

+ + + + +
+ + +
const NLAIC::CIdentType CGoal::IdGoal [static] +
+
+ + + + + +
+   + + +

+Initial value:

+

+Definition at line 406 of file static_def_init.cpp. +

+Referenced by getType.

+


The documentation for this class was generated from the following files: + + + +
                                                                                                                                                                    +
+ + -- cgit v1.2.1