Main MRPT website > C++ reference for MRPT 1.4.0
obs/CObservationWirelessPower.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 CObservationWirelessPower_H
10 #define CObservationWirelessPower_H
11 
13 #include <mrpt/obs/CObservation.h>
14 #include <mrpt/poses/CPose3D.h>
15 #include <mrpt/poses/CPose2D.h>
16 
17 namespace mrpt
18 {
19 namespace obs
20 {
22 
23  /** This represents a measurement of the wireless strength perceived by the robot.
24  * The signal level is given as a percentage.
25  *
26  * \sa CObservation, mrpt::hwdrivers::CWirelessPower for a software sensor capable of reading this kind of observations.
27  * \ingroup mrpt_obs_grp
28  */
30  {
31  // This must be added to any CSerializable derived class:
33 
34  public:
35  /** Constructor */
37 
38  /** @name The data members
39  * @{ */
40 
41  double power; //!< The power or signal strength as sensed by the Wifi receiver (In percentage: [0-100])
42  mrpt::poses::CPose3D sensorPoseOnRobot; //!< The location of the sensing antenna on the robot coordinate framework
43 
44  /** @} */
45 
46  void getSensorPose( mrpt::poses::CPose3D &out_sensorPose ) const MRPT_OVERRIDE;// See base class docs
47  void setSensorPose( const mrpt::poses::CPose3D &newSensorPose ) MRPT_OVERRIDE;// See base class docs
48  void getDescriptionAsText(std::ostream &o) const MRPT_OVERRIDE;// See base class docs
49 
50  }; // End of class def.
52 
53 
54  } // End of namespace
55 } // End of namespace
56 
57 #endif
mrpt::obs::CObservationWirelessPower
This represents a measurement of the wireless strength perceived by the robot.
Definition: obs/CObservationWirelessPower.h:30
mrpt::obs::CObservationWirelessPower::CObservationWirelessPower
CObservationWirelessPower()
Constructor.
CObservation.h
mrpt
This is the global namespace for all Mobile Robot Programming Toolkit (MRPT) libraries.
Definition: CParticleFilter.h:17
CPose2D.h
mrpt::poses::CPose3D
A class used to store a 3D pose (a 3D translation + a rotation in 3D).
Definition: CPose3D.h:73
DEFINE_SERIALIZABLE_POST_CUSTOM_BASE_LINKAGE
#define DEFINE_SERIALIZABLE_POST_CUSTOM_BASE_LINKAGE(class_name, base_name, _LINKAGE_)
Definition: CSerializable.h:174
mrpt::obs::CObservationWirelessPower::power
double power
The power or signal strength as sensed by the Wifi receiver (In percentage: [0-100])
Definition: obs/CObservationWirelessPower.h:41
mrpt::obs::CObservationWirelessPower::getDescriptionAsText
void getDescriptionAsText(std::ostream &o) const MRPT_OVERRIDE
Build a detailed, multi-line textual description of the observation contents and dump it to the outpu...
CPose3D.h
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
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:48
mrpt::obs::CObservationWirelessPower::setSensorPose
void setSensorPose(const mrpt::poses::CPose3D &newSensorPose) MRPT_OVERRIDE
A general method to change the sensor pose on the robot.
mrpt::obs::CObservationWirelessPower::sensorPoseOnRobot
mrpt::poses::CPose3D sensorPoseOnRobot
The location of the sensing antenna on the robot coordinate framework.
Definition: obs/CObservationWirelessPower.h:42
CSerializable.h
mrpt::obs::CObservationWirelessPower::getSensorPose
void getSensorPose(mrpt::poses::CPose3D &out_sensorPose) const MRPT_OVERRIDE
A general method to retrieve the sensor pose on the robot.
MRPT_OVERRIDE
#define MRPT_OVERRIDE
C++11 "override" for virtuals:
Definition: mrpt_macros.h:28



Page generated by Doxygen 1.8.20 for MRPT 1.4.0 SVN: at Thu Aug 27 02:40:23 UTC 2020