dx::promoted< _value_t >::preference< preference_t, preference_value_t > Class Template Reference

#include <dx_value.h>

Inheritance diagram for dx::promoted< _value_t >::preference< preference_t, preference_value_t >:

Collaboration diagram for dx::promoted< _value_t >::preference< preference_t, preference_value_t >:

Public Types
typedef std::unique_lock< mutex_t >	lock_t
typedef std::mutex	mutex_t
typedef value_t	value_t

Public Member Functions
	catch (...)
	catch (...)
	catch (...)
DX_PRAGMA_IGNORE_RETURN_VALUE_BEGIN	catch (const dx::exception &__dx_exception)
DX_PRAGMA_IGNORE_RETURN_VALUE_BEGIN	catch (const dx::exception &__dx_exception)
DX_PRAGMA_IGNORE_RETURN_VALUE_BEGIN	catch (const dx::exception &__dx_exception)
	catch (const std::exception &__std_exception)
	catch (const std::exception &__std_exception)
	catch (const std::exception &__std_exception)
void	commit (lock_t &&lock, const value_t &value) try
	operator bool () const noexcept
DX_PRAGMA_IGNORE_RETURN_VALUE_END	operator const value_t & () try
promoted &	operator++ () noexcept
value_t	operator++ (int) noexcept
promoted &	operator+= (const value_t &value) noexcept
promoted &	operator-- () noexcept
value_t	operator-- (int) noexcept
promoted &	operator-= (const value_t &value) noexcept
const value_t &	operator-> ()
DX_PRAGMA_IGNORE_RETURN_VALUE_END bool	operator== (const value_t &value) noexcept
bool	operator== (promoted &promoted) noexcept
	preference (const preference_t &_preference, decltype(listen)&&listen, decltype(dflt)&&dflt=[]() ->value_t{return {};}, decltype(align)&&align=[](const value_t &value, const value_t &){return value;}, decltype(preference_value)&&preference_value=[](const value_t &value){return static_cast< const preference_value_t & >(value);}, decltype(value)&&value=[](const preference_value_t &preference_value){value_t value;return value=preference_value;})
	preference (const preference_t &_preference, decltype(listen)::mapped_type &&listen, decltype(dflt)&&dflt=[]() ->value_t{return {};}, decltype(align)&&align=[](const value_t &value, const value_t &){return value;}, decltype(preference_value)&&preference_value=[](const value_t &value){return static_cast< const preference_value_t & >(value);}, decltype(value)&&value=[](const preference_value_t &preference_value){value_t value;return value=preference_value;})
	preference (const preference_t &preference, decltype(dflt)&&dflt=[]() ->value_t{return {};}, decltype(align)&&align=[](const value_t &value, const value_t &){return value;}, decltype(preference_value)&&preference_value=[](const value_t &value){return static_cast< const preference_value_t & >(value);}, decltype(value)&&value=[](const preference_value_t &preference_value){value_t value;return value=preference_value;})
	preference (preference_t &&_preference, decltype(listen)&&listen, decltype(dflt)&&dflt=[]() ->value_t{return {};}, decltype(align)&&align=[](const value_t &value, const value_t &){return value;}, decltype(preference_value)&&preference_value=[](const value_t &value){return static_cast< const preference_value_t & >(value);}, decltype(value)&&value=[](const preference_value_t &preference_value){value_t value;return value=preference_value;})
	preference (preference_t &&_preference, decltype(listen)::mapped_type &&listen, decltype(dflt)&&dflt=[]() ->value_t{return {};}, decltype(align)&&align=[](const value_t &value, const value_t &){return value;}, decltype(preference_value)&&preference_value=[](const value_t &value){return static_cast< const preference_value_t & >(value);}, decltype(value)&&value=[](const preference_value_t &preference_value){value_t value;return value=preference_value;})
	preference (preference_t &&preference, decltype(dflt)&&dflt=[]() ->value_t{return {};}, decltype(align)&&align=[](const value_t &value, const value_t &){return value;}, decltype(preference_value)&&preference_value=[](const value_t &value){return static_cast< const preference_value_t & >(value);}, decltype(value)&&value=[](const preference_value_t &preference_value){value_t value;return value=preference_value;})

Public Attributes
std::function< value_t(const value_t &, const value_t &)	align )
	align(value, current_value) to closest valid value; be aware that current might not be valid (check promoted::initiazed!)
preference_t	backing_store
std::function< value_t()>	dflt
	provide default value
bool	initialized
std::map< void *, std::function< void(const value_t &)>	listen )
std::function< preference_value_t(const value_t &)	preference_value )
	convert promoted value type into preference_value type for storing into preference
std::function< void(lock_t &&, const value_t &, const value_t &)	server )
	\ indicate the value is in transition - does not have the new value yet
bool	transient
	\ indicate the value has been initialized
std::function< value_t(const preference_value_t &)	value )
	convert preference_value - as read from preference - to promoted value type

Member Typedef Documentation

lock_t

typedef std::unique_lock<mutex_t> dx::promoted< value_t >::lock_t

inherited

mutex_t

typedef std::mutex dx::promoted< value_t >::mutex_t

inherited

value_t

typedef value_t dx::promoted< value_t >::value_t

inherited

Constructor & Destructor Documentation

preference() [1/6]

template<typename _value_t >

template<typename preference_t , typename preference_value_t >

dx::promoted< _value_t >::preference< preference_t, preference_value_t >::preference ( preference_t && preference, decltype(dflt)&& dflt = []()->value_t{return {};}, decltype(align)&& align = [](const value_t& value, const value_t&){return value;}, decltype(preference_value)&& preference_value = [](const value_t& value){return static_cast<const preference_value_t&>(value);}, decltype(value)&& value = [](const preference_value_t& preference_value){value_t value; return value= preference_value;} )

inline

preference() [2/6]

template<typename _value_t >

template<typename preference_t , typename preference_value_t >

dx::promoted< _value_t >::preference< preference_t, preference_value_t >::preference ( const preference_t & preference, decltype(dflt)&& dflt = []()->value_t{return {};}, decltype(align)&& align = [](const value_t& value, const value_t&){return value;}, decltype(preference_value)&& preference_value = [](const value_t& value){return static_cast<const preference_value_t&>(value);}, decltype(value)&& value = [](const preference_value_t& preference_value){value_t value; return value= preference_value;} )

inline

preference() [3/6]

template<typename _value_t >

template<typename preference_t , typename preference_value_t >

dx::promoted< _value_t >::preference< preference_t, preference_value_t >::preference ( preference_t && _preference, decltype(listen)&& listen, decltype(dflt)&& dflt = []()->value_t{return {};}, decltype(align)&& align = [](const value_t& value, const value_t&){return value;}, decltype(preference_value)&& preference_value = [](const value_t& value){return static_cast<const preference_value_t&>(value);}, decltype(value)&& value = [](const preference_value_t& preference_value){value_t value; return value= preference_value;} )

inline

preference() [4/6]

template<typename _value_t >

template<typename preference_t , typename preference_value_t >

dx::promoted< _value_t >::preference< preference_t, preference_value_t >::preference ( preference_t && _preference, decltype(listen)::mapped_type && listen, decltype(dflt)&& dflt = []()->value_t{return {};}, decltype(align)&& align = [](const value_t& value, const value_t&){return value;}, decltype(preference_value)&& preference_value = [](const value_t& value){return static_cast<const preference_value_t&>(value);}, decltype(value)&& value = [](const preference_value_t& preference_value){value_t value; return value= preference_value;} )

inline

preference() [5/6]

template<typename _value_t >

template<typename preference_t , typename preference_value_t >

dx::promoted< _value_t >::preference< preference_t, preference_value_t >::preference ( const preference_t & _preference, decltype(listen)&& listen, decltype(dflt)&& dflt = []()->value_t{return {};}, decltype(align)&& align = [](const value_t& value, const value_t&){return value;}, decltype(preference_value)&& preference_value = [](const value_t& value){return static_cast<const preference_value_t&>(value);}, decltype(value)&& value = [](const preference_value_t& preference_value){value_t value; return value= preference_value;} )

inline

preference() [6/6]

template<typename _value_t >

template<typename preference_t , typename preference_value_t >

dx::promoted< _value_t >::preference< preference_t, preference_value_t >::preference ( const preference_t & _preference, decltype(listen)::mapped_type && listen, decltype(dflt)&& dflt = []()->value_t{return {};}, decltype(align)&& align = [](const value_t& value, const value_t&){return value;}, decltype(preference_value)&& preference_value = [](const value_t& value){return static_cast<const preference_value_t&>(value);}, decltype(value)&& value = [](const preference_value_t& preference_value){value_t value; return value= preference_value;} )

inline

Member Function Documentation

catch() [1/9]

dx::promoted< value_t >::catch ( ... )

inlineinherited

catch() [2/9]

dx::promoted< value_t >::catch ( ... )

inlineinherited

catch() [3/9]

dx::promoted< value_t >::catch ( ... )

inlineinherited

catch() [4/9]

DX_PRAGMA_IGNORE_RETURN_VALUE_BEGIN dx::promoted< value_t >::catch ( const dx::exception & __dx_exception )

inlineinherited

catch() [5/9]

DX_PRAGMA_IGNORE_RETURN_VALUE_BEGIN dx::promoted< value_t >::catch ( const dx::exception & __dx_exception )

inlineinherited

catch() [6/9]

DX_PRAGMA_IGNORE_RETURN_VALUE_BEGIN dx::promoted< value_t >::catch ( const dx::exception & __dx_exception )

inlineinherited

catch() [7/9]

dx::promoted< value_t >::catch ( const std::exception & __std_exception )

inlineinherited

catch() [8/9]

dx::promoted< value_t >::catch ( const std::exception & __std_exception )

inlineinherited

catch() [9/9]

dx::promoted< value_t >::catch ( const std::exception & __std_exception )

inlineinherited

commit()

void dx::promoted< value_t >::commit ( lock_t && lock, const value_t & value )

inlineinherited

operator bool()

template<typename _value_t >

template<typename preference_t , typename preference_value_t >

dx::promoted< _value_t >::preference< preference_t, preference_value_t >::operator bool ( ) const

inlinenoexcept

operator const value_t &()

DX_PRAGMA_IGNORE_RETURN_VALUE_END dx::promoted< value_t >::operator const value_t & ( )

inlineinherited

operator++() [1/2]

promoted & dx::promoted< value_t >::operator++ ( )

inlinenoexceptinherited

operator++() [2/2]

value_t dx::promoted< value_t >::operator++ ( int )

inlinenoexceptinherited

operator+=()

promoted & dx::promoted< value_t >::operator+= ( const value_t & value )

inlinenoexceptinherited

operator--() [1/2]

promoted & dx::promoted< value_t >::operator-- ( )

inlinenoexceptinherited

operator--() [2/2]

value_t dx::promoted< value_t >::operator-- ( int )

inlinenoexceptinherited

operator-=()

promoted & dx::promoted< value_t >::operator-= ( const value_t & value )

inlinenoexceptinherited

operator->()

const value_t & dx::promoted< value_t >::operator-> ( )

inlineinherited

operator==() [1/2]

DX_PRAGMA_IGNORE_RETURN_VALUE_END bool dx::promoted< value_t >::operator== ( const value_t & value )

inlinenoexceptinherited

operator==() [2/2]

bool dx::promoted< value_t >::operator== ( promoted< value_t > & promoted )

inlinenoexceptinherited

Member Data Documentation

align

template<typename _value_t >

template<typename preference_t , typename preference_value_t >

std::function<value_t(const value_t&, const value_t&) dx::promoted< _value_t >::preference< preference_t, preference_value_t >::align)

align(value, current_value) to closest valid value; be aware that current might not be valid (check promoted::initiazed!)

backing_store

template<typename _value_t >

template<typename preference_t , typename preference_value_t >

preference_t dx::promoted< _value_t >::preference< preference_t, preference_value_t >::backing_store

dflt

template<typename _value_t >

template<typename preference_t , typename preference_value_t >

std::function<value_t()> dx::promoted< _value_t >::preference< preference_t, preference_value_t >::dflt

provide default value

initialized

bool dx::promoted< value_t >::initialized

inherited

listen

std::map<void*, std::function<void(const value_t&)> dx::promoted< value_t >::listen)

inherited

preference_value

template<typename _value_t >

template<typename preference_t , typename preference_value_t >

std::function<preference_value_t(const value_t&) dx::promoted< _value_t >::preference< preference_t, preference_value_t >::preference_value)

convert promoted value type into preference_value type for storing into preference

server

std::function<void(lock_t&&, const value_t&, const value_t&) dx::promoted< value_t >::server)

inherited

\ indicate the value is in transition - does not have the new value yet

server: handle synchronous and asynchronous value updates and initialization lock: lock promoted value from access during update value: new value (if in transition) current: current value to allow discarding update and reverting to current value if update is not permitted

it needs to handle these case: not initialized and not in transition: initialze and commit the value not initialized and in transition: if dependent on external settings initialize a temporary and compare it with the new value and update the external setting if required make sure to commit the new value so listeners get notified either synchronously or asynchronously by external notification initialized and in transition: update external settings if any and make sure to commit the new value so listeners get notified either synchronously or asynchronousl by external notification

server will not be called with this state: initialized and not in transation

transient

bool dx::promoted< value_t >::transient

inherited

\ indicate the value has been initialized

value

template<typename _value_t >

template<typename preference_t , typename preference_value_t >

std::function<value_t(const preference_value_t&) dx::promoted< _value_t >::preference< preference_t, preference_value_t >::value)

convert preference_value - as read from preference - to promoted value type

---

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

• dx_value.h