|
|
|
|
Documentation |
|
Main Page Namespace List Class Hierarchy Alphabetical List Compound List File List Namespace Members Compound Members File Members Related Pages Search
NLAIAGENT::IMessageBase Class ReferenceAbstract Base class for message, all message tansited by agent have this class as base class.
More...
#include <msg.h>
Inheritance diagram for NLAIAGENT::IMessageBase:
List of all members.
Public Types |
enum | TPerformatif {
PUndefine,
PExec,
PAchieve,
PAsk,
PBreak,
PTell,
PKill,
PError,
PEven,
PService
} |
Public Methods |
void | setMessageGroup (IBaseGroupType *g) |
const IBaseGroupType * | getMessageGroup () const |
| IMessageBase () |
| IMessageBase (IObjectIA *sender, IBaseGroupType *g) |
| IMessageBase (IObjectIA *sender, IBasicMessageGroup &msg_group, IBaseGroupType *g) |
| IMessageBase (const IMessageBase &m) |
virtual | ~IMessageBase () |
const IBasicMessageGroup & | getGroup () const |
void | setGroup (IBasicMessageGroup &grp) |
| Set the IBasicMessageGroup whiche define the group of the message. More...
|
void | setPerformatif (TPerformatif p) |
const TPerformatif & | getPerformatif () const |
|
void | setSender (IObjectIA *s, bool v=false) |
void | setReceiver (IObjectIA *r, bool v=false) |
void | setContinuation (IObjectIA *r, bool v=false) |
void | setDispatch (bool state=true) |
bool | getDispatch () const |
const IObjectIA * | getSender () const |
const IObjectIA * | getReceiver () const |
const IObjectIA * | getContinuation () const |
|
void | setMethodIndex (sint32 h, sint32 n) |
sint32 | getMethodIndex () const |
const sint32 | getHeritanceIndex () const |
void | setProtcetSender () |
void | UnsetProtcetSender () |
bool | getProtcetSender () const |
|
virtual IObjectIA & | operator= (const IObjectIA &a) |
| Equality operator. More...
|
virtual sint32 | getMethodIndexSize () const |
| getMethodIndexSize define the nomber of method define in the class. More...
|
virtual tQueue | isMember (const IVarName *className, const IVarName *methodName, const IObjectIA &p) const |
| The method isMember(nameSubClass,methodName,param) return the best method correspondent to the search. 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, IObjectIA *) |
| The methode runMethodeMember(sint32 index,IObjectIA *param) allow us to run a own member method. More...
|
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...
|
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 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 CProcessResult | sendMessage (IObjectIA *) |
| The method sendMessage(const IObjectIA &msg) allow us to achive a message defined in msg. More...
|
virtual CProcessResult | sendMessage (const IVarName &, IObjectIA *) |
| This method allow to send a message to an compoment given by an string IVarName. More...
|
Private Attributes |
IObjectIA * | _Sender |
| Who send the message. More...
|
bool | _SenderIsVolatile |
IObjectIA * | _Receiver |
| witch Agent the message have to be achieve. More...
|
bool | _ReceiverIsVolatile |
IObjectIA * | _Continuation |
| This adresse is when receiver have to inform something at a third agent. More...
|
bool | _ContinuationIsVolatile |
IBasicMessageGroup * | _MsgGroup |
| Message is arranged by group. More...
|
sint32 | _ReservedMethodIndexVar |
| This reserved variable represent the offset of the Run(MSG) if the message come from script. More...
|
sint32 | _ReservedHeritanceIndexVar |
| if the message come from script then this reserved variable represent the offset of the base class which the Run(MSG) is. More...
|
TPerformatif | _Performatif |
| This variable define the performatif for agent dialog protocole. More...
|
bool | _comeFromC_PLUS |
| This bool allow to know here the message come from: scriptes agent or hard coded agent. More...
|
bool | _Dispatch |
| Is true if agent want to dispatch it to its child;. More...
|
bool | _ProtectSender |
Static Private Attributes |
CMethodCall | _Method [] |
Detailed Description
Abstract Base class for message, all message tansited by agent have this class as base class.
-
Author:
-
Chafik sameh , Portier Pierre , Robert Gabriel , Nevrax France
-
Date:
-
2000
Definition at line 51 of file msg.h.
Member Enumeration Documentation
enum NLAIAGENT::IMessageBase::TPerformatif
|
|
Constructor & Destructor Documentation
NLAIAGENT::IMessageBase::IMessageBase |
( |
|
) |
|
|
|
Definition at line 82 of file msg.cpp.
References _comeFromC_PLUS, _Continuation, _ContinuationIsVolatile, _Dispatch, _Performatif, _ProtectSender, _Receiver, _ReceiverIsVolatile, _ReservedHeritanceIndexVar, _ReservedMethodIndexVar, _SenderIsVolatile, and PUndefine.
Referenced by NLAIAGENT::CMessageList::CMessageList, NLAIAGENT::CMessageVector::CMessageVector, isEqual, and operator=. |
|
Definition at line 96 of file msg.cpp.
References _comeFromC_PLUS, _Continuation, _ContinuationIsVolatile, _Dispatch, _Performatif, _ProtectSender, _Receiver, _ReceiverIsVolatile, _ReservedHeritanceIndexVar, _ReservedMethodIndexVar, _SenderIsVolatile, and PUndefine. |
|
Definition at line 111 of file msg.cpp.
References _comeFromC_PLUS, _Continuation, _ContinuationIsVolatile, _Dispatch, _Performatif, _ProtectSender, _Receiver, _ReceiverIsVolatile, _ReservedHeritanceIndexVar, _ReservedMethodIndexVar, _SenderIsVolatile, and PUndefine. |
NLAIAGENT::IMessageBase::IMessageBase |
( |
const IMessageBase & |
m |
) |
|
|
|
Definition at line 127 of file msg.cpp.
References _comeFromC_PLUS, _Continuation, _ContinuationIsVolatile, _Dispatch, _MsgGroup, _Performatif, _ProtectSender, _Receiver, _ReceiverIsVolatile, _ReservedHeritanceIndexVar, _ReservedMethodIndexVar, _Sender, and _SenderIsVolatile. |
NLAIAGENT::IMessageBase::~IMessageBase |
( |
|
) |
[virtual] |
|
Member Function Documentation
const IObjectIA* NLAIAGENT::IMessageBase::getContinuation |
( |
|
) |
const [inline] |
|
void NLAIAGENT::IMessageBase::getDebugString |
( |
std::string & |
t |
) |
const [virtual] |
|
bool NLAIAGENT::IMessageBase::getDispatch |
( |
|
) |
const [inline] |
|
const sint32 NLAIAGENT::IMessageBase::getHeritanceIndex |
( |
|
) |
const [inline] |
|
const IBaseGroupType* NLAIAGENT::IMessageBase::getMessageGroup |
( |
|
) |
const [inline] |
|
sint32 NLAIAGENT::IMessageBase::getMethodIndex |
( |
|
) |
const [inline] |
|
sint32 NLAIAGENT::IMessageBase::getMethodIndexSize |
( |
|
) |
const [virtual] |
|
const TPerformatif& NLAIAGENT::IMessageBase::getPerformatif |
( |
|
) |
const [inline] |
|
bool NLAIAGENT::IMessageBase::getProtcetSender |
( |
|
) |
const [inline] |
|
const IObjectIA* NLAIAGENT::IMessageBase::getReceiver |
( |
|
) |
const [inline] |
|
const IObjectIA* NLAIAGENT::IMessageBase::getSender |
( |
|
) |
const [inline] |
|
bool NLAIAGENT::IMessageBase::isEqual |
( |
const IBasicObjectIA & |
a |
) |
const [virtual] |
|
|
Load the class from a stream.
Reimplemented from NLAIAGENT::IListBasicManager.
Reimplemented in NLAIAGENT::CMessageScript.
Definition at line 249 of file msg.cpp.
References _comeFromC_PLUS, _Continuation, _MsgGroup, _Performatif, _Receiver, _Sender, NLAIC::CIdentTypeAlloc::allocClass, id, r, NLMISC::IStream::serial, setContinuation, setReceiver, setSender, and t. |
|
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::IListBasicManager.
Reimplemented in NLAIAGENT::CMessageScript.
Definition at line 392 of file msg.cpp.
References _Continuation, _Receiver, _ReservedHeritanceIndexVar, _ReservedMethodIndexVar, _Sender, NLAIAGENT::_TContinuation, NLAIAGENT::_TInitProtocol, NLAIAGENT::_TProtcetSender, NLAIAGENT::_TReceiver, NLAIAGENT::_TSender, NLAIAGENT::_TSetContinuation, NLAIAGENT::_TSetSender, NLAIAGENT::_TXchgReceiverIsSender, NLAIAGENT::IBaseGroupType::IBaseGroupType, index, NLAIAGENT::IObjectIA::IObjectIA, setContinuation, setProtcetSender, setSender, and t. |
|
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::IListBasicManager.
Reimplemented in NLAIAGENT::CMessageScript.
Definition at line 387 of file msg.cpp.
References index. |
void NLAIAGENT::IMessageBase::setContinuation |
( |
IObjectIA * |
r, |
|
|
bool |
v = false |
|
) |
|
|
void NLAIAGENT::IMessageBase::setDispatch |
( |
bool |
state = true |
) |
[inline] |
|
|
Set the IBasicMessageGroup whiche define the group of the message.
Definition at line 140 of file msg.h.
References _MsgGroup.
Referenced by NLAIAGENT::CCancelGoalMsg::CCancelGoalMsg, NLAIAGENT::CConnectObjectValueMsg::CConnectObjectValueMsg, NLAIAGENT::CFactMsg::CFactMsg, NLAIAGENT::CFailureMsg::CFailureMsg, NLAIAGENT::CGetValueMsg::CGetValueMsg, NLAIAGENT::CGoalMsg::CGoalMsg, NLAIAGENT::CMessageScript::CMessageScript, NLAIAGENT::COnChangeMsg::COnChangeMsg, NLAIAGENT::CSetValueMsg::CSetValueMsg, NLAIAGENT::CSuccessMsg::CSuccessMsg, and operator=. |
void NLAIAGENT::IMessageBase::setMessageGroup |
( |
IBaseGroupType * |
g |
) |
[inline] |
|
|
Definition at line 113 of file msg.h.
References NLAIAGENT::IListBasicManager::_List, and NLAIAGENT::IBaseGroupType::IBaseGroupType.
Referenced by NLAIAGENT::CCancelGoalMsg::CCancelGoalMsg, NLAIAGENT::CConnectObjectValueMsg::CConnectObjectValueMsg, NLAIAGENT::CFactMsg::CFactMsg, NLAIAGENT::CFailureMsg::CFailureMsg, NLAIAGENT::CGetValueMsg::CGetValueMsg, NLAIAGENT::CGoalMsg::CGoalMsg, NLAIAGENT::CMessageList::CMessageList, NLAIAGENT::CMessageScript::CMessageScript, NLAIAGENT::CMessageVector::CMessageVector, NLAIAGENT::COnChangeMsg::COnChangeMsg, and NLAIAGENT::CSuccessMsg::CSuccessMsg. |
void NLAIAGENT::IMessageBase::setMethodIndex |
( |
sint32 |
h, |
|
|
sint32 |
n |
|
) |
[inline] |
|
void NLAIAGENT::IMessageBase::setPerformatif |
( |
TPerformatif |
p |
) |
[inline] |
|
|
Definition at line 146 of file msg.h.
References _Performatif, and TPerformatif.
Referenced by NLAILOGIC::CGoalPath::failure, NLAILOGIC::IGoal::failure, NLAILOGIC::CGoalPath::onActivate, NLAILOGIC::CGoalPath::onUnActivate, NLAIAGENT::COperatorScript::order, NLAIAGENT::CAgentScript::runAskGetValue, NLAIAGENT::CAgentScript::runTellComponent, NLAILOGIC::CGoalPath::success, NLAILOGIC::IGoal::success, and NLAIAGENT::CAgentOperation::update. |
void NLAIAGENT::IMessageBase::setProtcetSender |
( |
|
) |
[inline] |
|
void NLAIAGENT::IMessageBase::setReceiver |
( |
IObjectIA * |
r, |
|
|
bool |
v = false |
|
) |
|
|
void NLAIAGENT::IMessageBase::setSender |
( |
IObjectIA * |
s, |
|
|
bool |
v = false |
|
) |
|
|
|
Definition at line 173 of file msg.cpp.
References _Sender, _SenderIsVolatile, s, and v.
Referenced by NLAILOGIC::CGoalPath::failure, NLAILOGIC::IGoal::failure, load, NLAILOGIC::CGoalPath::onActivate, NLAILOGIC::CGoalPath::onUnActivate, NLAIAGENT::COperatorScript::order, runMethodeMember, NLAISCRIPT::CMsgSetSender::runOpCode, NLAIAGENT::CAgentScript::runTellComponent, NLAILOGIC::CGoalPath::success, NLAILOGIC::IGoal::success, and NLAIAGENT::CAgentOperation::update. |
void NLAIAGENT::IMessageBase::UnsetProtcetSender |
( |
|
) |
[inline] |
|
Member Data Documentation
bool NLAIAGENT::IMessageBase::_comeFromC_PLUS [private]
|
|
|
This bool allow to know here the message come from: scriptes agent or hard coded agent.
Definition at line 107 of file msg.h.
Referenced by IMessageBase, load, and save. |
IObjectIA* NLAIAGENT::IMessageBase::_Continuation [private]
|
|
bool NLAIAGENT::IMessageBase::_ContinuationIsVolatile [private]
|
|
bool NLAIAGENT::IMessageBase::_Dispatch [private]
|
|
|
Initial value:
{
IMessageBase::CMethodCall(_SENDER_,_TSender),
IMessageBase::CMethodCall(_RECEIVER_,_TReceiver),
IMessageBase::CMethodCall(_CONTINUATION_,_TContinuation),
IMessageBase::CMethodCall(_SETCONTINUATION_,_TSetContinuation),
IMessageBase::CMethodCall("XChangeReceiverSender",_TXchgReceiverIsSender),
IMessageBase::CMethodCall("ProtcetSender",_TProtcetSender),
IMessageBase::CMethodCall("InitProtocol",_TInitProtocol),
IMessageBase::CMethodCall("SetSender",_TSetSender)
}
Reimplemented from NLAIAGENT::IBaseGroupType.
Definition at line 62 of file msg.cpp. |
TPerformatif NLAIAGENT::IMessageBase::_Performatif [private]
|
|
bool NLAIAGENT::IMessageBase::_ProtectSender [private]
|
|
IObjectIA* NLAIAGENT::IMessageBase::_Receiver [private]
|
|
bool NLAIAGENT::IMessageBase::_ReceiverIsVolatile [private]
|
|
sint32 NLAIAGENT::IMessageBase::_ReservedHeritanceIndexVar [private]
|
|
sint32 NLAIAGENT::IMessageBase::_ReservedMethodIndexVar [private]
|
|
IObjectIA* NLAIAGENT::IMessageBase::_Sender [private]
|
|
bool NLAIAGENT::IMessageBase::_SenderIsVolatile [private]
|
|
The documentation for this class was generated from the following files:
|
|