realtime_box.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2009, Willow Garage, Inc.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  * * Redistributions in binary form must reproduce the above copyright
11  * notice, this list of conditions and the following disclaimer in the
12  * documentation and/or other materials provided with the distribution.
13  * * Neither the name of the Willow Garage, Inc. nor the names of its
14  * contributors may be used to endorse or promote products derived from
15  * this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
21  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27  * POSSIBILITY OF SUCH DAMAGE.
28  */
29 
30 // Author: Stuart Glaser
31 
32 #ifndef REALTIME_TOOLS__REALTIME_BOX_H__
33 #define REALTIME_TOOLS__REALTIME_BOX_H__
34 
35 #include <mutex>
36 #include <string>
37 
38 namespace realtime_tools {
39 
46 template <class T>
48 {
49 public:
50  RealtimeBox(const T &initial = T()) : thing_(initial)
51  {
52  }
53 
54  void set(const T &value)
55  {
56  std::lock_guard<std::mutex> guard(thing_lock_RT_);
57  thing_ = value;
58  }
59 
60  void get(T &ref)
61  {
62  std::lock_guard<std::mutex> guard(thing_lock_RT_);
63  ref = thing_;
64  }
65 
66 private:
67  // The thing that's in the box.
68  T thing_;
69 
70  // Protects access to the thing in the box. This mutex is
71  // guaranteed to be locked for no longer than the duration of the
72  // copy, so as long as the copy is realtime safe and the OS has
73  // priority inheritance for mutexes, this lock can be safely locked
74  // from within realtime.
75  std::mutex thing_lock_RT_;
76 };
77 
78 } // namespace
79 
80 #endif
realtime_tools::RealtimeBox::get
void get(T &ref)
Definition: realtime_box.h:60
realtime_tools::RealtimeBox::thing_lock_RT_
std::mutex thing_lock_RT_
Definition: realtime_box.h:75
realtime_tools::RealtimeBox
Definition: realtime_box.h:47
realtime_tools::RealtimeBox::RealtimeBox
RealtimeBox(const T &initial=T())
Definition: realtime_box.h:50
realtime_tools
Definition: realtime_box.h:38
realtime_tools::RealtimeBox::set
void set(const T &value)
Definition: realtime_box.h:54
realtime_tools::RealtimeBox::thing_
T thing_
Definition: realtime_box.h:68


realtime_tools
Author(s): Stuart Glaser
autogenerated on Mon Jan 8 2024 03:20:12