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

Detailed Description

Declares a class derived from "CObservation" that represents one (or more) range measurements to labeled beacons.

See Also
CObservation

Definition at line 28 of file obs/CObservationBeaconRanges.h.

#include <mrpt/obs/CObservationBeaconRanges.h>

Inheritance diagram for mrpt::obs::CObservationBeaconRanges:
Inheritance graph

Classes

struct  TMeasurement
 Each one of the measurements: 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 ()
 
 CObservationBeaconRanges ()
 Default constructor. More...
 
void debugPrintOut ()
 Prints out the contents of the object. More...
 
void getSensorPose (mrpt::poses::CPose3D &out_sensorPose) const MRPT_OVERRIDE
 A general method to retrieve the sensor pose on the robot. More...
 
void setSensorPose (const mrpt::poses::CPose3D &newSensorPose) MRPT_OVERRIDE
 A general method to change the sensor pose on the robot. More...
 
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. More...
 
float getSensedRangeByBeaconID (int32_t beaconID)
 Easy look-up into the vector sensedData, returns the range for a given beacon, or 0 if the beacon is not observed. 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 mxArraywriteToMatlab () 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

float minSensorDistance
 Information about the sensor: More...
 
float maxSensorDistance
 
float stdError
 The "sigma" of the sensor, assuming a zero-mean Gaussian noise model. More...
 
std::deque< TMeasurementsensedData
 The list of observed ranges: More...
 
mrpt::poses::CPose2D auxEstimatePose
 The (X,Y,PHI) pose estimated by the UWB software, for comparison purposes (Added in streamming version 1) 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...
 

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. More...
 
std::string sensorLabel
 An arbitrary label that can be used to identify the sensor. More...
 
mrpt::system::TTimeStamp getTimeStamp () const
 Returns CObservation::timestamp for all kind of observations. More...
 
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. More...
 

RTTI stuff

typedef CObservationBeaconRangesPtr SmartPtr
 
static mrpt::utils::CLASSINIT _init_CObservationBeaconRanges
 
static mrpt::utils::TRuntimeClassId classCObservationBeaconRanges
 
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::CObjectduplicate () const
 Returns a copy of the object, indepently of its class. More...
 
static mrpt::utils::CObjectCreateObject ()
 
static CObservationBeaconRangesPtr Create ()
 

Member Typedef Documentation

typedef CObservationBeaconRangesPtr mrpt::obs::CObservationBeaconRanges::SmartPtr

A typedef for the associated smart pointer

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

Constructor & Destructor Documentation

mrpt::obs::CObservationBeaconRanges::CObservationBeaconRanges ( )

Default constructor.

Member Function Documentation

static const mrpt::utils::TRuntimeClassId* mrpt::obs::CObservationBeaconRanges::_GetBaseClass ( )
staticprotected
CObject* mrpt::utils::CObject::clone ( ) const
inlineinherited

Cloning interface for smart pointers.

Definition at line 139 of file CObject.h.

static CObservationBeaconRangesPtr mrpt::obs::CObservationBeaconRanges::Create ( )
static
static mrpt::utils::CObject* mrpt::obs::CObservationBeaconRanges::CreateObject ( )
static
void mrpt::obs::CObservationBeaconRanges::debugPrintOut ( )

Prints out the contents of the object.

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

Returns a copy of the object, indepently of its class.

Implements mrpt::utils::CObject.

mrpt::utils::CObjectPtr mrpt::utils::CObject::duplicateGetSmartPtr ( ) const
inlineinherited

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).

Definition at line 136 of file CObject.h.

void mrpt::obs::CObservationBeaconRanges::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.

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.

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

Returns information about the class of an object in runtime.

Reimplemented from mrpt::obs::CObservation.

float mrpt::obs::CObservationBeaconRanges::getSensedRangeByBeaconID ( int32_t  beaconID)

Easy look-up into the vector sensedData, returns the range for a given beacon, or 0 if the beacon is not observed.

void mrpt::obs::CObservationBeaconRanges::getSensorPose ( mrpt::poses::CPose3D out_sensorPose) const
virtual

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.

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
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.

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.

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.

void mrpt::obs::CObservationBeaconRanges::operator delete ( void *  ptr) throw ()
inline

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

void mrpt::obs::CObservationBeaconRanges::operator delete ( void *  memory,
void *  ptr 
) throw ()
inline

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

void mrpt::obs::CObservationBeaconRanges::operator delete ( void *  ptr,
const std::nothrow_t &   
) throw ()
inline

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

void mrpt::obs::CObservationBeaconRanges::operator delete[] ( void *  ptr) throw ()
inline

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

void* mrpt::obs::CObservationBeaconRanges::operator new ( size_t  size,
const std::nothrow_t &   
) throw ()
inline

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

static void* mrpt::obs::CObservationBeaconRanges::operator new ( size_t  size,
void *  ptr 
)
inlinestatic

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

void* mrpt::obs::CObservationBeaconRanges::operator new ( size_t  size)
inline

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

void* mrpt::obs::CObservationBeaconRanges::operator new[] ( size_t  size)
inline

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

void mrpt::obs::CObservationBeaconRanges::readFromStream ( mrpt::utils::CStream in,
int  version 
)
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.

Parameters
inThe input binary stream where the object data must read from.
versionThe version of the object stored in the stream: use this version number in your code to know how to read the incoming data.
Exceptions
std::exceptionOn any error, see CStream::ReadBuffer
See Also
CStream

Implements mrpt::utils::CSerializable.

void mrpt::obs::CObservationBeaconRanges::setSensorPose ( const mrpt::poses::CPose3D newSensorPose)
virtual

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.

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
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.

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.

virtual mxArray* mrpt::utils::CSerializable::writeToMatlab ( ) const
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.

Returns
A new 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.

void mrpt::obs::CObservationBeaconRanges::writeToStream ( mrpt::utils::CStream out,
int *  getVersion 
) const
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.

Parameters
outThe output binary stream where object must be dumped.
getVersionIf 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.
Exceptions
std::exceptionOn any error, see CStream::WriteBuffer
See Also
CStream

Implements mrpt::utils::CSerializable.

Member Data Documentation

mrpt::utils::CLASSINIT mrpt::obs::CObservationBeaconRanges::_init_CObservationBeaconRanges
staticprotected

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

mrpt::poses::CPose2D mrpt::obs::CObservationBeaconRanges::auxEstimatePose

The (X,Y,PHI) pose estimated by the UWB software, for comparison purposes (Added in streamming version 1)

Definition at line 71 of file obs/CObservationBeaconRanges.h.

const mrpt::utils::TRuntimeClassId mrpt::utils::CObject::classCObject
staticinherited

Definition at line 124 of file CObject.h.

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

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

mrpt::utils::TRuntimeClassId mrpt::obs::CObservationBeaconRanges::classCObservationBeaconRanges
static

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

const mrpt::utils::TRuntimeClassId mrpt::utils::CSerializable::classCSerializable
staticinherited

Definition at line 42 of file CSerializable.h.

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

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

float mrpt::obs::CObservationBeaconRanges::maxSensorDistance

Definition at line 40 of file obs/CObservationBeaconRanges.h.

float mrpt::obs::CObservationBeaconRanges::minSensorDistance

Information about the sensor:

Definition at line 40 of file obs/CObservationBeaconRanges.h.

std::deque<TMeasurement> mrpt::obs::CObservationBeaconRanges::sensedData

The list of observed ranges:

Definition at line 68 of file obs/CObservationBeaconRanges.h.

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.

float mrpt::obs::CObservationBeaconRanges::stdError

The "sigma" of the sensor, assuming a zero-mean Gaussian noise model.

Definition at line 44 of file obs/CObservationBeaconRanges.h.

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.




Page generated by Doxygen 1.8.3.1 for MRPT 1.4.0 SVN:Unversioned directory at Fri Apr 22 11:21:46 CEST 2016 Hosted on:
SourceForge.net Logo