Main MRPT website > C++ reference for MRPT 1.9.9
List of all members | Public Member Functions | Static Public Member Functions | Public Attributes
mrpt::nav::CLogFileRecord_ND Class Reference

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:
Inheritance graph

Public Member Functions

voidoperator new (size_t size)
 
voidoperator new[] (size_t size)
 
void operator delete (void *ptr) noexcept
 
void operator delete[] (void *ptr) noexcept
 
void operator delete (void *memory, void *ptr) noexcept
 
voidoperator new (size_t size, const std::nothrow_t &) noexcept
 
void operator delete (void *ptr, const std::nothrow_t &) noexcept
 
virtual const mrpt::math::CMatrixDgetDirectionScores () const
 
virtual mxArraywriteToMatlab () 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 voidoperator new (size_t size, void *ptr)
 

Public Attributes

std::vector< int > gaps_ini
 Member data. More...
 
std::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 [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_ND >
 
using ConstPtr = std::shared_ptr< const CLogFileRecord_ND >
 
using UniquePtr = std::unique_ptr< CLogFileRecord_ND >
 
using ConstUniquePtr = std::unique_ptr< const CLogFileRecord_ND >
 
static mrpt::rtti::CLASSINIT _init_CLogFileRecord_ND
 
static const mrpt::rtti::TRuntimeClassId runtimeClassId
 
static constexpr const char * className = "CLogFileRecord_ND"
 
static const mrpt::rtti::TRuntimeClassId_GetBaseClass ()
 
static constexpr auto getClassName ()
 
static const mrpt::rtti::TRuntimeClassIdGetRuntimeClassIdStatic ()
 
static mrpt::rtti::CObjectCreateObject ()
 
template<typename... Args>
static Ptr Create (Args &&... args)
 
template<typename... Args>
static UniquePtr CreateUnique (Args &&... args)
 
virtual const mrpt::rtti::TRuntimeClassIdGetRuntimeClass () const override
 Returns information about the class of an object in runtime. More...
 
virtual mrpt::rtti::CObjectclone () const override
 Returns a deep copy (clone) of the object, indepently of its class. More...
 

Member Typedef Documentation

◆ ConstPtr

Definition at line 167 of file CHolonomicND.h.

◆ ConstUniquePtr

Definition at line 167 of file CHolonomicND.h.

◆ Ptr

A type for the associated smart pointer

Definition at line 167 of file CHolonomicND.h.

◆ UniquePtr

Definition at line 167 of file CHolonomicND.h.

Member Function Documentation

◆ _GetBaseClass()

static const mrpt::rtti::TRuntimeClassId* mrpt::nav::CLogFileRecord_ND::_GetBaseClass ( )
staticprotected

◆ clone()

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

Definition at line 167 of file CHolonomicND.h.

◆ CreateObject()

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

◆ CreateUnique()

template<typename... Args>
static UniquePtr mrpt::nav::CLogFileRecord_ND::CreateUnique ( Args &&...  args)
inlinestatic

Definition at line 167 of file CHolonomicND.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_ND::getClassName ( )
inlinestaticconstexpr

Definition at line 167 of file CHolonomicND.h.

◆ getDirectionScores()

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

Reimplemented in mrpt::nav::CLogFileRecord_FullEval.

Definition at line 36 of file CHolonomicLogFileRecord.h.

◆ GetRuntimeClass()

virtual const mrpt::rtti::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::rtti::TRuntimeClassId& mrpt::nav::CLogFileRecord_ND::GetRuntimeClassIdStatic ( )
static

◆ operator delete() [1/3]

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

Definition at line 167 of file CHolonomicND.h.

◆ operator delete() [2/3]

void mrpt::nav::CLogFileRecord_ND::operator delete ( 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)
inline

Definition at line 167 of file CHolonomicND.h.

◆ operator new() [2/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() [3/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[]()

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

Definition at line 167 of file CHolonomicND.h.

◆ serializeFrom()

void CLogFileRecord_ND::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
inThe input binary stream where the object data must read from.
versionThe 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::exceptionOn any I/O error

Implements mrpt::serialization::CSerializable.

Definition at line 626 of file CHolonomicND.cpp.

References MRPT_THROW_UNKNOWN_SERIALIZATION_VERSION.

◆ serializeGetVersion()

uint8_t CLogFileRecord_ND::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 618 of file CHolonomicND.cpp.

◆ serializeTo()

void CLogFileRecord_ND::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::exceptionOn any I/O error

Implements mrpt::serialization::CSerializable.

Definition at line 619 of file CHolonomicND.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 70 of file CSerializable.h.

Member Data Documentation

◆ _init_CLogFileRecord_ND

mrpt::rtti::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"
staticconstexpr

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

◆ evaluation

double mrpt::nav::CLogFileRecord_ND::evaluation

Definition at line 175 of file CHolonomicND.h.

◆ gaps_end

std::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

std::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::rtti::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.




Page generated by Doxygen 1.8.17 for MRPT 1.9.9 Git: ad3a9d8ae Tue May 1 23:10:22 2018 -0700 at miƩ 12 jul 2023 10:03:34 CEST