Plaquette
 
Loading...
Searching...
No Matches
pq::Value< T, Codec > Class Template Reference
Inheritance diagram for pq::Value< T, Codec >:
Collaboration diagram for pq::Value< T, Codec >:

Public Types

using value_type = T
 

Public Member Functions

 Value (T initial)
 
float put (float x) override
 Pushes value into the unit.
 
float get () override
 Returns value (typically between 0 and 1, may vary depending on class).
 
value () const
 
void value (T v)
 
 operator T () const
 
Valueoperator= (T v)
 
Valueoperator++ ()
 
Valueoperator-- ()
 
operator++ (int)
 
operator-- (int)
 
operator- () const
 
Valueoperator+= (T rhs)
 
Valueoperator-= (T rhs)
 
Valueoperator*= (T rhs)
 
Valueoperator/= (T rhs)
 
Valueoperator+= (const Value &rhs)
 
Valueoperator-= (const Value &rhs)
 
Valueoperator*= (const Value &rhs)
 
Valueoperator/= (const Value &rhs)
 
template<typename U = T>
enable_if_t< supports_modulo< U >::value, Value & > operator%= (U rhs)
 
template<typename U = T>
enable_if_t< supports_modulo< U >::value, Value & > operator%= (const Value &rhs)
 
 operator float ()
 Object can be used directly to access its value.
 
virtual float mapTo (float toLow, float toHigh)
 Maps value to new range.
 
 operator bool ()
 Operator that allows usage in conditional expressions.
 

Static Public Member Functions

static bool analogToDigital (float f)
 Converts analog (float) value to digital (bool) value.
 
static float digitalToAnalog (bool b)
 Converts digital (bool) value to analog (float) value.
 

Protected Attributes

_v
 

Friends

bool operator== (const Value &a, const Value &b)
 
bool operator!= (const Value &a, const Value &b)
 
bool operator< (const Value &a, const Value &b)
 
bool operator<= (const Value &a, const Value &b)
 
bool operator> (const Value &a, const Value &b)
 
bool operator>= (const Value &a, const Value &b)
 
bool operator== (const Value &a, T b)
 
bool operator== (T a, const Value &b)
 
bool operator!= (const Value &a, T b)
 
bool operator!= (T a, const Value &b)
 
bool operator< (const Value &a, T b)
 
bool operator< (T a, const Value &b)
 
bool operator<= (const Value &a, T b)
 
bool operator<= (T a, const Value &b)
 
bool operator> (const Value &a, T b)
 
bool operator> (T a, const Value &b)
 
bool operator>= (const Value &a, T b)
 
bool operator>= (T a, const Value &b)
 
operator+ (const Value &a, const Value &b)
 
operator- (const Value &a, const Value &b)
 
operator* (const Value &a, const Value &b)
 
operator/ (const Value &a, const Value &b)
 
operator+ (const Value &a, T b)
 
operator+ (T a, const Value &b)
 
operator- (const Value &a, T b)
 
operator- (T a, const Value &b)
 
operator* (const Value &a, T b)
 
operator* (T a, const Value &b)
 
operator/ (const Value &a, T b)
 
operator/ (T a, const Value &b)
 
template<typename U = T>
enable_if_t< supports_modulo< U >::value, U > operator% (const Value &a, const Value &b)
 
template<typename U = T>
enable_if_t< supports_modulo< U >::value, U > operator% (const Value &a, U b)
 
template<typename U = T>
enable_if_t< supports_modulo< U >::value, U > operator% (U a, const Value &b)
 

Member Function Documentation

◆ get()

template<typename T , class Codec = ValueCodec<T>>
float pq::Value< T, Codec >::get ( )
inlineoverridevirtual

Returns value (typically between 0 and 1, may vary depending on class).

Reimplemented from pq::Flowable.

◆ mapTo()

virtual float pq::Flowable::mapTo ( float  toLow,
float  toHigh 
)
inlinevirtualinherited

Maps value to new range.

This function guarantees that the value is within [toLow, toHigh]. If the unit's values are unbounded, returns get() constrained to [toLow, toHigh].

Reimplemented in pq::Normalizer, pq::DigitalUnit, pq::AnalogSource, pq::AnalogIn, pq::Ramp, pq::StreamIn, and pq::StreamOut.

◆ put()

template<typename T , class Codec = ValueCodec<T>>
float pq::Value< T, Codec >::put ( float  value)
inlineoverridevirtual

Pushes value into the unit.

Parameters
valuethe value sent to the unit
Returns
the new value of the unit

Reimplemented from pq::Flowable.


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