Public Types | Public Member Functions | Private Attributes | List of all members
astra_ros::ParameterImpl< T > Class Template Reference

Internal implementation of a Parameter. More...

#include <Parameter.hpp>

Public Types

typedef std::function< bool(const T &value, const T &previous)> OnChange
 
typedef T ValueType
 

Public Member Functions

const T & get () const noexcept
 
const boost::optional< OnChange > & getOnChangeHandler () const
 
 ParameterImpl ()
 
 ParameterImpl (const T &value)
 
bool set (const T &value) noexcept
 
void setOnChangeHandler (const boost::optional< OnChange > &on_change)
 

Private Attributes

std::mutex mutex_
 
boost::optional< OnChangeon_change_
 
value_
 

Detailed Description

template<typename T>
class astra_ros::ParameterImpl< T >

Internal implementation of a Parameter.

Definition at line 16 of file Parameter.hpp.

Member Typedef Documentation

◆ OnChange

template<typename T >
typedef std::function<bool (const T &value, const T &previous)> astra_ros::ParameterImpl< T >::OnChange

Definition at line 20 of file Parameter.hpp.

◆ ValueType

template<typename T >
typedef T astra_ros::ParameterImpl< T >::ValueType

Definition at line 19 of file Parameter.hpp.

Constructor & Destructor Documentation

◆ ParameterImpl() [1/2]

template<typename T >
astra_ros::ParameterImpl< T >::ParameterImpl ( )
inline

Definition at line 22 of file Parameter.hpp.

◆ ParameterImpl() [2/2]

template<typename T >
astra_ros::ParameterImpl< T >::ParameterImpl ( const T &  value)
inline

Definition at line 27 of file Parameter.hpp.

Member Function Documentation

◆ get()

template<typename T >
const T& astra_ros::ParameterImpl< T >::get ( ) const
inlinenoexcept

Definition at line 53 of file Parameter.hpp.

◆ getOnChangeHandler()

template<typename T >
const boost::optional<OnChange>& astra_ros::ParameterImpl< T >::getOnChangeHandler ( ) const
inline

Definition at line 64 of file Parameter.hpp.

◆ set()

template<typename T >
bool astra_ros::ParameterImpl< T >::set ( const T &  value)
inlinenoexcept

Definition at line 32 of file Parameter.hpp.

◆ setOnChangeHandler()

template<typename T >
void astra_ros::ParameterImpl< T >::setOnChangeHandler ( const boost::optional< OnChange > &  on_change)
inline

Definition at line 59 of file Parameter.hpp.

Member Data Documentation

◆ mutex_

template<typename T >
std::mutex astra_ros::ParameterImpl< T >::mutex_
mutableprivate

Definition at line 70 of file Parameter.hpp.

◆ on_change_

template<typename T >
boost::optional<OnChange> astra_ros::ParameterImpl< T >::on_change_
private

Definition at line 73 of file Parameter.hpp.

◆ value_

template<typename T >
T astra_ros::ParameterImpl< T >::value_
private

Definition at line 72 of file Parameter.hpp.


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


astra_ros
Author(s): Braden McDorman
autogenerated on Wed Mar 2 2022 00:53:06