---

IDEA::TelemetryMessageData Class Reference

Data to send telemetry message. More...

#include <MessageDefinitions.hh>

Inheritance diagram for IDEA::TelemetryMessageData:

List of all members.

Public Methods
	TelemetryMessageData (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 &value, int index, int identifier=getNextUniqueIdentifier(), const IntSet &subMessages=IntSet(), int parent=-1)
	Constructor.
const std::string &	getValue () const
	Returns.
int	getIndex () const
	Returns.
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
	TelemetryMessageData (const TokenLocation &sourceLocation, const TokenLocation &targetLocation, const std::string &sourceToken, const std::string &value, int index, int identifier, const IntSet &subMessages, int parent)
Private Attributes
std::string	m_Value
int	m_Index

---

Detailed Description

Data to send telemetry message.

class TelemetryMessageData

---

Constructor & Destructor Documentation

IDEA::TelemetryMessageData::TelemetryMessageData (  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 &    value, int    index, int    identifier = getNextUniqueIdentifier(), const IntSet &    subMessages = IntSet(), int    parent = -1 )  [inline]

Constructor.

IDEA::TelemetryMessageData::TelemetryMessageData (  const TokenLocation &    sourceLocation, const TokenLocation &    targetLocation, const std::string &    sourceToken, const std::string &    value, int    index, int    identifier, const IntSet &    subMessages, int    parent )  [inline, private]

---

Member Function Documentation

Prototype* IDEA::TelemetryMessageData::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::TelemetryMessageData::getIndex (    )  const [inline]

Returns.

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

const std::string& IDEA::TelemetryMessageData::getValue (    )  const [inline]

Returns.

---

Member Data Documentation

int IDEA::TelemetryMessageData::m_Index [private]

std::string IDEA::TelemetryMessageData::m_Value [private]

---

Contact information © IDEA