wavelet::Attribute< T > Class Template Reference

Generic Attribute. More...

#include <attribute.hpp>

Public Member Functions
	Attribute (AttributeHandler *parent=nullptr, T const &value=T(), T const &limit_min=default_limit_min(), T const &limit_max=default_limit_max())
	Default Constructor. More...
	Attribute (Attribute const &src)
	Copy Constructor. More...
template<typename U >
Attribute &	operator= (Attribute< U > const &src)
	Assignment operator. More...
virtual	~Attribute ()
	Destructor.
void	set (T const &value, bool silently=false)
	Set the attribute value. More...
T	get () const
	get the attribute's current value More...
T	getCopy () const
	get a copy of the attribute's current value More...
void	set_limit_min (T const &limit_min=default_limit_min())
	set the attribute's minimum value More...
void	set_limit_max (T const &limit_max=default_limit_max())
	set the attribute's maximum value More...
void	set_limits (T const &limit_min=default_limit_min(), T const &limit_max=default_limit_max())
	set the attribute's limit values More...
void	set_parent (AttributeHandler *parent)
	set the parent to receive change notifications More...
AttributeHandler *	get_parent () const
	get the parent to receive change notifications More...

Detailed Description

template<typename T>
class wavelet::Attribute< T >

Generic Attribute.

Template Parameters

T	attribute type

Constructor & Destructor Documentation

template<typename T>

wavelet::Attribute< T >::Attribute ( AttributeHandler *  parent = nullptr, T const &  value = T(), T const &  limit_min = default_limit_min(), T const &  limit_max = default_limit_max()  )

inline

Default Constructor.

Parameters

parent	parent attribute handler (notified at attribute changes)
value	attribute value
limit_min	minimum limit
limit_max	maximum limit

template<typename T>

wavelet::Attribute< T >::Attribute ( Attribute< T > const &  src )

inline

Copy Constructor.

Parameters

src	source attribute

Warning

Also copies the attribute's parent object

Member Function Documentation

template<typename T>

T wavelet::Attribute< T >::get ( ) const

inline

get the attribute's current value

Returns

the attribute's current value

template<typename T>

AttributeHandler* wavelet::Attribute< T >::get_parent ( ) const

inline

get the parent to receive change notifications

Returns

parent object

template<typename T>

T wavelet::Attribute< T >::getCopy ( ) const

inline

get a copy of the attribute's current value

Returns

a copy of the attribute's current value

template<typename T>

template<typename U >

Attribute& wavelet::Attribute< T >::operator= ( Attribute< U > const &  src )

inline

Assignment operator.

Parameters

src	source attribute

Returns

copy of the source Attribute object

Warning

Also copies the attribute's parent object

template<typename T>

void wavelet::Attribute< T >::set ( T const &  value, bool  silently = false  )

inline

Set the attribute value.

Parameters

value	requested value
silently	if true, don't notify the parent object

Exceptions

domain_error	exception if the value exceeds the limits
runtime_error	exception if the limit checking are not implemented for the current type

template<typename T>

void wavelet::Attribute< T >::set_limit_max ( T const &  limit_max = default_limit_max() )

inline

set the attribute's maximum value

Parameters

limit_max

maximum value

template<typename T>

void wavelet::Attribute< T >::set_limit_min ( T const &  limit_min = default_limit_min() )

inline

set the attribute's minimum value

Parameters

limit_min

minimum value

template<typename T>

void wavelet::Attribute< T >::set_limits ( T const &  limit_min = default_limit_min(), T const &  limit_max = default_limit_max()  )

inline

set the attribute's limit values

Parameters

limit_min	minimum value
limit_max	maximum value

template<typename T>

void wavelet::Attribute< T >::set_parent ( AttributeHandler *  parent )

inline

set the parent to receive change notifications

Parameters

parent

parent object

---

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

• attribute.hpp