ape  0.5.0
Audio Programming Environment
Classes | Public Member Functions | List of all members
ape::SharedValue< T > Class Template Reference

An assignable (from T ) value to be used as arguments for a Label. You should store these separately, and when you assign to them the linked Label will get updated. More...

#include <label.h>

Public Member Functions

 SharedValue (const T value=T())
 
SharedValue< T > & operator= (const T &value)
 Write to the value contained. More...
 
 operator T ()
 Read the value contained. More...
 
detail::ControlBlockBase::Handle createHandle ()
 Create a handle to this value. The value will be kept alive until all the handles go out of scope. More...
 
T * getPtr ()
 Retrieve a pointer to the shared value. Used internally. More...
 
const char * getTypeDesignator ()
 Used internally. More...
 

Detailed Description

template<typename T>
class ape::SharedValue< T >

An assignable (from T ) value to be used as arguments for a Label. You should store these separately, and when you assign to them the linked Label will get updated.

Template Parameters
TA primitive, scalar type (integers, floating point types or pointer).

Constructor & Destructor Documentation

◆ SharedValue()

template<typename T >
ape::SharedValue< T >::SharedValue ( const T  value = T())
inline

Member Function Documentation

◆ createHandle()

template<typename T >
detail::ControlBlockBase::Handle ape::SharedValue< T >::createHandle ( )
inline

Create a handle to this value. The value will be kept alive until all the handles go out of scope.

Returns

◆ getPtr()

template<typename T >
T* ape::SharedValue< T >::getPtr ( )
inline

Retrieve a pointer to the shared value. Used internally.

◆ getTypeDesignator()

template<typename T >
const char* ape::SharedValue< T >::getTypeDesignator ( )
inline

Used internally.

◆ operator T()

template<typename T >
ape::SharedValue< T >::operator T ( )
inline

Read the value contained.

◆ operator=()

template<typename T >
SharedValue<T>& ape::SharedValue< T >::operator= ( const T &  value)
inline

Write to the value contained.


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