Declares a class derived from "CObservation" that represents a Global Positioning System (GPS) reading.
Definition at line 28 of file obs/CObservationGPS.h.
#include <mrpt/obs/CObservationGPS.h>
Classes | |
struct | TGPSDatum_GGA |
The GPS datum for GGA commands. More... | |
struct | TGPSDatum_PZS |
The GPS datum for TopCon's mmGPS devices. More... | |
struct | TGPSDatum_RMC |
The GPS datum for RMC commands. More... | |
struct | TGPSDatum_SATS |
A generic structure for statistics about tracked satelites and their positions. More... | |
struct | TUTCTime |
A UTC time-stamp structure for GPS messages. More... | |
Public Member Functions | |
void * | operator new (size_t size) |
void * | operator new[] (size_t size) |
void | operator delete (void *ptr) throw () |
void | operator delete[] (void *ptr) throw () |
void | operator delete (void *memory, void *ptr) throw () |
void * | operator new (size_t size, const std::nothrow_t &) throw () |
void | operator delete (void *ptr, const std::nothrow_t &) throw () |
CObservationGPS () | |
ctor More... | |
void | dumpToStream (mrpt::utils::CStream &out) const |
Dumps the contents of the observation in a human-readable form to a given output stream. More... | |
void | dumpToConsole (std::ostream &o=std::cout) const |
Dumps the contents of the observation in a human-readable form to the console. More... | |
void | clear () |
Empties this observation, setting all "has_*_datum" to "false". More... | |
void | getSensorPose (mrpt::poses::CPose3D &out_sensorPose) const |
A general method to retrieve the sensor pose on the robot. More... | |
void | setSensorPose (const mrpt::poses::CPose3D &newSensorPose) |
A general method to change the sensor pose on the robot. More... | |
virtual void | getDescriptionAsText (std::ostream &o) const |
Build a detailed, multi-line textual description of the observation contents and dump it to the output stream. More... | |
template<class METRICMAP > | |
bool | insertObservationInto (METRICMAP *theMap, const mrpt::poses::CPose3D *robotPose=NULL) const |
This method is equivalent to: More... | |
void | getSensorPose (mrpt::math::TPose3D &out_sensorPose) const |
A general method to retrieve the sensor pose on the robot. More... | |
void | setSensorPose (const mrpt::math::TPose3D &newSensorPose) |
A general method to change the sensor pose on the robot. More... | |
virtual mxArray * | writeToMatlab () const |
Introduces a pure virtual method responsible for writing to a mxArray Matlab object, typically a MATLAB struct whose contents are documented in each derived class. More... | |
mrpt::utils::CObjectPtr | duplicateGetSmartPtr () const |
Returns a copy of the object, indepently of its class, as a smart pointer (the newly created object will exist as long as any copy of this smart pointer). More... | |
CObject * | clone () const |
Cloning interface for smart pointers. More... | |
Delayed-load manual control methods. | |
virtual void | load () const |
Makes sure all images and other fields which may be externally stored are loaded in memory. More... | |
virtual void | unload () |
Unload all images, for the case they being delayed-load images stored in external files (othewise, has no effect). More... | |
Static Public Member Functions | |
static void * | operator new (size_t size, void *ptr) |
Public Attributes | |
mrpt::poses::CPose3D | sensorPose |
The sensor pose on the robot. More... | |
bool | has_GGA_datum |
Will be true if the corresponding field contains data read from the sensor, or false if it is not available. More... | |
bool | has_RMC_datum |
Will be true if the corresponding field contains data read from the sensor, or false if it is not available. More... | |
bool | has_PZS_datum |
Will be true if the corresponding field contains data read from the sensor, or false if it is not available. More... | |
bool | has_SATS_datum |
Will be true if the corresponding field contains data read from the sensor, or false if it is not available. More... | |
TGPSDatum_GGA | GGA_datum |
If "has_GGA_datum" is true, this contains the read GGA datum. More... | |
TGPSDatum_RMC | RMC_datum |
If "has_RMC_datum" is true, this contains the read RMC datum. More... | |
TGPSDatum_PZS | PZS_datum |
If "has_PZS_datum" is true, this contains the read PZS datum (TopCon's mmGPS devices only) More... | |
TGPSDatum_SATS | SATS_datum |
If "has_SATS_datum" is true, this contains the read PZS datum (TopCon's mmGPS devices only) More... | |
Data common to any observation | |
mrpt::system::TTimeStamp | timestamp |
The associated time-stamp. More... | |
std::string | sensorLabel |
An arbitrary label that can be used to identify the sensor. More... | |
Static Public Attributes | |
static const mrpt::utils::TRuntimeClassId | classCObject |
RTTI stuff | |
static const mrpt::utils::TRuntimeClassId | classCObservation |
RTTI stuff | |
static const mrpt::utils::TRuntimeClassId | classCSerializable |
Protected Member Functions | |
void | swap (CObservation &o) |
Swap with another observation, ONLY the data defined here in the base class CObservation. It's protected since it'll be only called from child classes that should know what else to swap appart from these common data. More... | |
CSerializable virtual methods | |
void | writeToStream (mrpt::utils::CStream &out, int *getVersion) const |
Introduces a pure virtual method responsible for writing to a CStream. More... | |
void | readFromStream (mrpt::utils::CStream &in, int version) |
Introduces a pure virtual method responsible for loading from a CStream This can not be used directly be users, instead use "stream >> object;" for reading it from a stream or "stream >> object_ptr;" if the class is unknown apriori. More... | |
RTTI stuff | |
typedef CObservationGPSPtr | SmartPtr |
static mrpt::utils::CLASSINIT | _init_CObservationGPS |
static mrpt::utils::TRuntimeClassId | classCObservationGPS |
static const mrpt::utils::TRuntimeClassId * | classinfo |
static const mrpt::utils::TRuntimeClassId * | _GetBaseClass () |
virtual const mrpt::utils::TRuntimeClassId * | GetRuntimeClass () const |
Returns information about the class of an object in runtime. More... | |
virtual mrpt::utils::CObject * | duplicate () const |
Returns a copy of the object, indepently of its class. More... | |
static mrpt::utils::CObject * | CreateObject () |
static CObservationGPSPtr | Create () |
typedef CObservationGPSPtr mrpt::obs::CObservationGPS::SmartPtr |
A typedef for the associated smart pointer
Definition at line 31 of file obs/CObservationGPS.h.
mrpt::obs::CObservationGPS::CObservationGPS | ( | ) |
ctor
|
staticprotected |
void mrpt::obs::CObservationGPS::clear | ( | ) |
Empties this observation, setting all "has_*_datum" to "false".
|
inlineinherited |
|
static |
|
static |
void mrpt::obs::CObservationGPS::dumpToConsole | ( | std::ostream & | o = std::cout | ) | const |
Dumps the contents of the observation in a human-readable form to the console.
void mrpt::obs::CObservationGPS::dumpToStream | ( | mrpt::utils::CStream & | out | ) | const |
Dumps the contents of the observation in a human-readable form to a given output stream.
|
virtual |
Returns a copy of the object, indepently of its class.
Implements mrpt::utils::CObject.
|
inlineinherited |
|
virtual |
Build a detailed, multi-line textual description of the observation contents and dump it to the output stream.
Reimplemented from mrpt::obs::CObservation.
|
virtual |
Returns information about the class of an object in runtime.
Reimplemented from mrpt::obs::CObservation.
|
inherited |
A general method to retrieve the sensor pose on the robot.
Note that most sensors will return a full (6D) CPose3D, but see the derived classes for more details or special cases.
|
inlinevirtual |
A general method to retrieve the sensor pose on the robot.
Note that most sensors will return a full (6D) CPose3D, but see the derived classes for more details or special cases.
Implements mrpt::obs::CObservation.
Definition at line 261 of file obs/CObservationGPS.h.
|
inlineinherited |
This method is equivalent to:
theMap | The map where this observation is to be inserted: the map will be updated. |
robotPose | The pose of the robot base for this observation, relative to the target metric map. Set to NULL (default) to use (0,0,0deg) |
Definition at line 91 of file obs/CObservation.h.
|
inlinevirtualinherited |
Makes sure all images and other fields which may be externally stored are loaded in memory.
Note that for all CImages, calling load() is not required since the images will be automatically loaded upon first access, so load() shouldn't be needed to be called in normal cases by the user. If all the data were alredy loaded or this object has no externally stored data fields, calling this method has no effects.
Reimplemented in mrpt::obs::CObservation3DRangeScan.
Definition at line 133 of file obs/CObservation.h.
|
inline |
Definition at line 31 of file obs/CObservationGPS.h.
|
inline |
Definition at line 31 of file obs/CObservationGPS.h.
|
inline |
Definition at line 31 of file obs/CObservationGPS.h.
|
inline |
Definition at line 31 of file obs/CObservationGPS.h.
|
inline |
Definition at line 31 of file obs/CObservationGPS.h.
|
inlinestatic |
Definition at line 31 of file obs/CObservationGPS.h.
|
inline |
Definition at line 31 of file obs/CObservationGPS.h.
|
inline |
Definition at line 31 of file obs/CObservationGPS.h.
|
protectedvirtual |
Introduces a pure virtual method responsible for loading from a CStream This can not be used directly be users, instead use "stream >> object;" for reading it from a stream or "stream >> object_ptr;" if the class is unknown apriori.
in | The input binary stream where the object data must read from. |
version | The version of the object stored in the stream: use this version number in your code to know how to read the incoming data. |
std::exception | On any error, see CStream::ReadBuffer |
Implements mrpt::utils::CSerializable.
|
inherited |
A general method to change the sensor pose on the robot.
Note that most sensors will use the full (6D) CPose3D, but see the derived classes for more details or special cases.
|
inlinevirtual |
A general method to change the sensor pose on the robot.
Note that most sensors will use the full (6D) CPose3D, but see the derived classes for more details or special cases.
Implements mrpt::obs::CObservation.
Definition at line 263 of file obs/CObservationGPS.h.
References DEFINE_SERIALIZABLE_POST_CUSTOM_BASE_LINKAGE, and OBS_IMPEXP.
|
protectedinherited |
Swap with another observation, ONLY the data defined here in the base class CObservation. It's protected since it'll be only called from child classes that should know what else to swap appart from these common data.
|
inlinevirtualinherited |
Unload all images, for the case they being delayed-load images stored in external files (othewise, has no effect).
Reimplemented in mrpt::obs::CObservation3DRangeScan.
Definition at line 137 of file obs/CObservation.h.
References DEFINE_SERIALIZABLE_POST_CUSTOM_BASE_LINKAGE, and OBS_IMPEXP.
|
inlinevirtualinherited |
Introduces a pure virtual method responsible for writing to a mxArray
Matlab object, typically a MATLAB struct
whose contents are documented in each derived class.
mxArray
(caller is responsible of memory freeing) or NULL is class does not support conversion to MATLAB. Definition at line 79 of file CSerializable.h.
References BASE_IMPEXP, mrpt::utils::CSerializablePtr, DEFINE_MRPT_OBJECT_POST, mrpt::utils::ObjectToOctetVector(), mrpt::utils::ObjectToRawString(), mrpt::utils::ObjectToString(), mrpt::utils::OctetVectorToObject(), mrpt::utils::RawStringToObject(), and mrpt::utils::StringToObject().
|
protectedvirtual |
Introduces a pure virtual method responsible for writing to a CStream.
This can not be used directly be users, instead use "stream << object;" for writing it to a stream.
out | The output binary stream where object must be dumped. |
getVersion | If NULL, the object must be dumped. If not, only the version of the object dump must be returned in this pointer. This enables the versioning of objects dumping and backward compatibility with previously stored data. |
std::exception | On any error, see CStream::WriteBuffer |
Implements mrpt::utils::CSerializable.
|
staticprotected |
Definition at line 31 of file obs/CObservationGPS.h.
|
staticinherited |
|
staticinherited |
Definition at line 53 of file obs/CObservation.h.
|
static |
Definition at line 31 of file obs/CObservationGPS.h.
|
staticinherited |
Definition at line 42 of file CSerializable.h.
|
static |
Definition at line 31 of file obs/CObservationGPS.h.
TGPSDatum_GGA mrpt::obs::CObservationGPS::GGA_datum |
If "has_GGA_datum" is true, this contains the read GGA datum.
Definition at line 252 of file obs/CObservationGPS.h.
bool mrpt::obs::CObservationGPS::has_GGA_datum |
Will be true if the corresponding field contains data read from the sensor, or false if it is not available.
Definition at line 235 of file obs/CObservationGPS.h.
bool mrpt::obs::CObservationGPS::has_PZS_datum |
Will be true if the corresponding field contains data read from the sensor, or false if it is not available.
Definition at line 245 of file obs/CObservationGPS.h.
bool mrpt::obs::CObservationGPS::has_RMC_datum |
Will be true if the corresponding field contains data read from the sensor, or false if it is not available.
Definition at line 240 of file obs/CObservationGPS.h.
bool mrpt::obs::CObservationGPS::has_SATS_datum |
Will be true if the corresponding field contains data read from the sensor, or false if it is not available.
Definition at line 250 of file obs/CObservationGPS.h.
TGPSDatum_PZS mrpt::obs::CObservationGPS::PZS_datum |
If "has_PZS_datum" is true, this contains the read PZS datum (TopCon's mmGPS devices only)
Definition at line 254 of file obs/CObservationGPS.h.
TGPSDatum_RMC mrpt::obs::CObservationGPS::RMC_datum |
If "has_RMC_datum" is true, this contains the read RMC datum.
Definition at line 253 of file obs/CObservationGPS.h.
TGPSDatum_SATS mrpt::obs::CObservationGPS::SATS_datum |
If "has_SATS_datum" is true, this contains the read PZS datum (TopCon's mmGPS devices only)
Definition at line 255 of file obs/CObservationGPS.h.
|
inherited |
An arbitrary label that can be used to identify the sensor.
Definition at line 69 of file obs/CObservation.h.
mrpt::poses::CPose3D mrpt::obs::CObservationGPS::sensorPose |
The sensor pose on the robot.
Definition at line 40 of file obs/CObservationGPS.h.
|
inherited |
The associated time-stamp.
Definition at line 65 of file obs/CObservation.h.
Page generated by Doxygen 1.8.12 for MRPT 1.3.2 SVN: at Thu Nov 10 13:46:27 UTC 2016 |