Detailed Description

This represents a measurement of the batteries on the robot.

The battery levels are in volts in the form of the public members:

voltageMainRobotBattery
voltageMainRobotComputer

voltageOtherBatteries

There are boolean flags for signaling when the corresponding values have been filled out or not.

See also: CObservation

Definition at line 31 of file CObservationBatteryState.h.

#include <mrpt/obs/CObservationBatteryState.h>

Inheritance diagram for mrpt::obs::CObservationBatteryState:

Public Member Functions
	CObservationBatteryState ()
	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
	Makes a deep copy of the object and returns a smart pointer to it. More...

Public Attributes
double	voltageMainRobotBattery {0}
	The data members. More...

double	voltageMainRobotComputer {0}

bool	voltageMainRobotBatteryIsValid {false}
	These values must be true if the corresponding fields contain valid values. More...

bool	voltageMainRobotComputerIsValid {false}

mrpt::math::CVectorDouble	voltageOtherBatteries
	The users can use this vector for any arbitrary number of batteries or any other analog measurements. More...

std::vector< bool >	voltageOtherBatteriesValid
	These values must be true if the corresponding fields contain valid values (it MUST has the same size than voltageOtherBatteries) 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...

CSerializable virtual methods
virtual void	serializeTo (CSchemeArchiveBase &out) const
	Virtual method for writing (serializing) to an abstract schema based archive. More...

virtual void	serializeFrom (CSchemeArchiveBase &in)
	Virtual method for reading (deserializing) from an abstract schema based 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< CObservationBatteryState >

using	ConstPtr = std::shared_ptr< const CObservationBatteryState >

using	UniquePtr = std::unique_ptr< CObservationBatteryState >

using	ConstUniquePtr = std::unique_ptr< const CObservationBatteryState >

static mrpt::rtti::CLASSINIT	_init_CObservationBatteryState

static const mrpt::rtti::TRuntimeClassId	runtimeClassId

static constexpr const char *	className = "CObservationBatteryState"

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

static constexpr auto	getClassName ()

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

static std::shared_ptr< CObject >	CreateObject ()

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

template<typename Alloc , typename... Args>
static Ptr	CreateAlloc (const Alloc &alloc, 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::CObservationBatteryState::ConstPtr = std::shared_ptr<const CObservationBatteryState >

Definition at line 33 of file CObservationBatteryState.h.

◆ ConstUniquePtr

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

Definition at line 33 of file CObservationBatteryState.h.

◆ Ptr

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

A type for the associated smart pointer

Definition at line 33 of file CObservationBatteryState.h.

◆ UniquePtr

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

Definition at line 33 of file CObservationBatteryState.h.

Constructor & Destructor Documentation

◆ CObservationBatteryState()

CObservationBatteryState::CObservationBatteryState ( )

Constructor.

Definition at line 25 of file CObservationBatteryState.cpp.

Member Function Documentation

◆ _GetBaseClass()

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

staticprotected

◆ clone()

virtual mrpt::rtti::CObject* mrpt::obs::CObservationBatteryState::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::CObservationBatteryState::Create ( Args &&... args )

inlinestatic

Definition at line 33 of file CObservationBatteryState.h.

◆ CreateAlloc()

template<typename Alloc , typename... Args>

static Ptr mrpt::obs::CObservationBatteryState::CreateAlloc	(	const Alloc &	alloc,
		Args &&...	args
	)

inlinestatic

Definition at line 33 of file CObservationBatteryState.h.

◆ CreateObject()

static std::shared_ptr<CObject> mrpt::obs::CObservationBatteryState::CreateObject ( )

static

◆ CreateUnique()

template<typename... Args>

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

inlinestatic

Definition at line 33 of file CObservationBatteryState.h.

◆ duplicateGetSmartPtr()

mrpt::rtti::CObject::Ptr CObject::duplicateGetSmartPtr ( ) const

inlineinherited

Makes a deep copy of the object and returns a smart pointer to it.

Definition at line 200 of file CObject.h.

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getClassName()

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

inlinestatic

Definition at line 33 of file CObservationBatteryState.h.

◆ getDescriptionAsText()

void CObservationBatteryState::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 82 of file CObservationBatteryState.cpp.

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

Here is the call graph for this function:

◆ 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::CObservationBatteryState::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::CObservationBatteryState::GetRuntimeClassIdStatic ( )

static

◆ getSensorPose() [1/2]

void CObservationBatteryState::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 71 of file CObservationBatteryState.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 25 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.

◆ 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, and mrpt::obs::CObservationPointCloud.

Definition at line 154 of file CObservation.h.

Referenced by mrpt::maps::COctoMapBase< octomap::OcTree, octomap::OcTreeNode >::internal_build_PointCloud_for_observation().

Here is the caller graph for this function:

◆ serializeFrom() [1/2]

void CObservationBatteryState::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 41 of file CObservationBatteryState.cpp.

References INVALID_TIMESTAMP, and MRPT_THROW_UNKNOWN_SERIALIZATION_VERSION.

◆ serializeFrom() [2/2]

virtual void mrpt::serialization::CSerializable::serializeFrom ( CSchemeArchiveBase & in )

inlineprotectedvirtualinherited

Virtual method for reading (deserializing) from an abstract schema based archive.

Definition at line 74 of file CSerializable.h.

References mrpt::serialization::CSerializable::GetRuntimeClass(), and THROW_EXCEPTION.

Here is the call graph for this function:

◆ serializeGetVersion()

uint8_t CObservationBatteryState::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 30 of file CObservationBatteryState.cpp.

◆ serializeTo() [1/2]

void CObservationBatteryState::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 31 of file CObservationBatteryState.cpp.

◆ serializeTo() [2/2]

virtual void mrpt::serialization::CSerializable::serializeTo ( CSchemeArchiveBase & out ) const

inlineprotectedvirtualinherited

Virtual method for writing (serializing) to an abstract schema based archive.

Definition at line 64 of file CSerializable.h.

References mrpt::serialization::CSerializable::GetRuntimeClass(), and THROW_EXCEPTION.

Here is the call graph for this function:

◆ setSensorPose() [1/2]

void CObservationBatteryState::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 77 of file CObservationBatteryState.cpp.

References MRPT_UNUSED_PARAM.

◆ 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 32 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 37 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().

Here is the caller graph for this function:

◆ 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, and mrpt::obs::CObservationPointCloud.

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 90 of file CSerializable.h.

Member Data Documentation

◆ _init_CObservationBatteryState

mrpt::rtti::CLASSINIT mrpt::obs::CObservationBatteryState::_init_CObservationBatteryState

staticprotected

Definition at line 33 of file CObservationBatteryState.h.

◆ className

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

static

Definition at line 33 of file CObservationBatteryState.h.

◆ runtimeClassId

const mrpt::rtti::TRuntimeClassId mrpt::obs::CObservationBatteryState::runtimeClassId

staticprotected

Definition at line 33 of file CObservationBatteryState.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.

◆ voltageMainRobotBattery

double mrpt::obs::CObservationBatteryState::voltageMainRobotBattery {0}

The data members.

See also: voltageMainRobotBatteryIsValid,voltageMainRobotComputerIsValid

Definition at line 43 of file CObservationBatteryState.h.

◆ voltageMainRobotBatteryIsValid

bool mrpt::obs::CObservationBatteryState::voltageMainRobotBatteryIsValid {false}

These values must be true if the corresponding fields contain valid values.

See also: voltageMainRobotBattery,voltageMainRobotComputer

Definition at line 49 of file CObservationBatteryState.h.

◆ voltageMainRobotComputer

double mrpt::obs::CObservationBatteryState::voltageMainRobotComputer {0}

Definition at line 43 of file CObservationBatteryState.h.

◆ voltageMainRobotComputerIsValid

bool mrpt::obs::CObservationBatteryState::voltageMainRobotComputerIsValid {false}

Definition at line 50 of file CObservationBatteryState.h.

◆ voltageOtherBatteries

mrpt::math::CVectorDouble mrpt::obs::CObservationBatteryState::voltageOtherBatteries

The users can use this vector for any arbitrary number of batteries or any other analog measurements.

See also: voltageOtherBatteriesValid

Definition at line 56 of file CObservationBatteryState.h.

◆ voltageOtherBatteriesValid

std::vector<bool> mrpt::obs::CObservationBatteryState::voltageOtherBatteriesValid

These values must be true if the corresponding fields contain valid values (it MUST has the same size than voltageOtherBatteries)

Definition at line 61 of file CObservationBatteryState.h.

Detailed Description

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

◆ CObservationBatteryState()

Member Function Documentation

◆ _GetBaseClass()

◆ clone()

◆ Create()

◆ CreateAlloc()

◆ CreateObject()

◆ CreateUnique()

◆ duplicateGetSmartPtr()

◆ getClassName()

◆ getDescriptionAsText()

◆ getOriginalReceivedTimeStamp()

◆ GetRuntimeClass()

◆ GetRuntimeClassIdStatic()

◆ getSensorPose() [1/2]

◆ getSensorPose() [2/2]

◆ getTimeStamp()

◆ insertObservationInto()

◆ load()

◆ serializeFrom() [1/2]

◆ serializeFrom() [2/2]

◆ serializeGetVersion()

◆ serializeTo() [1/2]

◆ serializeTo() [2/2]

◆ setSensorPose() [1/2]

◆ setSensorPose() [2/2]

◆ swap()

◆ unload()

◆ writeToMatlab()

Member Data Documentation

◆ _init_CObservationBatteryState

◆ className

◆ runtimeClassId

◆ sensorLabel

◆ timestamp

◆ voltageMainRobotBattery

◆ voltageMainRobotBatteryIsValid

◆ voltageMainRobotComputer

◆ voltageMainRobotComputerIsValid

◆ voltageOtherBatteries

◆ voltageOtherBatteriesValid