---

IDEA::MessageDataBase Class Reference
[Agent handle classes]

Base class for every MessageData class, stores the location of the token initiating the message, the location the message is supposed to be going and the name of the token initiating the message. More...

#include <MessageDefinitions.hh>

Inheritance diagram for IDEA::MessageDataBase:

List of all members.

Public Methods
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.
Prototype *	clone () const
	Returns a copy if the invoking class.
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.
Protected Methods
	MessageDataBase (const Message::Type &type, 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, int identifier, const IntSet &subMessages, int parent)
	Constructor for a message of type type from agent source, class sourceClass, timeline sourceTimeline and token sourceToken. The message is/was intended for target agent, class targetClass and timeline targetTimeline.
	MessageDataBase (const Message::Type &type, const TokenLocation &sourceLocation, const TokenLocation &targetLocation, const std::string &sourceToken, int identifier, const IntSet &subMessages=IntSet(), int parent=-1)
	Constructor for a message of type type and source sourceLocation, sourceToken and target targetLocation.
Static Protected Methods
int	getNextUniqueIdentifier ()
	Returns a unique identifier for this agent.
Private Methods
	MessageDataBase ()
	Default constructor, not implemented by design.
	MessageDataBase (const MessageDataBase &)
	Copy constructor, not implemented by design.
MessageDataBase &	operator= (const MessageDataBase &)
	Assignment operator, not implemented by design.
Private Attributes
TokenLocation	m_SourceLocation
TokenLocation	m_TargetLocation
std::string	m_SourceToken

---

Detailed Description

Base class for every MessageData class, stores the location of the token initiating the message, the location the message is supposed to be going and the name of the token initiating the message.

Author:

David Rijsman rijsman@email.arc.nasa.gov

---

Constructor & Destructor Documentation

IDEA::MessageDataBase::MessageDataBase (  const Message::Type &    type, 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, int    identifier, const IntSet &    subMessages, int    parent )  [inline, protected]

Constructor for a message of type type from agent source, class sourceClass, timeline sourceTimeline and token sourceToken. The message is/was intended for target agent, class targetClass and timeline targetTimeline.

IDEA::MessageDataBase::MessageDataBase (  const Message::Type &    type, const TokenLocation &    sourceLocation, const TokenLocation &    targetLocation, const std::string &    sourceToken, int    identifier, const IntSet &    subMessages = IntSet(), int    parent = -1 )  [inline, protected]

Constructor for a message of type type and source sourceLocation, sourceToken and target targetLocation.

IDEA::MessageDataBase::MessageDataBase (    )  [private]

Default constructor, not implemented by design.

IDEA::MessageDataBase::MessageDataBase (  const MessageDataBase &    )  [private]

Copy constructor, not implemented by design.

---

Member Function Documentation

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

Returns a copy if the invoking class. Implements IDEA::Prototype. Reimplemented in IDEA::ObjectMessageData, IDEA::StartMessageData, IDEA::ValueMessageData, IDEA::StatusMessageData, IDEA::StopMessageData, and IDEA::TelemetryMessageData.

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.

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]

Returns the source of the message.

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

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]

Returns the target of the message.

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

Returns the message type of the invoking instance.

MessageDataBase& IDEA::MessageDataBase::operator= (  const MessageDataBase &    )  [private]

Assignment operator, not implemented by design.

---

Member Data Documentation

TokenLocation IDEA::MessageDataBase::m_SourceLocation [private]

std::string IDEA::MessageDataBase::m_SourceToken [private]

TokenLocation IDEA::MessageDataBase::m_TargetLocation [private]

---

Contact information © IDEA