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::CColouredPointsMap::TColourOptions Struct Reference

Detailed Description

The definition of parameters for generating colors from laser scans.

Definition at line 204 of file maps/CColouredPointsMap.h.

#include <mrpt/maps/CColouredPointsMap.h>

Inheritance diagram for mrpt::maps::CColouredPointsMap::TColourOptions:
Inheritance graph

Public Member Functions

 TColourOptions ()
 Initilization of default parameters.
 
virtual ~TColourOptions ()
 
void loadFromConfigFile (const mrpt::utils::CConfigFileBase &source, const std::string &section) 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

TColouringMethod scheme
 
float z_min
 
float z_max
 
float d_max
 

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)
 

Constructor & Destructor Documentation

◆ TColourOptions()

mrpt::maps::CColouredPointsMap::TColourOptions::TColourOptions ( )

Initilization of default parameters.

◆ ~TColourOptions()

virtual mrpt::maps::CColouredPointsMap::TColourOptions::~TColourOptions ( )
inlinevirtual

Definition at line 208 of file maps/CColouredPointsMap.h.

Member Function Documentation

◆ dumpToConsole()

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

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

◆ dumpToTextStream()

void mrpt::maps::CColouredPointsMap::TColourOptions::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

◆ loadFromConfigFile()

void mrpt::maps::CColouredPointsMap::TColourOptions::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

◆ 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

Member Data Documentation

◆ d_max

float mrpt::maps::CColouredPointsMap::TColourOptions::d_max

Definition at line 215 of file maps/CColouredPointsMap.h.

◆ scheme

TColouringMethod mrpt::maps::CColouredPointsMap::TColourOptions::scheme

Definition at line 213 of file maps/CColouredPointsMap.h.

◆ z_max

float mrpt::maps::CColouredPointsMap::TColourOptions::z_max

Definition at line 214 of file maps/CColouredPointsMap.h.

◆ z_min

float mrpt::maps::CColouredPointsMap::TColourOptions::z_min

Definition at line 214 of file maps/CColouredPointsMap.h.




Page generated by Doxygen 1.9.6 for MRPT 1.4.0 SVN: at Fri Jan 20 02:28:26 UTC 2023