RSB  0.9.6
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
EventId.h
Go to the documentation of this file.
1 /* ============================================================
2  *
3  * This file is a part of the RSB project.
4  *
5  * Copyright (C) 2011 by Johannes Wienke <jwienke at techfak dot uni-bielefeld dot de>
6  *
7  * This file may be licensed under the terms of the
8  * GNU Lesser General Public License Version 3 (the ``LGPL''),
9  * or (at your option) any later version.
10  *
11  * Software distributed under the License is distributed
12  * on an ``AS IS'' basis, WITHOUT WARRANTY OF ANY KIND, either
13  * express or implied. See the LGPL for the specific language
14  * governing rights and limitations.
15  *
16  * You should have received a copy of the LGPL along with this
17  * program. If not, go to http://www.gnu.org/licenses/lgpl.html
18  * or write to the Free Software Foundation, Inc.,
19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20  *
21  * The development of this software was supported by:
22  * CoR-Lab, Research Institute for Cognition and Robotics
23  * Bielefeld University
24  *
25  * ============================================================ */
26 
27 #pragma once
28 
29 #include <boost/cstdint.hpp>
30 #include <boost/operators.hpp>
31 #include <boost/thread.hpp>
32 #include <boost/shared_ptr.hpp>
33 
34 #include <rsc/misc/UUID.h>
35 #include <rsc/runtime/Printable.h>
36 
37 #include "rsb/rsbexports.h"
38 
39 namespace rsb {
40 
48 class RSB_EXPORT EventId: boost::totally_ordered<EventId>,
49  public rsc::runtime::Printable {
50 public:
51 
52  EventId(const rsc::misc::UUID& participantId,
53  const boost::uint32_t& sequenceNumber);
54  virtual ~EventId();
55 
56  rsc::misc::UUID getParticipantId() const;
57  boost::uint32_t getSequenceNumber() const;
58 
59  rsc::misc::UUID getAsUUID() const;
60 
61  bool operator==(const EventId& other) const;
62  bool operator<(const EventId& other) const;
63 
64  std::string getClassName() const;
65  void printContents(std::ostream& stream) const;
66 
67 private:
68 
72  rsc::misc::UUID participantId;
73  boost::uint32_t sequenceNumber;
74 
78  mutable rsc::misc::UUIDPtr id;
79 
80 };
81 
82 typedef boost::shared_ptr<EventId> EventIdPtr;
83 
84 }
boost::uint32_t sequenceNumber
Definition: EventId.h:73
boost::shared_ptr< EventId > EventIdPtr
Definition: Event.h:46
rsc::misc::UUIDPtr id
A cache for the generated uuid.
Definition: EventId.h:78
rsc::misc::UUID participantId
The id of the sending participant.
Definition: EventId.h:72
A unique ID for events in RSB.
Definition: EventId.h:48