Detailed Description

A class for storing extra information about the execution of CHolonomicVFF navigation.

See also: CHolonomicVFF, CHolonomicLogFileRecord

Definition at line 25 of file CHolonomicVFF.h.

#include <mrpt/nav/holonomic/CHolonomicVFF.h>

Inheritance diagram for mrpt::nav::CLogFileRecord_VFF:

Public Member Functions
virtual const mrpt::math::CMatrixD *	getDirectionScores () const

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

Public Attributes
std::vector< std::vector< double > >	dirs_eval
	Final [N-1] and earlier stages [0...N-1] evaluation scores for each direction, in the same order of TP-Obstacles. More...

Protected Member Functions
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...

RTTI stuff

using	Ptr = std::shared_ptr< mrpt::nav ::CLogFileRecord_VFF >

using	ConstPtr = std::shared_ptr< const mrpt::nav ::CLogFileRecord_VFF >

using	UniquePtr = std::unique_ptr< mrpt::nav ::CLogFileRecord_VFF >

using	ConstUniquePtr = std::unique_ptr< const mrpt::nav ::CLogFileRecord_VFF >

static const mrpt::rtti::TRuntimeClassId	runtimeClassId

static constexpr const char *	className = "mrpt::nav" "::" "CLogFileRecord_VFF"

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::nav::CLogFileRecord_VFF::ConstPtr = std::shared_ptr<const mrpt::nav :: CLogFileRecord_VFF >

Definition at line 27 of file CHolonomicVFF.h.

◆ ConstUniquePtr

using mrpt::nav::CLogFileRecord_VFF::ConstUniquePtr = std::unique_ptr<const mrpt::nav :: CLogFileRecord_VFF >

Definition at line 27 of file CHolonomicVFF.h.

◆ Ptr

using mrpt::nav::CLogFileRecord_VFF::Ptr = std::shared_ptr< mrpt::nav :: CLogFileRecord_VFF >

A type for the associated smart pointer

Definition at line 27 of file CHolonomicVFF.h.

◆ UniquePtr

using mrpt::nav::CLogFileRecord_VFF::UniquePtr = std::unique_ptr< mrpt::nav :: CLogFileRecord_VFF >

Definition at line 27 of file CHolonomicVFF.h.

Member Function Documentation

◆ _GetBaseClass()

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

staticprotected

◆ clone()

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

inlinestatic

Definition at line 27 of file CHolonomicVFF.h.

◆ CreateAlloc()

template<typename Alloc , typename... Args>

static Ptr mrpt::nav::CLogFileRecord_VFF::CreateAlloc	(	const Alloc &	alloc,
		Args &&...	args
	)

inlinestatic

Definition at line 27 of file CHolonomicVFF.h.

◆ CreateObject()

static std::shared_ptr<CObject> mrpt::nav::CLogFileRecord_VFF::CreateObject ( )

static

◆ CreateUnique()

template<typename... Args>

static UniquePtr mrpt::nav::CLogFileRecord_VFF::CreateUnique ( Args &&... args )

inlinestatic

Definition at line 27 of file CHolonomicVFF.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 204 of file CObject.h.

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

Referenced by mrpt::obs::CRawlog::insert().

◆ getClassName()

static constexpr auto mrpt::nav::CLogFileRecord_VFF::getClassName ( )

inlinestaticconstexpr

Definition at line 27 of file CHolonomicVFF.h.

◆ getDirectionScores()

virtual const mrpt::math::CMatrixD* mrpt::nav::CHolonomicLogFileRecord::getDirectionScores ( ) const

inlinevirtualinherited

Reimplemented in mrpt::nav::CLogFileRecord_FullEval.

Definition at line 33 of file CHolonomicLogFileRecord.h.

◆ GetRuntimeClass()

virtual const mrpt::rtti::TRuntimeClassId* mrpt::nav::CLogFileRecord_VFF::GetRuntimeClass ( ) const

overridevirtual

Returns information about the class of an object in runtime.

Reimplemented from mrpt::nav::CHolonomicLogFileRecord.

◆ GetRuntimeClassIdStatic()

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

static

◆ serializeFrom() [1/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.

◆ serializeFrom() [2/2]

void CLogFileRecord_VFF::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 132 of file CHolonomicVFF.cpp.

References MRPT_THROW_UNKNOWN_SERIALIZATION_VERSION.

◆ serializeGetVersion()

uint8_t CLogFileRecord_VFF::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 127 of file CHolonomicVFF.cpp.

◆ serializeTo() [1/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.

◆ serializeTo() [2/2]

void CLogFileRecord_VFF::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 128 of file CHolonomicVFF.cpp.

◆ 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

◆ className

constexpr const char* mrpt::nav::CLogFileRecord_VFF::className = "mrpt::nav" "::" "CLogFileRecord_VFF"

staticconstexpr

Definition at line 27 of file CHolonomicVFF.h.

◆ dirs_eval

std::vector<std::vector<double> > mrpt::nav::CHolonomicLogFileRecord::dirs_eval

inherited

Final [N-1] and earlier stages [0...N-1] evaluation scores for each direction, in the same order of TP-Obstacles.

May be not filled by all methods.

Definition at line 31 of file CHolonomicLogFileRecord.h.

Referenced by mrpt::nav::CLogFileRecord_FullEval::serializeFrom(), and mrpt::nav::CLogFileRecord_FullEval::serializeTo().

◆ runtimeClassId

const mrpt::rtti::TRuntimeClassId mrpt::nav::CLogFileRecord_VFF::runtimeClassId

staticprotected

Definition at line 27 of file CHolonomicVFF.h.

Detailed Description

Public Member Functions

Public Attributes

Protected Member Functions

RTTI stuff

Member Typedef Documentation

◆ ConstPtr

◆ ConstUniquePtr

◆ Ptr

◆ UniquePtr

Member Function Documentation

◆ _GetBaseClass()

◆ clone()

◆ Create()

◆ CreateAlloc()

◆ CreateObject()

◆ CreateUnique()

◆ duplicateGetSmartPtr()

◆ getClassName()

◆ getDirectionScores()

◆ GetRuntimeClass()

◆ GetRuntimeClassIdStatic()

◆ serializeFrom() [1/2]

◆ serializeFrom() [2/2]

◆ serializeGetVersion()

◆ serializeTo() [1/2]

◆ serializeTo() [2/2]

◆ writeToMatlab()

Member Data Documentation

◆ className

◆ dirs_eval

◆ runtimeClassId