Detailed Description

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

See also: CHolonomicFullEval, CHolonomicLogFileRecord

Definition at line 162 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...

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)

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 [0] and alternative [1..N] evaluation scores for each direction, in the same order of TP-Obstacles. More...

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

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

using	ConstPtr = std::shared_ptr< const CLogFileRecord_FullEval >

static mrpt::utils::CLASSINIT	_init_CLogFileRecord_FullEval

static const mrpt::utils::TRuntimeClassId	runtimeClassId

static constexpr const char *	className = "CLogFileRecord_FullEval"

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

Definition at line 164 of file CHolonomicFullEval.h.

◆ Ptr

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

A typedef for the associated smart pointer

Definition at line 164 of file CHolonomicFullEval.h.

Constructor & Destructor Documentation

◆ CLogFileRecord_FullEval()

CLogFileRecord_FullEval::CLogFileRecord_FullEval ( )

Definition at line 588 of file CHolonomicFullEval.cpp.

Member Function Documentation

◆ _GetBaseClass()

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

staticprotected

◆ clone()

virtual mrpt::utils::CObject* mrpt::nav::CLogFileRecord_FullEval::clone ( ) const

overridevirtual

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

Implements mrpt::utils::CObject.

◆ Create()

template<typename... Args>

static Ptr mrpt::nav::CLogFileRecord_FullEval::Create ( Args &&... args )

inlinestatic

Definition at line 164 of file CHolonomicFullEval.h.

◆ CreateObject()

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

static

◆ getDirectionScores()

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

inlineoverridevirtual

Reimplemented from mrpt::nav::CHolonomicLogFileRecord.

Definition at line 178 of file CHolonomicFullEval.h.

References dirs_scores.

◆ GetRuntimeClass()

virtual const mrpt::utils::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::utils::TRuntimeClassId& mrpt::nav::CLogFileRecord_FullEval::GetRuntimeClassIdStatic ( )

static

◆ operator delete() [1/3]

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

inlinenoexcept

Definition at line 164 of file CHolonomicFullEval.h.

◆ operator delete() [2/3]

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

inlinenoexcept

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

◆ operator delete[]()

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

inlinenoexcept

Definition at line 164 of file CHolonomicFullEval.h.

◆ operator new() [1/3]

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

inlinenoexcept

Definition at line 164 of file CHolonomicFullEval.h.

◆ operator new() [2/3]

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

inlinestatic

Definition at line 164 of file CHolonomicFullEval.h.

◆ operator new() [3/3]

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

inline

Definition at line 164 of file CHolonomicFullEval.h.

◆ operator new[]()

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

inline

Definition at line 164 of file CHolonomicFullEval.h.

◆ readFromStream()

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

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

◆ 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 CLogFileRecord_FullEval::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 593 of file CHolonomicFullEval.cpp.

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

Member Data Documentation

◆ _init_CLogFileRecord_FullEval

mrpt::utils::CLASSINIT mrpt::nav::CLogFileRecord_FullEval::_init_CLogFileRecord_FullEval

staticprotected

Definition at line 164 of file CHolonomicFullEval.h.

◆ className

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

static

Definition at line 164 of file CHolonomicFullEval.h.

◆ dirs_eval

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

inherited

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

May be not filled by all methods.

Definition at line 33 of file CHolonomicLogFileRecord.h.

Referenced by readFromStream(), and writeToStream().

◆ 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 174 of file CHolonomicFullEval.h.

Referenced by getDirectionScores(), readFromStream(), and writeToStream().

◆ evaluation

double mrpt::nav::CLogFileRecord_FullEval::evaluation

Definition at line 170 of file CHolonomicFullEval.h.

Referenced by readFromStream(), and writeToStream().

◆ runtimeClassId

const mrpt::utils::TRuntimeClassId mrpt::nav::CLogFileRecord_FullEval::runtimeClassId

staticprotected

Definition at line 164 of file CHolonomicFullEval.h.

◆ selectedSector

int32_t mrpt::nav::CLogFileRecord_FullEval::selectedSector

Member data.

Definition at line 169 of file CHolonomicFullEval.h.

Referenced by readFromStream(), and writeToStream().

◆ selectedTarget

int32_t mrpt::nav::CLogFileRecord_FullEval::selectedTarget

Normally = 0.

Can be >0 if multiple targets passed simultaneously.

Definition at line 176 of file CHolonomicFullEval.h.

Referenced by readFromStream(), and writeToStream().

Detailed Description

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

RTTI stuff

Member Typedef Documentation

◆ ConstPtr

◆ Ptr

Constructor & Destructor Documentation

◆ CLogFileRecord_FullEval()

Member Function Documentation

◆ _GetBaseClass()

◆ clone()

◆ Create()

◆ CreateObject()

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

◆ readFromStream()

◆ writeToMatlab()

◆ writeToStream()

Member Data Documentation

◆ _init_CLogFileRecord_FullEval

◆ className

◆ dirs_eval

◆ dirs_scores

◆ evaluation

◆ runtimeClassId

◆ selectedSector

◆ selectedTarget