Eaagles::Simulation::Message Class Reference

Inherits Eaagles::Basic::LcObject.

Inheritance diagram for Eaagles::Simulation::Message:

[legend]Collaboration diagram for Eaagles::Simulation::Message:

[legend]List of all members.

Public Types
enum	AckCodes { ACK_REQUESTED, ACK }
Public Member Functions
	Message ()
std::string	getSenderName ()
std::list< std::string >	getDestNames ()
virtual double	getTimeStamp ()
virtual double	getLifeSpan ()
AckCodes	getAckCode ()
std::string	getDatalinkName ()
virtual void	setSenderName (std::string sName)
virtual void	setTimeStamp (double ts)
virtual void	setLifeSpan (double ls)
virtual void	setDatalinkName (std::string dln)
virtual void	setAckCode (AckCodes a)
virtual bool	addDestName (std::string name)
virtual void	removeDestName (std::string name)
virtual void	clearDestNames ()
Private Attributes
std::string	senderName
std::list< std::string >	destNames
double	timeStamp
double	lifeSpan
AckCodes	ack
std::string	datalinkName

---

Member Enumeration Documentation

enum Eaagles::Simulation::Message::AckCodes

Enumerator:

ACK_REQUESTED
ACK

---

Constructor & Destructor Documentation

Eaagles::Simulation::Message::Message

(

)

---

Member Function Documentation

std::string Eaagles::Simulation::Message::getSenderName

(

)

[inline]

Description: returns the message senders name.

get functions

std::list<std::string> Eaagles::Simulation::Message::getDestNames

(

)

[inline]

const std::list<std::string> getDestNames() const { return destNames; } Description: returns the list of destination name strings Description: returns the first destination name in the list

virtual double Eaagles::Simulation::Message::getTimeStamp

(

)

[inline, virtual]

Description: returns the time at which this message was sent (if on receive end).

virtual double Eaagles::Simulation::Message::getLifeSpan

(

)

[inline, virtual]

Description: returns the length of time in seconds which this message is valid.

AckCodes Eaagles::Simulation::Message::getAckCode

(

)

[inline]

Description: returns the ack code for this message.

std::string Eaagles::Simulation::Message::getDatalinkName

(

)

[inline]

Description: returns the datalink name of this message.

virtual void Eaagles::Simulation::Message::setSenderName

(

std::string

sName

)

[inline, virtual]

Description: sets the sender name of this message to the value passed in as a parameter.

set functions

virtual void Eaagles::Simulation::Message::setTimeStamp

(

double

ts

)

[inline, virtual]

Description: sets the time stamp to the value passed in as a parameter.

virtual void Eaagles::Simulation::Message::setLifeSpan

(

double

ls

)

[inline, virtual]

Description: sets the life span of to the value passed in as a parameter.

virtual void Eaagles::Simulation::Message::setDatalinkName

(

std::string

dln

)

[inline, virtual]

Description: sets the datalink name to the value passed in as a parameter.

virtual void Eaagles::Simulation::Message::setAckCode

(

AckCodes

a

)

[inline, virtual]

Description: sets the ack code to the value passed in as parameter.

bool Eaagles::Simulation::Message::addDestName

(

std::string

name

)

[virtual]

Description: adds a destination name to the list of intended recipients of this message.

void Eaagles::Simulation::Message::removeDestName

(

std::string

name

)

[virtual]

Description: removes all destination names that fully match the value passed in as a parameter.

void Eaagles::Simulation::Message::clearDestNames

(

)

[virtual]

Description: clears the list of destination names.

---

Member Data Documentation

std::string Eaagles::Simulation::Message::senderName [private]

std::list<std::string> Eaagles::Simulation::Message::destNames [private]

double Eaagles::Simulation::Message::timeStamp [private]

double Eaagles::Simulation::Message::lifeSpan [private]

AckCodes Eaagles::Simulation::Message::ack [private]

std::string Eaagles::Simulation::Message::datalinkName [private]

---