Main MRPT website
>
C++ reference for MRPT 1.4.0
mrpt
obs
obs/CObservationComment.h
Go to the documentation of this file.
1
/* +---------------------------------------------------------------------------+
2
| Mobile Robot Programming Toolkit (MRPT) |
3
| http://www.mrpt.org/ |
4
| |
5
| Copyright (c) 2005-2016, Individual contributors, see AUTHORS file |
6
| See: http://www.mrpt.org/Authors - All rights reserved. |
7
| Released under BSD License. See details in http://www.mrpt.org/License |
8
+---------------------------------------------------------------------------+ */
9
#ifndef CObservationComment_H
10
#define CObservationComment_H
11
12
#include <
mrpt/utils/CSerializable.h
>
13
#include <
mrpt/obs/CObservation.h
>
14
15
namespace
mrpt
16
{
17
namespace
obs
18
{
19
DEFINE_SERIALIZABLE_PRE_CUSTOM_BASE_LINKAGE
( CObservationComment , CObservation,
OBS_IMPEXP
)
20
21
22
/** This "observation" is actually a placeholder for a text block with comments or additional parameters attached to a given rawlog file.
23
* There should be only one of this observations in a rawlog file, and it's recommended to insert/modify them from the application RawlogViewer.
24
*
25
* \sa CObservation
26
* \ingroup mrpt_obs_grp
27
*/
28
class
OBS_IMPEXP
CObservationComment
: public
CObservation
29
{
30
// This must be added to any CSerializable derived class:
31
DEFINE_SERIALIZABLE
(
CObservationComment
)
32
33
public
:
34
/** Constructor.
35
*/
36
CObservationComment
( ) :
37
text()
38
{ }
39
40
/** Destructor
41
*/
42
virtual
~CObservationComment
()
43
{ }
44
45
/** The text block. */
46
std::string
text
;
47
48
// See base class docs
49
void
getSensorPose
(
mrpt::poses::CPose3D
& )
const
MRPT_OVERRIDE
{ }
50
void
setSensorPose
(
const
mrpt::poses::CPose3D
& )
MRPT_OVERRIDE
{ }
51
void
getDescriptionAsText(std::ostream &o)
const
MRPT_OVERRIDE
;
52
53
};
// End of class def.
54
DEFINE_SERIALIZABLE_POST_CUSTOM_BASE_LINKAGE
( CObservationComment , CObservation,
OBS_IMPEXP
)
55
56
}
// End of namespace
57
}
// End of namespace
58
59
#endif
mrpt::obs::CObservationComment::text
std::string text
The text block.
Definition:
obs/CObservationComment.h:46
CObservation.h
mrpt::obs::CObservationComment::CObservationComment
CObservationComment()
Constructor.
Definition:
obs/CObservationComment.h:36
mrpt::obs::CObservationComment
This "observation" is actually a placeholder for a text block with comments or additional parameters ...
Definition:
obs/CObservationComment.h:28
mrpt
This is the global namespace for all Mobile Robot Programming Toolkit (MRPT) libraries.
Definition:
CParticleFilter.h:16
mrpt::obs::CObservationComment::setSensorPose
void setSensorPose(const mrpt::poses::CPose3D &) MRPT_OVERRIDE
A general method to change the sensor pose on the robot.
Definition:
obs/CObservationComment.h:50
mrpt::poses::CPose3D
A class used to store a 3D pose (a 3D translation + a rotation in 3D).
Definition:
CPose3D.h:72
DEFINE_SERIALIZABLE_POST_CUSTOM_BASE_LINKAGE
#define DEFINE_SERIALIZABLE_POST_CUSTOM_BASE_LINKAGE(class_name, base_name, _LINKAGE_)
Definition:
CSerializable.h:174
mrpt::obs::CObservationComment::~CObservationComment
virtual ~CObservationComment()
Destructor.
Definition:
obs/CObservationComment.h:42
DEFINE_SERIALIZABLE_PRE_CUSTOM_BASE_LINKAGE
#define DEFINE_SERIALIZABLE_PRE_CUSTOM_BASE_LINKAGE(class_name, base_name, _LINKAGE_)
This declaration must be inserted in all CSerializable classes definition, before the class declarati...
Definition:
CSerializable.h:170
OBS_IMPEXP
#define OBS_IMPEXP
Definition:
obs/include/mrpt/obs/link_pragmas.h:90
DEFINE_SERIALIZABLE
#define DEFINE_SERIALIZABLE(class_name)
This declaration must be inserted in all CSerializable classes definition, within the class declarati...
Definition:
CSerializable.h:147
mrpt::obs::CObservation
Declares a class that represents any robot's observation.
Definition:
obs/CObservation.h:47
mrpt::obs::CObservationComment::getSensorPose
void getSensorPose(mrpt::poses::CPose3D &) const MRPT_OVERRIDE
A general method to retrieve the sensor pose on the robot.
Definition:
obs/CObservationComment.h:49
CSerializable.h
MRPT_OVERRIDE
#define MRPT_OVERRIDE
C++11 "override" for virtuals:
Definition:
mrpt_macros.h:28
Page generated by
Doxygen 1.8.16
for MRPT 1.4.0 SVN: at Mon Oct 14 23:08:25 UTC 2019