Main MRPT website > C++ reference for MRPT 1.4.0
List of all members | Public Member Functions | Public Attributes | Static Protected Member Functions
mrpt::maps::TMapGenericParams Class Reference

Detailed Description

Common params to all maps derived from mrpt::maps::CMetricMap

Definition at line 66 of file metric_map_types.h.

#include <mrpt/maps/metric_map_types.h>

Inheritance diagram for mrpt::maps::TMapGenericParams:
Inheritance graph

Public Member Functions

 TMapGenericParams ()
 
void loadFromConfigFile (const mrpt::utils::CConfigFileBase &source, const std::string &sectionNamePrefix) MRPT_OVERRIDE
 This method load the options from a ".ini"-like file or memory-stored string list.
 
void dumpToTextStream (mrpt::utils::CStream &out) const MRPT_OVERRIDE
 This method should clearly display all the contents of the structure in textual form, sending it to a CStream.
 
void loadFromConfigFileName (const std::string &config_file, const std::string &section)
 Behaves like loadFromConfigFile, but you can pass directly a file name and a temporary CConfigFile object will be created automatically to load the file.
 
virtual void saveToConfigFile (mrpt::utils::CConfigFileBase &target, const std::string &section) const
 This method saves the options to a ".ini"-like file or memory-stored string list.
 
void saveToConfigFileName (const std::string &config_file, const std::string &section) const
 Behaves like saveToConfigFile, but you can pass directly a file name and a temporary CConfigFile object will be created automatically to save the file.
 
void dumpToConsole () const
 Just like dumpToTextStream() but sending the text to the console (std::cout)
 

Public Attributes

bool enableSaveAs3DObject
 (Default=true) If false, calling CMetricMap::getAs3DObject() will have no effects
 
bool enableObservationLikelihood
 (Default=true) Enable computing observation likelihoods with this map
 
bool enableObservationInsertion
 (Default=true) Enable inserting observations in this map
 

Protected Member Functions

CSerializable virtual methods
void writeToStream (mrpt::utils::CStream &out, int *getVersion) const MRPT_OVERRIDE
 
void readFromStream (mrpt::utils::CStream &in, int version) MRPT_OVERRIDE
 

Static Protected Member Functions

static void dumpVar_int (CStream &out, const char *varName, int v)
 Used to print variable info from dumpToTextStream with the macro LOADABLEOPTS_DUMP_VAR.
 
static void dumpVar_float (CStream &out, const char *varName, float v)
 
static void dumpVar_double (CStream &out, const char *varName, double v)
 
static void dumpVar_bool (CStream &out, const char *varName, bool v)
 
static void dumpVar_string (CStream &out, const char *varName, const std::string &v)
 

RTTI stuff <br>

typedef TMapGenericParamsPtr SmartPtr
 
static mrpt::utils::CLASSINIT _init_TMapGenericParams
 
static mrpt::utils::TRuntimeClassId classTMapGenericParams
 
static const mrpt::utils::TRuntimeClassIdclassinfo
 
static const mrpt::utils::TRuntimeClassId_GetBaseClass ()
 
virtual const mrpt::utils::TRuntimeClassIdGetRuntimeClass () const MRPT_OVERRIDE
 
virtual mrpt::utils::CObjectduplicate () const MRPT_OVERRIDE
 
static mrpt::utils::CObjectCreateObject ()
 
static TMapGenericParamsPtr Create ()
 

Member Typedef Documentation

◆ SmartPtr

A typedef for the associated smart pointer

Definition at line 68 of file metric_map_types.h.

Constructor & Destructor Documentation

◆ TMapGenericParams()

mrpt::maps::TMapGenericParams::TMapGenericParams ( )

Member Function Documentation

◆ _GetBaseClass()

static const mrpt::utils::TRuntimeClassId * mrpt::maps::TMapGenericParams::_GetBaseClass ( )
staticprotected

◆ Create()

static TMapGenericParamsPtr mrpt::maps::TMapGenericParams::Create ( )
static

◆ CreateObject()

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

◆ dumpToConsole()

void mrpt::utils::CLoadableOptions::dumpToConsole ( ) const
inherited

Just like dumpToTextStream() but sending the text to the console (std::cout)

◆ dumpToTextStream()

void mrpt::maps::TMapGenericParams::dumpToTextStream ( mrpt::utils::CStream out) const
virtual

This method should clearly display all the contents of the structure in textual form, sending it to a CStream.

The default implementation in this base class relies on saveToConfigFile() to generate a plain text representation of all the parameters.

Reimplemented from mrpt::utils::CLoadableOptions.

◆ dumpVar_bool()

static void mrpt::utils::CLoadableOptions::dumpVar_bool ( CStream out,
const char *  varName,
bool  v 
)
staticprotectedinherited

◆ dumpVar_double()

static void mrpt::utils::CLoadableOptions::dumpVar_double ( CStream out,
const char *  varName,
double  v 
)
staticprotectedinherited

◆ dumpVar_float()

static void mrpt::utils::CLoadableOptions::dumpVar_float ( CStream out,
const char *  varName,
float  v 
)
staticprotectedinherited

◆ dumpVar_int()

static void mrpt::utils::CLoadableOptions::dumpVar_int ( CStream out,
const char *  varName,
int  v 
)
staticprotectedinherited

Used to print variable info from dumpToTextStream with the macro LOADABLEOPTS_DUMP_VAR.

◆ dumpVar_string()

static void mrpt::utils::CLoadableOptions::dumpVar_string ( CStream out,
const char *  varName,
const std::string &  v 
)
staticprotectedinherited

◆ duplicate()

virtual mrpt::utils::CObject * mrpt::maps::TMapGenericParams::duplicate ( ) const
virtual

◆ GetRuntimeClass()

virtual const mrpt::utils::TRuntimeClassId * mrpt::maps::TMapGenericParams::GetRuntimeClass ( ) const
virtual

◆ loadFromConfigFile()

void mrpt::maps::TMapGenericParams::loadFromConfigFile ( const mrpt::utils::CConfigFileBase source,
const std::string &  section 
)
virtual

This method load the options from a ".ini"-like file or memory-stored string list.

Only those parameters found in the given "section" and having the same name that the variable are loaded. Those not found in the file will stay with their previous values (usually the default values loaded at initialization). An example of an ".ini" file:

[section]
resolution = 0.10 // blah blah...
modeSelection = 1 // 0=blah, 1=blah,...
See also
loadFromConfigFileName, saveToConfigFile

Implements mrpt::utils::CLoadableOptions.

◆ loadFromConfigFileName()

void mrpt::utils::CLoadableOptions::loadFromConfigFileName ( const std::string &  config_file,
const std::string &  section 
)
inherited

Behaves like loadFromConfigFile, but you can pass directly a file name and a temporary CConfigFile object will be created automatically to load the file.

See also
loadFromConfigFile

◆ readFromStream()

void mrpt::maps::TMapGenericParams::readFromStream ( mrpt::utils::CStream in,
int  version 
)
protected

◆ saveToConfigFile()

virtual void mrpt::utils::CLoadableOptions::saveToConfigFile ( mrpt::utils::CConfigFileBase target,
const std::string &  section 
) const
virtualinherited

This method saves the options to a ".ini"-like file or memory-stored string list.

See also
loadFromConfigFile, saveToConfigFileName

Reimplemented in mrpt::nav::CHolonomicND::TOptions, mrpt::nav::CHolonomicVFF::TOptions, mrpt::vision::TMultiResDescMatchOptions, and mrpt::vision::TMultiResDescOptions.

◆ saveToConfigFileName()

void mrpt::utils::CLoadableOptions::saveToConfigFileName ( const std::string &  config_file,
const std::string &  section 
) const
inherited

Behaves like saveToConfigFile, but you can pass directly a file name and a temporary CConfigFile object will be created automatically to save the file.

See also
saveToConfigFile, loadFromConfigFileName

◆ writeToStream()

void mrpt::maps::TMapGenericParams::writeToStream ( mrpt::utils::CStream out,
int *  getVersion 
) const
protected

Member Data Documentation

◆ _init_TMapGenericParams

mrpt::utils::CLASSINIT mrpt::maps::TMapGenericParams::_init_TMapGenericParams
staticprotected

Definition at line 68 of file metric_map_types.h.

◆ classinfo

const mrpt::utils::TRuntimeClassId* mrpt::maps::TMapGenericParams::classinfo
static

Definition at line 68 of file metric_map_types.h.

◆ classTMapGenericParams

mrpt::utils::TRuntimeClassId mrpt::maps::TMapGenericParams::classTMapGenericParams
static

Definition at line 68 of file metric_map_types.h.

◆ enableObservationInsertion

bool mrpt::maps::TMapGenericParams::enableObservationInsertion

(Default=true) Enable inserting observations in this map

Definition at line 72 of file metric_map_types.h.

◆ enableObservationLikelihood

bool mrpt::maps::TMapGenericParams::enableObservationLikelihood

(Default=true) Enable computing observation likelihoods with this map

Definition at line 71 of file metric_map_types.h.

◆ enableSaveAs3DObject

bool mrpt::maps::TMapGenericParams::enableSaveAs3DObject

(Default=true) If false, calling CMetricMap::getAs3DObject() will have no effects

Definition at line 70 of file metric_map_types.h.




Page generated by Doxygen 1.9.8 for MRPT 1.4.0 SVN: at Wed Dec 6 15:06:50 UTC 2023