MRPT logo

mrpt::utils::CLoadableOptions Class Reference

This is a virtual base class for sets of options than can be loaded from a ".ini" file. More...

#include <mrpt/utils/CLoadableOptions.h>

Inheritance diagram for mrpt::utils::CLoadableOptions:
mrpt::bayes::CKalmanFilterCapable::TKF_options mrpt::bayes::CParticleFilter::TParticleFilterOptions mrpt::monoslam::CMonoSlam::TOptions mrpt::reactivenav::CPRRTNavigator::TOptions mrpt::slam::CBeaconMap::TInsertionOptions mrpt::slam::CBeaconMap::TLikelihoodOptions mrpt::slam::CColouredPointsMap::TColourOptions mrpt::slam::CGasConcentrationGridMap2D::TInsertionOptions mrpt::slam::CGridMapAligner::TConfigParams mrpt::slam::CHeightGridMap2D::TInsertionOptions mrpt::slam::CICP::TConfigParams mrpt::slam::CIncrementalMapPartitioner::TOptions mrpt::slam::CLandmarksMap::TInsertionOptions mrpt::slam::CLandmarksMap::TLikelihoodOptions mrpt::slam::CMetricMapBuilderRBPF::TConstructionOptions mrpt::slam::CMultiMetricMap::TOptions mrpt::slam::CMultiMetricMapPDF::TPredictionParams mrpt::slam::COccupancyGridMap2D::TInsertionOptions mrpt::slam::COccupancyGridMap2D::TLikelihoodOptions mrpt::slam::CPointsMap::TInsertionOptions mrpt::slam::CRangeBearingKFSLAM2D::TOptions mrpt::slam::CRangeBearingKFSLAM::TOptions mrpt::slam::TKLDParams mrpt::slam::TSetOfMetricMapInitializers mrpt::vision::CCamModel mrpt::vision::CFeatureExtraction::TOptions mrpt::vision::TMatchingOptions mrpt::vision::TStereoSystemParams

List of all members.

Public Member Functions

virtual void loadFromConfigFile (const mrpt::utils::CConfigFileBase &source, const std::string &section)=0
 This method load the options from a ".ini"-like file or memory-stored string list.
void dumpToConsole () const
 This method must display clearly all the contents of the structure in textual form, sending it to a CStream.
virtual void dumpToTextStream (CStream &out) const =0
 This method must display clearly all the contents of the structure in textual form, sending it to a CStream.
virtual ~CLoadableOptions ()
 Virtual destructor.

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)

Detailed Description

This is a virtual base class for sets of options than can be loaded from a ".ini" file.

Definition at line 45 of file CLoadableOptions.h.


Constructor & Destructor Documentation

virtual mrpt::utils::CLoadableOptions::~CLoadableOptions (  )  [inline, virtual]

Virtual destructor.

Definition at line 83 of file CLoadableOptions.h.


Member Function Documentation

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

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

virtual void mrpt::utils::CLoadableOptions::dumpToTextStream ( CStream out  )  const [pure virtual]
static void mrpt::utils::CLoadableOptions::dumpVar_bool ( CStream out,
const char *  varName,
bool  v 
) [static, protected]
static void mrpt::utils::CLoadableOptions::dumpVar_double ( CStream out,
const char *  varName,
double  v 
) [static, protected]
static void mrpt::utils::CLoadableOptions::dumpVar_float ( CStream out,
const char *  varName,
float  v 
) [static, protected]
static void mrpt::utils::CLoadableOptions::dumpVar_int ( CStream out,
const char *  varName,
int  v 
) [static, protected]

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 
) [static, protected]
virtual void mrpt::utils::CLoadableOptions::loadFromConfigFile ( const mrpt::utils::CConfigFileBase source,
const std::string &  section 
) [pure 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,...

Implemented in mrpt::slam::CBeaconMap::TLikelihoodOptions, mrpt::slam::CBeaconMap::TInsertionOptions, mrpt::slam::CColouredPointsMap::TColourOptions, mrpt::slam::CGasConcentrationGridMap2D::TInsertionOptions, mrpt::slam::CGridMapAligner::TConfigParams, mrpt::slam::CHeightGridMap2D::TInsertionOptions, mrpt::slam::CICP::TConfigParams, mrpt::slam::CIncrementalMapPartitioner::TOptions, mrpt::slam::CLandmarksMap::TInsertionOptions, mrpt::slam::CLandmarksMap::TLikelihoodOptions, mrpt::slam::CMetricMapBuilderRBPF::TConstructionOptions, mrpt::slam::CMultiMetricMap::TOptions, mrpt::slam::TSetOfMetricMapInitializers, mrpt::slam::CMultiMetricMapPDF::TPredictionParams, mrpt::slam::COccupancyGridMap2D::TInsertionOptions, mrpt::slam::COccupancyGridMap2D::TLikelihoodOptions, mrpt::slam::CPointsMap::TInsertionOptions, mrpt::slam::CRangeBearingKFSLAM::TOptions, mrpt::slam::CRangeBearingKFSLAM2D::TOptions, mrpt::slam::TKLDParams, mrpt::vision::CCamModel, mrpt::vision::CFeatureExtraction::TOptions, mrpt::vision::TStereoSystemParams, mrpt::vision::TMatchingOptions, mrpt::bayes::CKalmanFilterCapable::TKF_options, mrpt::bayes::CParticleFilter::TParticleFilterOptions, mrpt::monoslam::CMonoSlam::TOptions, and mrpt::reactivenav::CPRRTNavigator::TOptions.




Page generated by Doxygen 1.6.1 for MRPT 0.7.1 SVN: at Tue Dec 22 08:29:35 CET 2009