Detailed Description

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

Definition at line 66 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) MRPT_OVERRIDE
	This method load the options from a ".ini"-like file or memory-stored string list. More...

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. 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...

virtual mxArray *	writeToMatlab () const
	Introduces a pure virtual method responsible for writing to a `mxArray` Matlab object, typically a MATLAB `struct` whose contents are documented in each derived class. More...

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

RTTI classes and functions
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...

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	Ptr

typedef TMapGenericParamsPtr	ConstPtr

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

◆ ConstPtr

typedef TMapGenericParamsPtr mrpt::maps::TMapGenericParams::ConstPtr

Definition at line 68 of file metric_map_types.h.

◆ Ptr

typedef TMapGenericParamsPtr mrpt::maps::TMapGenericParams::Ptr

A typedef for the associated smart pointer

Definition at line 68 of file metric_map_types.h.

Constructor & Destructor Documentation

◆ TMapGenericParams()

TMapGenericParams::TMapGenericParams ( )

Definition at line 23 of file metric_map_types.cpp.

Member Function Documentation

◆ _GetBaseClass()

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

staticprotected

◆ clone()

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

inlineinherited

Cloning interface for smart pointers.

Definition at line 133 of file CObject.h.

◆ Create()

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

static

◆ CreateObject()

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

static

◆ dumpToConsole()

void CLoadableOptions::dumpToConsole ( ) const

inherited

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

Definition at line 47 of file CLoadableOptions.cpp.

References mrpt::utils::CLoadableOptions::dumpToTextStream(), and loadable_opts_my_cout.

Referenced by mrpt::hmtslam::CTopLCDetector_GridMatching::computeTopologicalObservationModel(), mrpt::hmtslam::CHMTSLAM::loadOptions(), and mrpt::graphslam::optimizers::CLevMarqGSO< GRAPH_T >::printParams().

◆ dumpToTextStream()

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

Definition at line 36 of file metric_map_types.cpp.

References LOADABLEOPTS_DUMP_VAR.

Referenced by mrpt::maps::TMetricMapInitializer::dumpToTextStream().

◆ dumpVar_bool()

void CLoadableOptions::dumpVar_bool	(	CStream &	out,
		const char *	varName,
		bool	v
	)

staticprotectedinherited

Definition at line 67 of file CLoadableOptions.cpp.

References LOADABLEOPTS_COLUMN_WIDTH, and mrpt::utils::CStream::printf().

◆ dumpVar_double()

void CLoadableOptions::dumpVar_double	(	CStream &	out,
		const char *	varName,
		double	v
	)

staticprotectedinherited

Definition at line 62 of file CLoadableOptions.cpp.

References LOADABLEOPTS_COLUMN_WIDTH, and mrpt::utils::CStream::printf().

◆ dumpVar_float()

void CLoadableOptions::dumpVar_float	(	CStream &	out,
		const char *	varName,
		float	v
	)

staticprotectedinherited

Definition at line 57 of file CLoadableOptions.cpp.

References LOADABLEOPTS_COLUMN_WIDTH, and mrpt::utils::CStream::printf().

◆ dumpVar_int()

void CLoadableOptions::dumpVar_int	(	CStream &	out,
		const char *	varName,
		int	v
	)

staticprotectedinherited

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

Definition at line 52 of file CLoadableOptions.cpp.

References LOADABLEOPTS_COLUMN_WIDTH, and mrpt::utils::CStream::printf().

◆ dumpVar_string()

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

staticprotectedinherited

Definition at line 72 of file CLoadableOptions.cpp.

References LOADABLEOPTS_COLUMN_WIDTH, and mrpt::utils::CStream::printf().

◆ duplicate()

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

virtual

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

Implements mrpt::utils::CObject.

◆ duplicateGetSmartPtr()

mrpt::utils::CObjectPtr 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 162 of file CObject.h.

References mrpt::utils::CObjectPtr.

Referenced by mrpt::obs::CRawlog::addActions(), mrpt::slam::CIncrementalMapPartitioner::addMapFrame(), and mrpt::obs::CRawlog::addObservations().

◆ GetRuntimeClass()

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.

◆ loadFromConfigFile()

void 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.

Definition at line 30 of file metric_map_types.cpp.

References MRPT_LOAD_CONFIG_VAR.

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

◆ 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 23 of file CLoadableOptions.cpp.

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

Referenced by mrpt::graphslam::optimizers::CLevMarqGSO< GRAPH_T >::loadParams().

◆ operator delete() [1/3]

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

inline

Definition at line 68 of file metric_map_types.h.

◆ operator delete() [2/3]

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

inline

Definition at line 68 of file metric_map_types.h.

◆ operator delete() [3/3]

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

inline

Definition at line 68 of file metric_map_types.h.

◆ operator delete[]()

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

inline

Definition at line 68 of file metric_map_types.h.

◆ operator new() [1/3]

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

inline

Definition at line 68 of file metric_map_types.h.

◆ operator new() [2/3]

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

inlinestatic

Definition at line 68 of file metric_map_types.h.

◆ operator new() [3/3]

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

inline

Definition at line 68 of file metric_map_types.h.

◆ operator new[]()

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

inline

Definition at line 68 of file metric_map_types.h.

◆ readFromStream()

void 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.

Definition at line 54 of file metric_map_types.cpp.

References MRPT_THROW_UNKNOWN_SERIALIZATION_VERSION, and version.

◆ saveToConfigFile()

void 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::nav::CPTG_RobotShape_Circular, mrpt::nav::CPTG_RobotShape_Polygonal, mrpt::nav::CParameterizedTrajectoryGenerator, mrpt::nav::CAbstractNavigator::TAbstractNavigatorParams, mrpt::nav::CAbstractPTGBasedReactive::TAbstractPTGNavigatorParams, mrpt::nav::CPTG_DiffDrive_CollisionGridBased, mrpt::nav::CHolonomicND::TOptions, mrpt::nav::CWaypointsNavigator::TWaypointsNavigatorParams, mrpt::nav::CHolonomicFullEval::TOptions, mrpt::nav::CReactiveNavigationSystem::TReactiveNavigatorParams, mrpt::nav::CHolonomicVFF::TOptions, mrpt::nav::CMultiObjectiveMotionOptimizerBase::TParamsBase, mrpt::maps::CPointCloudFilterByDistance::TOptions, mrpt::nav::CPTG_DiffDrive_C, mrpt::nav::CPTG_DiffDrive_alpha, mrpt::nav::CMultiObjMotionOpt_Scalarization::TParams, mrpt::nav::CPTG_DiffDrive_CC, mrpt::nav::CPTG_DiffDrive_CCS, mrpt::nav::CPTG_DiffDrive_CS, and mrpt::nav::CPTG_Holo_Blend.

Definition at line 31 of file CLoadableOptions.cpp.

References MRPT_UNUSED_PARAM.

Referenced by mrpt::utils::CLoadableOptions::dumpToTextStream(), and mrpt::utils::CLoadableOptions::saveToConfigFileName().

◆ 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 39 of file CLoadableOptions.cpp.

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

◆ writeToMatlab()

virtual mxArray* mrpt::utils::CSerializable::writeToMatlab ( ) const

inlinevirtualinherited

Introduces a pure virtual method responsible for writing to a mxArray Matlab object, typically a MATLAB struct whose contents are documented in each derived class.

Returns: A new mxArray (caller is responsible of memory freeing) or NULL is class does not support conversion to MATLAB.

Definition at line 79 of file CSerializable.h.

◆ writeToStream()

void 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.

Definition at line 44 of file metric_map_types.cpp.

References version.

Member Data Documentation

◆ _init_TMapGenericParams

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

staticprotected

Definition at line 68 of file metric_map_types.h.

◆ classCObject

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

staticinherited

Definition at line 118 of file CObject.h.

◆ classCSerializable

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

staticinherited

Definition at line 42 of file CSerializable.h.

◆ classinfo

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

static

Definition at line 68 of file metric_map_types.h.

◆ classTMapGenericParams

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

static

Definition at line 68 of file metric_map_types.h.

◆ enableObservationInsertion

bool mrpt::maps::TMapGenericParams::enableObservationInsertion

(Default=true) Enable inserting observations in this map

Definition at line 72 of file metric_map_types.h.

◆ enableObservationLikelihood

bool mrpt::maps::TMapGenericParams::enableObservationLikelihood

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

Definition at line 71 of file metric_map_types.h.

◆ enableSaveAs3DObject

bool mrpt::maps::TMapGenericParams::enableSaveAs3DObject

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

Definition at line 70 of file metric_map_types.h.

Referenced by mrpt::maps::CGasConcentrationGridMap2D::getAs3DObject(), mrpt::maps::CReflectivityGridMap2D::getAs3DObject(), mrpt::maps::CHeightGridMap2D::getAs3DObject(), mrpt::maps::CBeaconMap::getAs3DObject(), mrpt::maps::CRandomFieldGridMap2D::getAs3DObject(), mrpt::maps::CLandmarksMap::getAs3DObject(), and mrpt::maps::CPointsMap::getAs3DObject().

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

◆ ConstPtr

◆ Ptr

Constructor & Destructor Documentation

◆ TMapGenericParams()

Member Function Documentation

◆ _GetBaseClass()

◆ clone()

◆ Create()

◆ CreateObject()

◆ dumpToConsole()

◆ dumpToTextStream()

◆ dumpVar_bool()

◆ dumpVar_double()

◆ dumpVar_float()

◆ dumpVar_int()

◆ dumpVar_string()

◆ duplicate()

◆ duplicateGetSmartPtr()

◆ GetRuntimeClass()

◆ loadFromConfigFile()

◆ loadFromConfigFileName()

◆ operator delete() [1/3]

◆ operator delete() [2/3]

◆ operator delete() [3/3]

◆ operator delete[]()

◆ operator new() [1/3]

◆ operator new() [2/3]

◆ operator new() [3/3]

◆ operator new[]()

◆ readFromStream()

◆ saveToConfigFile()

◆ saveToConfigFileName()

◆ writeToMatlab()

◆ writeToStream()

Member Data Documentation

◆ _init_TMapGenericParams

◆ classCObject

◆ classCSerializable

◆ classinfo

◆ classTMapGenericParams

◆ enableObservationInsertion

◆ enableObservationLikelihood

◆ enableSaveAs3DObject