Main MRPT website > C++ reference for MRPT 1.4.0
List of all members | Public Member Functions | Public Attributes | Protected Member Functions
mrpt::obs::CObservationOdometry Class Reference

Detailed Description

An observation of the current (cumulative) odometry for a wheeled robot.

This kind of observation will only occur in a "observation-only" rawlog file, otherwise odometry are modeled with actions. Refer to the page on rawlogs.

See also
CObservation, CActionRobotMovement2D

Definition at line 31 of file obs/CObservationOdometry.h.

#include <mrpt/obs/CObservationOdometry.h>

Inheritance diagram for mrpt::obs::CObservationOdometry:
Inheritance graph

Public Member Functions

 CObservationOdometry ()
 Constructor.
 
void getSensorPose (mrpt::poses::CPose3D &out_sensorPose) const MRPT_OVERRIDE
 A general method to retrieve the sensor pose on the robot.
 
void setSensorPose (const mrpt::poses::CPose3D &) MRPT_OVERRIDE
 A general method to change the sensor pose on the robot.
 
void getDescriptionAsText (std::ostream &o) const MRPT_OVERRIDE
 Build a detailed, multi-line textual description of the observation contents and dump it to the output stream.
 
template<class METRICMAP >
bool insertObservationInto (METRICMAP *theMap, const mrpt::poses::CPose3D *robotPose=NULL) const
 This method is equivalent to:
 
void getSensorPose (mrpt::math::TPose3D &out_sensorPose) const
 A general method to retrieve the sensor pose on the robot.
 
void setSensorPose (const mrpt::math::TPose3D &newSensorPose)
 A general method to change the sensor pose on the robot.
 
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.
 
virtual void unload ()
 Unload all images, for the case they being delayed-load images stored in external files (othewise, has no effect).
 

Public Attributes

poses::CPose2D odometry
 The absolute odometry measurement (IT IS NOT INCREMENTAL)
 
bool hasEncodersInfo
 "true" means that "encoderLeftTicks" and "encoderRightTicks" contain valid values.
 
int32_t encoderLeftTicks
 For odometry only: the ticks count for each wheel in ABSOLUTE VALUE (IT IS NOT INCREMENTAL) (positive means FORWARD, for both wheels);.
 
int32_t encoderRightTicks
 
bool hasVelocities
 "true" means that "velocityLin" and "velocityAng" contain valid values.
 
float velocityLin
 The velocity of the robot, linear in meters/sec and angular in rad/sec.
 
float velocityAng
 

Static Public Attributes

RTTI stuff <br>
static const mrpt::utils::TRuntimeClassId classCObservation
 

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.
 
CSerializable virtual methods
void writeToStream (mrpt::utils::CStream &out, int *getVersion) const MRPT_OVERRIDE
 
void readFromStream (mrpt::utils::CStream &in, int version) MRPT_OVERRIDE
 

RTTI stuff <br>

typedef CObservationOdometryPtr SmartPtr
 
static mrpt::utils::CLASSINIT _init_CObservationOdometry
 
static mrpt::utils::TRuntimeClassId classCObservationOdometry
 
static const mrpt::utils::TRuntimeClassIdclassinfo
 
static const mrpt::utils::TRuntimeClassId_GetBaseClass ()
 
virtual const mrpt::utils::TRuntimeClassIdGetRuntimeClass () const MRPT_OVERRIDE
 
virtual mrpt::utils::CObjectduplicate () const MRPT_OVERRIDE
 
static mrpt::utils::CObjectCreateObject ()
 
static CObservationOdometryPtr Create ()
 

Data common to any observation

mrpt::system::TTimeStamp timestamp
 The associated UTC time-stamp. Where available, this should contain the accurate satellite-based timestamp of the sensor reading.
 
std::string sensorLabel
 An arbitrary label that can be used to identify the sensor.
 
mrpt::system::TTimeStamp getTimeStamp () const
 Returns CObservation::timestamp for all kind of observations.
 
virtual mrpt::system::TTimeStamp getOriginalReceivedTimeStamp () const
 By default, returns CObservation::timestamp but in sensors capable of satellite (or otherwise) accurate UTC timing of readings, this contains the computer-based timestamp of reception, which may be slightly different than timestamp.
 

Member Typedef Documentation

◆ SmartPtr

A typedef for the associated smart pointer

Definition at line 34 of file obs/CObservationOdometry.h.

Constructor & Destructor Documentation

◆ CObservationOdometry()

mrpt::obs::CObservationOdometry::CObservationOdometry ( )

Constructor.

Member Function Documentation

◆ _GetBaseClass()

static const mrpt::utils::TRuntimeClassId * mrpt::obs::CObservationOdometry::_GetBaseClass ( )
staticprotected

◆ Create()

static CObservationOdometryPtr mrpt::obs::CObservationOdometry::Create ( )
static

◆ CreateObject()

static mrpt::utils::CObject * mrpt::obs::CObservationOdometry::CreateObject ( )
static

◆ duplicate()

virtual mrpt::utils::CObject * mrpt::obs::CObservationOdometry::duplicate ( ) const
virtual

◆ getDescriptionAsText()

void mrpt::obs::CObservationOdometry::getDescriptionAsText ( std::ostream &  o) const
virtual

Build a detailed, multi-line textual description of the observation contents and dump it to the output stream.

Note
If overried by derived classes, call base CObservation::getDescriptionAsText() first to show common information.
This is the text that appears in RawLogViewer when selecting an object in the dataset

Reimplemented from mrpt::obs::CObservation.

◆ getOriginalReceivedTimeStamp()

virtual mrpt::system::TTimeStamp mrpt::obs::CObservation::getOriginalReceivedTimeStamp ( ) const
inlinevirtualinherited

By default, returns CObservation::timestamp but in sensors capable of satellite (or otherwise) accurate UTC timing of readings, this contains the computer-based timestamp of reception, which may be slightly different than timestamp.

See also
getTimeStamp()

Reimplemented in mrpt::obs::CObservationGPS, and mrpt::obs::CObservationVelodyneScan.

Definition at line 65 of file obs/CObservation.h.

◆ GetRuntimeClass()

virtual const mrpt::utils::TRuntimeClassId * mrpt::obs::CObservationOdometry::GetRuntimeClass ( ) const
virtual

Reimplemented from mrpt::obs::CObservation.

◆ getSensorPose() [1/2]

void mrpt::obs::CObservation::getSensorPose ( mrpt::math::TPose3D out_sensorPose) const
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.

See also
setSensorPose

◆ getSensorPose() [2/2]

void mrpt::obs::CObservationOdometry::getSensorPose ( mrpt::poses::CPose3D out_sensorPose) const
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.

See also
setSensorPose

Implements mrpt::obs::CObservation.

Definition at line 58 of file obs/CObservationOdometry.h.

◆ getTimeStamp()

mrpt::system::TTimeStamp mrpt::obs::CObservation::getTimeStamp ( ) const
inlineinherited

Returns CObservation::timestamp for all kind of observations.

See also
getOriginalReceivedTimeStamp()

Definition at line 63 of file obs/CObservation.h.

◆ insertObservationInto()

template<class METRICMAP >
bool mrpt::obs::CObservation::insertObservationInto ( METRICMAP *  theMap,
const mrpt::poses::CPose3D robotPose = NULL 
) const
inlineinherited

This method is equivalent to:

map->insertObservation(this, robotPose)
Parameters
theMapThe map where this observation is to be inserted: the map will be updated.
robotPoseThe pose of the robot base for this observation, relative to the target metric map. Set to NULL (default) to use (0,0,0deg)
Returns
Returns true if the map has been updated, or false if this observations has nothing to do with a metric map (for example, a sound observation).
See also
CMetricMap, CMetricMap::insertObservation

Definition at line 83 of file obs/CObservation.h.

◆ load()

virtual void mrpt::obs::CObservation::load ( ) const
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.

See also
unload

Reimplemented in mrpt::obs::CObservation3DRangeScan.

Definition at line 125 of file obs/CObservation.h.

◆ readFromStream()

void mrpt::obs::CObservationOdometry::readFromStream ( mrpt::utils::CStream in,
int  version 
)
protected

◆ setSensorPose() [1/2]

void mrpt::obs::CObservation::setSensorPose ( const mrpt::math::TPose3D newSensorPose)
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.

See also
getSensorPose

◆ setSensorPose() [2/2]

void mrpt::obs::CObservationOdometry::setSensorPose ( const mrpt::poses::CPose3D newSensorPose)
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.

See also
getSensorPose

Implements mrpt::obs::CObservation.

Definition at line 59 of file obs/CObservationOdometry.h.

◆ swap()

void mrpt::obs::CObservation::swap ( CObservation o)
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.

◆ unload()

virtual void mrpt::obs::CObservation::unload ( )
inlinevirtualinherited

Unload all images, for the case they being delayed-load images stored in external files (othewise, has no effect).

See also
load

Reimplemented in mrpt::obs::CObservation3DRangeScan.

Definition at line 129 of file obs/CObservation.h.

◆ writeToStream()

void mrpt::obs::CObservationOdometry::writeToStream ( mrpt::utils::CStream out,
int *  getVersion 
) const
protected

Member Data Documentation

◆ _init_CObservationOdometry

mrpt::utils::CLASSINIT mrpt::obs::CObservationOdometry::_init_CObservationOdometry
staticprotected

Definition at line 34 of file obs/CObservationOdometry.h.

◆ classCObservation

const mrpt::utils::TRuntimeClassId mrpt::obs::CObservation::classCObservation
staticinherited

Definition at line 50 of file obs/CObservation.h.

◆ classCObservationOdometry

mrpt::utils::TRuntimeClassId mrpt::obs::CObservationOdometry::classCObservationOdometry
static

Definition at line 34 of file obs/CObservationOdometry.h.

◆ classinfo

const mrpt::utils::TRuntimeClassId* mrpt::obs::CObservationOdometry::classinfo
static

Definition at line 34 of file obs/CObservationOdometry.h.

◆ encoderLeftTicks

int32_t mrpt::obs::CObservationOdometry::encoderLeftTicks

For odometry only: the ticks count for each wheel in ABSOLUTE VALUE (IT IS NOT INCREMENTAL) (positive means FORWARD, for both wheels);.

See also
hasEncodersInfo

Definition at line 48 of file obs/CObservationOdometry.h.

◆ encoderRightTicks

int32_t mrpt::obs::CObservationOdometry::encoderRightTicks

Definition at line 48 of file obs/CObservationOdometry.h.

◆ hasEncodersInfo

bool mrpt::obs::CObservationOdometry::hasEncodersInfo

"true" means that "encoderLeftTicks" and "encoderRightTicks" contain valid values.

Definition at line 43 of file obs/CObservationOdometry.h.

◆ hasVelocities

bool mrpt::obs::CObservationOdometry::hasVelocities

"true" means that "velocityLin" and "velocityAng" contain valid values.

Definition at line 50 of file obs/CObservationOdometry.h.

◆ odometry

poses::CPose2D mrpt::obs::CObservationOdometry::odometry

The absolute odometry measurement (IT IS NOT INCREMENTAL)

Definition at line 41 of file obs/CObservationOdometry.h.

◆ sensorLabel

std::string mrpt::obs::CObservation::sensorLabel
inherited

An arbitrary label that can be used to identify the sensor.

Definition at line 60 of file obs/CObservation.h.

◆ timestamp

mrpt::system::TTimeStamp mrpt::obs::CObservation::timestamp
inherited

The associated UTC time-stamp. Where available, this should contain the accurate satellite-based timestamp of the sensor reading.

See also
getOriginalReceivedTimeStamp(), getTimeStamp()

Definition at line 59 of file obs/CObservation.h.

◆ velocityAng

float mrpt::obs::CObservationOdometry::velocityAng

Definition at line 54 of file obs/CObservationOdometry.h.

◆ velocityLin

float mrpt::obs::CObservationOdometry::velocityLin

The velocity of the robot, linear in meters/sec and angular in rad/sec.

Definition at line 54 of file obs/CObservationOdometry.h.




Page generated by Doxygen 1.9.8 for MRPT 1.4.0 SVN: at Thu Dec 14 16:41:50 UTC 2023