All Classes Namespaces Files Functions Variables Typedefs Friends Macros Groups Pages
Public Types | Public Attributes | List of all members
sdf::ParamPrivate Class Reference

#include <Param.hh>

Public Types

typedef boost::variant< bool,
char, std::string, int,
uint64_t, unsigned int, double,
float, sdf::Time, sdf::Color,
ignition::math::Vector3d,
ignition::math::Vector2i,
ignition::math::Vector2d,
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...
 
bool required
 True if the parameter is required. More...
 
bool set
 True if the parameter is set. More...
 
std::string typeName
 
std::function< boost::any()> updateFunc
 Update function pointer. More...
 
ParamVariant value
 This parameter's value. More...
 

Member Typedef Documentation

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

Member Data Documentation

ParamVariant sdf::ParamPrivate::defaultValue

This parameter's default value.

Referenced by sdf::Param::GetDefault().

std::string sdf::ParamPrivate::description

Description of the parameter.

std::string sdf::ParamPrivate::key
bool sdf::ParamPrivate::required

True if the parameter is required.

bool sdf::ParamPrivate::set

True if the parameter is set.

std::string sdf::ParamPrivate::typeName
std::function<boost::any ()> sdf::ParamPrivate::updateFunc

Update function pointer.

Referenced by sdf::Param::SetUpdateFunc().

ParamVariant sdf::ParamPrivate::value

This parameter's value.

Referenced by sdf::Param::Get(), and sdf::Param::IsType().


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