Detailed Description

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

See also: CHolonomicND, CHolonomicLogFileRecord

Definition at line 165 of file CHolonomicND.h.

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

Inheritance diagram for mrpt::nav::CLogFileRecord_ND:

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

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

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
vector_int	gaps_ini
	Member data. More...

vector_int	gaps_end

std::vector< double >	gaps_eval

int32_t	selectedSector

double	evaluation

double	riskEvaluation

CHolonomicND::TSituations	situation

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

using	ConstPtr = std::shared_ptr< const CLogFileRecord_ND >

static mrpt::utils::CLASSINIT	_init_CLogFileRecord_ND

static const mrpt::utils::TRuntimeClassId	runtimeClassId

static constexpr const char *	className = "CLogFileRecord_ND"

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_ND::ConstPtr = std::shared_ptr<const CLogFileRecord_ND >

Definition at line 167 of file CHolonomicND.h.

◆ Ptr

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

A typedef for the associated smart pointer

Definition at line 167 of file CHolonomicND.h.

Member Function Documentation

◆ _GetBaseClass()

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

staticprotected

◆ clone()

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

inlinestatic

Definition at line 167 of file CHolonomicND.h.

◆ CreateObject()

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

static

◆ getDirectionScores()

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

inlinevirtualinherited

Reimplemented in mrpt::nav::CLogFileRecord_FullEval.

Definition at line 35 of file CHolonomicLogFileRecord.h.

◆ GetRuntimeClass()

virtual const mrpt::utils::TRuntimeClassId* mrpt::nav::CLogFileRecord_ND::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_ND::GetRuntimeClassIdStatic ( )

static

◆ operator delete() [1/3]

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

inlinenoexcept

Definition at line 167 of file CHolonomicND.h.

◆ operator delete() [2/3]

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

inlinenoexcept

Definition at line 167 of file CHolonomicND.h.

◆ operator delete() [3/3]

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

inlinenoexcept

Definition at line 167 of file CHolonomicND.h.

◆ operator delete[]()

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

inlinenoexcept

Definition at line 167 of file CHolonomicND.h.

◆ operator new() [1/3]

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

inlinenoexcept

Definition at line 167 of file CHolonomicND.h.

◆ operator new() [2/3]

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

inlinestatic

Definition at line 167 of file CHolonomicND.h.

◆ operator new() [3/3]

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

inline

Definition at line 167 of file CHolonomicND.h.

◆ operator new[]()

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

inline

Definition at line 167 of file CHolonomicND.h.

◆ readFromStream()

void CLogFileRecord_ND::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 641 of file CHolonomicND.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 CLogFileRecord_ND::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 625 of file CHolonomicND.cpp.

Member Data Documentation

◆ _init_CLogFileRecord_ND

mrpt::utils::CLASSINIT mrpt::nav::CLogFileRecord_ND::_init_CLogFileRecord_ND

staticprotected

Definition at line 167 of file CHolonomicND.h.

◆ className

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

static

Definition at line 167 of file CHolonomicND.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 mrpt::nav::CLogFileRecord_FullEval::readFromStream(), and mrpt::nav::CLogFileRecord_FullEval::writeToStream().

◆ evaluation

double mrpt::nav::CLogFileRecord_ND::evaluation

Definition at line 175 of file CHolonomicND.h.

◆ gaps_end

vector_int mrpt::nav::CLogFileRecord_ND::gaps_end

Definition at line 172 of file CHolonomicND.h.

◆ gaps_eval

std::vector<double> mrpt::nav::CLogFileRecord_ND::gaps_eval

Definition at line 173 of file CHolonomicND.h.

Referenced by mrpt::nav::CHolonomicND::searchBestGap().

◆ gaps_ini

vector_int mrpt::nav::CLogFileRecord_ND::gaps_ini

Member data.

Definition at line 172 of file CHolonomicND.h.

◆ riskEvaluation

double mrpt::nav::CLogFileRecord_ND::riskEvaluation

Definition at line 176 of file CHolonomicND.h.

◆ runtimeClassId

const mrpt::utils::TRuntimeClassId mrpt::nav::CLogFileRecord_ND::runtimeClassId

staticprotected

Definition at line 167 of file CHolonomicND.h.

◆ selectedSector

int32_t mrpt::nav::CLogFileRecord_ND::selectedSector

Definition at line 174 of file CHolonomicND.h.

◆ situation

CHolonomicND::TSituations mrpt::nav::CLogFileRecord_ND::situation

Definition at line 177 of file CHolonomicND.h.

Detailed Description

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

RTTI stuff

Member Typedef Documentation

◆ ConstPtr

◆ Ptr

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_ND

◆ className

◆ dirs_eval

◆ evaluation

◆ gaps_end

◆ gaps_eval

◆ gaps_ini

◆ riskEvaluation

◆ runtimeClassId

◆ selectedSector

◆ situation