dx::coreaudio::promoted::property< value_t, coreaudio_value_t, settable > Class Template Reference

coreaudio::promoted::property More...

#include <dx_coreaudio_property.h>

Inheritance diagram for dx::coreaudio::promoted::property< value_t, coreaudio_value_t, settable >:

Collaboration diagram for dx::coreaudio::promoted::property< value_t, coreaudio_value_t, settable >:

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

Public Member Functions
	catch (...)
	catch (...)
	catch (...)
	catch (const dx::exception &__dx_exception)
	catch (const dx::exception &__dx_exception)
	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 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-> ()
bool	operator== (const value_t &value) noexcept
bool	operator== (promoted &promoted) noexcept
	property (const ::AudioObjectID &id, const ::AudioObjectPropertyAddress &address, const decltype(promoted::listen)&listen, const struct coreaudio::property::qualifier &qualifier={})
	property (const ::AudioObjectID &id, const ::AudioObjectPropertyAddress &address, const struct coreaudio::property::qualifier &qualifier={})
	property (const ::AudioObjectID &id, const ::AudioObjectPropertyAddress &address, decltype(promoted::listen)::mapped_type &&listen, const struct coreaudio::property::qualifier &qualifier={})
	property (const ::AudioObjectID &id, const ::AudioObjectPropertyAddress &address, decltype(promoted::server)&&server, const struct coreaudio::property::qualifier &qualifier={})
	~property () noexcept

Public Attributes
bool	initialized {}
std::map< void *, std::function< void(const value_t &)>	listen )
std::function< void(lock_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

Protected Attributes
value_t	value

Detailed Description

template<typename value_t, typename coreaudio_value_t, bool settable>
class dx::coreaudio::promoted::property< value_t, coreaudio_value_t, settable >

coreaudio::promoted::property

see promoted<value_t> in dx_value.h

usage:

dx::promoted<value_t> promoted\_value;
promoted\_value= new value assignment;
// * get current value from coreaudio::property if initial assignment
// * commits new value to coreaudio::property if new assignment is different from current value
// * returns current value - updated from coreaudio::property if value has changed
current value= promoted\_value;
// * get current value from coreaudio::property if initial assignment
// * returns current value

Member Typedef Documentation

lock_t

template<typename value_t >

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

inherited

mutex_t

template<typename value_t >

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

inherited

Constructor & Destructor Documentation

property() [1/4]

template<typename value_t , typename coreaudio_value_t , bool settable>

dx::coreaudio::promoted::property< value_t, coreaudio_value_t, settable >::property ( const ::AudioObjectID & id, const ::AudioObjectPropertyAddress & address, const decltype(promoted::listen)& listen, const struct coreaudio::property< value_t, coreaudio_value_t, settable >::qualifier & qualifier = {} )

inline

property() [2/4]

template<typename value_t , typename coreaudio_value_t , bool settable>

dx::coreaudio::promoted::property< value_t, coreaudio_value_t, settable >::property ( const ::AudioObjectID & id, const ::AudioObjectPropertyAddress & address, decltype(promoted::listen)::mapped_type && listen, const struct coreaudio::property< value_t, coreaudio_value_t, settable >::qualifier & qualifier = {} )

inline

property() [3/4]

template<typename value_t , typename coreaudio_value_t , bool settable>

dx::coreaudio::promoted::property< value_t, coreaudio_value_t, settable >::property ( const ::AudioObjectID & id, const ::AudioObjectPropertyAddress & address, const struct coreaudio::property< value_t, coreaudio_value_t, settable >::qualifier & qualifier = {} )

inline

property() [4/4]

template<typename value_t , typename coreaudio_value_t , bool settable>

dx::coreaudio::promoted::property< value_t, coreaudio_value_t, settable >::property ( const ::AudioObjectID & id, const ::AudioObjectPropertyAddress & address, decltype(promoted::server)&& server, const struct coreaudio::property< value_t, coreaudio_value_t, settable >::qualifier & qualifier = {} )

inline

~property()

template<typename value_t , typename coreaudio_value_t , bool settable>

dx::coreaudio::promoted::property< value_t, coreaudio_value_t, settable >::~property ( )

inlinenoexcept

Member Function Documentation

catch() [1/9]

template<typename value_t >

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

inlineinherited

catch() [2/9]

template<typename value_t >

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

inlineinherited

catch() [3/9]

template<typename value_t >

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

inlineinherited

catch() [4/9]

template<typename value_t >

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

inlineinherited

catch() [5/9]

template<typename value_t >

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

inlineinherited

catch() [6/9]

template<typename value_t >

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

inlineinherited

catch() [7/9]

template<typename value_t >

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

inlineinherited

catch() [8/9]

template<typename value_t >

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

inlineinherited

catch() [9/9]

template<typename value_t >

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

inlineinherited

commit()

template<typename value_t >

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

inlineinherited

Here is the caller graph for this function:

operator const value_t &()

template<typename value_t >

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

inlineinherited

operator++() [1/2]

template<typename value_t >

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

inlinenoexceptinherited

Here is the call graph for this function:

operator++() [2/2]

template<typename value_t >

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

inlinenoexceptinherited

Here is the call graph for this function:

operator+=()

template<typename value_t >

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

inlinenoexceptinherited

Here is the call graph for this function:

operator--() [1/2]

template<typename value_t >

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

inlinenoexceptinherited

Here is the call graph for this function:

operator--() [2/2]

template<typename value_t >

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

inlinenoexceptinherited

Here is the call graph for this function:

operator-=()

template<typename value_t >

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

inlinenoexceptinherited

Here is the call graph for this function:

operator->()

template<typename value_t >

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

inlineinherited

operator==() [1/2]

template<typename value_t >

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

inlinenoexceptinherited

Here is the caller graph for this function:

operator==() [2/2]

template<typename value_t >

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

inlinenoexceptinherited

Here is the call graph for this function:

Member Data Documentation

initialized

template<typename value_t >

bool dx::promoted< value_t >::initialized {}

inherited

listen

template<typename value_t , typename coreaudio_value_t , bool settable>

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

server

template<typename value_t >

std::function<void(lock_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 it needs to handle these case: not initialized and not in transation: initialze and commit the value not initialized and in transation: 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

template<typename value_t >

bool dx::promoted< value_t >::transient {}

inherited

\ indicate the value has been initialized

value

template<typename value_t >

value_t dx::promoted< value_t >::value

protectedinherited

---

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

• dx_coreaudio_property.h