LocalGuidance
A library that generates velocity references to follow a path.
parameter_handler::Parameter< ValueType_ > Class Template Reference

#include <Parameter.hpp>

Inheritance diagram for parameter_handler::Parameter< ValueType_ >:
Inheritance graph

Public Member Functions

 Parameter (const ValueType_ &value=ValueType_())
 
 Parameter (const ValueType_ &value, const ValueType_ &min, const ValueType_ &max)
 
 Parameter (const std::string &name, const ValueType_ &value, const ValueType_ &min, const ValueType_ &max)
 
 Parameter (const Parameter< ValueType_ > &other)
 
 Parameter (const ParameterInterface &other)
 
virtual ~Parameter ()
 
const ValueType_ & getValue () const
 
const ValueType_ & getDefaultValue () const
 
const ValueType_ & getMinValue () const
 
const ValueType_ & getMaxValue () const
 
void setValue (const ValueType_ &value)
 
template<typename V_ = ValueType_>
void setValue (const typename V_::Scalar &value, unsigned int row, unsigned int col=0, typename std::enable_if< std::is_base_of< Eigen::MatrixBase< V_ >, V_ >::value >::type *=0)
 
void resetWithDefaultValueAndRelativeBounds (const ValueType_ &value, const ValueType_ &relativeUpperBound)
 
void setDefaultValue (const ValueType_ &value)
 
void setMinValue (const ValueType_ &value)
 
void setMaxValue (const ValueType_ &value)
 
void resetToDefault ()
 
bool load (const std::string &filename)
 
bool store (const std::string &filename, bool append=false) const
 
bool load (const tinyxml_tools::DocumentHandleXML &doc)
 
bool store (tinyxml_tools::DocumentHandleXML &doc) const
 
- Public Member Functions inherited from parameter_handler::ParameterInterface
 ParameterInterface ()
 
 ParameterInterface (const ParameterInterface &other)
 
virtual ~ParameterInterface ()
 
const std::string & getName () const
 
void setName (const std::string &name)
 
const std::type_index & getType () const
 
template<typename ValueType_ >
const ValueType_ & getValue () const
 
template<typename ValueType_ >
const ValueType_ & getMinValue () const
 
template<typename ValueType_ >
const ValueType_ & getMaxValue () const
 
template<typename ValueType_ >
const ValueType_ & getDefaultValue () const
 
template<typename ValueType_ >
void setValue (const ValueType_ &value)
 
template<typename ValueType_ >
void setMinValue (const ValueType_ &value)
 
template<typename ValueType_ >
void setMaxValue (const ValueType_ &value)
 
template<typename ValueType_ >
void setDefaultValue (const ValueType_ &value)
 
ParameterInterface clone () const
 
ParameterInterfaceoperator= (const ParameterInterface &other)
 
void notifyObservers ()
 
void addObserver (ParameterObserverInterface *observer)
 
void removeObserver (ParameterObserverInterface *observer)
 

Protected Member Functions

std::shared_ptr< internal::ParameterValue< ValueType_ > > getValuePtr ()
 
std::shared_ptr< const internal::ParameterValue< ValueType_ > > getValuePtr () const
 
- Protected Member Functions inherited from parameter_handler::ParameterInterface
 ParameterInterface (const std::type_index &type, const internal::ParameterValuePtr &value, const std::string &name=std::string())
 

Additional Inherited Members

- Protected Attributes inherited from parameter_handler::ParameterInterface
std::type_index type_
 
internal::ParameterValuePtr value_
 
std::string name_
 

Constructor & Destructor Documentation

template<typename ValueType_>
parameter_handler::Parameter< ValueType_ >::Parameter ( const ValueType_ &  value = ValueType_())
inline
template<typename ValueType_>
parameter_handler::Parameter< ValueType_ >::Parameter ( const ValueType_ &  value,
const ValueType_ &  min,
const ValueType_ &  max 
)
inline
template<typename ValueType_>
parameter_handler::Parameter< ValueType_ >::Parameter ( const std::string &  name,
const ValueType_ &  value,
const ValueType_ &  min,
const ValueType_ &  max 
)
inline
template<typename ValueType_>
parameter_handler::Parameter< ValueType_ >::Parameter ( const Parameter< ValueType_ > &  other)
inline
template<typename ValueType_>
parameter_handler::Parameter< ValueType_ >::Parameter ( const ParameterInterface other)
inline
template<typename ValueType_>
virtual parameter_handler::Parameter< ValueType_ >::~Parameter ( )
inlinevirtual

Member Function Documentation

template<typename ValueType_>
const ValueType_& parameter_handler::Parameter< ValueType_ >::getDefaultValue ( ) const
inline
template<typename ValueType_>
const ValueType_& parameter_handler::Parameter< ValueType_ >::getMaxValue ( ) const
inline
template<typename ValueType_>
const ValueType_& parameter_handler::Parameter< ValueType_ >::getMinValue ( ) const
inline
template<typename ValueType_>
const ValueType_& parameter_handler::Parameter< ValueType_ >::getValue ( ) const
inline
template<typename ValueType_>
std::shared_ptr<internal::ParameterValue<ValueType_> > parameter_handler::Parameter< ValueType_ >::getValuePtr ( )
inlineprotected
template<typename ValueType_>
std::shared_ptr<const internal::ParameterValue<ValueType_> > parameter_handler::Parameter< ValueType_ >::getValuePtr ( ) const
inlineprotected
template<typename ValueType_>
bool parameter_handler::Parameter< ValueType_ >::load ( const std::string &  filename)
inline
template<typename ValueType_>
bool parameter_handler::Parameter< ValueType_ >::load ( const tinyxml_tools::DocumentHandleXML doc)
inline
template<typename ValueType_>
void parameter_handler::Parameter< ValueType_ >::resetToDefault ( )
inline
template<typename ValueType_>
void parameter_handler::Parameter< ValueType_ >::resetWithDefaultValueAndRelativeBounds ( const ValueType_ &  value,
const ValueType_ &  relativeUpperBound 
)
inline
template<typename ValueType_>
void parameter_handler::Parameter< ValueType_ >::setDefaultValue ( const ValueType_ &  value)
inline
template<typename ValueType_>
void parameter_handler::Parameter< ValueType_ >::setMaxValue ( const ValueType_ &  value)
inline
template<typename ValueType_>
void parameter_handler::Parameter< ValueType_ >::setMinValue ( const ValueType_ &  value)
inline
template<typename ValueType_>
void parameter_handler::Parameter< ValueType_ >::setValue ( const ValueType_ &  value)
inline
template<typename ValueType_>
template<typename V_ = ValueType_>
void parameter_handler::Parameter< ValueType_ >::setValue ( const typename V_::Scalar &  value,
unsigned int  row,
unsigned int  col = 0,
typename std::enable_if< std::is_base_of< Eigen::MatrixBase< V_ >, V_ >::value >::type *  = 0 
)
inline
template<typename ValueType_>
bool parameter_handler::Parameter< ValueType_ >::store ( const std::string &  filename,
bool  append = false 
) const
inline
template<typename ValueType_>
bool parameter_handler::Parameter< ValueType_ >::store ( tinyxml_tools::DocumentHandleXML doc) const
inline

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