Public Types | Public Member Functions | Public Attributes | List of all members
sdf::v12::ParamPrivate Class Reference

#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 Member Functions

bool StringFromValueImpl (const PrintConfig &_config, const std::string &_typeName, const ParamVariant &_value, std::string &_valueStr) const
 Method used to get the string representation from a ParamVariant. More...
 
template<typename T >
std::string TypeToString () const
 Data type to string mapping. More...
 
bool ValueFromStringImpl (const std::string &_typeName, const std::string &_valueStr, ParamVariant &_valueToSet) const
 Method used to set the Param from a passed-in string. More...
 

Public Attributes

std::string defaultStrValue
 This parameter's default value that was provided as a string. More...
 
ParamVariant defaultValue
 This parameter's default value. More...
 
std::string description
 Description of the parameter. More...
 
bool ignoreParentAttributes
 True if the value has been parsed while ignoring its parent element's attributes, and will continue to ignore them for subsequent reparses. More...
 
std::string key
 Key value. More...
 
std::optional< ParamVariantmaxValue
 This parameter's maximum allowed value. More...
 
std::optional< ParamVariantminValue
 This parameter's minimum allowed value. More...
 
ElementWeakPtr parentElement
 Parent element. More...
 
bool required
 True if the parameter is required. More...
 
bool set
 True if the parameter is set. More...
 
std::optional< std::string > strValue
 This parameter's value that was provided as a string. 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::v12::ParamPrivate::ParamVariant

Member Function Documentation

◆ StringFromValueImpl()

bool sdf::v12::ParamPrivate::StringFromValueImpl ( const PrintConfig _config,
const std::string &  _typeName,
const ParamVariant _value,
std::string &  _valueStr 
) const

Method used to get the string representation from a ParamVariant.

Parameters
[in]_configPrint configuration for the string output
[in]_typeNameThe data type of the value
[in]_valueThe value
[in]_valueStrThe string representation of the value
Returns
True if the string was successfully retrieved from the value, false otherwise.

◆ TypeToString()

template<typename T >
std::string sdf::v12::ParamPrivate::TypeToString

Data type to string mapping.

Returns
The type as a string, empty string if unknown type

◆ ValueFromStringImpl()

bool sdf::v12::ParamPrivate::ValueFromStringImpl ( const std::string &  _typeName,
const std::string &  _valueStr,
ParamVariant _valueToSet 
) const

Method used to set the Param from a passed-in string.

Parameters
[in]_typeNameThe data type of the value to set
[in]_valueStrThe value as a string
[out]_valueToSetThe value to set
Returns
True if the value was successfully set, false otherwise

Member Data Documentation

◆ defaultStrValue

std::string sdf::v12::ParamPrivate::defaultStrValue

This parameter's default value that was provided as a string.

◆ defaultValue

ParamVariant sdf::v12::ParamPrivate::defaultValue

This parameter's default value.

◆ description

std::string sdf::v12::ParamPrivate::description

Description of the parameter.

◆ ignoreParentAttributes

bool sdf::v12::ParamPrivate::ignoreParentAttributes

True if the value has been parsed while ignoring its parent element's attributes, and will continue to ignore them for subsequent reparses.

◆ key

std::string sdf::v12::ParamPrivate::key

Key value.

◆ maxValue

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

This parameter's maximum allowed value.

◆ minValue

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

This parameter's minimum allowed value.

◆ parentElement

ElementWeakPtr sdf::v12::ParamPrivate::parentElement

Parent element.

◆ required

bool sdf::v12::ParamPrivate::required

True if the parameter is required.

◆ set

bool sdf::v12::ParamPrivate::set

True if the parameter is set.

◆ strValue

std::optional<std::string> sdf::v12::ParamPrivate::strValue

This parameter's value that was provided as a string.

◆ typeName

std::string sdf::v12::ParamPrivate::typeName

◆ updateFunc

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

Update function pointer.

◆ value

ParamVariant sdf::v12::ParamPrivate::value

This parameter's value.


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