MIRA
VisualizationTextTrace.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2012 by
3  * MetraLabs GmbH (MLAB), GERMANY
4  * and
5  * Neuroinformatics and Cognitive Robotics Labs (NICR) at TU Ilmenau, GERMANY
6  * All rights reserved.
7  *
8  * Contact: info@mira-project.org
9  *
10  * Commercial Usage:
11  * Licensees holding valid commercial licenses may use this file in
12  * accordance with the commercial license agreement provided with the
13  * software or, alternatively, in accordance with the terms contained in
14  * a written agreement between you and MLAB or NICR.
15  *
16  * GNU General Public License Usage:
17  * Alternatively, this file may be used under the terms of the GNU
18  * General Public License version 3.0 as published by the Free Software
19  * Foundation and appearing in the file LICENSE.GPL3 included in the
20  * packaging of this file. Please review the following information to
21  * ensure the GNU General Public License version 3.0 requirements will be
22  * met: http://www.gnu.org/copyleft/gpl.html.
23  * Alternatively you may (at your option) use any later version of the GNU
24  * General Public License if such license has been publicly approved by
25  * MLAB and NICR (or its successors, if any).
26  *
27  * IN NO EVENT SHALL "MLAB" OR "NICR" BE LIABLE TO ANY PARTY FOR DIRECT,
28  * INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF
29  * THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF "MLAB" OR
30  * "NICR" HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  *
32  * "MLAB" AND "NICR" SPECIFICALLY DISCLAIM ANY WARRANTIES, INCLUDING,
33  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
34  * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
35  * ON AN "AS IS" BASIS, AND "MLAB" AND "NICR" HAVE NO OBLIGATION TO
36  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS OR MODIFICATIONS.
37  */
38 
47 #ifndef _MIRA_VISUALIZATIONTEXTTRACE_H_
48 #define _MIRA_VISUALIZATIONTEXTTRACE_H_
49 
51 
52 namespace mira {
53 
55 
57 {
58 public:
60 public:
61  virtual void setName(const std::string& name) = 0;
62  virtual void setStamped(const Time& timestamp, const std::string& frameID,
63  uint32 sequenceID, const std::string& text) = 0;
64  template <typename T>
65  void setStamped(const Stamped<T>& stamped) {
66  setStamped(stamped.timestamp, stamped.frameID, stamped.sequenceID);
67  }
68 };
69 
71 {
72 public:
73 
74  virtual IVisualizationTextTraceItem* addItem() = 0;
75  virtual void destroyItem(IVisualizationTextTraceItem* item) = 0;
76 
77  virtual void clipHistory(const Time& timestamp) = 0;
78 
79  virtual bool isAcceptingUpdates() { return true; }
80 };
81 
83 
90  public Visualization
91 {
93 public:
94 
97 
98  template <typename Reflector>
99  void reflect(Reflector& r) {
101 
102  // don't need to reflect mPrecision as that is stored
103  // in the site and forwarded to all visualizations
104  }
105 
106 public:
107 
119  virtual void init(IVisualizationSite* site);
120 
121 
122 public:
123 
129  virtual IVisualizationTextTraceSite* getSite();
130 
131 public:
132 
140  virtual void setupScene(IVisualizationTextTraceSite* site) = 0;
141 
142 public:
143 
147  void setPrecision(uint precision);
148 
152  virtual IVisualizationTextTraceItem* getItem() = 0;
153 
154 protected:
155 
157 
158 private:
159 
161 };
162 
164 
165 }
166 
167 #endif
void setStamped(const Stamped< T > &stamped)
Definition: VisualizationTextTrace.h:65
Time timestamp
The time stamp when the data was obtained.
Definition: Stamped.h:104
specialize cv::DataType for our ImgPixel and inherit from cv::DataType<Vec>
Definition: IOService.h:67
Abstract base class for all derived visualizations, namely Visualization3D and Visualization2D.
Definition: Visualization.h:90
Definition: VisualizationTextTrace.h:70
#define MIRA_REFLECT_BASE(reflector, BaseClass)
Macro that can be used to reflect the base class easily.
Definition: ReflectorInterface.h:912
virtual bool isAcceptingUpdates()
Definition: VisualizationTextTrace.h:79
void reflect(Reflector &r)
Definition: VisualizationTextTrace.h:99
The interface between a Visualization and the container of the visualization (e.g.
Definition: Visualization.h:75
virtual IVisualizationTextTraceItem * addItem()=0
Wrapper class for boost::posix_time::ptime for adding more functionality to it.
Definition: Time.h:418
#define MIRA_ABSTRACT_OBJECT(classIdentifier)
Use this MACRO instead of MIRA_OBJECT to declare the class as abstract.
Definition: FactoryMacros.h:235
The primary interface between a Visualization and the container of the visualization (e...
Definition: Visualization.h:65
Definition: VisualizationTextTrace.h:56
Declaration of Visualization and related classes.
Abstract base class for a text visualization tracing the data history.
Definition: VisualizationTextTrace.h:89
virtual void setStamped(const Time &timestamp, const std::string &frameID, uint32 sequenceID, const std::string &text)=0
virtual void clipHistory(const Time &timestamp)=0
Mix in for adding a time stamp, an optional frame id and an optional sequence id to data types like P...
Definition: Stamped.h:149
virtual void destroyItem(IVisualizationTextTraceItem *item)=0
#define MIRA_GUI_VISUALIZATION_EXPORT
Definition: GuiVisualizationExports.h:61
virtual ~VisualizationTextTrace()
Definition: VisualizationTextTrace.h:96
PropertyHint precision(int p)
Sets the attribute "precision".
Definition: PropertyHint.h:285
uint32 sequenceID
A user defined sequence ID.
Definition: Stamped.h:111
virtual void setName(const std::string &name)=0
std::string frameID
The unique id of the transform frame that this data is assigned to (if any, otherwise empty) ...
Definition: Stamped.h:108
uint mPrecision
Definition: VisualizationTextTrace.h:156
virtual ~IVisualizationTextTraceItem()
Definition: VisualizationTextTrace.h:59