Boost  v1.57.0
doxygen for www.boost.org
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
boost::attributes::constant< T > Class Template Reference

A class of an attribute that holds a single constant value. More...

#include <constant.hpp>

Inheritance diagram for boost::attributes::constant< T >:
Collaboration diagram for boost::attributes::constant< T >:

Classes

class  impl
 Factory implementation. More...
 

Public Types

typedef T value_type
 Attribute value type. More...
 

Public Member Functions

 constant (value_type const &value)
 Constructor with the stored value initialization. More...
 
 constant (BOOST_RV_REF(value_type) value)
 Constructor with the stored value initialization. More...
 
 constant (cast_source const &source)
 Constructor for casting support. More...
 
value_type const & get () const
 
bool operator! () const BOOST_NOEXCEPT
 Verifies that the factory is not in empty state. More...
 
attribute_value get_value () const
 
void swap (attribute &that) BOOST_NOEXCEPT
 The method swaps two factories (i.e. More...
 

Protected Member Functions

implget_impl () const BOOST_NOEXCEPT
 
void set_impl (intrusive_ptr< impl > p) BOOST_NOEXCEPT
 Sets the pointer to the factory implementation. More...
 

Detailed Description

template<typename T>
class boost::attributes::constant< T >

A class of an attribute that holds a single constant value.

The constant is a simplest and one of the most frequently used types of attributes. It stores a constant value, which it eventually returns as its value each time requested.

Member Typedef Documentation

template<typename T>
typedef T boost::attributes::constant< T >::value_type

Attribute value type.

Constructor & Destructor Documentation

template<typename T>
boost::attributes::constant< T >::constant ( value_type const &  value)
inlineexplicit

Constructor with the stored value initialization.

template<typename T>
boost::attributes::constant< T >::constant ( BOOST_RV_REF(value_type value)
inlineexplicit

Constructor with the stored value initialization.

template<typename T>
boost::attributes::constant< T >::constant ( cast_source const &  source)
inlineexplicit

Constructor for casting support.

Member Function Documentation

template<typename T>
value_type const& boost::attributes::constant< T >::get ( ) const
inline
Returns
Reference to the contained value.
attribute_value boost::attribute::get_value ( ) const
inherited
Returns
The actual attribute value. It shall not return empty values (exceptions shall be used to indicate errors).
bool boost::attribute::operator! ( ) const
inlineinherited

Verifies that the factory is not in empty state.

Verifies that the factory is in empty state

void boost::attribute::set_impl ( intrusive_ptr< impl p)
inlineprotectedinherited

Sets the pointer to the factory implementation.

Parameters
pPointer to the implementation. Must not be NULL.

References boost::multiprecision::backends::p, and boost::intrusive_ptr< T >::swap().

Referenced by boost::attributes::counter< T >::counter().

void boost::attribute::swap ( attribute that)
inlineinherited

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