Detailed Description

This class stores a sequence of relative, incremental 2D poses.

It is useful as the bases storing unit for more complex probability particles and for computing the absolute pose of any intermediate pose.

See also: CPose2D, CMultiMetricMap

Definition at line 26 of file CPoses2DSequence.h.

#include <mrpt/poses/CPoses2DSequence.h>

Inheritance diagram for mrpt::poses::CPoses2DSequence:

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

	CPoses2DSequence ()
	Default constructor. More...

size_t	posesCount ()
	Returns the poses count in the sequence: More...

void	getPose (unsigned int ind, CPose2D &outPose)
	Reads the stored pose at index "ind", where the first one is 0, the last "posesCount() - 1". More...

void	changePose (unsigned int ind, CPose2D &inPose)
	Changes the stored pose at index "ind", where the first one is 0, the last "posesCount() - 1". More...

void	appendPose (CPose2D &newPose)
	Appends a new pose at the end of sequence. More...

void	clear ()
	Clears the sequence. More...

CPose2D	absolutePoseOf (unsigned int n)
	Returns the absolute pose of a robot after moving "n" poses, so for "n=0" the origin pose (0,0,0deg) is returned, for "n=1" the first pose is returned, and for "n=posesCount()", the pose of robot after moving ALL poses is returned, all of them relative to the starting pose. More...

CPose2D	absolutePoseAfterAll ()
	A shortcut for "absolutePoseOf( posesCount() )". More...

float	computeTraveledDistanceAfter (unsigned int n)
	Returns the traveled distance after moving "n" poses, so for "n=0" it returns 0, for "n=1" the first traveled distance, and for "n=posesCount()", the total distance after ALL movements. More...

float	computeTraveledDistanceAfterAll ()
	Returns the traveled distance after ALL movements. 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...

RTTI classes and functions
mrpt::utils::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)

Protected Member Functions
CSerializable virtual methods
void	writeToStream (mrpt::utils::CStream &out, int *getVersion) const override
	Introduces a pure virtual method responsible for writing to a CStream. More...

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

Private Attributes
mrpt::aligned_containers< CPose2D >::vector_t	poses
	The internal sequence of poses, stored as relative, incremental poses, thus each one is situated just at the end point of last one, where the first one is referenced to (0,0,0deg) More...

RTTI stuff
using	Ptr = std::shared_ptr< CPoses2DSequence >

using	ConstPtr = std::shared_ptr< const CPoses2DSequence >

static mrpt::utils::CLASSINIT	_init_CPoses2DSequence

static const mrpt::utils::TRuntimeClassId	runtimeClassId

static constexpr const char *	className = "CPoses2DSequence"

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

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

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

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

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

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

Member Typedef Documentation

◆ ConstPtr

using mrpt::poses::CPoses2DSequence::ConstPtr = std::shared_ptr<const CPoses2DSequence >

Definition at line 28 of file CPoses2DSequence.h.

◆ Ptr

using mrpt::poses::CPoses2DSequence::Ptr = std::shared_ptr< CPoses2DSequence >

A typedef for the associated smart pointer

Definition at line 28 of file CPoses2DSequence.h.

Constructor & Destructor Documentation

◆ CPoses2DSequence()

CPoses2DSequence::CPoses2DSequence ( )

Default constructor.

Definition at line 25 of file CPoses2DSequence.cpp.

Member Function Documentation

◆ _GetBaseClass()

static const mrpt::utils::TRuntimeClassId* mrpt::poses::CPoses2DSequence::_GetBaseClass ( )

staticprotected

◆ absolutePoseAfterAll()

CPose2D CPoses2DSequence::absolutePoseAfterAll ( )

A shortcut for "absolutePoseOf( posesCount() )".

See also: absolutePoseOf, posesCount

Definition at line 131 of file CPoses2DSequence.cpp.

◆ absolutePoseOf()

CPose2D CPoses2DSequence::absolutePoseOf ( unsigned int n )

Returns the absolute pose of a robot after moving "n" poses, so for "n=0" the origin pose (0,0,0deg) is returned, for "n=1" the first pose is returned, and for "n=posesCount()", the pose of robot after moving ALL poses is returned, all of them relative to the starting pose.

Exceptions

std::exception On invalid index value

See also: absolutePoseAfterAll

Definition at line 116 of file CPoses2DSequence.cpp.

References THROW_EXCEPTION.

◆ appendPose()

void CPoses2DSequence::appendPose ( CPose2D & newPose )

Appends a new pose at the end of sequence.

Remember that poses are relative, incremental to the last one.

Definition at line 99 of file CPoses2DSequence.cpp.

◆ changePose()

void CPoses2DSequence::changePose	(	unsigned int	ind,
		CPose2D &	inPose
	)

Changes the stored pose at index "ind", where the first one is 0, the last "posesCount() - 1".

Exceptions

std::exception On invalid index value

Definition at line 88 of file CPoses2DSequence.cpp.

References THROW_EXCEPTION.

◆ clear()

void CPoses2DSequence::clear ( )

Clears the sequence.

Definition at line 107 of file CPoses2DSequence.cpp.

◆ clone()

virtual mrpt::utils::CObject* mrpt::poses::CPoses2DSequence::clone ( ) const

overridevirtual

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

Implements mrpt::utils::CObject.

◆ computeTraveledDistanceAfter()

float CPoses2DSequence::computeTraveledDistanceAfter ( unsigned int n )

Returns the traveled distance after moving "n" poses, so for "n=0" it returns 0, for "n=1" the first traveled distance, and for "n=posesCount()", the total distance after ALL movements.

Exceptions

std::exception On invalid index value

See also: computeTraveledDistanceAfterAll

Definition at line 142 of file CPoses2DSequence.cpp.

References mrpt::math::norm(), and THROW_EXCEPTION.

Here is the call graph for this function:

◆ computeTraveledDistanceAfterAll()

float CPoses2DSequence::computeTraveledDistanceAfterAll ( )

Returns the traveled distance after ALL movements.

A shortcut for "computeTraveledDistanceAfter( posesCount() )".

See also: computeTraveledDistanceAfter

Definition at line 158 of file CPoses2DSequence.cpp.

◆ Create()

template<typename... Args>

static Ptr mrpt::poses::CPoses2DSequence::Create ( Args &&... args )

inlinestatic

Definition at line 28 of file CPoses2DSequence.h.

◆ CreateObject()

static mrpt::utils::CObject* mrpt::poses::CPoses2DSequence::CreateObject ( )

static

◆ getPose()

void CPoses2DSequence::getPose	(	unsigned int	ind,
		CPose2D &	outPose
	)

Reads the stored pose at index "ind", where the first one is 0, the last "posesCount() - 1".

Exceptions

std::exception On invalid index value

Definition at line 77 of file CPoses2DSequence.cpp.

References THROW_EXCEPTION.

◆ GetRuntimeClass()

virtual const mrpt::utils::TRuntimeClassId* mrpt::poses::CPoses2DSequence::GetRuntimeClass ( ) const

overridevirtual

Returns information about the class of an object in runtime.

Reimplemented from mrpt::utils::CSerializable.

◆ GetRuntimeClassIdStatic()

static const mrpt::utils::TRuntimeClassId& mrpt::poses::CPoses2DSequence::GetRuntimeClassIdStatic ( )

static

◆ operator delete() [1/3]

void mrpt::poses::CPoses2DSequence::operator delete ( void * ptr )

inlinenoexcept

Definition at line 28 of file CPoses2DSequence.h.

◆ operator delete() [2/3]

void mrpt::poses::CPoses2DSequence::operator delete	(	void *	memory,
		void *	ptr
	)

inlinenoexcept

Definition at line 28 of file CPoses2DSequence.h.

◆ operator delete() [3/3]

void mrpt::poses::CPoses2DSequence::operator delete	(	void *	ptr,
		const std::nothrow_t &
	)

inlinenoexcept

Definition at line 28 of file CPoses2DSequence.h.

◆ operator delete[]()

void mrpt::poses::CPoses2DSequence::operator delete[] ( void * ptr )

inlinenoexcept

Definition at line 28 of file CPoses2DSequence.h.

◆ operator new() [1/3]

void* mrpt::poses::CPoses2DSequence::operator new	(	size_t	size,
		const std::nothrow_t &
	)

inlinenoexcept

Definition at line 28 of file CPoses2DSequence.h.

◆ operator new() [2/3]

static void* mrpt::poses::CPoses2DSequence::operator new	(	size_t	size,
		void *	ptr
	)

inlinestatic

Definition at line 28 of file CPoses2DSequence.h.

◆ operator new() [3/3]

void* mrpt::poses::CPoses2DSequence::operator new ( size_t size )

inline

Definition at line 28 of file CPoses2DSequence.h.

◆ operator new[]()

void* mrpt::poses::CPoses2DSequence::operator new[] ( size_t size )

inline

Definition at line 28 of file CPoses2DSequence.h.

◆ posesCount()

size_t CPoses2DSequence::posesCount ( )

Returns the poses count in the sequence:

Definition at line 29 of file CPoses2DSequence.cpp.

◆ readFromStream()

void CPoses2DSequence::readFromStream	(	mrpt::utils::CStream &	in,
		int	version
	)

overrideprotectedvirtual

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

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 error, see CStream::ReadBuffer

See also: CStream

Implements mrpt::utils::CSerializable.

Definition at line 54 of file CPoses2DSequence.cpp.

References MRPT_THROW_UNKNOWN_SERIALIZATION_VERSION.

◆ writeToMatlab()

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 nullptr is class does not support conversion to MATLAB.

Definition at line 89 of file CSerializable.h.

◆ writeToStream()

void CPoses2DSequence::writeToStream	(	mrpt::utils::CStream &	out,
		int *	getVersion
	)		const

overrideprotectedvirtual

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

out	The output binary stream where object must be dumped.
getVersion	If nullptr, 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::exception On any error, see CStream::WriteBuffer

See also: CStream

Implements mrpt::utils::CSerializable.

Definition at line 34 of file CPoses2DSequence.cpp.

Member Data Documentation

◆ _init_CPoses2DSequence

mrpt::utils::CLASSINIT mrpt::poses::CPoses2DSequence::_init_CPoses2DSequence

staticprotected

Definition at line 28 of file CPoses2DSequence.h.

◆ className

constexpr const char* mrpt::poses::CPoses2DSequence::className = "CPoses2DSequence"

static

Definition at line 28 of file CPoses2DSequence.h.

◆ poses

mrpt::aligned_containers<CPose2D>::vector_t mrpt::poses::CPoses2DSequence::poses

private

The internal sequence of poses, stored as relative, incremental poses, thus each one is situated just at the end point of last one, where the first one is referenced to (0,0,0deg)

Definition at line 94 of file CPoses2DSequence.h.

◆ runtimeClassId

const mrpt::utils::TRuntimeClassId mrpt::poses::CPoses2DSequence::runtimeClassId

staticprotected

Definition at line 28 of file CPoses2DSequence.h.

Detailed Description

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

RTTI stuff

Member Typedef Documentation

◆ ConstPtr

◆ Ptr

Constructor & Destructor Documentation

◆ CPoses2DSequence()

Member Function Documentation

◆ _GetBaseClass()

◆ absolutePoseAfterAll()

◆ absolutePoseOf()

◆ appendPose()

◆ changePose()

◆ clear()

◆ clone()

◆ computeTraveledDistanceAfter()

◆ computeTraveledDistanceAfterAll()

◆ Create()

◆ CreateObject()

◆ getPose()

◆ GetRuntimeClass()

◆ GetRuntimeClassIdStatic()

◆ 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[]()

◆ posesCount()

◆ readFromStream()

◆ writeToMatlab()

◆ writeToStream()

Member Data Documentation

◆ _init_CPoses2DSequence

◆ className

◆ poses

◆ runtimeClassId