Detailed Description

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

See also: CHolonomicFullEval, CHolonomicLogFileRecord

Definition at line 114 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) throw ()

void	operator delete[] (void *ptr) throw ()

void	operator delete (void memory, void ptr) throw ()

void *	operator new (size_t size, const std::nothrow_t &) throw ()

void	operator delete (void *ptr, const std::nothrow_t &) throw ()

	CLogFileRecord_FullEval ()

const mrpt::math::CMatrixD *	getDirectionScores () const MRPT_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...

mrpt::utils::CObjectPtr	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...

CObject *	clone () const
	Cloning interface for smart pointers. 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. Not all directions may have evaluations, in which case a "-1" value will be found. More...

int32_t	selectedTarget
	Normally = 0. Can be >0 if multiple targets passed simultaneously. 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. May be not filled by all methods. More...

Static Public Attributes
static const mrpt::utils::TRuntimeClassId	classCObject

RTTI stuff
static const mrpt::utils::TRuntimeClassId	classCHolonomicLogFileRecord

RTTI stuff
static const mrpt::utils::TRuntimeClassId	classCSerializable

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

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

typedef CLogFileRecord_FullEvalPtr	ConstPtr

static mrpt::utils::CLASSINIT	_init_CLogFileRecord_FullEval

static mrpt::utils::TRuntimeClassId	classCLogFileRecord_FullEval

static const mrpt::utils::TRuntimeClassId *	classinfo

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

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

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

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

static CLogFileRecord_FullEvalPtr	Create ()

Member Typedef Documentation

◆ ConstPtr

typedef CLogFileRecord_FullEvalPtr mrpt::nav::CLogFileRecord_FullEval::ConstPtr

Definition at line 116 of file CHolonomicFullEval.h.

◆ Ptr

typedef CLogFileRecord_FullEvalPtr mrpt::nav::CLogFileRecord_FullEval::Ptr

A typedef for the associated smart pointer

Definition at line 116 of file CHolonomicFullEval.h.

Constructor & Destructor Documentation

◆ CLogFileRecord_FullEval()

CLogFileRecord_FullEval::CLogFileRecord_FullEval ( )

Definition at line 512 of file CHolonomicFullEval.cpp.

Member Function Documentation

◆ _GetBaseClass()

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

staticprotected

◆ clone()

CObject* mrpt::utils::CObject::clone ( ) const

inlineinherited

Cloning interface for smart pointers.

Definition at line 143 of file CObject.h.

◆ Create()

static CLogFileRecord_FullEvalPtr mrpt::nav::CLogFileRecord_FullEval::Create ( )

static

Referenced by mrpt::nav::CHolonomicFullEval::navigate().

◆ CreateObject()

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

static

◆ duplicate()

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

virtual

Returns a copy of the object, indepently of its class.

Implements mrpt::utils::CObject.

◆ duplicateGetSmartPtr()

mrpt::utils::CObjectPtr mrpt::utils::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 140 of file CObject.h.

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

◆ getDirectionScores()

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

inlinevirtual

Reimplemented from mrpt::nav::CHolonomicLogFileRecord.

Definition at line 126 of file CHolonomicFullEval.h.

◆ GetRuntimeClass()

virtual const mrpt::utils::TRuntimeClassId* mrpt::nav::CLogFileRecord_FullEval::GetRuntimeClass ( ) const

virtual

Returns information about the class of an object in runtime.

Reimplemented from mrpt::nav::CHolonomicLogFileRecord.

◆ operator delete() [1/3]

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

inline

Definition at line 116 of file CHolonomicFullEval.h.

◆ operator delete() [2/3]

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

inline

Definition at line 116 of file CHolonomicFullEval.h.

◆ operator delete() [3/3]

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

inline

Definition at line 116 of file CHolonomicFullEval.h.

◆ operator delete[]()

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

inline

Definition at line 116 of file CHolonomicFullEval.h.

◆ operator new() [1/3]

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

inline

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

◆ operator new() [3/3]

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

inline

Definition at line 116 of file CHolonomicFullEval.h.

◆ operator new[]()

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

inline

Definition at line 116 of file CHolonomicFullEval.h.

◆ readFromStream()

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

protectedvirtual

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 533 of file CHolonomicFullEval.cpp.

References mrpt::nav::CHolonomicLogFileRecord::dirs_eval, dirs_scores, evaluation, MRPT_THROW_UNKNOWN_SERIALIZATION_VERSION, selectedSector, selectedTarget, and 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 NULL is class does not support conversion to MATLAB.

Definition at line 79 of file CSerializable.h.

◆ writeToStream()

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

protectedvirtual

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 NULL, 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 520 of file CHolonomicFullEval.cpp.

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

Member Data Documentation

◆ _init_CLogFileRecord_FullEval

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

staticprotected

Definition at line 116 of file CHolonomicFullEval.h.

◆ classCHolonomicLogFileRecord

const mrpt::utils::TRuntimeClassId mrpt::nav::CHolonomicLogFileRecord::classCHolonomicLogFileRecord

staticinherited

Definition at line 32 of file CHolonomicLogFileRecord.h.

◆ classCLogFileRecord_FullEval

mrpt::utils::TRuntimeClassId mrpt::nav::CLogFileRecord_FullEval::classCLogFileRecord_FullEval

static

Definition at line 116 of file CHolonomicFullEval.h.

◆ classCObject

const mrpt::utils::TRuntimeClassId mrpt::utils::CObject::classCObject

staticinherited

Definition at line 128 of file CObject.h.

◆ classCSerializable

const mrpt::utils::TRuntimeClassId mrpt::utils::CSerializable::classCSerializable

staticinherited

Definition at line 42 of file CSerializable.h.

◆ classinfo

const mrpt::utils::TRuntimeClassId* mrpt::nav::CLogFileRecord_FullEval::classinfo

static

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

Referenced by readFromStream(), and writeToStream().

◆ evaluation

double mrpt::nav::CLogFileRecord_FullEval::evaluation

Definition at line 122 of file CHolonomicFullEval.h.

Referenced by readFromStream(), and writeToStream().

◆ selectedSector

int32_t mrpt::nav::CLogFileRecord_FullEval::selectedSector

Member data.

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

Referenced by readFromStream(), and writeToStream().

Detailed Description

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

RTTI stuff

Member Typedef Documentation

◆ ConstPtr

◆ Ptr

Constructor & Destructor Documentation

◆ CLogFileRecord_FullEval()

Member Function Documentation

◆ _GetBaseClass()

◆ clone()

◆ Create()

◆ CreateObject()

◆ duplicate()

◆ duplicateGetSmartPtr()

◆ getDirectionScores()

◆ GetRuntimeClass()

◆ 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

◆ classCHolonomicLogFileRecord

◆ classCLogFileRecord_FullEval

◆ classCObject

◆ classCSerializable

◆ classinfo

◆ dirs_eval

◆ dirs_scores

◆ evaluation

◆ selectedSector

◆ selectedTarget