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_VFF Class Reference

Detailed Description

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

See also
CHolonomicVFF, CHolonomicLogFileRecord

Definition at line 28 of file CHolonomicVFF.h.

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

Inheritance diagram for mrpt::nav::CLogFileRecord_VFF:
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...
 
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 voidoperator new (size_t size, void *ptr)
 

Public Attributes

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_VFF >
 
using ConstPtr = std::shared_ptr< const CLogFileRecord_VFF >
 
static mrpt::utils::CLASSINIT _init_CLogFileRecord_VFF
 
static const mrpt::utils::TRuntimeClassId runtimeClassId
 
static constexpr const char * className = "CLogFileRecord_VFF"
 
static const mrpt::utils::TRuntimeClassId_GetBaseClass ()
 
static const mrpt::utils::TRuntimeClassIdGetRuntimeClassIdStatic ()
 
static mrpt::utils::CObjectCreateObject ()
 
template<typename... Args>
static Ptr Create (Args &&... args)
 
virtual const mrpt::utils::TRuntimeClassIdGetRuntimeClass () const override
 Returns information about the class of an object in runtime. More...
 
virtual mrpt::utils::CObjectclone () const override
 Returns a deep copy (clone) of the object, indepently of its class. More...
 

Member Typedef Documentation

◆ ConstPtr

Definition at line 30 of file CHolonomicVFF.h.

◆ Ptr

A typedef for the associated smart pointer

Definition at line 30 of file CHolonomicVFF.h.

Member Function Documentation

◆ _GetBaseClass()

static const mrpt::utils::TRuntimeClassId* mrpt::nav::CLogFileRecord_VFF::_GetBaseClass ( )
staticprotected

◆ clone()

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

Definition at line 30 of file CHolonomicVFF.h.

◆ CreateObject()

static mrpt::utils::CObject* mrpt::nav::CLogFileRecord_VFF::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_VFF::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_VFF::GetRuntimeClassIdStatic ( )
static

◆ operator delete() [1/3]

void mrpt::nav::CLogFileRecord_VFF::operator delete ( void ptr)
inlinenoexcept

Definition at line 30 of file CHolonomicVFF.h.

◆ operator delete() [2/3]

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

Definition at line 30 of file CHolonomicVFF.h.

◆ operator delete() [3/3]

void mrpt::nav::CLogFileRecord_VFF::operator delete ( void ptr,
const std::nothrow_t &   
)
inlinenoexcept

Definition at line 30 of file CHolonomicVFF.h.

◆ operator delete[]()

void mrpt::nav::CLogFileRecord_VFF::operator delete[] ( void ptr)
inlinenoexcept

Definition at line 30 of file CHolonomicVFF.h.

◆ operator new() [1/3]

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

Definition at line 30 of file CHolonomicVFF.h.

◆ operator new() [2/3]

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

Definition at line 30 of file CHolonomicVFF.h.

◆ operator new() [3/3]

void* mrpt::nav::CLogFileRecord_VFF::operator new ( size_t  size)
inline

Definition at line 30 of file CHolonomicVFF.h.

◆ operator new[]()

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

Definition at line 30 of file CHolonomicVFF.h.

◆ readFromStream()

void CLogFileRecord_VFF::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
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 error, see CStream::ReadBuffer
See also
CStream

Implements mrpt::utils::CSerializable.

Definition at line 151 of file CHolonomicVFF.cpp.

References MRPT_THROW_UNKNOWN_SERIALIZATION_VERSION, and MRPT_UNUSED_PARAM.

◆ 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_VFF::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
outThe output binary stream where object must be dumped.
getVersionIf 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::exceptionOn any error, see CStream::WriteBuffer
See also
CStream

Implements mrpt::utils::CSerializable.

Definition at line 137 of file CHolonomicVFF.cpp.

References MRPT_UNUSED_PARAM.

Member Data Documentation

◆ _init_CLogFileRecord_VFF

mrpt::utils::CLASSINIT mrpt::nav::CLogFileRecord_VFF::_init_CLogFileRecord_VFF
staticprotected

Definition at line 30 of file CHolonomicVFF.h.

◆ className

constexpr const char* mrpt::nav::CLogFileRecord_VFF::className = "CLogFileRecord_VFF"
static

Definition at line 30 of file CHolonomicVFF.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().

◆ runtimeClassId

const mrpt::utils::TRuntimeClassId mrpt::nav::CLogFileRecord_VFF::runtimeClassId
staticprotected

Definition at line 30 of file CHolonomicVFF.h.




Page generated by Doxygen 1.8.14 for MRPT 1.9.9 Git: ae4571287 Thu Nov 23 00:06:53 2017 +0100 at dom oct 27 23:51:55 CET 2019