Detailed Description

Common params to all maps derived from mrpt::maps::CMetricMap.

Definition at line 56 of file metric_map_types.h.

#include <mrpt/maps/metric_map_types.h>

Inheritance diagram for mrpt::maps::TMapGenericParams:

Public Member Functions
void *	operator new (size_t size)

void *	operator new[] (size_t size)

void	operator delete (void *ptr) throw ()

void	operator delete[] (void *ptr) throw ()

void	operator delete (void memory, void ptr) throw ()

void *	operator new (size_t size, const std::nothrow_t &) throw ()

void	operator delete (void *ptr, const std::nothrow_t &) throw ()

	TMapGenericParams ()

void	loadFromConfigFile (const mrpt::utils::CConfigFileBase &source, const std::string &sectionNamePrefix)
	This method load the options from a ".ini"-like file or memory-stored string list. More...

void	dumpToTextStream (mrpt::utils::CStream &out) const
	Dump the options of the metric map in human-readable format. 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...

mrpt::utils::CObjectPtr	duplicateGetSmartPtr () const
	Returns a copy of the object, indepently of its class, as a smart pointer (the newly created object will exist as long as any copy of this smart pointer). More...

CObject *	clone () const
	Cloning interface for smart pointers. More...

Static Public Member Functions
static void *	operator new (size_t size, void *ptr)

Public Attributes
bool	enableSaveAs3DObject
	(Default=true) If false, calling CMetricMap::getAs3DObject() will have no effects More...

bool	enableObservationLikelihood
	(Default=true) Enable computing observation likelihoods with this map More...

bool	enableObservationInsertion
	(Default=true) Enable inserting observations in this map More...

Static Public Attributes
static const mrpt::utils::TRuntimeClassId	classCObject

RTTI stuff
static const mrpt::utils::TRuntimeClassId	classCSerializable

Protected Member Functions
CSerializable virtual methods
void	writeToStream (mrpt::utils::CStream &out, int *getVersion) const
	Introduces a pure virtual method responsible for writing to a CStream. More...

void	readFromStream (mrpt::utils::CStream &in, int version)
	Introduces a pure virtual method responsible for loading from a CStream This can not be used directly be users, instead use "stream >> object;" for reading it from a stream or "stream >> object_ptr;" if the class is unknown apriori. More...

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)

RTTI stuff
typedef TMapGenericParamsPtr	SmartPtr

static mrpt::utils::CLASSINIT	_init_TMapGenericParams

static mrpt::utils::TRuntimeClassId	classTMapGenericParams

static const mrpt::utils::TRuntimeClassId *	classinfo

static const mrpt::utils::TRuntimeClassId *	_GetBaseClass ()

virtual const mrpt::utils::TRuntimeClassId *	GetRuntimeClass () const
	Returns information about the class of an object in runtime. More...

virtual mrpt::utils::CObject *	duplicate () const
	Returns a copy of the object, indepently of its class. More...

static mrpt::utils::CObject *	CreateObject ()

static TMapGenericParamsPtr	Create ()

Member Typedef Documentation

typedef TMapGenericParamsPtr mrpt::maps::TMapGenericParams::SmartPtr

A typedef for the associated smart pointer

Definition at line 58 of file metric_map_types.h.

Constructor & Destructor Documentation

mrpt::maps::TMapGenericParams::TMapGenericParams ( )

Member Function Documentation

static const mrpt::utils::TRuntimeClassId* mrpt::maps::TMapGenericParams::_GetBaseClass ( )

staticprotected

CObject* mrpt::utils::CObject::clone ( ) const

inlineinherited

Cloning interface for smart pointers.

Definition at line 139 of file CObject.h.

static TMapGenericParamsPtr mrpt::maps::TMapGenericParams::Create ( )

static

static mrpt::utils::CObject* mrpt::maps::TMapGenericParams::CreateObject ( )

static

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

inherited

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

void mrpt::maps::TMapGenericParams::dumpToTextStream ( mrpt::utils::CStream & out ) const

virtual

Dump the options of the metric map in human-readable format.

Reimplemented from mrpt::utils::CLoadableOptions.

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

virtual mrpt::utils::CObject* mrpt::maps::TMapGenericParams::duplicate ( ) const

virtual

Returns a copy of the object, indepently of its class.

Implements mrpt::utils::CObject.

mrpt::utils::CObjectPtr mrpt::utils::CObject::duplicateGetSmartPtr ( ) const

inlineinherited

Returns a copy of the object, indepently of its class, as a smart pointer (the newly created object will exist as long as any copy of this smart pointer).

Definition at line 136 of file CObject.h.

virtual const mrpt::utils::TRuntimeClassId* mrpt::maps::TMapGenericParams::GetRuntimeClass ( ) const

virtual

Returns information about the class of an object in runtime.

Reimplemented from mrpt::utils::CSerializable.

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

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

void mrpt::maps::TMapGenericParams::operator delete	(	void *	ptr	)
throw	(
	)

inline

Definition at line 58 of file metric_map_types.h.

void mrpt::maps::TMapGenericParams::operator delete	(	void *	memory,
		void *	ptr
	)
throw	(
	)

inline

Definition at line 58 of file metric_map_types.h.

void mrpt::maps::TMapGenericParams::operator delete	(	void *	ptr,
		const std::nothrow_t &
	)
throw	(
	)

inline

Definition at line 58 of file metric_map_types.h.

void mrpt::maps::TMapGenericParams::operator delete[]	(	void *	ptr	)
throw	(
	)

inline

Definition at line 58 of file metric_map_types.h.

static void* mrpt::maps::TMapGenericParams::operator new	(	size_t	size,
		void *	ptr
	)

inlinestatic

Definition at line 58 of file metric_map_types.h.

void* mrpt::maps::TMapGenericParams::operator new	(	size_t	size,
		const std::nothrow_t &
	)
throw	(
	)

inline

Definition at line 58 of file metric_map_types.h.

void* mrpt::maps::TMapGenericParams::operator new ( size_t size )

inline

Definition at line 58 of file metric_map_types.h.

void* mrpt::maps::TMapGenericParams::operator new[] ( size_t size )

inline

Definition at line 58 of file metric_map_types.h.

void mrpt::maps::TMapGenericParams::readFromStream	(	mrpt::utils::CStream &	in,
		int	version
	)

protectedvirtual

Introduces a pure virtual method responsible for loading from a CStream This can not be used directly be users, instead use "stream >> object;" for reading it from a stream or "stream >> object_ptr;" if the class is unknown apriori.

Parameters

in	The input binary stream where the object data must read from.
version	The version of the object stored in the stream: use this version number in your code to know how to read the incoming data.

Exceptions

std::exception On any error, see CStream::ReadBuffer

See also: CStream

Implements mrpt::utils::CSerializable.

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::srba::RbaEngine< KF2KF_POSE_TYPE, LM_TYPE, OBS_TYPE, RBA_OPTIONS >::TSRBAParameters, 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

void mrpt::maps::TMapGenericParams::writeToStream	(	mrpt::utils::CStream &	out,
		int *	getVersion
	)		const

protectedvirtual

Introduces a pure virtual method responsible for writing to a CStream.

This can not be used directly be users, instead use "stream << object;" for writing it to a stream.

Parameters

out	The output binary stream where object must be dumped.
getVersion	If NULL, the object must be dumped. If not, only the version of the object dump must be returned in this pointer. This enables the versioning of objects dumping and backward compatibility with previously stored data.

Exceptions

std::exception On any error, see CStream::WriteBuffer

See also: CStream

Implements mrpt::utils::CSerializable.

Member Data Documentation

mrpt::utils::CLASSINIT mrpt::maps::TMapGenericParams::_init_TMapGenericParams

staticprotected

Definition at line 58 of file metric_map_types.h.

const mrpt::utils::TRuntimeClassId mrpt::utils::CObject::classCObject

staticinherited

Definition at line 124 of file CObject.h.

const mrpt::utils::TRuntimeClassId mrpt::utils::CSerializable::classCSerializable

staticinherited

Definition at line 38 of file CSerializable.h.

const mrpt::utils::TRuntimeClassId* mrpt::maps::TMapGenericParams::classinfo

static

Definition at line 58 of file metric_map_types.h.

mrpt::utils::TRuntimeClassId mrpt::maps::TMapGenericParams::classTMapGenericParams

static

Definition at line 58 of file metric_map_types.h.

bool mrpt::maps::TMapGenericParams::enableObservationInsertion

(Default=true) Enable inserting observations in this map

Definition at line 62 of file metric_map_types.h.

bool mrpt::maps::TMapGenericParams::enableObservationLikelihood

(Default=true) Enable computing observation likelihoods with this map

Definition at line 61 of file metric_map_types.h.

bool mrpt::maps::TMapGenericParams::enableSaveAs3DObject

(Default=true) If false, calling CMetricMap::getAs3DObject() will have no effects

Definition at line 60 of file metric_map_types.h.

Detailed Description

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

RTTI stuff

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation