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_1CActorScript.html | 2489 ++++++++++++++++++++ 1 file changed, 2489 insertions(+) create mode 100644 docs/doxygen/nel/classNLAIAGENT_1_1CActorScript.html (limited to 'docs/doxygen/nel/classNLAIAGENT_1_1CActorScript.html') diff --git a/docs/doxygen/nel/classNLAIAGENT_1_1CActorScript.html b/docs/doxygen/nel/classNLAIAGENT_1_1CActorScript.html new file mode 100644 index 00000000..9584d9a1 --- /dev/null +++ b/docs/doxygen/nel/classNLAIAGENT_1_1CActorScript.html @@ -0,0 +1,2489 @@ + + + + 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::CActorScript Class Reference

Class CActorScript Scripted actors for the creations of FSMs and other controlers. +More... +

+#include <actor_script.h> +

Inheritance diagram for NLAIAGENT::CActorScript: +

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

Public Methods
	CActorScript (IAgentManager *, bool activated=false)
	CActorScript (const CActorScript &)
	CActorScript (IAgentManager , IBasicAgent , std::list< IObjectIA * > &, NLAISCRIPT::CAgentClass *)
virtual	~CActorScript ()
bool	isActivated ()
	Returns true if the actor has a token. More...
void	activate ()
	Activates the actor. More...
virtual void	onActivate ()
	Callback called at the activation of the actor. More...
void	unActivate ()
	Unactivates the actor. More...
virtual void	onUnActivate ()
	Callback called when the agent is unactivated. More...
virtual const NLAIC::IBasicType *	clone () const
	Inherited functions. 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 bool	isEqual (const IBasicObjectIA &a) const
	Implementation of the isEqual of the IBasicObjectIA. More...
virtual void	processMessages ()
	The processMessages method, process the loop/Run message. More...
virtual const CProcessResult &	run ()
	The work of an agent. More...
virtual CProcessResult	sendMessage (IObjectIA *)
	sendMessage allow agent to send a message to an ather agent.The message is a IMessageBase. 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...
virtual void	save (NLMISC::IStream &os)
	Save the class in a stream. More...
virtual void	load (NLMISC::IStream &is)
	Load the class from a stream. More...
virtual int	getBaseMethodCount () const
	Return the nomber of internal C++ hard coded method that the class can process. More...
virtual sint32	getMethodIndexSize () const
	getMethodIndexSize define the nomber of method define in the class. More...
virtual tQueue	getPrivateMember (const IVarName , const IVarName , const IObjectIA &) const
virtual IObjectIA::CProcessResult	runMethodBase (int heritance, int index, IObjectIA *)
virtual IObjectIA::CProcessResult	runMethodBase (int index, IObjectIA *)
virtual void	cancel ()
virtual void	processSuccess (NLAIAGENT::IObjectIA *)
	Own success and failure functions These function telle other operators and goals that might be waiting for the execution of this one. More...
virtual void	processFailure (NLAIAGENT::IObjectIA *)
virtual void	success ()
virtual void	failure ()
void	pause ()
	Pauses the actor. More...
void	restart ()
	Restarts the actor. More...
virtual void	onPause ()
	These functions can be overloaded to have the actor execute something when paused or restarted. More...
virtual void	onRestart ()
virtual void	onSuccess (IObjectIA *)
	Dependencies failure and success notification These functions are called by other operators or goals who failed or succeeded. More...
virtual void	onFailure (IObjectIA *)
virtual float	priority () const
	Priority of the operator. More...
virtual void	setTopLevel (CAgentScript *)
const CAgentScript *	getTopLevel () const
virtual IMessageBase *	runTell (const IMessageBase &m)
	runTell is to processing reltative to PTell Performatif. More...
virtual void	Launch (const std::string &name, NLAIAGENT::IBasicAgent *)
Static Public Methods
void	initClass ()
void	releaseClass ()
Static Public Attributes
NLAISCRIPT::COperandSimpleListOr *	ParamIdSuccessMsg = NULL
NLAISCRIPT::CParam *	ParamSuccessMsg = NULL
NLAISCRIPT::COperandSimpleListOr *	ParamIdFailureMsg = NULL
NLAISCRIPT::CParam *	ParamFailureMsg = NULL
const NLAIC::CIdentType	IdActorScript
Protected Types
enum	c_funcs_id { + fid_activate, +fid_onActivate, +fid_unActivate, +fid_onUnActivate, + + fid_switch, +fid_launch, +fid_launch_goal, +fid_launched, + + fid_pause, +fid_restart, +fid_success, +fid_msg_success, + + fid_failure, +fid_msg_failure, +fid_nb_answers, +fid_toplevel, + + fid_owner, +fid_isactive, +fid_last + + }
Protected Methods
virtual void	switchActor (CActorScript *, bool stay_active=false)
	Transfers activity to another actor. More...
virtual void	switchActor (std::vector< CActorScript * > &, bool stay_active=false)
	Transfers activity to another actor. More...
virtual void	switchActor (std::vector< CComponentHandle * > &, bool stay_active=false)
	Transfers activity to another actor. More...
Protected Attributes
bool	_IsActivated
bool	_OnActivate
bool	_IsPaused
sint32	_OnActivateIndex
sint32	_OnUnActivateIndex
sint32	_OnPauseIndex
sint32	_OnRestartIndex
sint32	_OnSuccessIndex
sint32	_OnFailureIndex
sint32	_NbAnswers
std::vector< CComponentHandle * >	_Actors
std::list< IBasicAgent * >	_Launched
CAgentScript *	_TopLevel

Detailed Description

+Class CActorScript Scripted actors for the creations of FSMs and other controlers. +

+You can think of activation as a set of tokens passed between actors. The number of tokens isn't fixed, which means one transition can activate more than one actor. An actor has a list of conditions under which he's going to pass activation to other actors. A simple state machine is a particular case in which there's always only one token for all actors. If a run() is defined, the activated actor becomes an active agent with an activity at each cycle. +

+ +

+Definition at line 49 of file actor_script.h.

Member Enumeration Documentation

+ + + + +
+ + +
enum NLAIAGENT::CActorScript::c_funcs_id [protected] +
+
+ + + + + +
+ + + +
+
+Enumeration values:
+ + + + + + + + + + + + + + + + + + + + +
fid_activate +
fid_onActivate +
fid_unActivate +
fid_onUnActivate +
fid_switch +
fid_launch +
fid_launch_goal +
fid_launched +
fid_pause +
fid_restart +
fid_success +
fid_msg_success +
fid_failure +
fid_msg_failure +
fid_nb_answers +
fid_toplevel +
fid_owner +
fid_isactive +
fid_last +
+
+ +
+Reimplemented in NLAIAGENT::COperatorScript. +
+Definition at line 53 of file actor_script.h.
+

Constructor & Destructor Documentation

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
NLAIAGENT::CActorScript::CActorScript ( IAgentManager * ,
bool activated = false
)
+
+ + + + + +
+ + + +
+ +
+Definition at line 95 of file actor_script.cpp. +
+References _IsActivated, _IsPaused, _NbAnswers, _OnActivateIndex, _OnUnActivateIndex, and _TopLevel. +
+Referenced by clone, Launch, newInstance, pause, restart, NLAIAGENT::CFsmScript::setTopLevel, setTopLevel, switchActor, and unActivate.
+

+ + + + +
+ + + + + + + + + + +
NLAIAGENT::CActorScript::CActorScript ( const CActorScript & )
+
+ + + + + +
+ + + +
+ +
+Definition at line 71 of file actor_script.cpp. +
+References _IsActivated, _IsPaused, _NbAnswers, _OnActivateIndex, _OnUnActivateIndex, and _TopLevel.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NLAIAGENT::CActorScript::CActorScript ( IAgentManager * ,
IBasicAgent * ,
std::list< IObjectIA * > & ,
NLAISCRIPT::CAgentClass *
)
+
+ + + + + +
+ + + +
+ +
+Definition at line 81 of file actor_script.cpp. +
+References _IsActivated, _IsPaused, _NbAnswers, _OnActivateIndex, _OnUnActivateIndex, _TopLevel, and components.
+

+ + + + +
+ + + + + + + + + +
NLAIAGENT::CActorScript::~CActorScript ( ) [virtual]
+
+ + + + + +
+ + + +
+ +
+Definition at line 105 of file actor_script.cpp. +
+References _Launched, and nlinfo.
+

Member Function Documentation

+ + + + +
+ + + + + + + + + +
void NLAIAGENT::CActorScript::activate ( )
+
+ + + + + +
+ + + +
+Activates the actor. +
+ +
+Definition at line 126 of file actor_script.cpp. +
+References NLAIAGENT::CAgentScript::_AgentClass, _IsActivated, _OnActivateIndex, NLAIAGENT::CAgentScript::CAgentScript, NLAIAGENT::IConnectIA::getParent, NLAISCRIPT::CAgentClass::isMember, onActivate, r, and NLAIAGENT::tQueue. +
+Referenced by NLAIAGENT::CSeqFsmScript::onSuccess, NLAIAGENT::COperatorScript::run, and runMethodBase.
+

+ + + + +
+ + + + + + + + + +
void NLAIAGENT::CActorScript::cancel ( ) [virtual]
+
+ + + + + +
+ + + +
+ +
+Reimplemented in NLAIAGENT::COperatorScript. +
+Definition at line 921 of file actor_script.cpp. +
+References unActivate.
+

+ + + + +
+ + + + + + + + + +
const NLAIC::IBasicType * NLAIAGENT::CActorScript::clone ( ) const [virtual]
+
+ + + + + +
+ + + +
+Inherited functions. +
+ +
+Reimplemented from NLAIAGENT::CAgentScript. +
+Reimplemented in NLAIAGENT::CFsmScript. +
+Definition at line 356 of file actor_script.cpp. +
+References CActorScript.
+

+ + + + +
+ + + + + + + + + +
void NLAIAGENT::CActorScript::failure ( ) [virtual]
+
+ + + + + +
+ + + +
+ +
+Reimplemented in NLAILOGIC::CGoalPath. +
+Definition at line 985 of file actor_script.cpp. +
+References NLAIAGENT::CAgentScript::_AgentClass, _OnFailureIndex, NLAIAGENT::IAgentManager::getAgentContext, NLAIAGENT::CAgentScript::getAgentManager, NLAISCRIPT::CAgentClass::isMember, onFailure, r, NLAIAGENT::CAgentScript::runMethodeMember, NLAISCRIPT::CCodeContext::Self, and NLAIAGENT::tQueue. +
+Referenced by processFailure.
+

+ + + + +
+ + + + + + + + + +
int NLAIAGENT::CActorScript::getBaseMethodCount ( ) const [virtual]
+
+ + + + + +
+ + + +
+Return the nomber of internal C++ hard coded method that the class can process. +
+ +
+Reimplemented from NLAIAGENT::CAgentScript. +
+Reimplemented in NLAIAGENT::CFsmScript. +
+Definition at line 769 of file actor_script.cpp. +
+References fid_last.
+

+ + + + +
+ + + + + + + + + + +
void NLAIAGENT::CActorScript::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::CAgentScript. +
+Reimplemented in NLAIAGENT::CFsmScript. +
+Definition at line 376 of file actor_script.cpp. +
+References t.
+

+ + + + +
+ + + + + + + + + +
sint32 NLAIAGENT::CActorScript::getMethodIndexSize ( ) const [virtual]
+
+ + + + + +
+ + + +
+getMethodIndexSize define the nomber of method define in the class. +
+ +
+Reimplemented from NLAIAGENT::CAgentScript. +
+Reimplemented in NLAIAGENT::CFsmScript. +
+Definition at line 446 of file actor_script.cpp. +
+References fid_last.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
tQueue NLAIAGENT::CActorScript::getPrivateMember ( const IVarName * ,
const IVarName * ,
const IObjectIA &
) const [virtual]
+
+ + + + + +
+ + + +
+ +
+Reimplemented in NLAIAGENT::COperatorScript. +
+Definition at line 774 of file actor_script.cpp. +
+References fid_activate, fid_failure, fid_isactive, fid_launch, fid_launch_goal, fid_launched, fid_msg_failure, fid_msg_success, fid_nb_answers, fid_onActivate, fid_onUnActivate, fid_owner, fid_pause, fid_restart, fid_success, fid_switch, fid_toplevel, fid_unActivate, NLAIAGENT::CVectorGroupType::IdVectorGroupType, param, ParamFailureMsg, ParamSuccessMsg, NLAIAGENT::tQueue, and NLAIC::CIdentType::VoidType.
+

+ + + + +
+ + + + + + + + + +
const CAgentScript * NLAIAGENT::CActorScript::getTopLevel ( ) const
+
+ + + + + +
+ + + +
+ +
+Definition at line 948 of file actor_script.cpp. +
+References _TopLevel. +
+Referenced by runMethodBase.
+

+ + + + +
+ + + + + + + + + +
const NLAIC::CIdentType & NLAIAGENT::CActorScript::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). +
+Reimplemented from NLAIAGENT::CAgentScript. +
+Reimplemented in NLAIAGENT::CFsmScript. +
+Definition at line 426 of file actor_script.cpp. +
+References IdActorScript. +
+Referenced by processFailure, and processSuccess.
+

+ + + + +
+ + + + + + + + + +
void NLAIAGENT::CActorScript::initClass ( ) [static]
+
+ + + + + +
+ + + +
+ +
+Definition at line 50 of file actor_script.cpp. +
+References NLAIAGENT::CFailureMsg::IdFailureMsg, NLAISCRIPT::CFailureMsgClass::IdFailureMsgClass, NLAIAGENT::CSuccessMsg::IdSuccessMsg, NLAISCRIPT::CSuccessMsgClass::IdSuccessMsgClass, ParamIdFailureMsg, and ParamIdSuccessMsg.
+

+ + + + +
+ + + + + + + + + +
bool NLAIAGENT::CActorScript::isActivated ( )
+
+ + + + + +
+ + + +
+Returns true if the actor has a token. +
+ +
+Definition at line 120 of file actor_script.cpp. +
+References _IsActivated.
+

+ + + + +
+ + + + + + + + + + +
bool NLAIAGENT::CActorScript::isEqual ( const IBasicObjectIA & a ) const [virtual]
+
+ + + + + +
+ + + +
+Implementation of the isEqual of the IBasicObjectIA. +
+ +
+Reimplemented from NLAIAGENT::CAgentScript. +
+Reimplemented in NLAIAGENT::CFsmScript. +
+Definition at line 385 of file actor_script.cpp.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
void NLAIAGENT::CActorScript::Launch ( const std::string & name,
NLAIAGENT::IBasicAgent *
) [virtual]
+
+ + + + + +
+ + + +
+ +
+Definition at line 609 of file actor_script.cpp. +
+References _Launched, _NbAnswers, _TopLevel, NLAIAGENT::CAgentScript::addDynamicAgent, CActorScript, and NLAIAGENT::IObjectIA::isClassInheritedFrom. +
+Referenced by runMethodBase.
+

+ + + + +
+ + + + + + + + + + +
void NLAIAGENT::CActorScript::load ( NLMISC::IStream & is ) [virtual]
+
+ + + + + +
+ + + +
+Load the class from a stream. +
+ +
+Reimplemented from NLAIAGENT::CAgentScript. +
+Reimplemented in NLAIAGENT::CFsmScript. +
+Definition at line 438 of file actor_script.cpp. +
+References _IsActivated, and NLMISC::IStream::serial.
+

+ + + + +
+ + + + + + + + + +
const NLAIC::IBasicType * NLAIAGENT::CActorScript::newInstance ( ) const [virtual]
+
+ + + + + +
+ + + +
+This function allow a new instance, that mean that the class is a class factory. +
+ +
+Reimplemented from NLAIAGENT::CAgentScript. +
+Reimplemented in NLAIAGENT::CFsmScript. +
+Definition at line 362 of file actor_script.cpp. +
+References NLAIAGENT::CAgentScript::_AgentClass, NLAISCRIPT::CAgentClass::buildNewInstance, and CActorScript.
+

+ + + + +
+ + + + + + + + + +
void NLAIAGENT::CActorScript::onActivate ( ) [virtual]
+
+ + + + + +
+ + + +
+Callback called at the activation of the actor. +
+ +
+Reimplemented in NLAILOGIC::CGoalPath. +
+Definition at line 345 of file actor_script.cpp. +
+Referenced by activate, NLAIAGENT::COperatorScript::execOnActivate, and runMethodBase.
+

+ + + + +
+ + + + + + + + + + +
virtual void NLAIAGENT::CActorScript::onFailure ( IObjectIA * ) [inline, virtual]
+
+ + + + + +
+ + + +
+ +
+Reimplemented in NLAIAGENT::CSeqFsmScript. +
+Definition at line 184 of file actor_script.h. +
+References NLAIAGENT::IObjectIA::IObjectIA. +
+Referenced by failure, NLAIAGENT::CFsmScript::runMethodBase, and runMethodBase.
+

+ + + + +
+ + + + + + + + + +
void NLAIAGENT::CActorScript::onPause ( ) [virtual]
+
+ + + + + +
+ + + +
+These functions can be overloaded to have the actor execute something when paused or restarted. +
+ +
+Definition at line 237 of file actor_script.cpp. +
+Referenced by pause.
+

+ + + + +
+ + + + + + + + + +
void NLAIAGENT::CActorScript::onRestart ( ) [virtual]
+
+ + + + + +
+ + + +
+ +
+Definition at line 288 of file actor_script.cpp. +
+Referenced by restart.
+

+ + + + +
+ + + + + + + + + + +
virtual void NLAIAGENT::CActorScript::onSuccess ( IObjectIA * ) [inline, virtual]
+
+ + + + + +
+ + + +
+Dependencies failure and success notification These functions are called by other operators or goals who failed or succeeded. +
+ +
+Reimplemented in NLAIAGENT::CSeqFsmScript. +
+Definition at line 183 of file actor_script.h. +
+References NLAIAGENT::IObjectIA::IObjectIA. +
+Referenced by NLAIAGENT::CFsmScript::runMethodBase, runMethodBase, and success.
+

+ + + + +
+ + + + + + + + + +
void NLAIAGENT::CActorScript::onUnActivate ( ) [virtual]
+
+ + + + + +
+ + + +
+Callback called when the agent is unactivated. +
+ +
+Reimplemented in NLAILOGIC::CGoalPath. +
+Definition at line 351 of file actor_script.cpp. +
+Referenced by runMethodBase, and unActivate.
+

+ + + + +
+ + + + + + + + + +
void NLAIAGENT::CActorScript::pause ( )
+
+ + + + + +
+ + + +
+Pauses the actor. +
+ +
+Definition at line 191 of file actor_script.cpp. +
+References NLAIAGENT::CAgentScript::_AgentClass, NLAIAGENT::CAgentScript::_Components, _IsPaused, _Launched, NLAIAGENT::CAgentScript::_NbComponents, _OnPauseIndex, CActorScript, NLAIAGENT::CAgentScript::getAgentManager, NLAISCRIPT::CAgentClass::isMember, onPause, r, NLAIAGENT::CAgentScript::runMethodeMember, NLAISCRIPT::CCodeContext::Self, NLAIC::CTypeOfObject::tActor, and NLAIAGENT::tQueue. +
+Referenced by NLAIAGENT::COperatorScript::checkPause, and runMethodBase.
+

+ + + + +
+ + + + + + + + + +
float NLAIAGENT::CActorScript::priority ( ) const [virtual]
+
+ + + + + +
+ + + +
+Priority of the operator. +
+ +
+Reimplemented in NLAIAGENT::COperatorScript. +
+Definition at line 926 of file actor_script.cpp.
+

+ + + + +
+ + + + + + + + + + +
void NLAIAGENT::CActorScript::processFailure ( NLAIAGENT::IObjectIA * ) [virtual]
+
+ + + + + +
+ + + +
+ +
+Definition at line 1004 of file actor_script.cpp. +
+References failure, getType, NLAIC::IPointerGestion::incRef, and param. +
+Referenced by runMethodBase.
+

+ + + + +
+ + + + + + + + + +
void NLAIAGENT::CActorScript::processMessages ( ) [virtual]
+
+ + + + + +
+ + + +
+The processMessages method, process the loop/Run message. +
+ +
+Reimplemented from NLAIAGENT::CAgentScript. +
+Definition at line 395 of file actor_script.cpp. +
+Referenced by run.
+

+ + + + +
+ + + + + + + + + + +
void NLAIAGENT::CActorScript::processSuccess ( NLAIAGENT::IObjectIA * ) [virtual]
+
+ + + + + +
+ + + +
+Own success and failure functions These function telle other operators and goals that might be waiting for the execution of this one. +
+ +
+Definition at line 953 of file actor_script.cpp. +
+References getType, param, and success. +
+Referenced by runMethodBase, and runTell.
+

+ + + + +
+ + + + + + + + + +
void NLAIAGENT::CActorScript::releaseClass ( ) [static]
+
+ + + + + +
+ + + +
+ +
+Definition at line 63 of file actor_script.cpp. +
+References NLAIC::IPointerGestion::release.
+

+ + + + +
+ + + + + + + + + +
void NLAIAGENT::CActorScript::restart ( )
+
+ + + + + +
+ + + +
+Restarts the actor. +
+ +
+Definition at line 243 of file actor_script.cpp. +
+References NLAIAGENT::CAgentScript::_AgentClass, NLAIAGENT::CAgentScript::_Components, _IsPaused, _Launched, NLAIAGENT::CAgentScript::_NbComponents, _OnRestartIndex, CActorScript, NLAIAGENT::CAgentScript::getAgentManager, NLAISCRIPT::CAgentClass::isMember, onRestart, r, NLAIAGENT::CAgentScript::runMethodeMember, NLAISCRIPT::CCodeContext::Self, NLAIC::CTypeOfObject::tActor, and NLAIAGENT::tQueue. +
+Referenced by NLAIAGENT::COperatorScript::checkPause, and runMethodBase.
+

+ + + + +
+ + + + + + + + + +
const IObjectIA::CProcessResult & NLAIAGENT::CActorScript::run ( ) [virtual]
+
+ + + + + +
+ + + +
+The work of an agent. +
+Typically agent process child message, process its message and run its activity. +
+Reimplemented from NLAIAGENT::CAgentScript. +
+Reimplemented in NLAIAGENT::CFsmScript. +
+Definition at line 401 of file actor_script.cpp. +
+References _OnActivateIndex, NLAIAGENT::CAgentScript::getAgentManager, processMessages, r, NLAIAGENT::CAgentScript::runMethodeMember, and NLAISCRIPT::CCodeContext::Self.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
IObjectIA::CProcessResult NLAIAGENT::CActorScript::runMethodBase ( int index,
IObjectIA *
) [virtual]
+
+ + + + + +
+ + + +
+ +
+Reimplemented from NLAIAGENT::CAgentScript. +
+Reimplemented in NLAIAGENT::CFsmScript. +
+Definition at line 630 of file actor_script.cpp. +
+References _IsActivated, _NbAnswers, activate, fid_activate, fid_failure, fid_isactive, fid_launch, fid_msg_failure, fid_msg_success, fid_nb_answers, fid_onActivate, fid_onUnActivate, fid_owner, fid_pause, fid_restart, fid_success, fid_switch, fid_toplevel, fid_unActivate, NLAIAGENT::IConnectIA::getParent, getTopLevel, NLAIAGENT::IAgent::IAgent, NLAIAGENT::IBasicAgent::IBasicAgent, index, NLAIAGENT::IObjectIA::IObjectIA, Launch, onActivate, onUnActivate, params, pause, processFailure, processSuccess, r, restart, s, switchActor, and unActivate.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
IObjectIA::CProcessResult NLAIAGENT::CActorScript::runMethodBase ( int heritance,
int index,
IObjectIA *
) [virtual]
+
+ + + + + +
+ + + +
+ +
+Reimplemented from NLAIAGENT::CAgentScript. +
+Reimplemented in NLAIAGENT::CSeqFsmScript. +
+Definition at line 454 of file actor_script.cpp. +
+References _IsActivated, _Launched, _NbAnswers, activate, NLAILOGIC::CGoalPath::addGoal, fid_activate, fid_failure, fid_isactive, fid_launch, fid_launch_goal, fid_launched, fid_msg_failure, fid_msg_success, fid_nb_answers, fid_onActivate, fid_onUnActivate, fid_owner, fid_pause, fid_restart, fid_success, fid_switch, fid_toplevel, fid_unActivate, NLAIAGENT::IBaseGroupType::getFront, NLAIAGENT::IConnectIA::getParent, getTopLevel, NLAIAGENT::IAgent::IAgent, NLAIAGENT::IBasicAgent::IBasicAgent, NLAIC::IPointerGestion::incRef, index, Launch, onActivate, onFailure, onSuccess, onUnActivate, params, pause, NLAIAGENT::IBaseGroupType::popFront, r, restart, s, NLAILOGIC::CGoalPath::setFather, NLAIAGENT::IBaseGroupType::size, switchActor, and unActivate.
+

+ + + + +
+ + + + + + + + + + +
IMessageBase * NLAIAGENT::CActorScript::runTell ( const IMessageBase & m ) [virtual]
+
+ + + + + +
+ + + +
+runTell is to processing reltative to PTell Performatif. +
+its call from the IObjectIA *run(const IMessageBase &m) method. +
+Reimplemented from NLAIAGENT::IBasicAgent. +
+Definition at line 1020 of file actor_script.cpp. +
+References processSuccess.
+

+ + + + +
+ + + + + + + + + + +
void NLAIAGENT::CActorScript::save ( NLMISC::IStream & os ) [virtual]
+
+ + + + + +
+ + + +
+Save the class in a stream. +
+ +
+Reimplemented from NLAIAGENT::CAgentScript. +
+Reimplemented in NLAIAGENT::CFsmScript. +
+Definition at line 431 of file actor_script.cpp. +
+References _IsActivated, and NLMISC::IStream::serial.
+

+ + + + +
+ + + + + + + + + + +
IObjectIA::CProcessResult NLAIAGENT::CActorScript::sendMessage ( IObjectIA * m ) [virtual]
+
+ + + + + +
+ + + +
+sendMessage allow agent to send a message to an ather agent.The message is a IMessageBase. +
+ +
+Reimplemented from NLAIAGENT::CAgentScript. +
+Definition at line 390 of file actor_script.cpp.
+

+ + + + +
+ + + + + + + + + + +
void NLAIAGENT::CActorScript::setTopLevel ( CAgentScript * ) [virtual]
+
+ + + + + +
+ + + +
+ +
+Reimplemented from NLAIAGENT::CAgentScript. +
+Reimplemented in NLAIAGENT::CFsmScript. +
+Definition at line 932 of file actor_script.cpp. +
+References NLAIAGENT::CAgentScript::_Components, NLAIAGENT::CAgentScript::_NbComponents, _TopLevel, and CActorScript.
+

+ + + + +
+ + + + + + + + + +
void NLAIAGENT::CActorScript::success ( ) [virtual]
+
+ + + + + +
+ + + +
+ +
+Reimplemented in NLAILOGIC::CGoalPath. +
+Definition at line 966 of file actor_script.cpp. +
+References NLAIAGENT::CAgentScript::_AgentClass, _OnSuccessIndex, NLAIAGENT::IAgentManager::getAgentContext, NLAIAGENT::CAgentScript::getAgentManager, NLAISCRIPT::CAgentClass::isMember, onSuccess, r, NLAIAGENT::CAgentScript::runMethodeMember, NLAISCRIPT::CCodeContext::Self, and NLAIAGENT::tQueue. +
+Referenced by processSuccess.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
void NLAIAGENT::CActorScript::switchActor ( std::vector< CComponentHandle * > & ,
bool stay_active = false
) [protected, virtual]
+
+ + + + + +
+ + + +
+Transfers activity to another actor. +
+The second arg bool must be set to true for this agent to stay active, false otherwise. +
+Definition at line 323 of file actor_script.cpp. +
+References CActorScript, nlwarning, and unActivate.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
void NLAIAGENT::CActorScript::switchActor ( std::vector< CActorScript * > & ,
bool stay_active = false
) [protected, virtual]
+
+ + + + + +
+ + + +
+Transfers activity to another actor. +
+The second arg bool must be set to true for this agent to stay active, false otherwise. +
+Definition at line 306 of file actor_script.cpp. +
+References unActivate.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
void NLAIAGENT::CActorScript::switchActor ( CActorScript * ,
bool stay_active = false
) [protected, virtual]
+
+ + + + + +
+ + + +
+Transfers activity to another actor. +
+The second arg bool must be set to true for this agent to stay active, false otherwise. +
+Definition at line 295 of file actor_script.cpp. +
+References unActivate. +
+Referenced by runMethodBase.
+

+ + + + +
+ + + + + + + + + +
void NLAIAGENT::CActorScript::unActivate ( )
+
+ + + + + +
+ + + +
+Unactivates the actor. +
+ +
+Definition at line 149 of file actor_script.cpp. +
+References NLAIAGENT::CAgentScript::_AgentClass, _IsActivated, _IsPaused, _Launched, _OnActivateIndex, _OnUnActivateIndex, CActorScript, NLAIAGENT::CAgentScript::CAgentScript, NLAIAGENT::IAgentManager::getAgentContext, NLAIAGENT::CAgentScript::getAgentManager, NLAIAGENT::IConnectIA::getParent, NLAISCRIPT::CAgentClass::isMember, onUnActivate, r, NLAIAGENT::CAgentScript::removeDynamic, NLAIAGENT::CAgentScript::runMethodeMember, NLAISCRIPT::CCodeContext::Self, and NLAIAGENT::tQueue. +
+Referenced by cancel, NLAIAGENT::COperatorScript::onFailure, NLAIAGENT::COperatorScript::onSuccess, NLAIAGENT::COperatorScript::run, runMethodBase, and switchActor.
+

Member Data Documentation

+ + + + +
+ + +
std::vector<CComponentHandle *> NLAIAGENT::CActorScript::_Actors [protected] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 92 of file actor_script.h.
+

+ + + + +
+ + +
bool NLAIAGENT::CActorScript::_IsActivated [protected] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 76 of file actor_script.h. +
+Referenced by activate, CActorScript, NLAIAGENT::COperatorScript::checkActivation, isActivated, load, NLAIAGENT::COperatorScript::run, runMethodBase, save, and unActivate.
+

+ + + + +
+ + +
bool NLAIAGENT::CActorScript::_IsPaused [protected] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 78 of file actor_script.h. +
+Referenced by CActorScript, NLAIAGENT::COperatorScript::checkPause, pause, restart, NLAIAGENT::COperatorScript::run, NLAIAGENT::COperatorScript::runMethodBase, and unActivate.
+

+ + + + +
+ + +
std::list<IBasicAgent *> NLAIAGENT::CActorScript::_Launched [protected] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 94 of file actor_script.h. +
+Referenced by Launch, pause, restart, runMethodBase, unActivate, and ~CActorScript.
+

+ + + + +
+ + +
sint32 NLAIAGENT::CActorScript::_NbAnswers [protected] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 88 of file actor_script.h. +
+Referenced by CActorScript, Launch, NLAIAGENT::COperatorScript::order, and runMethodBase.
+

+ + + + +
+ + +
bool NLAIAGENT::CActorScript::_OnActivate [protected] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 77 of file actor_script.h.
+

+ + + + +
+ + +
sint32 NLAIAGENT::CActorScript::_OnActivateIndex [protected] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 81 of file actor_script.h. +
+Referenced by activate, CActorScript, NLAIAGENT::COperatorScript::execOnActivate, run, and unActivate.
+

+ + + + +
+ + +
sint32 NLAIAGENT::CActorScript::_OnFailureIndex [protected] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 86 of file actor_script.h. +
+Referenced by failure.
+

+ + + + +
+ + +
sint32 NLAIAGENT::CActorScript::_OnPauseIndex [protected] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 83 of file actor_script.h. +
+Referenced by pause.
+

+ + + + +
+ + +
sint32 NLAIAGENT::CActorScript::_OnRestartIndex [protected] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 84 of file actor_script.h. +
+Referenced by restart.
+

+ + + + +
+ + +
sint32 NLAIAGENT::CActorScript::_OnSuccessIndex [protected] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 85 of file actor_script.h. +
+Referenced by success.
+

+ + + + +
+ + +
sint32 NLAIAGENT::CActorScript::_OnUnActivateIndex [protected] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 82 of file actor_script.h. +
+Referenced by CActorScript, and unActivate.
+

+ + + + +
+ + +
CAgentScript* NLAIAGENT::CActorScript::_TopLevel [protected] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 96 of file actor_script.h. +
+Referenced by CActorScript, getTopLevel, Launch, NLAIAGENT::CFsmScript::setTopLevel, and setTopLevel.
+

+ + + + +
+ + +
const NLAIC::CIdentType CActorScript::IdActorScript [static] +
+
+ + + + + +
+ + + +
+ +
+Referenced by NLAISCRIPT::CActorClass::CActorClass, and getType.
+

+ + + + +
+ + +
NLAISCRIPT::CParam * NLAIAGENT::CActorScript::ParamFailureMsg = NULL [static] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 48 of file actor_script.cpp. +
+Referenced by getPrivateMember, and NLAIAGENT::CFsmScript::isMember.
+

+ + + + +
+ + +
NLAISCRIPT::COperandSimpleListOr * NLAIAGENT::CActorScript::ParamIdFailureMsg = NULL [static] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 47 of file actor_script.cpp. +
+Referenced by initClass.
+

+ + + + +
+ + +
NLAISCRIPT::COperandSimpleListOr * NLAIAGENT::CActorScript::ParamIdSuccessMsg = NULL [static] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 45 of file actor_script.cpp. +
+Referenced by initClass.
+

+ + + + +
+ + +
NLAISCRIPT::CParam * NLAIAGENT::CActorScript::ParamSuccessMsg = NULL [static] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 46 of file actor_script.cpp. +
+Referenced by getPrivateMember, and NLAIAGENT::CFsmScript::isMember.
+

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

+ + + +
+

+ + -- cgit v1.2.1

NLAIAGENT::CActorScript Class Reference

Public Methods

Static Public Methods

Static Public Attributes

Protected Types

Protected Methods

Protected Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation