MRPT  1.9.9
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 163 of file CHolonomicND.h.

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

Inheritance diagram for mrpt::nav::CLogFileRecord_ND:

Public Member Functions

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 for polymorphic hierarchies
mrpt::rtti::CObject::Ptr duplicateGetSmartPtr () const
 Makes a deep copy of the object and returns a smart pointer to it. More...
 

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...
 
CSerializable virtual methods
virtual void serializeTo (CSchemeArchiveBase &out) const
 Virtual method for writing (serializing) to an abstract schema based archive. More...
 
virtual void serializeFrom (CSchemeArchiveBase &in)
 Virtual method for reading (deserializing) from an abstract schema based 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 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 std::shared_ptr< CObjectCreateObject ()
 
template<typename... Args>
static Ptr Create (Args &&... args)
 
template<typename Alloc , typename... Args>
static Ptr CreateAlloc (const Alloc &alloc, 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

◆ ConstUniquePtr

Definition at line 165 of file CHolonomicND.h.

◆ Ptr

A type for the associated smart pointer

Definition at line 165 of file CHolonomicND.h.

◆ UniquePtr

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

◆ CreateAlloc()

template<typename Alloc , typename... Args>
static Ptr mrpt::nav::CLogFileRecord_ND::CreateAlloc ( const Alloc &  alloc,
Args &&...  args 
)
inlinestatic

Definition at line 165 of file CHolonomicND.h.

◆ CreateObject()

static std::shared_ptr<CObject> mrpt::nav::CLogFileRecord_ND::CreateObject ( )
static

◆ CreateUnique()

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

Definition at line 165 of file CHolonomicND.h.

◆ duplicateGetSmartPtr()

mrpt::rtti::CObject::Ptr CObject::duplicateGetSmartPtr ( ) const
inlineinherited

Makes a deep copy of the object and returns a smart pointer to it.

Definition at line 191 of file CObject.h.

References mrpt::rtti::CObject::clone().

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

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getClassName()

static constexpr auto mrpt::nav::CLogFileRecord_ND::getClassName ( )
inlinestatic

Definition at line 165 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 33 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

◆ serializeFrom() [1/2]

virtual void mrpt::serialization::CSerializable::serializeFrom ( CSchemeArchiveBase in)
inlineprotectedvirtualinherited

Virtual method for reading (deserializing) from an abstract schema based archive.

Definition at line 74 of file CSerializable.h.

References mrpt::serialization::CSerializable::GetRuntimeClass(), and THROW_EXCEPTION.

Here is the call graph for this function:

◆ serializeFrom() [2/2]

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() [1/2]

virtual void mrpt::serialization::CSerializable::serializeTo ( CSchemeArchiveBase out) const
inlineprotectedvirtualinherited

Virtual method for writing (serializing) to an abstract schema based archive.

Definition at line 64 of file CSerializable.h.

References mrpt::serialization::CSerializable::GetRuntimeClass(), and THROW_EXCEPTION.

Here is the call graph for this function:

◆ serializeTo() [2/2]

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 90 of file CSerializable.h.

Member Data Documentation

◆ className

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

Definition at line 165 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 31 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 173 of file CHolonomicND.h.

◆ gaps_end

std::vector<int> mrpt::nav::CLogFileRecord_ND::gaps_end

Definition at line 170 of file CHolonomicND.h.

◆ gaps_eval

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

Definition at line 171 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 170 of file CHolonomicND.h.

◆ riskEvaluation

double mrpt::nav::CLogFileRecord_ND::riskEvaluation

Definition at line 174 of file CHolonomicND.h.

◆ runtimeClassId

const mrpt::rtti::TRuntimeClassId mrpt::nav::CLogFileRecord_ND::runtimeClassId
staticprotected

Definition at line 165 of file CHolonomicND.h.

◆ selectedSector

int32_t mrpt::nav::CLogFileRecord_ND::selectedSector

Definition at line 172 of file CHolonomicND.h.

◆ situation

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

Definition at line 175 of file CHolonomicND.h.




Page generated by Doxygen 1.8.14 for MRPT 1.9.9 Git: 765b969e7 Sun Sep 22 19:55:28 2019 +0200 at dom sep 22 20:00:14 CEST 2019