MRPT  2.0.3
CAction.h
Go to the documentation of this file.
1 /* +------------------------------------------------------------------------+
2  | Mobile Robot Programming Toolkit (MRPT) |
3  | https://www.mrpt.org/ |
4  | |
5  | Copyright (c) 2005-2020, Individual contributors, see AUTHORS file |
6  | See: https://www.mrpt.org/Authors - All rights reserved. |
7  | Released under BSD License. See: https://www.mrpt.org/License |
8  +------------------------------------------------------------------------+ */
9 #pragma once
10 
12 #include <mrpt/system/datetime.h>
13 
14 namespace mrpt::obs
15 {
16 /** Declares a class for storing a robot action. It is used in
17  * mrpt::obs::CRawlog,
18  * for logs storage and particle filter based simulations.
19  * See derived classes for implementations.
20  *
21  * \sa CActionCollection, CRawlog
22  * \ingroup mrpt_obs_grp
23  */
25 {
27  public:
28  /** Default ctor */
29  CAction() = default;
30  ~CAction() override = default;
31 
32  /** The associated time-stamp.*/
34 
35  /** Build a detailed, multi-line textual description of the action
36  * contents and dump it to the output stream.
37  * \note If overried by derived classes, call base
38  * CAction::getDescriptionAsText() first to show common information.
39  */
40  virtual void getDescriptionAsText(std::ostream& o) const;
41 
42  /** Return by value version of getDescriptionAsText(std::ostream&) */
43  std::string getDescriptionAsTextValue() const;
44 
45 }; // End of class def.
46 
47 } // namespace mrpt::obs
INVALID_TIMESTAMP
#define INVALID_TIMESTAMP
Represents an invalid timestamp, where applicable.
Definition: datetime.h:43
mrpt::obs
This namespace contains representation of robot actions and observations.
Definition: CParticleFilter.h:17
mrpt::obs::CAction::~CAction
~CAction() override=default
mrpt::obs::CAction::CAction
CAction()=default
Default ctor.
mrpt::serialization::CSerializable
The virtual base class which provides a unified interface for all persistent objects in MRPT.
Definition: CSerializable.h:30
mrpt::system::TTimeStamp
mrpt::Clock::time_point TTimeStamp
A system independent time type, it holds the the number of 100-nanosecond intervals since January 1,...
Definition: datetime.h:40
DEFINE_VIRTUAL_SERIALIZABLE
#define DEFINE_VIRTUAL_SERIALIZABLE(class_name)
This declaration must be inserted in virtual CSerializable classes definition:
Definition: CSerializable.h:171
mrpt::obs::CAction::getDescriptionAsText
virtual void getDescriptionAsText(std::ostream &o) const
Build a detailed, multi-line textual description of the action contents and dump it to the output str...
Definition: CAction.cpp:22
mrpt::obs::CAction::getDescriptionAsTextValue
std::string getDescriptionAsTextValue() const
Return by value version of getDescriptionAsText(std::ostream&)
Definition: CAction.cpp:34
mrpt::obs::CAction
Declares a class for storing a robot action.
Definition: CAction.h:24
CSerializable.h
mrpt::obs::CAction::timestamp
mrpt::system::TTimeStamp timestamp
The associated time-stamp.
Definition: CAction.h:33
datetime.h



Page generated by Doxygen 1.8.17 for MRPT 2.0.3 at Fri May 15 15:49:54 UTC 2020