Main MRPT website > C++ reference for MRPT 1.9.9
Classes | Namespaces | Macros | Functions
CConfigFileBase.h File Reference
#include <mrpt/utils/utils_defs.h>
#include <mrpt/system/string_utils.h>
#include <sstream>
#include <iomanip>
#include <mrpt/utils/TEnumType.h>
#include <type_traits>

Go to the source code of this file.

Classes

class  mrpt::utils::CConfigFileBase
 This class allows loading and storing values and vectors of different types from a configuration text, which can be implemented as a ".ini" file, a memory-stored string, etc... More...
 

Namespaces

 mrpt
 This is the global namespace for all Mobile Robot Programming Toolkit (MRPT) libraries.
 
 mrpt::utils
 Classes for serialization, sockets, ini-file manipulation, streams, list of properties-values, timewatch, extensions to STL.
 

Macros

#define MRPT_LOAD_CONFIG_VAR( variableName, variableType, configFileObject, sectionNameStr)
 An useful macro for loading variables stored in a INI-like file under a key with the same name that the variable, and assigning the variable the current value if not found in the config file. More...
 
#define MRPT_LOAD_CONFIG_VAR_CS(variableName, variableType)   MRPT_LOAD_CONFIG_VAR(variableName, variableType, c, s)
 Shortcut for MRPT_LOAD_CONFIG_VAR() for config file object named c and section string named s More...
 
#define MRPT_LOAD_CONFIG_VAR_DEGREES( variableName, configFileObject, sectionNameStr)
 Loads a double variable, stored as radians but entered in the INI-file as degrees. More...
 
#define MRPT_LOAD_CONFIG_VAR_DEGREES_NO_DEFAULT( variableName, configFileObject, sectionNameStr)
 Loads a double, required, variable, stored as radians but entered in the INI-file as degrees. More...
 
#define MRPT_LOAD_CONFIG_VAR_CAST( variableName, variableType, variableTypeCast, configFileObject, sectionNameStr)
 
#define MRPT_LOAD_HERE_CONFIG_VAR( variableName, variableType, targetVariable, configFileObject, sectionNameStr)
 
#define MRPT_LOAD_HERE_CONFIG_VAR_NO_DEFAULT( variableName, variableType, targetVariable, configFileObject, sectionNameStr)
 
#define MRPT_LOAD_HERE_CONFIG_VAR_DEGREES( variableName, variableType, targetVariable, configFileObject, sectionNameStr)
 
#define MRPT_LOAD_HERE_CONFIG_VAR_DEGREES_NO_DEFAULT( variableName, variableType, targetVariable, configFileObject, sectionNameStr)
 
#define MRPT_LOAD_CONFIG_VAR_NO_DEFAULT( variableName, variableType, configFileObject, sectionNameStr)
 
#define MRPT_LOAD_CONFIG_VAR_REQUIRED_CS(variableName, variableType)   MRPT_LOAD_CONFIG_VAR_NO_DEFAULT(variableName, variableType, c, s)
 Shortcut for MRPT_LOAD_CONFIG_VAR_NO_DEFAULT() for REQUIRED variables config file object named c and section string named s More...
 
#define MRPT_LOAD_CONFIG_VAR_CAST_NO_DEFAULT( variableName, variableType, variableTypeCast, configFileObject, sectionNameStr)
 
#define MRPT_LOAD_HERE_CONFIG_VAR_CAST( variableName, variableType, variableTypeCast, targetVariable, configFileObject, sectionNameStr)
 
#define MRPT_LOAD_HERE_CONFIG_VAR_CAST_NO_DEFAULT( variableName, variableType, variableTypeCast, targetVariable, configFileObject, sectionNameStr)
 
#define MRPT_SAVE_CONFIG_VAR(variableName, configFileObject, sectionNameStr)
 
#define MRPT_SAVE_CONFIG_VAR_DEGREES( variableName, configFileObject, sectionNameStr)
 
#define MRPT_SAVE_CONFIG_VAR_COMMENT(variableName, __comment)
 
#define MRPT_SAVE_CONFIG_VAR_DEGREES_COMMENT( __entryName, __variable, __comment)
 

Functions

int mrpt::utils::MRPT_SAVE_NAME_PADDING ()
 Default padding sizes for macros MRPT_SAVE_CONFIG_VAR_COMMENT(), etc. More...
 
int mrpt::utils::MRPT_SAVE_VALUE_PADDING ()
 

Macro Definition Documentation

◆ MRPT_LOAD_CONFIG_VAR

#define MRPT_LOAD_CONFIG_VAR (   variableName,
  variableType,
  configFileObject,
  sectionNameStr 
)
Value:
{ \
variableName = configFileObject.read_##variableType( \
sectionNameStr, #variableName, variableName); \
}

An useful macro for loading variables stored in a INI-like file under a key with the same name that the variable, and assigning the variable the current value if not found in the config file.

The variableType must be the suffix of "read_XXX" functions, i.e. int, bool,...

Definition at line 279 of file CConfigFileBase.h.

Referenced by mrpt::maps::CRandomFieldGridMap2D::TInsertionOptionsCommon::internal_loadFromConfigFile_common(), mrpt::hwdrivers::CVelodyneScanner::loadConfig_sensorSpecific(), mrpt::kinematics::CVehicleVelCmd::TVelCmdParams::loadConfigFile(), mrpt::slam::TKLDParams::loadFromConfigFile(), mrpt::nav::CPTG_Holo_Blend::loadFromConfigFile(), mrpt::slam::CMetricMapBuilderICP::TConfigParams::loadFromConfigFile(), mrpt::slam::CIncrementalMapPartitioner::TOptions::loadFromConfigFile(), mrpt::hmtslam::CTopLCDetector_FabMap::TOptions::loadFromConfigFile(), mrpt::maps::CPointCloudFilterByDistance::TOptions::loadFromConfigFile(), mrpt::bayes::TKF_options::loadFromConfigFile(), mrpt::nav::CHolonomicVFF::TOptions::loadFromConfigFile(), mrpt::maps::CReflectivityGridMap2D::TInsertionOptions::loadFromConfigFile(), mrpt::slam::CICP::TConfigParams::loadFromConfigFile(), mrpt::slam::CGridMapAligner::TConfigParams::loadFromConfigFile(), mrpt::slam::CMetricMapBuilderRBPF::TConstructionOptions::loadFromConfigFile(), mrpt::vision::CFeatureExtraction::TOptions::loadFromConfigFile(), mrpt::maps::CHeightGridMap2D::TInsertionOptions::loadFromConfigFile(), mrpt::maps::TMapGenericParams::loadFromConfigFile(), mrpt::maps::COctoMapBase< OCTREE, OCTREE_NODE >::TInsertionOptions::loadFromConfigFile(), mrpt::nav::CHolonomicND::TOptions::loadFromConfigFile(), mrpt::bayes::CParticleFilter::TParticleFilterOptions::loadFromConfigFile(), mrpt::nav::CHolonomicFullEval::TOptions::loadFromConfigFile(), mrpt::slam::CRangeBearingKFSLAM2D::TOptions::loadFromConfigFile(), mrpt::maps::CMultiMetricMapPDF::TPredictionParams::loadFromConfigFile(), mrpt::nav::CWaypointsNavigator::TWaypointsNavigatorParams::loadFromConfigFile(), mrpt::nav::CPTG_DiffDrive_CollisionGridBased::loadFromConfigFile(), mrpt::maps::CBeaconMap::TInsertionOptions::loadFromConfigFile(), mrpt::slam::CRangeBearingKFSLAM::TOptions::loadFromConfigFile(), mrpt::maps::CPointsMap::TInsertionOptions::loadFromConfigFile(), mrpt::maps::COctoMapBase< OCTREE, OCTREE_NODE >::TLikelihoodOptions::loadFromConfigFile(), mrpt::maps::CColouredPointsMap::TColourOptions::loadFromConfigFile(), mrpt::maps::CPointsMap::TLikelihoodOptions::loadFromConfigFile(), mrpt::hmtslam::CHMTSLAM::TOptions::loadFromConfigFile(), mrpt::maps::COccupancyGridMap2D::TInsertionOptions::loadFromConfigFile(), mrpt::maps::COctoMap::TMapDefinition::loadFromConfigFile_map_specific(), mrpt::maps::CColouredOctoMap::TMapDefinition::loadFromConfigFile_map_specific(), mrpt::maps::CWirelessPowerGridMap2D::TMapDefinition::loadFromConfigFile_map_specific(), mrpt::maps::CHeightGridMap2D_MRF::TMapDefinition::loadFromConfigFile_map_specific(), mrpt::maps::CReflectivityGridMap2D::TMapDefinition::loadFromConfigFile_map_specific(), mrpt::maps::CHeightGridMap2D::TMapDefinition::loadFromConfigFile_map_specific(), mrpt::maps::CGasConcentrationGridMap2D::TMapDefinition::loadFromConfigFile_map_specific(), and mrpt::maps::COccupancyGridMap2D::TMapDefinition::loadFromConfigFile_map_specific().

◆ MRPT_LOAD_CONFIG_VAR_CAST

#define MRPT_LOAD_CONFIG_VAR_CAST (   variableName,
  variableType,
  variableTypeCast,
  configFileObject,
  sectionNameStr 
)
Value:
{ \
variableName = static_cast<variableTypeCast>( \
configFileObject.read_##variableType( \
sectionNameStr, #variableName, variableName)); \
}

Definition at line 313 of file CConfigFileBase.h.

Referenced by mrpt::vision::CFeatureExtraction::TOptions::loadFromConfigFile().

◆ MRPT_LOAD_CONFIG_VAR_CAST_NO_DEFAULT

#define MRPT_LOAD_CONFIG_VAR_CAST_NO_DEFAULT (   variableName,
  variableType,
  variableTypeCast,
  configFileObject,
  sectionNameStr 
)
Value:
{ \
try \
{ \
variableName = static_cast<variableTypeCast>( \
configFileObject.read_##variableType( \
sectionNameStr, #variableName, variableName, true)); \
} \
catch (std::exception&) \
{ \
THROW_EXCEPTION( \
"Value for '%s' not found in config file in section '%s'", \
static_cast<const char*>(#variableName), \
std::string(sectionNameStr).c_str())); \
} \
}
std::string format(const char *fmt,...) MRPT_printf_format_check(1
A std::string version of C sprintf.
Definition: format.cpp:19
GLsizei const GLchar ** string
Definition: glext.h:4101

Definition at line 398 of file CConfigFileBase.h.

Referenced by mrpt::hmtslam::CHMTSLAM::TOptions::loadFromConfigFile().

◆ MRPT_LOAD_CONFIG_VAR_CS

#define MRPT_LOAD_CONFIG_VAR_CS (   variableName,
  variableType 
)    MRPT_LOAD_CONFIG_VAR(variableName, variableType, c, s)

◆ MRPT_LOAD_CONFIG_VAR_DEGREES

#define MRPT_LOAD_CONFIG_VAR_DEGREES (   variableName,
  configFileObject,
  sectionNameStr 
)
Value:
{ \
variableName = mrpt::utils::DEG2RAD( \
configFileObject.read_double( \
sectionNameStr, #variableName, \
mrpt::utils::RAD2DEG(variableName))); \
}
double DEG2RAD(const double x)
Degrees to radians.
Definition: bits.h:96
double RAD2DEG(const double x)
Radians to degrees.
Definition: bits.h:102

Loads a double variable, stored as radians but entered in the INI-file as degrees.

Definition at line 293 of file CConfigFileBase.h.

Referenced by mrpt::slam::TKLDParams::loadFromConfigFile(), mrpt::slam::CMetricMapBuilderICP::TConfigParams::loadFromConfigFile(), mrpt::maps::CPointCloudFilterByDistance::TOptions::loadFromConfigFile(), mrpt::nav::CWaypointsNavigator::TWaypointsNavigatorParams::loadFromConfigFile(), mrpt::maps::CPointsMap::TInsertionOptions::loadFromConfigFile(), mrpt::hmtslam::CHMTSLAM::TOptions::loadFromConfigFile(), and mrpt::maps::COccupancyGridMap2D::TInsertionOptions::loadFromConfigFile().

◆ MRPT_LOAD_CONFIG_VAR_DEGREES_NO_DEFAULT

#define MRPT_LOAD_CONFIG_VAR_DEGREES_NO_DEFAULT (   variableName,
  configFileObject,
  sectionNameStr 
)
Value:
{ \
variableName = mrpt::utils::DEG2RAD( \
configFileObject.read_double( \
sectionNameStr, #variableName, \
mrpt::utils::RAD2DEG(variableName), true)); \
}
double DEG2RAD(const double x)
Degrees to radians.
Definition: bits.h:96
double RAD2DEG(const double x)
Radians to degrees.
Definition: bits.h:102

Loads a double, required, variable, stored as radians but entered in the INI-file as degrees.

Definition at line 304 of file CConfigFileBase.h.

◆ MRPT_LOAD_CONFIG_VAR_NO_DEFAULT

#define MRPT_LOAD_CONFIG_VAR_NO_DEFAULT (   variableName,
  variableType,
  configFileObject,
  sectionNameStr 
)
Value:
{ \
try \
{ \
variableName = configFileObject.read_##variableType( \
sectionNameStr, #variableName, variableName, true); \
} \
catch (std::exception&) \
{ \
THROW_EXCEPTION( \
"Value for '%s' not found in config file in section '%s'", \
static_cast<const char*>(#variableName), \
std::string(sectionNameStr).c_str())); \
} \
}
std::string format(const char *fmt,...) MRPT_printf_format_check(1
A std::string version of C sprintf.
Definition: format.cpp:19
GLsizei const GLchar ** string
Definition: glext.h:4101

Definition at line 375 of file CConfigFileBase.h.

Referenced by IMPLEMENTS_SERIALIZABLE(), mrpt::kinematics::CVehicleVelCmd::TVelCmdParams::loadConfigFile(), mrpt::slam::CGridMapAligner::TConfigParams::loadFromConfigFile(), mrpt::bayes::CParticleFilter::TParticleFilterOptions::loadFromConfigFile(), mrpt::nav::CHolonomicFullEval::TOptions::loadFromConfigFile(), and mrpt::nav::CParameterizedTrajectoryGenerator::loadFromConfigFile().

◆ MRPT_LOAD_CONFIG_VAR_REQUIRED_CS

#define MRPT_LOAD_CONFIG_VAR_REQUIRED_CS (   variableName,
  variableType 
)    MRPT_LOAD_CONFIG_VAR_NO_DEFAULT(variableName, variableType, c, s)

◆ MRPT_LOAD_HERE_CONFIG_VAR

#define MRPT_LOAD_HERE_CONFIG_VAR (   variableName,
  variableType,
  targetVariable,
  configFileObject,
  sectionNameStr 
)

◆ MRPT_LOAD_HERE_CONFIG_VAR_CAST

#define MRPT_LOAD_HERE_CONFIG_VAR_CAST (   variableName,
  variableType,
  variableTypeCast,
  targetVariable,
  configFileObject,
  sectionNameStr 
)
Value:
targetVariable = static_cast<variableTypeCast>( \
configFileObject.read_##variableType( \
sectionNameStr, #variableName, targetVariable));

Definition at line 418 of file CConfigFileBase.h.

◆ MRPT_LOAD_HERE_CONFIG_VAR_CAST_NO_DEFAULT

#define MRPT_LOAD_HERE_CONFIG_VAR_CAST_NO_DEFAULT (   variableName,
  variableType,
  variableTypeCast,
  targetVariable,
  configFileObject,
  sectionNameStr 
)
Value:
{ \
try \
{ \
targetVariable = static_cast<variableTypeCast>( \
configFileObject.read_##variableType( \
sectionNameStr, #variableName, targetVariable, true)); \
} \
catch (std::exception&) \
{ \
THROW_EXCEPTION( \
"Value for '%s' not found in config file in section '%s'", \
static_cast<const char*>(#variableName), \
std::string(sectionNameStr).c_str())); \
} \
}
std::string format(const char *fmt,...) MRPT_printf_format_check(1
A std::string version of C sprintf.
Definition: format.cpp:19
GLsizei const GLchar ** string
Definition: glext.h:4101

Definition at line 425 of file CConfigFileBase.h.

◆ MRPT_LOAD_HERE_CONFIG_VAR_DEGREES

#define MRPT_LOAD_HERE_CONFIG_VAR_DEGREES (   variableName,
  variableType,
  targetVariable,
  configFileObject,
  sectionNameStr 
)
Value:
targetVariable = mrpt::utils::DEG2RAD( \
configFileObject.read_##variableType( \
sectionNameStr, #variableName, \
mrpt::utils::RAD2DEG(targetVariable), false));
double DEG2RAD(const double x)
Degrees to radians.
Definition: bits.h:96
double RAD2DEG(const double x)
Radians to degrees.
Definition: bits.h:102

Definition at line 347 of file CConfigFileBase.h.

Referenced by mrpt::nav::CParameterizedTrajectoryGenerator::loadFromConfigFile().

◆ MRPT_LOAD_HERE_CONFIG_VAR_DEGREES_NO_DEFAULT

#define MRPT_LOAD_HERE_CONFIG_VAR_DEGREES_NO_DEFAULT (   variableName,
  variableType,
  targetVariable,
  configFileObject,
  sectionNameStr 
)
Value:
{ \
try \
{ \
targetVariable = mrpt::utils::DEG2RAD( \
configFileObject.read_##variableType( \
sectionNameStr, #variableName, targetVariable, true)); \
} \
catch (std::exception&) \
{ \
THROW_EXCEPTION( \
"Value for '%s' not found in config file in section '%s'", \
static_cast<const char*>(#variableName), \
std::string(sectionNameStr).c_str())); \
} \
}
std::string format(const char *fmt,...) MRPT_printf_format_check(1
A std::string version of C sprintf.
Definition: format.cpp:19
double DEG2RAD(const double x)
Degrees to radians.
Definition: bits.h:96
GLsizei const GLchar ** string
Definition: glext.h:4101

Definition at line 355 of file CConfigFileBase.h.

Referenced by IMPLEMENTS_SERIALIZABLE(), mrpt::kinematics::CVehicleVelCmd::TVelCmdParams::loadConfigFile(), mrpt::nav::CPTG_Holo_Blend::loadFromConfigFile(), mrpt::slam::CMetricMapBuilderRBPF::TConstructionOptions::loadFromConfigFile(), and mrpt::nav::CPTG_DiffDrive_CollisionGridBased::loadFromConfigFile().

◆ MRPT_LOAD_HERE_CONFIG_VAR_NO_DEFAULT

#define MRPT_LOAD_HERE_CONFIG_VAR_NO_DEFAULT (   variableName,
  variableType,
  targetVariable,
  configFileObject,
  sectionNameStr 
)
Value:
{ \
try \
{ \
targetVariable = configFileObject.read_##variableType( \
sectionNameStr, #variableName, targetVariable, true); \
} \
catch (std::exception&) \
{ \
THROW_EXCEPTION( \
"Value for '%s' not found in config file in section '%s'", \
static_cast<const char*>(#variableName), \
std::string(sectionNameStr).c_str())); \
} \
}
std::string format(const char *fmt,...) MRPT_printf_format_check(1
A std::string version of C sprintf.
Definition: format.cpp:19
GLsizei const GLchar ** string
Definition: glext.h:4101

Definition at line 328 of file CConfigFileBase.h.

Referenced by mrpt::nav::CPTG_Holo_Blend::loadFromConfigFile(), mrpt::vision::CCamModel::loadFromConfigFile(), mrpt::nav::CPTG_DiffDrive_CollisionGridBased::loadFromConfigFile(), and mrpt::nav::CParameterizedTrajectoryGenerator::loadFromConfigFile().

◆ MRPT_SAVE_CONFIG_VAR

#define MRPT_SAVE_CONFIG_VAR (   variableName,
  configFileObject,
  sectionNameStr 
)
Value:
{ \
configFileObject.write(sectionNameStr, #variableName, variableName); \
}

Definition at line 445 of file CConfigFileBase.h.

◆ MRPT_SAVE_CONFIG_VAR_COMMENT

#define MRPT_SAVE_CONFIG_VAR_COMMENT (   variableName,
  __comment 
)

◆ MRPT_SAVE_CONFIG_VAR_DEGREES

#define MRPT_SAVE_CONFIG_VAR_DEGREES (   variableName,
  configFileObject,
  sectionNameStr 
)
Value:
{ \
configFileObject.write( \
sectionNameStr, #variableName, \
mrpt::utils::RAD2DEG(variableName)); \
}
double RAD2DEG(const double x)
Radians to degrees.
Definition: bits.h:102

Definition at line 450 of file CConfigFileBase.h.

◆ MRPT_SAVE_CONFIG_VAR_DEGREES_COMMENT

#define MRPT_SAVE_CONFIG_VAR_DEGREES_COMMENT (   __entryName,
  __variable,
  __comment 
)
Value:
{ \
c.write( \
s, __entryName, mrpt::utils::RAD2DEG(__variable), \
}
GLdouble s
Definition: glext.h:3676
int MRPT_SAVE_NAME_PADDING()
Default padding sizes for macros MRPT_SAVE_CONFIG_VAR_COMMENT(), etc.
double RAD2DEG(const double x)
Radians to degrees.
Definition: bits.h:102
int MRPT_SAVE_VALUE_PADDING()

Definition at line 465 of file CConfigFileBase.h.

Referenced by mrpt::maps::CPointCloudFilterByDistance::TOptions::saveToConfigFile(), mrpt::kinematics::CVehicleVelCmd::TVelCmdParams::saveToConfigFile(), and mrpt::nav::CWaypointsNavigator::TWaypointsNavigatorParams::saveToConfigFile().




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