Detailed Description

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

See also: CHolonomicFullEval, CHolonomicLogFileRecord

Definition at line 165 of file CHolonomicFullEval.h.

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

Inheritance diagram for mrpt::nav::CLogFileRecord_FullEval:

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

	CLogFileRecord_FullEval ()

const mrpt::math::CMatrixD *	getDirectionScores () const override

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

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

Public Attributes
int32_t	selectedSector
	Member data. More...

double	evaluation

mrpt::math::CMatrixD	dirs_scores
	Individual scores for each direction: (i,j), i (row) are directions, j (cols) are scores. More...

int32_t	selectedTarget
	Normally = 0. More...

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

using	ConstPtr = std::shared_ptr< const CLogFileRecord_FullEval >

using	UniquePtr = std::unique_ptr< CLogFileRecord_FullEval >

using	ConstUniquePtr = std::unique_ptr< const CLogFileRecord_FullEval >

static mrpt::rtti::CLASSINIT	_init_CLogFileRecord_FullEval

static const mrpt::rtti::TRuntimeClassId	runtimeClassId

static constexpr const char *	className = "CLogFileRecord_FullEval"

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

Definition at line 167 of file CHolonomicFullEval.h.

◆ ConstUniquePtr

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

Definition at line 167 of file CHolonomicFullEval.h.

◆ Ptr

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

A type for the associated smart pointer

Definition at line 167 of file CHolonomicFullEval.h.

◆ UniquePtr

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

Definition at line 167 of file CHolonomicFullEval.h.

Constructor & Destructor Documentation

◆ CLogFileRecord_FullEval()

CLogFileRecord_FullEval::CLogFileRecord_FullEval ( )

Definition at line 591 of file CHolonomicFullEval.cpp.

Member Function Documentation

◆ _GetBaseClass()

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

staticprotected

◆ clone()

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

inlinestatic

Definition at line 167 of file CHolonomicFullEval.h.

◆ CreateObject()

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

static

◆ CreateUnique()

template<typename... Args>

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

inlinestatic

Definition at line 167 of file CHolonomicFullEval.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 169 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::nav::CLogFileRecord_FullEval::getClassName ( )

inlinestaticconstexpr

Definition at line 167 of file CHolonomicFullEval.h.

◆ getDirectionScores()

const mrpt::math::CMatrixD* mrpt::nav::CLogFileRecord_FullEval::getDirectionScores ( ) const

inlineoverridevirtual

Reimplemented from mrpt::nav::CHolonomicLogFileRecord.

Definition at line 181 of file CHolonomicFullEval.h.

References dirs_scores.

◆ GetRuntimeClass()

virtual const mrpt::rtti::TRuntimeClassId* mrpt::nav::CLogFileRecord_FullEval::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_FullEval::GetRuntimeClassIdStatic ( )

static

◆ operator delete() [1/3]

void mrpt::nav::CLogFileRecord_FullEval::operator delete	(	void *	memory,
		void *	ptr
	)

inlinenoexcept

Definition at line 167 of file CHolonomicFullEval.h.

◆ operator delete() [2/3]

void mrpt::nav::CLogFileRecord_FullEval::operator delete ( void * ptr )

inlinenoexcept

Definition at line 167 of file CHolonomicFullEval.h.

◆ operator delete() [3/3]

void mrpt::nav::CLogFileRecord_FullEval::operator delete	(	void *	ptr,
		const std::nothrow_t &
	)

inlinenoexcept

Definition at line 167 of file CHolonomicFullEval.h.

◆ operator delete[]()

void mrpt::nav::CLogFileRecord_FullEval::operator delete[] ( void * ptr )

inlinenoexcept

Definition at line 167 of file CHolonomicFullEval.h.

◆ operator new() [1/3]

void* mrpt::nav::CLogFileRecord_FullEval::operator new ( size_t size )

inline

Definition at line 167 of file CHolonomicFullEval.h.

◆ operator new() [2/3]

void* mrpt::nav::CLogFileRecord_FullEval::operator new	(	size_t	size,
		const std::nothrow_t &
	)

inlinenoexcept

Definition at line 167 of file CHolonomicFullEval.h.

◆ operator new() [3/3]

static void* mrpt::nav::CLogFileRecord_FullEval::operator new	(	size_t	size,
		void *	ptr
	)

inlinestatic

Definition at line 167 of file CHolonomicFullEval.h.

◆ operator new[]()

void* mrpt::nav::CLogFileRecord_FullEval::operator new[] ( size_t size )

inline

Definition at line 167 of file CHolonomicFullEval.h.

◆ serializeFrom()

void CLogFileRecord_FullEval::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 607 of file CHolonomicFullEval.cpp.

References mrpt::nav::CHolonomicLogFileRecord::dirs_eval, dirs_scores, evaluation, MRPT_THROW_UNKNOWN_SERIALIZATION_VERSION, selectedSector, and selectedTarget.

◆ serializeGetVersion()

uint8_t CLogFileRecord_FullEval::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 596 of file CHolonomicFullEval.cpp.

◆ serializeTo()

void CLogFileRecord_FullEval::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 597 of file CHolonomicFullEval.cpp.

References mrpt::nav::CHolonomicLogFileRecord::dirs_eval, dirs_scores, evaluation, selectedSector, and selectedTarget.

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

Member Data Documentation

◆ _init_CLogFileRecord_FullEval

mrpt::rtti::CLASSINIT mrpt::nav::CLogFileRecord_FullEval::_init_CLogFileRecord_FullEval

staticprotected

Definition at line 167 of file CHolonomicFullEval.h.

◆ className

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

staticconstexpr

Definition at line 167 of file CHolonomicFullEval.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 34 of file CHolonomicLogFileRecord.h.

Referenced by serializeFrom(), and serializeTo().

◆ dirs_scores

mrpt::math::CMatrixD mrpt::nav::CLogFileRecord_FullEval::dirs_scores

Individual scores for each direction: (i,j), i (row) are directions, j (cols) are scores.

Not all directions may have evaluations, in which case a "-1" value will be found.

Definition at line 177 of file CHolonomicFullEval.h.

Referenced by getDirectionScores(), serializeFrom(), and serializeTo().

◆ evaluation

double mrpt::nav::CLogFileRecord_FullEval::evaluation

Definition at line 173 of file CHolonomicFullEval.h.

Referenced by serializeFrom(), and serializeTo().

◆ runtimeClassId

const mrpt::rtti::TRuntimeClassId mrpt::nav::CLogFileRecord_FullEval::runtimeClassId

staticprotected

Definition at line 167 of file CHolonomicFullEval.h.

◆ selectedSector

int32_t mrpt::nav::CLogFileRecord_FullEval::selectedSector

Member data.

Definition at line 172 of file CHolonomicFullEval.h.

Referenced by serializeFrom(), and serializeTo().

◆ selectedTarget

int32_t mrpt::nav::CLogFileRecord_FullEval::selectedTarget

Normally = 0.

Can be >0 if multiple targets passed simultaneously.

Definition at line 179 of file CHolonomicFullEval.h.

Referenced by serializeFrom(), and serializeTo().

Detailed Description

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

RTTI stuff

Member Typedef Documentation

◆ ConstPtr

◆ ConstUniquePtr

◆ Ptr

◆ UniquePtr

Constructor & Destructor Documentation

◆ CLogFileRecord_FullEval()

Member Function Documentation

◆ _GetBaseClass()

◆ clone()

◆ Create()

◆ CreateObject()

◆ CreateUnique()

◆ duplicateGetSmartPtr()

◆ getClassName()

◆ getDirectionScores()

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

◆ serializeFrom()

◆ serializeGetVersion()

◆ serializeTo()

◆ writeToMatlab()

Member Data Documentation

◆ _init_CLogFileRecord_FullEval

◆ className

◆ dirs_eval

◆ dirs_scores

◆ evaluation

◆ runtimeClassId

◆ selectedSector

◆ selectedTarget