Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members  

IDEA::StatusMessageData Class Reference

Data to send status message. More...

#include <MessageDefinitions.hh>

Inheritance diagram for IDEA::StatusMessageData:

IDEA::MessageDataBase IDEA::MessageData IDEA::Prototype List of all members.

Public Methods

 StatusMessageData (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 token, const std::string &value, int identifier=getNextUniqueIdentifier(), const IntSet &subMessages=IntSet(), int parent=-1)
 Constructor.

int getExternalTokenId () const
 Returns.

const std::string & getValue () const
 Returns.

Prototypeclone () const
 Returns.

const TokenLocationgetSourceLocation () const
 Returns the source of the message.

const TokenLocationgetTargetLocation () 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::TypegetType () 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 IntSetgetSubMessages () 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

 StatusMessageData (const TokenLocation &sourceLocation, const TokenLocation &targetLocation, const std::string &sourceToken, int token, const std::string &value, int identifier, const IntSet &subMessages, int parent)
 Returns.


Private Attributes

int m_ExternalTokenId
std::string m_Value

Detailed Description

Data to send status message.


Constructor & Destructor Documentation

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

Constructor.

IDEA::StatusMessageData::StatusMessageData const TokenLocation   sourceLocation,
const TokenLocation   targetLocation,
const std::string &    sourceToken,
int    token,
const std::string &    value,
int    identifier,
const IntSet   subMessages,
int    parent
[inline, private]
 

Returns.


Member Function Documentation

Prototype* IDEA::StatusMessageData::clone   const [inline, virtual]
 

Returns.

Reimplemented from IDEA::MessageDataBase.

int IDEA::StatusMessageData::getExternalTokenId   const [inline]
 

Returns.

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, 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::StatusMessageData::getValue   const [inline]
 

Returns.


Member Data Documentation

int IDEA::StatusMessageData::m_ExternalTokenId [private]
 

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


Contact information
© IDEA
Generated on Fri Feb 3 17:09:49 2006 for IDEA.