mvsim::TParamEntry Struct Reference

#include <TParameterDefinitions.h>

Public Member Functions
template<typename T >
	TParamEntry (const char *format_, T *targetVariable)
void	parse (const std::string &str, const std::string &varName, const std::map< std::string, std::string > &variableNamesValues={}, const char *functionNameContext="") const

Public Attributes
const char *	format = nullptr
void *	val = nullptr

Detailed Description

Normal case: sscanf()-like specifiers, and "void*" pointing to corresponding variable type. Special cases:

• "%lf_deg" => "val" is a "double*". The read number will be converted from degrees to radians.
• "%s" => "val" is assumed to be a pointer to a std::string. Strings are trimmed of whitespaces.
• "%color" => Expected values: "#RRGGBB[AA]" ([00-FF] each). "val" is assumed to be a pointer to a mrpt::img::TColor
• "%pose2d" => Expects "X Y YAW_DEG". "Val" is a pointer to mrpt::poses::CPose2D
• "%pose2d_ptr3d" => Expects "X Y YAW_DEG". "Val" is a pointer to mrpt::poses::CPose3D
• "%pose3d" => Expects "X Y Z YAW_DEG PITCH_DEG ROLL_DEG". "Val" is a pointer to mrpt::poses::CPose3D
• "%point3d" => Expects "X Y [Z]". "Val" is a pointer to mrpt::math::TPoint3D
• "%bool" ==> bool*. Values: 'true'/'false' or '1'/'0'

Member Function Documentation

parse()

void mvsim::TParamEntry::parse	(	const std::string &	str,
		const std::string &	varName,
		const std::map< std::string, std::string > &	variableNamesValues = {},
		const char *	functionNameContext = ""
	)		const

Tries to parse the given input string according to the expected format, then store the result in "*val"

Exceptions

std::runtime_error

On format errors.

---

The documentation for this struct was generated from the following file:

• /home/docs/checkouts/readthedocs.org/user_builds/mvsimulator/checkouts/stable/modules/simulator/include/mvsim/TParameterDefinitions.h