Detailed Description

Declares a class derived from "CObservation" that represents a set of readings from gas sensors.

See also: CObservation

Definition at line 25 of file CObservationGasSensors.h.

#include <mrpt/obs/CObservationGasSensors.h>

Inheritance diagram for mrpt::obs::CObservationGasSensors:

Classes
class	CMOSmodel
	Declares a class within "CObservationGasSensors" that represents a set of gas concentration readings from the modelation of a MOS gas sensor readings. More...

struct	TObservationENose
	The structure for each e-nose. More...

Public Member Functions
void *	operator new (size_t size)

void *	operator new[] (size_t size)

void	operator delete (void *ptr) noexcept

void	operator delete[] (void *ptr) noexcept

void	operator delete (void memory, void ptr) noexcept

void *	operator new (size_t size, const std::nothrow_t &) noexcept

void	operator delete (void *ptr, const std::nothrow_t &) noexcept

	CObservationGasSensors ()
	Constructor. More...

void	getSensorPose (mrpt::poses::CPose3D &out_sensorPose) const override
	A general method to retrieve the sensor pose on the robot. More...

void	setSensorPose (const mrpt::poses::CPose3D &newSensorPose) override
	A general method to change the sensor pose on the robot. More...

void	getDescriptionAsText (std::ostream &o) const override
	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=nullptr) 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...

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

RTTI classes and functions for polymorphic hierarchies
mrpt::rtti::CObject::Ptr	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...

Static Public Member Functions
static void *	operator new (size_t size, void *ptr)

Public Attributes
std::vector< TObservationENose >	m_readings
	One entry per e-nose on the robot. More...

Protected Member Functions
void	swap (CObservation &o)
	Swap with another observation, ONLY the data defined here in the base class CObservation. More...

CSerializable virtual methods
uint8_t	serializeGetVersion () const override
	Must return the current versioning number of the object. More...

void	serializeTo (mrpt::serialization::CArchive &out) const override
	Pure virtual method for writing (serializing) to an abstract archive. More...

void	serializeFrom (mrpt::serialization::CArchive &in, uint8_t serial_version) override
	Pure virtual method for reading (deserializing) from an abstract archive. More...

Data common to any observation
mrpt::system::TTimeStamp	timestamp {mrpt::system::now()}
	The associated UTC time-stamp. 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
using	Ptr = std::shared_ptr< CObservationGasSensors >

using	ConstPtr = std::shared_ptr< const CObservationGasSensors >

using	UniquePtr = std::unique_ptr< CObservationGasSensors >

using	ConstUniquePtr = std::unique_ptr< const CObservationGasSensors >

static mrpt::rtti::CLASSINIT	_init_CObservationGasSensors

static const mrpt::rtti::TRuntimeClassId	runtimeClassId

static constexpr const char *	className = "CObservationGasSensors"

static const mrpt::rtti::TRuntimeClassId *	_GetBaseClass ()

static constexpr auto	getClassName ()

static const mrpt::rtti::TRuntimeClassId &	GetRuntimeClassIdStatic ()

static mrpt::rtti::CObject *	CreateObject ()

template<typename... Args>
static Ptr	Create (Args &&... args)

template<typename... Args>
static UniquePtr	CreateUnique (Args &&... args)

virtual const mrpt::rtti::TRuntimeClassId *	GetRuntimeClass () const override
	Returns information about the class of an object in runtime. More...

virtual mrpt::rtti::CObject *	clone () const override
	Returns a deep copy (clone) of the object, indepently of its class. More...

Member Typedef Documentation

◆ ConstPtr

using mrpt::obs::CObservationGasSensors::ConstPtr = std::shared_ptr<const CObservationGasSensors >

Definition at line 27 of file CObservationGasSensors.h.

◆ ConstUniquePtr

using mrpt::obs::CObservationGasSensors::ConstUniquePtr = std::unique_ptr<const CObservationGasSensors >

Definition at line 27 of file CObservationGasSensors.h.

◆ Ptr

using mrpt::obs::CObservationGasSensors::Ptr = std::shared_ptr< CObservationGasSensors >

A type for the associated smart pointer

Definition at line 27 of file CObservationGasSensors.h.

◆ UniquePtr

using mrpt::obs::CObservationGasSensors::UniquePtr = std::unique_ptr< CObservationGasSensors >

Definition at line 27 of file CObservationGasSensors.h.

Constructor & Destructor Documentation

◆ CObservationGasSensors()

CObservationGasSensors::CObservationGasSensors ( )

Constructor.

Definition at line 27 of file CObservationGasSensors.cpp.

Member Function Documentation

◆ _GetBaseClass()

static const mrpt::rtti::TRuntimeClassId* mrpt::obs::CObservationGasSensors::_GetBaseClass ( )

staticprotected

◆ clone()

virtual mrpt::rtti::CObject* mrpt::obs::CObservationGasSensors::clone ( ) const

overridevirtual

Returns a deep copy (clone) of the object, indepently of its class.

Implements mrpt::rtti::CObject.

◆ Create()

template<typename... Args>

static Ptr mrpt::obs::CObservationGasSensors::Create ( Args &&... args )

inlinestatic

Definition at line 27 of file CObservationGasSensors.h.

◆ CreateObject()

static mrpt::rtti::CObject* mrpt::obs::CObservationGasSensors::CreateObject ( )

static

◆ CreateUnique()

template<typename... Args>

static UniquePtr mrpt::obs::CObservationGasSensors::CreateUnique ( Args &&... args )

inlinestatic

Definition at line 27 of file CObservationGasSensors.h.

◆ duplicateGetSmartPtr()

mrpt::rtti::CObject::Ptr 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 168 of file CObject.h.

References mrpt::rtti::CObject::clone().

Referenced by mrpt::obs::CRawlog::addActions(), and mrpt::obs::CRawlog::addObservations().

◆ getClassName()

static constexpr auto mrpt::obs::CObservationGasSensors::getClassName ( )

inlinestatic

Definition at line 27 of file CObservationGasSensors.h.

◆ getDescriptionAsText()

void CObservationGasSensors::getDescriptionAsText ( std::ostream & o ) const

overridevirtual

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.

Definition at line 347 of file CObservationGasSensors.cpp.

References ASSERT_, mrpt::format(), and mrpt::obs::CObservation::getDescriptionAsText().

◆ 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 71 of file CObservation.h.

References mrpt::obs::CObservation::timestamp.

◆ GetRuntimeClass()

virtual const mrpt::rtti::TRuntimeClassId* mrpt::obs::CObservationGasSensors::GetRuntimeClass ( ) const

overridevirtual

Returns information about the class of an object in runtime.

Reimplemented from mrpt::obs::CObservation.

◆ GetRuntimeClassIdStatic()

static const mrpt::rtti::TRuntimeClassId& mrpt::obs::CObservationGasSensors::GetRuntimeClassIdStatic ( )

static

◆ getSensorPose() [1/2]

void CObservationGasSensors::getSensorPose ( mrpt::poses::CPose3D & out_sensorPose ) const

overridevirtual

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 144 of file CObservationGasSensors.cpp.

◆ getSensorPose() [2/2]

void 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

Definition at line 26 of file CObservation.cpp.

◆ getTimeStamp()

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

inlineinherited

Returns CObservation::timestamp for all kind of observations.

See also: getOriginalReceivedTimeStamp()

Definition at line 66 of file CObservation.h.

References mrpt::obs::CObservation::timestamp.

◆ insertObservationInto()

template<class METRICMAP >

bool mrpt::obs::CObservation::insertObservationInto	(	METRICMAP *	theMap,
		const mrpt::poses::CPose3D *	robotPose = `nullptr`
	)		const

inlineinherited

This method is equivalent to:

map->insertObservation(this, robotPose)

Parameters

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 nullptr (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: Maps and observations compatibility matrix

See also: CMetricMap, CMetricMap::insertObservation

Definition at line 99 of file CObservation.h.

Referenced by mrpt::maps::COccupancyGridMap2D::computeObservationLikelihood_CellsDifference().

◆ 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 154 of file CObservation.h.

◆ operator delete() [1/3]

void mrpt::obs::CObservationGasSensors::operator delete	(	void *	memory,
		void *	ptr
	)

inlinenoexcept

Definition at line 27 of file CObservationGasSensors.h.

◆ operator delete() [2/3]

void mrpt::obs::CObservationGasSensors::operator delete ( void * ptr )

inlinenoexcept

Definition at line 27 of file CObservationGasSensors.h.

◆ operator delete() [3/3]

void mrpt::obs::CObservationGasSensors::operator delete	(	void *	ptr,
		const std::nothrow_t &
	)

inlinenoexcept

Definition at line 27 of file CObservationGasSensors.h.

◆ operator delete[]()

void mrpt::obs::CObservationGasSensors::operator delete[] ( void * ptr )

inlinenoexcept

Definition at line 27 of file CObservationGasSensors.h.

◆ operator new() [1/3]

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

inlinestatic

Definition at line 27 of file CObservationGasSensors.h.

◆ operator new() [2/3]

void* mrpt::obs::CObservationGasSensors::operator new ( size_t size )

inline

Definition at line 27 of file CObservationGasSensors.h.

◆ operator new() [3/3]

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

inlinenoexcept

Definition at line 27 of file CObservationGasSensors.h.

◆ operator new[]()

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

inline

Definition at line 27 of file CObservationGasSensors.h.

◆ serializeFrom()

void CObservationGasSensors::serializeFrom	(	mrpt::serialization::CArchive &	in,
		uint8_t	serial_version
	)

overrideprotectedvirtual

Pure virtual method for reading (deserializing) from an abstract archive.

Users don't call this method directly. Instead, use stream >> object;.

Parameters

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.

Exceptions

std::exception On any I/O error

Implements mrpt::serialization::CSerializable.

Definition at line 47 of file CObservationGasSensors.cpp.

References ASSERT_, mrpt::poses::CPose3D::asTPose(), mrpt::obs::CObservationGasSensors::TObservationENose::eNosePoseOnTheRobot, INVALID_TIMESTAMP, MRPT_THROW_UNKNOWN_SERIALIZATION_VERSION, mrpt::obs::CObservationGasSensors::TObservationENose::readingsVoltage, and mrpt::obs::CObservationGasSensors::TObservationENose::sensorTypes.

◆ serializeGetVersion()

uint8_t CObservationGasSensors::serializeGetVersion ( ) const

overrideprotectedvirtual

Must return the current versioning number of the object.

Start in zero for new classes, and increments each time there is a change in the stored format.

Implements mrpt::serialization::CSerializable.

Definition at line 28 of file CObservationGasSensors.cpp.

◆ serializeTo()

void CObservationGasSensors::serializeTo ( mrpt::serialization::CArchive & out ) const

overrideprotectedvirtual

Pure virtual method for writing (serializing) to an abstract archive.

Users don't call this method directly. Instead, use stream << object;.

Exceptions

std::exception On any I/O error

Implements mrpt::serialization::CSerializable.

Definition at line 29 of file CObservationGasSensors.cpp.

◆ setSensorPose() [1/2]

void CObservationGasSensors::setSensorPose ( const mrpt::poses::CPose3D & newSensorPose )

overridevirtual

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 152 of file CObservationGasSensors.cpp.

References mrpt::poses::CPose3D::asTPose().

◆ setSensorPose() [2/2]

void 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

Definition at line 33 of file CObservation.cpp.

◆ swap()

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

Definition at line 38 of file CObservation.cpp.

References mrpt::obs::CObservation::sensorLabel, and mrpt::obs::CObservation::timestamp.

Referenced by mrpt::obs::CObservationStereoImages::swap(), and mrpt::obs::CObservation3DRangeScan::swap().

◆ 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 161 of file CObservation.h.

◆ writeToMatlab()

virtual mxArray* mrpt::serialization::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 nullptr is class does not support conversion to MATLAB.

Definition at line 68 of file CSerializable.h.

Member Data Documentation

◆ _init_CObservationGasSensors

mrpt::rtti::CLASSINIT mrpt::obs::CObservationGasSensors::_init_CObservationGasSensors

staticprotected

Definition at line 27 of file CObservationGasSensors.h.

◆ className

constexpr const char* mrpt::obs::CObservationGasSensors::className = "CObservationGasSensors"

static

Definition at line 27 of file CObservationGasSensors.h.

◆ m_readings

std::vector<TObservationENose> mrpt::obs::CObservationGasSensors::m_readings

One entry per e-nose on the robot.

Definition at line 73 of file CObservationGasSensors.h.

Referenced by mrpt::hwdrivers::CRaePID::doProcess(), mrpt::hwdrivers::CRaePID::getFullInfo(), mrpt::hwdrivers::CEnoseModular::getObservation(), mrpt::hwdrivers::CBoardENoses::getObservation(), and mrpt::maps::CGasConcentrationGridMap2D::internal_insertObservation().

◆ runtimeClassId

const mrpt::rtti::TRuntimeClassId mrpt::obs::CObservationGasSensors::runtimeClassId

staticprotected

Definition at line 27 of file CObservationGasSensors.h.

◆ sensorLabel

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

inherited

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

Definition at line 62 of file CObservation.h.

◆ timestamp

mrpt::system::TTimeStamp mrpt::obs::CObservation::timestamp {mrpt::system::now()}

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 60 of file CObservation.h.

Detailed Description

Classes

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Data common to any observation

RTTI stuff

Member Typedef Documentation

◆ ConstPtr

◆ ConstUniquePtr

◆ Ptr

◆ UniquePtr

Constructor & Destructor Documentation

◆ CObservationGasSensors()

Member Function Documentation

◆ _GetBaseClass()

◆ clone()

◆ Create()

◆ CreateObject()

◆ CreateUnique()

◆ duplicateGetSmartPtr()

◆ getClassName()

◆ getDescriptionAsText()

◆ getOriginalReceivedTimeStamp()

◆ GetRuntimeClass()

◆ GetRuntimeClassIdStatic()

◆ getSensorPose() [1/2]

◆ getSensorPose() [2/2]

◆ getTimeStamp()

◆ insertObservationInto()

◆ load()

◆ operator delete() [1/3]

◆ operator delete() [2/3]

◆ operator delete() [3/3]

◆ operator delete[]()

◆ operator new() [1/3]

◆ operator new() [2/3]

◆ operator new() [3/3]

◆ operator new[]()

◆ serializeFrom()

◆ serializeGetVersion()

◆ serializeTo()

◆ setSensorPose() [1/2]

◆ setSensorPose() [2/2]

◆ swap()

◆ unload()

◆ writeToMatlab()

Member Data Documentation

◆ _init_CObservationGasSensors

◆ className

◆ m_readings

◆ runtimeClassId

◆ sensorLabel

◆ timestamp