RSB  0.9.6
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
rsb::EventId Class Reference

A unique ID for events in RSB. More...

#include <EventId.h>

Inheritance diagram for rsb::EventId:
Inheritance graph
Collaboration diagram for rsb::EventId:
Collaboration graph

Public Member Functions

 EventId (const rsc::misc::UUID &participantId, const boost::uint32_t &sequenceNumber)
 
virtual ~EventId ()
 
rsc::misc::UUID getParticipantId () const
 
boost::uint32_t getSequenceNumber () const
 
rsc::misc::UUID getAsUUID () const
 
bool operator== (const EventId &other) const
 
bool operator< (const EventId &other) const
 
std::string getClassName () const
 
void printContents (std::ostream &stream) const
 

Private Attributes

rsc::misc::UUID participantId
 The id of the sending participant. More...
 
boost::uint32_t sequenceNumber
 
rsc::misc::UUIDPtr id
 A cache for the generated uuid. More...
 

Detailed Description

A unique ID for events in RSB.

Ids are composed of the sending participant's ID and a sequence number and can optionally be converted to UUIDs.

Author
jwienke

Definition at line 48 of file EventId.h.

Constructor & Destructor Documentation

rsb::EventId::EventId ( const rsc::misc::UUID &  participantId,
const boost::uint32_t &  sequenceNumber 
)

Definition at line 35 of file EventId.cpp.

rsb::EventId::~EventId ( )
virtual

Definition at line 40 of file EventId.cpp.

Member Function Documentation

rsc::misc::UUID rsb::EventId::getAsUUID ( ) const

Definition at line 51 of file EventId.cpp.

References id, participantId, and sequenceNumber.

string rsb::EventId::getClassName ( ) const

Definition at line 82 of file EventId.cpp.

rsc::misc::UUID rsb::EventId::getParticipantId ( ) const

Definition at line 43 of file EventId.cpp.

References participantId.

Referenced by rsb::protocol::fillEventId().

Here is the caller graph for this function:

boost::uint32_t rsb::EventId::getSequenceNumber ( ) const

Definition at line 47 of file EventId.cpp.

References sequenceNumber.

Referenced by rsb::protocol::fillEventId().

Here is the caller graph for this function:

bool rsb::EventId::operator< ( const EventId other) const

Definition at line 72 of file EventId.cpp.

References participantId, and sequenceNumber.

bool rsb::EventId::operator== ( const EventId other) const

Definition at line 66 of file EventId.cpp.

References participantId, and sequenceNumber.

void rsb::EventId::printContents ( std::ostream &  stream) const

Definition at line 86 of file EventId.cpp.

References participantId, and sequenceNumber.

Member Data Documentation

rsc::misc::UUIDPtr rsb::EventId::id
mutableprivate

A cache for the generated uuid.

Definition at line 78 of file EventId.h.

Referenced by getAsUUID().

rsc::misc::UUID rsb::EventId::participantId
private

The id of the sending participant.

Definition at line 72 of file EventId.h.

Referenced by getAsUUID(), getParticipantId(), operator<(), operator==(), and printContents().

boost::uint32_t rsb::EventId::sequenceNumber
private

Definition at line 73 of file EventId.h.

Referenced by getAsUUID(), getSequenceNumber(), operator<(), operator==(), and printContents().


The documentation for this class was generated from the following files: