Main MRPT website > C++ reference for MRPT 1.4.0
List of all members | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Friends
mrpt::maps::TMetricMapInitializer Struct Referenceabstract

Detailed Description

Virtual base for specifying the kind and parameters of one map (normally, to be inserted into mrpt::maps::CMultiMetricMap) See mrpt::maps::TSetOfMetricMapInitializers::loadFromConfigFile() as an easy way of initialize this object, or construct with the factory methods <metric_map_class>::MapDefinition() and TMetricMapInitializer::factory()

See also
TSetOfMetricMapInitializers, mrpt::maps::CMultiMetricMap

Definition at line 32 of file TMetricMapInitializer.h.

#include <mrpt/maps/TMetricMapInitializer.h>

Inheritance diagram for mrpt::maps::TMetricMapInitializer:
Inheritance graph

Public Member Functions

void loadFromConfigFile (const mrpt::utils::CConfigFileBase &source, const std::string &sectionNamePrefix) MRPT_OVERRIDE
 Load all params from a config file/source. More...
 
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. More...
 
const mrpt::utils::TRuntimeClassIdPtrgetMetricMapClassType () const
 Query the map type (C++ class), as set by the factory method MapDefinition() More...
 
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. More...
 
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. More...
 
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. More...
 
void dumpToConsole () const
 Just like dumpToTextStream() but sending the text to the console (std::cout) More...
 

Static Public Member Functions

static TMetricMapInitializerfactory (const std::string &mapClassName)
 Looks up in the registry of known map types and call the corresponding <metric_map_class>::MapDefinition(). More...
 

Public Attributes

mrpt::maps::TMapGenericParams genericMapParams
 Common params for all maps: These are automatically set in TMetricMapTypesRegistry::factoryMapObjectFromDefinition() More...
 

Protected Member Functions

 TMetricMapInitializer (const mrpt::utils::TRuntimeClassId *classID)
 
virtual void loadFromConfigFile_map_specific (const mrpt::utils::CConfigFileBase &source, const std::string &sectionNamePrefix)=0
 Load all map-specific params. More...
 
virtual void dumpToTextStream_map_specific (mrpt::utils::CStream &out) const =0
 

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

Protected Attributes

const mrpt::utils::TRuntimeClassIdPtr metricMapClassType
 Derived classes set this to CLASS_ID(< class >) where < class > is any CMetricMap derived class. More...
 

Friends

class TSetOfMetricMapInitializers
 

Constructor & Destructor Documentation

mrpt::maps::TMetricMapInitializer::TMetricMapInitializer ( const mrpt::utils::TRuntimeClassId classID)
protected

Member Function Documentation

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

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

void mrpt::maps::TMetricMapInitializer::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.

virtual void mrpt::maps::TMetricMapInitializer::dumpToTextStream_map_specific ( mrpt::utils::CStream out) const
protectedpure virtual
static void mrpt::utils::CLoadableOptions::dumpVar_bool ( CStream out,
const char *  varName,
bool  v 
)
staticprotectedinherited
static void mrpt::utils::CLoadableOptions::dumpVar_double ( CStream out,
const char *  varName,
double  v 
)
staticprotectedinherited
static void mrpt::utils::CLoadableOptions::dumpVar_float ( CStream out,
const char *  varName,
float  v 
)
staticprotectedinherited
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.

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

Looks up in the registry of known map types and call the corresponding <metric_map_class>::MapDefinition().

const mrpt::utils::TRuntimeClassIdPtr& mrpt::maps::TMetricMapInitializer::getMetricMapClassType ( ) const
inline

Query the map type (C++ class), as set by the factory method MapDefinition()

Definition at line 49 of file TMetricMapInitializer.h.

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

Load all params from a config file/source.

For examples and format, read the docs of mrpt::maps::CMultiMetricMap Typical section names:

  • <sectionNamePrefix>_creationOpts
  • <sectionNamePrefix>_insertOpts
  • <sectionNamePrefix>_likelihoodOpts

Implements mrpt::utils::CLoadableOptions.

virtual void mrpt::maps::TMetricMapInitializer::loadFromConfigFile_map_specific ( const mrpt::utils::CConfigFileBase source,
const std::string &  sectionNamePrefix 
)
protectedpure virtual
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
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::vision::TMultiResDescOptions, mrpt::vision::TMultiResDescMatchOptions, mrpt::nav::CHolonomicND::TOptions, and mrpt::nav::CHolonomicVFF::TOptions.

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

Friends And Related Function Documentation

friend class TSetOfMetricMapInitializers
friend

Definition at line 34 of file TMetricMapInitializer.h.

Member Data Documentation

mrpt::maps::TMapGenericParams mrpt::maps::TMetricMapInitializer::genericMapParams

Common params for all maps: These are automatically set in TMetricMapTypesRegistry::factoryMapObjectFromDefinition()

Definition at line 37 of file TMetricMapInitializer.h.

const mrpt::utils::TRuntimeClassIdPtr mrpt::maps::TMetricMapInitializer::metricMapClassType
protected

Derived classes set this to CLASS_ID(< class >) where < class > is any CMetricMap derived class.

Definition at line 56 of file TMetricMapInitializer.h.




Page generated by Doxygen 1.8.11 for MRPT 1.4.0 SVN:Unversioned directory at Mon May 30 18:20:32 UTC 2016