---

IDEA::StartMessageData Class Reference
[Agent handle classes]

Data to send start message. More...

#include <MessageDefinitions.hh>

Inheritance diagram for IDEA::StartMessageData:

List of all members.

Public Methods
	StartMessageData (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 externalToken, const std::string &parameters, const Time &earliestStart, const Time &latestStart, const Time &earliestEnd, const Time &latestEnd, const std::string &comRelay, int identifier=getNextUniqueIdentifier(), const IntSet &subMessages=IntSet(), int parent=-1)
	Constructor.
int	getExternalTokenId () const
	Returns the external token id of the started token.
const std::string &	getParameters () const
	Returns the parameters of the token.
const Time &	getEarliestStart () const
	Returns the earliest start of the token that started.
const Time &	getLatestStart () const
	Returns the latest start of the token that started.
const Time &	getEarliestEnd () const
	Returns the earliest end of the token that started.
const Time &	getLatestEnd () const
	Returns the latest end of the token that started.
const std::string &	getComRelay () const
	Returns the ComRelay key/name used for the receiving of the message.
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
	StartMessageData (const TokenLocation &sourceLocation, const TokenLocation &targetLocation, const std::string &sourceToken, int externalToken, const std::string &parameters, const Time &earliestStart, const Time &latestStart, const Time &earliestEnd, const Time &latestEnd, const std::string &comRelay, int identifier, const IntSet &subMessages, int parent)
Private Attributes
int	m_ExternalTokenId
std::string	m_Parameters
Time	m_EarliestStart
Time	m_LatestStart
Time	m_EarliestEnd
Time	m_LatestEnd
std::string	m_ComRelay

---

Detailed Description

Data to send start message.

Author:

David Rijsman rijsman@email.arc.nasa.gov

---

Constructor & Destructor Documentation

IDEA::StartMessageData::StartMessageData (  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    externalToken, const std::string &    parameters, const Time &    earliestStart, const Time &    latestStart, const Time &    earliestEnd, const Time &    latestEnd, const std::string &    comRelay, int    identifier = getNextUniqueIdentifier(), const IntSet &    subMessages = IntSet(), int    parent = -1 )  [inline]

Constructor.

IDEA::StartMessageData::StartMessageData (  const TokenLocation &    sourceLocation, const TokenLocation &    targetLocation, const std::string &    sourceToken, int    externalToken, const std::string &    parameters, const Time &    earliestStart, const Time &    latestStart, const Time &    earliestEnd, const Time &    latestEnd, const std::string &    comRelay, int    identifier, const IntSet &    subMessages, int    parent )  [inline, private]

---

Member Function Documentation

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

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

const std::string& IDEA::StartMessageData::getComRelay (    )  const [inline]

Returns the ComRelay key/name used for the receiving of the message. For a sending start-message this is an empty string.

const Time& IDEA::StartMessageData::getEarliestEnd (    )  const [inline]

Returns the earliest end of the token that started. This time is adjusted for latency-difference in the source-and-target agents.

const Time& IDEA::StartMessageData::getEarliestStart (    )  const [inline]

Returns the earliest start of the token that started. This time is adjusted for latency-difference in the source-and-target agents.

int IDEA::StartMessageData::getExternalTokenId (    )  const [inline]

Returns the external token id of the started token. This is the token-id used in the source-agent for the token that started.

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

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

const Time& IDEA::StartMessageData::getLatestEnd (    )  const [inline]

Returns the latest end of the token that started. This time is adjusted for latency-difference in the source-and-target agents.

const Time& IDEA::StartMessageData::getLatestStart (    )  const [inline]

Returns the latest start of the token that started. This time is adjusted for latency-difference in the source-and-target agents.

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

Returns a unique identifier for this agent.

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

Returns the parameters of the 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::StartMessageData::m_ComRelay [private]

Time IDEA::StartMessageData::m_EarliestEnd [private]

Time IDEA::StartMessageData::m_EarliestStart [private]

int IDEA::StartMessageData::m_ExternalTokenId [private]

Time IDEA::StartMessageData::m_LatestEnd [private]

Time IDEA::StartMessageData::m_LatestStart [private]

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

---

Contact information © IDEA