---

IDEA::ObjectMessageData Class Reference
[Agent handle classes]

Data to send object messages. More...

#include <MessageDefinitions.hh>

Inheritance diagram for IDEA::ObjectMessageData:

List of all members.

Public Methods
	ObjectMessageData (const std::string &source, const std::string &sourceClass, const std::string &sourceTimeline, const std::string &sourceToken, const std::string &target, const std::string &targetClass, const std::string &targetTimeline, const std::string &objectName, const std::string &objectClass, const std::string &objectToken, const std::string &parameters, int identifier=getNextUniqueIdentifier(), const IntSet &subMessages=IntSet(), int parent=-1)
	Constructor.
const std::string &	getObjectName () const
	Returns the name of the instance of PslObject ( of type getObjectClass() ) this data is referring to.
const std::string &	getObjectClass () const
	Returns the name of the PslObjectClass this data is referring to.
const std::string &	getObjectToken () const
	Returns the name of the PslToken instance which is executing on targetTimeline.
const std::string &	getParameters () const
	Returns a comma deliminated string containg parameters of the object token.
Prototype *	clone () const
	Returns a copy if the invoking class.
const TokenLocation &	getSourceLocation () const
	Returns the source of the message.
const TokenLocation &	getTargetLocation () const
	Returns the target of the message.
const std::string &	getSourceToken () const
	Returns the token name (predicate name) of the source of the message.
const Message::Type &	getType () const
	Returns the message type of the invoking instance.
int	getIdentifier () const
	Returns the unique identifier for this message.
int	getParent () const
	Returns the identifier of the parent of the invoking data. Returns -1 if no parent.
const IntSet &	getSubMessages () const
	Returns the number of sub messages the invoking data is associated with.
Static Protected Methods
int	getNextUniqueIdentifier ()
	Returns a unique identifier for this agent.
Private Methods
	ObjectMessageData (const TokenLocation &sourceLocation, const TokenLocation &targetLocation, const std::string &sourceToken, const std::string &objectName, const std::string &objectClass, const std::string &objectToken, const std::string &parameters, int identifier, const IntSet &subMessages, int parent)
Private Attributes
std::string	m_ObjectName
std::string	m_ObjectClass
std::string	m_ObjectToken
std::string	m_Parameters

---

Detailed Description

Data to send object messages.

Author:

David Rijsman rijsman@email.arc.nasa.gov

---

Constructor & Destructor Documentation

IDEA::ObjectMessageData::ObjectMessageData (  const std::string &    source, const std::string &    sourceClass, const std::string &    sourceTimeline, const std::string &    sourceToken, const std::string &    target, const std::string &    targetClass, const std::string &    targetTimeline, const std::string &    objectName, const std::string &    objectClass, const std::string &    objectToken, const std::string &    parameters, int    identifier = getNextUniqueIdentifier(), const IntSet &    subMessages = IntSet(), int    parent = -1 )  [inline]

Constructor.

IDEA::ObjectMessageData::ObjectMessageData (  const TokenLocation &    sourceLocation, const TokenLocation &    targetLocation, const std::string &    sourceToken, const std::string &    objectName, const std::string &    objectClass, const std::string &    objectToken, const std::string &    parameters, int    identifier, const IntSet &    subMessages, int    parent )  [inline, private]

---

Member Function Documentation

Prototype* IDEA::ObjectMessageData::clone (    )  [inline, virtual]

Returns a copy if the invoking class. Reimplemented from IDEA::MessageDataBase.

int IDEA::MessageData::getIdentifier (    )  const [inline, inherited]

Returns the unique identifier for this message. Reimplemented in IDEA::SimulatorDataBase.

int IDEA::MessageData::getNextUniqueIdentifier (    )  [static, protected, inherited]

Returns a unique identifier for this agent.

const std::string& IDEA::ObjectMessageData::getObjectClass (    )  const [inline]

Returns the name of the PslObjectClass this data is referring to.

const std::string& IDEA::ObjectMessageData::getObjectName (    )  const [inline]

Returns the name of the instance of PslObject ( of type getObjectClass() ) this data is referring to.

const std::string& IDEA::ObjectMessageData::getObjectToken (    )  const [inline]

Returns the name of the PslToken instance which is executing on targetTimeline.

const std::string& IDEA::ObjectMessageData::getParameters (    )  const [inline]

Returns a comma deliminated string containg parameters of the object token.

int IDEA::MessageData::getParent (    )  const [inline, inherited]

Returns the identifier of the parent of the invoking data. Returns -1 if no parent.

const TokenLocation& IDEA::MessageDataBase::getSourceLocation (    )  const [inline, inherited]

Returns the source of the message.

const std::string& IDEA::MessageDataBase::getSourceToken (    )  const [inline, inherited]

Returns the token name (predicate name) of the source of the message. Not all messages originate from a token this depends on the source of the message. Typically non IDEA agents do not have the notion of a token.

const IntSet& IDEA::MessageData::getSubMessages (    )  const [inline, inherited]

Returns the number of sub messages the invoking data is associated with.

const TokenLocation& IDEA::MessageDataBase::getTargetLocation (    )  const [inline, inherited]

Returns the target of the message.

const Message::Type& IDEA::MessageData::getType (    )  const [inline, inherited]

Returns the message type of the invoking instance.

---

Member Data Documentation

std::string IDEA::ObjectMessageData::m_ObjectClass [private]

std::string IDEA::ObjectMessageData::m_ObjectName [private]

std::string IDEA::ObjectMessageData::m_ObjectToken [private]

std::string IDEA::ObjectMessageData::m_Parameters [private]

---

Contact information © IDEA