#include <Param.hh>

Public Types
typedef std::variant< bool, char, std::string, int, std::uint64_t, unsigned int, double, float, sdf::Time, ignition::math::Angle, ignition::math::Color, ignition::math::Vector2i, ignition::math::Vector2d, ignition::math::Vector3d, ignition::math::Quaterniond, ignition::math::Pose3d >	ParamVariant

Public Attributes
ParamVariant	defaultValue
	This parameter's default value. More...

std::string	description
	Description of the parameter. More...

std::string	key
	Key value. More...

std::optional< ParamVariant >	maxValue
	This parameter's maximum allowed value. More...

std::optional< ParamVariant >	minValue
	This parameter's minimum allowed value. More...

bool	required
	True if the parameter is required. More...

bool	set
	True if the parameter is set. More...

std::string	typeName

std::function< std::any()>	updateFunc
	Update function pointer. More...

ParamVariant	value
	This parameter's value. More...

Member Typedef Documentation

◆ ParamVariant

typedef std::variant<bool, char, std::string, int, std::uint64_t, unsigned int, double, float, sdf::Time, ignition::math::Angle, ignition::math::Color, ignition::math::Vector2i, ignition::math::Vector2d, ignition::math::Vector3d, ignition::math::Quaterniond, ignition::math::Pose3d> sdf::v11::ParamPrivate::ParamVariant

Member Data Documentation

◆ defaultValue

ParamVariant sdf::v11::ParamPrivate::defaultValue

This parameter's default value.

◆ description

std::string sdf::v11::ParamPrivate::description

Description of the parameter.

◆ key

std::string sdf::v11::ParamPrivate::key

Key value.

◆ maxValue

std::optional<ParamVariant> sdf::v11::ParamPrivate::maxValue

This parameter's maximum allowed value.

◆ minValue

std::optional<ParamVariant> sdf::v11::ParamPrivate::minValue

This parameter's minimum allowed value.

◆ required

bool sdf::v11::ParamPrivate::required

True if the parameter is required.

◆ set

bool sdf::v11::ParamPrivate::set

True if the parameter is set.

◆ typeName

std::string sdf::v11::ParamPrivate::typeName

◆ updateFunc

std::function<std::any ()> sdf::v11::ParamPrivate::updateFunc

Update function pointer.

◆ value

ParamVariant sdf::v11::ParamPrivate::value

This parameter's value.

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

Param.hh

Public Types

Public Attributes