VISR  0.11.7
Versatile Interactive Scene Renderer
visr::rbbl::BiquadCoefficient< CoeffType > Class Template Reference

#include <biquad_coefficient.hpp>

Public Member Functions

 BiquadCoefficient ()
 
 BiquadCoefficient (BiquadCoefficient< CoeffType > const &rhs)=default
 
 BiquadCoefficient (CoeffType b0, CoeffType b1, CoeffType b2, CoeffType a1, CoeffType a2)
 
 BiquadCoefficient (std::initializer_list< CoeffType > const &coeffs)
 
BiquadCoefficientoperator= (BiquadCoefficient const &rhs)
 
CoeffType const * data () const
 
CoeffType * data ()
 
CoeffType const & operator[] (std::size_t idx) const
 
CoeffType & operator[] (std::size_t idx)
 
CoeffType const & at (std::size_t idx) const
 
CoeffType & at (std::size_t idx)
 
CoeffType const & b0 () const
 
CoeffType const & b1 () const
 
CoeffType const & b2 () const
 
CoeffType const & a1 () const
 
CoeffType const & a2 () const
 
CoeffType & b0 ()
 
CoeffType & b1 ()
 
CoeffType & b2 ()
 
CoeffType & a1 ()
 
CoeffType & a2 ()
 
void loadJson (boost::property_tree::ptree const &tree)
 
void loadJson (std::basic_istream< char > &)
 
void loadXml (boost::property_tree::ptree const &tree)
 
void loadXml (std::basic_istream< char > &)
 
void writeJson (boost::property_tree::ptree &tree) const
 
void writeJson (std::basic_ostream< char > &stream) const
 
void writeJson (std::string &str) const
 
void writeXml (boost::property_tree::ptree &tree) const
 
void writeXml (std::basic_ostream< char > &stream) const
 
void writeXml (std::string &str) const
 

Static Public Member Functions

static BiquadCoefficient fromJson (boost::property_tree::ptree const &tree)
 
static BiquadCoefficient fromJson (std::basic_istream< char > &stream)
 
static BiquadCoefficient fromXml (boost::property_tree::ptree const &tree)
 
static BiquadCoefficient fromXml (std::basic_istream< char > &stream)
 

Static Public Attributes

static const std::size_t cNumberOfCoeffs = 5
 

Detailed Description

template<typename CoeffType>
class visr::rbbl::BiquadCoefficient< CoeffType >

A FIFO-type message queue template class for storing and passing message data.

Template Parameters
CoeffTypeType of the contained elements.
Note
This class does provide the same level of thread safety as, e.g., the STL. I.e., calling code from different thread must ensure that concurrent accesses to the same instances are appropriately secured against race conditions.

Constructor & Destructor Documentation

◆ BiquadCoefficient() [1/4]

template<typename CoeffType>
visr::rbbl::BiquadCoefficient< CoeffType >::BiquadCoefficient ( )
inline

Create an default object corresponding to a flat EQ.

◆ BiquadCoefficient() [2/4]

template<typename CoeffType>
visr::rbbl::BiquadCoefficient< CoeffType >::BiquadCoefficient ( BiquadCoefficient< CoeffType > const &  rhs)
default

◆ BiquadCoefficient() [3/4]

template<typename CoeffType>
visr::rbbl::BiquadCoefficient< CoeffType >::BiquadCoefficient ( CoeffType  b0,
CoeffType  b1,
CoeffType  b2,
CoeffType  a1,
CoeffType  a2 
)
inline

◆ BiquadCoefficient() [4/4]

template<typename CoeffType>
visr::rbbl::BiquadCoefficient< CoeffType >::BiquadCoefficient ( std::initializer_list< CoeffType > const &  coeffs)
inline

Member Function Documentation

◆ a1() [1/2]

template<typename CoeffType>
CoeffType const& visr::rbbl::BiquadCoefficient< CoeffType >::a1 ( ) const
inline

◆ a1() [2/2]

template<typename CoeffType>
CoeffType& visr::rbbl::BiquadCoefficient< CoeffType >::a1 ( )
inline

◆ a2() [1/2]

template<typename CoeffType>
CoeffType const& visr::rbbl::BiquadCoefficient< CoeffType >::a2 ( ) const
inline

◆ a2() [2/2]

template<typename CoeffType>
CoeffType& visr::rbbl::BiquadCoefficient< CoeffType >::a2 ( )
inline

◆ at() [1/2]

template<typename CoeffType>
CoeffType const& visr::rbbl::BiquadCoefficient< CoeffType >::at ( std::size_t  idx) const
inline

◆ at() [2/2]

template<typename CoeffType>
CoeffType& visr::rbbl::BiquadCoefficient< CoeffType >::at ( std::size_t  idx)
inline

◆ b0() [1/2]

template<typename CoeffType>
CoeffType const& visr::rbbl::BiquadCoefficient< CoeffType >::b0 ( ) const
inline

◆ b0() [2/2]

template<typename CoeffType>
CoeffType& visr::rbbl::BiquadCoefficient< CoeffType >::b0 ( )
inline

◆ b1() [1/2]

template<typename CoeffType>
CoeffType const& visr::rbbl::BiquadCoefficient< CoeffType >::b1 ( ) const
inline

◆ b1() [2/2]

template<typename CoeffType>
CoeffType& visr::rbbl::BiquadCoefficient< CoeffType >::b1 ( )
inline

◆ b2() [1/2]

template<typename CoeffType>
CoeffType const& visr::rbbl::BiquadCoefficient< CoeffType >::b2 ( ) const
inline

◆ b2() [2/2]

template<typename CoeffType>
CoeffType& visr::rbbl::BiquadCoefficient< CoeffType >::b2 ( )
inline

◆ data() [1/2]

template<typename CoeffType>
CoeffType const* visr::rbbl::BiquadCoefficient< CoeffType >::data ( ) const
inline

◆ data() [2/2]

template<typename CoeffType>
CoeffType* visr::rbbl::BiquadCoefficient< CoeffType >::data ( )
inline

◆ fromJson() [1/2]

template<typename CoeffType >
BiquadCoefficient< CoeffType > visr::rbbl::BiquadCoefficient< CoeffType >::fromJson ( boost::property_tree::ptree const &  tree)
static

Create a BiquadCoefficient objects from JSON and XML representations.

◆ fromJson() [2/2]

template<typename CoeffType >
BiquadCoefficient< CoeffType > visr::rbbl::BiquadCoefficient< CoeffType >::fromJson ( std::basic_istream< char > &  stream)
static

◆ fromXml() [1/2]

template<typename CoeffType >
BiquadCoefficient< CoeffType > visr::rbbl::BiquadCoefficient< CoeffType >::fromXml ( boost::property_tree::ptree const &  tree)
static

◆ fromXml() [2/2]

template<typename CoeffType >
BiquadCoefficient< CoeffType > visr::rbbl::BiquadCoefficient< CoeffType >::fromXml ( std::basic_istream< char > &  stream)
static

◆ loadJson() [1/2]

template<typename CoeffType >
void visr::rbbl::BiquadCoefficient< CoeffType >::loadJson ( boost::property_tree::ptree const &  tree)

◆ loadJson() [2/2]

template<typename CoeffType >
void visr::rbbl::BiquadCoefficient< CoeffType >::loadJson ( std::basic_istream< char > &  stream)

◆ loadXml() [1/2]

template<typename CoeffType >
void visr::rbbl::BiquadCoefficient< CoeffType >::loadXml ( boost::property_tree::ptree const &  tree)

◆ loadXml() [2/2]

template<typename CoeffType >
void visr::rbbl::BiquadCoefficient< CoeffType >::loadXml ( std::basic_istream< char > &  stream)

◆ operator=()

template<typename CoeffType>
BiquadCoefficient& visr::rbbl::BiquadCoefficient< CoeffType >::operator= ( BiquadCoefficient< CoeffType > const &  rhs)
inline

◆ operator[]() [1/2]

template<typename CoeffType>
CoeffType const& visr::rbbl::BiquadCoefficient< CoeffType >::operator[] ( std::size_t  idx) const
inline

◆ operator[]() [2/2]

template<typename CoeffType>
CoeffType& visr::rbbl::BiquadCoefficient< CoeffType >::operator[] ( std::size_t  idx)
inline

◆ writeJson() [1/3]

template<typename CoeffType >
void visr::rbbl::BiquadCoefficient< CoeffType >::writeJson ( boost::property_tree::ptree &  tree) const

◆ writeJson() [2/3]

template<typename CoeffType >
void visr::rbbl::BiquadCoefficient< CoeffType >::writeJson ( std::basic_ostream< char > &  stream) const

◆ writeJson() [3/3]

template<typename CoeffType >
void visr::rbbl::BiquadCoefficient< CoeffType >::writeJson ( std::string &  str) const

◆ writeXml() [1/3]

template<typename CoeffType >
void visr::rbbl::BiquadCoefficient< CoeffType >::writeXml ( boost::property_tree::ptree &  tree) const

◆ writeXml() [2/3]

template<typename CoeffType >
void visr::rbbl::BiquadCoefficient< CoeffType >::writeXml ( std::basic_ostream< char > &  stream) const

◆ writeXml() [3/3]

template<typename CoeffType >
void visr::rbbl::BiquadCoefficient< CoeffType >::writeXml ( std::string &  str) const

Member Data Documentation

◆ cNumberOfCoeffs

template<typename CoeffType>
const std::size_t visr::rbbl::BiquadCoefficient< CoeffType >::cNumberOfCoeffs = 5
static

The number of coefficients to describe one biquad section.


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