MRPT  1.9.9
mrpt::maps::CGasConcentrationGridMap2D::TMapDefinition Struct Reference

Detailed Description

Definition at line 170 of file CGasConcentrationGridMap2D.h.

#include <mrpt/maps/CGasConcentrationGridMap2D.h>

Inheritance diagram for mrpt::maps::CGasConcentrationGridMap2D::TMapDefinition:

Public Types

using Ptr = std::shared_ptr< TMetricMapInitializer >
 Smart pointer to TMetricMapInitializer. More...
 

Public Member Functions

 TMapDefinition ()
 
void loadFromConfigFile (const mrpt::config::CConfigFileBase &source, const std::string &sectionNamePrefix) override
 Load all params from a config file/source. More...
 
void saveToConfigFile (mrpt::config::CConfigFileBase &target, const std::string &section) const override
 This method saves the options to a ".ini"-like file or memory-stored string list. More...
 
void dumpToTextStream (std::ostream &out) const override
 This method should clearly display all the contents of the structure in textual form, sending it to a std::ostream. More...
 
const mrpt::rtti::TRuntimeClassId::PtrgetMetricMapClassType () 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...
 
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

float min_x {-2}
 See CGasConcentrationGridMap2D::CGasConcentrationGridMap2D. More...
 
float max_x {2}
 
float min_y {-2}
 
float max_y {2}
 
float resolution {0.10f}
 
mrpt::maps::CGasConcentrationGridMap2D::TMapRepresentation mapType
 The kind of map representation (see CGasConcentrationGridMap2D::CGasConcentrationGridMap2D) More...
 
mrpt::maps::CGasConcentrationGridMap2D::TInsertionOptions insertionOpts
 Observations insertion options. More...
 
mrpt::maps::TMapGenericParams genericMapParams
 Common params for all maps: These are automatically set in TMetricMapTypesRegistry::factoryMapObjectFromDefinition() More...
 

Protected Member Functions

void loadFromConfigFile_map_specific (const mrpt::config::CConfigFileBase &source, const std::string &sectionNamePrefix) override
 Load all map-specific params. More...
 
void dumpToTextStream_map_specific (std::ostream &out) const override
 

Static Protected Member Functions

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

Protected Attributes

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

Member Typedef Documentation

◆ Ptr

Constructor & Destructor Documentation

◆ TMapDefinition()

CGasConcentrationGridMap2D::TMapDefinition::TMapDefinition ( )
default

Member Function Documentation

◆ dumpToConsole()

void CLoadableOptions::dumpToConsole ( ) const
inherited

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

Definition at line 44 of file CLoadableOptions.cpp.

References mrpt::config::CLoadableOptions::dumpToTextStream().

Referenced by mrpt::hmtslam::CTopLCDetector_GridMatching::computeTopologicalObservationModel(), and mrpt::ros1bridge::MapHdl::loadMap().

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

◆ dumpToTextStream()

void TMetricMapInitializer::dumpToTextStream ( std::ostream &  out) const
overridevirtualinherited

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

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

Reimplemented from mrpt::config::CLoadableOptions.

Definition at line 59 of file TMetricMapInitializer.cpp.

References mrpt::config::CLoadableOptions::dumpToTextStream(), mrpt::maps::TMetricMapInitializer::dumpToTextStream_map_specific(), mrpt::maps::TMetricMapInitializer::genericMapParams, and mrpt::maps::TMetricMapInitializer::metricMapClassType.

Here is the call graph for this function:

◆ dumpToTextStream_map_specific()

void CGasConcentrationGridMap2D::TMapDefinition::dumpToTextStream_map_specific ( std::ostream &  out) const
overrideprotectedvirtual

Implements mrpt::maps::TMetricMapInitializer.

Definition at line 66 of file CGasConcentrationGridMap2D.cpp.

References mrpt::format(), and LOADABLEOPTS_DUMP_VAR.

Here is the call graph for this function:

◆ dumpVar_bool()

void CLoadableOptions::dumpVar_bool ( std::ostream &  out,
const char *  varName,
bool  v 
)
staticprotectedinherited

Definition at line 63 of file CLoadableOptions.cpp.

References mrpt::format(), and LOADABLEOPTS_COLUMN_WIDTH.

Here is the call graph for this function:

◆ dumpVar_double()

void CLoadableOptions::dumpVar_double ( std::ostream &  out,
const char *  varName,
double  v 
)
staticprotectedinherited

Definition at line 57 of file CLoadableOptions.cpp.

References mrpt::format(), and LOADABLEOPTS_COLUMN_WIDTH.

Here is the call graph for this function:

◆ dumpVar_float()

void CLoadableOptions::dumpVar_float ( std::ostream &  out,
const char *  varName,
float  v 
)
staticprotectedinherited

Definition at line 51 of file CLoadableOptions.cpp.

References mrpt::format(), and LOADABLEOPTS_COLUMN_WIDTH.

Here is the call graph for this function:

◆ dumpVar_int()

void CLoadableOptions::dumpVar_int ( std::ostream &  out,
const char *  varName,
int  v 
)
staticprotectedinherited

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

Definition at line 45 of file CLoadableOptions.cpp.

References mrpt::format(), and LOADABLEOPTS_COLUMN_WIDTH.

Here is the call graph for this function:

◆ dumpVar_string()

void CLoadableOptions::dumpVar_string ( std::ostream &  out,
const char *  varName,
const std::string v 
)
staticprotectedinherited

Definition at line 70 of file CLoadableOptions.cpp.

References mrpt::format(), and LOADABLEOPTS_COLUMN_WIDTH.

Here is the call graph for this function:

◆ factory()

TMetricMapInitializer * TMetricMapInitializer::factory ( const std::string mapClassName)
staticinherited

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

Definition at line 22 of file TMetricMapInitializer.cpp.

◆ getMetricMapClassType()

const mrpt::rtti::TRuntimeClassId::Ptr& mrpt::maps::TMetricMapInitializer::getMetricMapClassType ( ) const
inlineinherited

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

Definition at line 59 of file TMetricMapInitializer.h.

References mrpt::maps::TMetricMapInitializer::metricMapClassType.

Referenced by mrpt::maps::internal::TMetricMapTypesRegistry::factoryMapObjectFromDefinition().

Here is the caller graph for this function:

◆ loadFromConfigFile()

void TMetricMapInitializer::loadFromConfigFile ( const mrpt::config::CConfigFileBase source,
const std::string sectionNamePrefix 
)
overridevirtualinherited

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

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

Implements mrpt::config::CLoadableOptions.

Definition at line 38 of file TMetricMapInitializer.cpp.

References mrpt::maps::TMetricMapInitializer::genericMapParams, mrpt::maps::TMapGenericParams::loadFromConfigFile(), and mrpt::maps::TMetricMapInitializer::loadFromConfigFile_map_specific().

Referenced by mrpt::maps::TSetOfMetricMapInitializers::loadFromConfigFile().

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

◆ loadFromConfigFile_map_specific()

void CGasConcentrationGridMap2D::TMapDefinition::loadFromConfigFile_map_specific ( const mrpt::config::CConfigFileBase source,
const std::string sectionNamePrefix 
)
overrideprotectedvirtual

Load all map-specific params.

Implements mrpt::maps::TMetricMapInitializer.

Definition at line 47 of file CGasConcentrationGridMap2D.cpp.

References MRPT_LOAD_CONFIG_VAR.

◆ loadFromConfigFileName()

void 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

Definition at line 22 of file CLoadableOptions.cpp.

References mrpt::config::CLoadableOptions::loadFromConfigFile().

Here is the call graph for this function:

◆ saveToConfigFile()

void TMetricMapInitializer::saveToConfigFile ( mrpt::config::CConfigFileBase target,
const std::string section 
) const
overridevirtualinherited

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

See also
loadFromConfigFile, saveToConfigFileName

Reimplemented from mrpt::config::CLoadableOptions.

Definition at line 51 of file TMetricMapInitializer.cpp.

References mrpt::maps::TMetricMapInitializer::genericMapParams, mrpt::maps::TMetricMapInitializer::metricMapClassType, and mrpt::maps::TMapGenericParams::saveToConfigFile().

Here is the call graph for this function:

◆ saveToConfigFileName()

void 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

Definition at line 37 of file CLoadableOptions.cpp.

References mrpt::config::CLoadableOptions::saveToConfigFile().

Here is the call graph for this function:

Member Data Documentation

◆ genericMapParams

◆ insertionOpts

mrpt::maps::CGasConcentrationGridMap2D::TInsertionOptions mrpt::maps::CGasConcentrationGridMap2D::TMapDefinition::insertionOpts

Observations insertion options.

Definition at line 178 of file CGasConcentrationGridMap2D.h.

Referenced by mrpt::maps::CGasConcentrationGridMap2D::internal_CreateFromMapDefinition().

◆ mapType

◆ max_x

float mrpt::maps::CGasConcentrationGridMap2D::TMapDefinition::max_x {2}

◆ max_y

float mrpt::maps::CGasConcentrationGridMap2D::TMapDefinition::max_y {2}

◆ metricMapClassType

const mrpt::rtti::TRuntimeClassId::Ptr mrpt::maps::TMetricMapInitializer::metricMapClassType
protectedinherited

◆ min_x

float mrpt::maps::CGasConcentrationGridMap2D::TMapDefinition::min_x {-2}

◆ min_y

float mrpt::maps::CGasConcentrationGridMap2D::TMapDefinition::min_y {-2}

◆ resolution

float mrpt::maps::CGasConcentrationGridMap2D::TMapDefinition::resolution {0.10f}



Page generated by Doxygen 1.8.14 for MRPT 1.9.9 Git: 034c2ee2a Tue Aug 20 02:15:02 2019 +0200 at mar ago 20 02:20:10 CEST 2019