VISR  0.11.6
Versatile Interactive Scene Renderer
visr::rbbl::ParametricIirCoefficient< CoefficientType > Class Template Reference

#include <parametric_iir_coefficient.hpp>

Inheritance diagram for visr::rbbl::ParametricIirCoefficient< CoefficientType >:
visr::rbbl::ParametricIirCoefficientBase

Public Member Functions

 ParametricIirCoefficient ()
 
 ParametricIirCoefficient (ParametricIirCoefficient const &rhs)
 
 ParametricIirCoefficient (ParametricIirCoefficient &&rhs)
 
 ParametricIirCoefficient (Type typeId, CoefficientType centerFrequency, CoefficientType quality, CoefficientType gain=static_cast< CoefficientType >(0.0))
 
Type type () const
 
CoefficientType frequency () const
 
CoefficientType quality () const
 
CoefficientType gain () const
 
void setType (Type newType)
 
void setFrequency (CoefficientType newFrequency)
 
void setQuality (CoefficientType newQuality)
 
void setGain (CoefficientType newGain)
 
ParametricIirCoefficientoperator= (ParametricIirCoefficient const &rhs)=default
 
void loadJson (boost::property_tree::ptree const &tree)
 
void loadJson (std::basic_istream< char > &stream)
 
void loadJson (std::string const &str)
 
void loadXml (boost::property_tree::ptree const &tree)
 
void loadXml (std::basic_istream< char > &stream)
 
void loadXml (std::string const &str)
 
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 ParametricIirCoefficient fromJson (boost::property_tree::ptree const &tree)
 
static ParametricIirCoefficient fromJson (std::basic_istream< char > &stream)
 
static ParametricIirCoefficient fromJson (std::string const &str)
 
static ParametricIirCoefficient fromXml (boost::property_tree::ptree const &tree)
 
static ParametricIirCoefficient fromXml (std::basic_istream< char > &stream)
 
static ParametricIirCoefficient fromXml (std::string const &str)
 
- Static Public Member Functions inherited from visr::rbbl::ParametricIirCoefficientBase
static Type stringToTypeId (std::string const &name)
 
static std::string const & typeIdToString (Type typeId)
 

Additional Inherited Members

- Public Types inherited from visr::rbbl::ParametricIirCoefficientBase
enum  Type {
  Type::lowpass, Type::highpass, Type::bandpass, Type::bandstop,
  Type::highshelf, Type::lowshelf, Type::peak, Type::allpass
}
 

Constructor & Destructor Documentation

◆ ParametricIirCoefficient() [1/4]

template<typename CoefficientType >
visr::rbbl::ParametricIirCoefficient< CoefficientType >::ParametricIirCoefficient ( )

Create an default object corresponding to a flat EQ.

◆ ParametricIirCoefficient() [2/4]

template<typename CoefficientType >
visr::rbbl::ParametricIirCoefficient< CoefficientType >::ParametricIirCoefficient ( ParametricIirCoefficient< CoefficientType > const &  rhs)
default

◆ ParametricIirCoefficient() [3/4]

template<typename CoefficientType >
visr::rbbl::ParametricIirCoefficient< CoefficientType >::ParametricIirCoefficient ( ParametricIirCoefficient< CoefficientType > &&  rhs)
default

◆ ParametricIirCoefficient() [4/4]

template<typename CoefficientType >
visr::rbbl::ParametricIirCoefficient< CoefficientType >::ParametricIirCoefficient ( Type  typeId,
CoefficientType  centerFrequency,
CoefficientType  quality,
CoefficientType  gain = static_cast<CoefficientType>(0.0) 
)
explicit

Member Function Documentation

◆ frequency()

template<typename CoefficientType = float>
CoefficientType visr::rbbl::ParametricIirCoefficient< CoefficientType >::frequency ( ) const
inline

◆ fromJson() [1/3]

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

Create a ParametricIirCoefficient objects from JSON and XML representations.

◆ fromJson() [2/3]

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

◆ fromJson() [3/3]

template<typename CoefficientType >
ParametricIirCoefficient< CoefficientType > visr::rbbl::ParametricIirCoefficient< CoefficientType >::fromJson ( std::string const &  str)
static

◆ fromXml() [1/3]

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

◆ fromXml() [2/3]

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

◆ fromXml() [3/3]

template<typename CoefficientType >
ParametricIirCoefficient< CoefficientType > visr::rbbl::ParametricIirCoefficient< CoefficientType >::fromXml ( std::string const &  str)
static

◆ gain()

template<typename CoefficientType = float>
CoefficientType visr::rbbl::ParametricIirCoefficient< CoefficientType >::gain ( ) const
inline

◆ loadJson() [1/3]

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

◆ loadJson() [2/3]

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

◆ loadJson() [3/3]

template<typename CoefficientType >
void visr::rbbl::ParametricIirCoefficient< CoefficientType >::loadJson ( std::string const &  str)

◆ loadXml() [1/3]

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

◆ loadXml() [2/3]

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

◆ loadXml() [3/3]

template<typename CoefficientType >
void visr::rbbl::ParametricIirCoefficient< CoefficientType >::loadXml ( std::string const &  str)

◆ operator=()

template<typename CoefficientType = float>
ParametricIirCoefficient& visr::rbbl::ParametricIirCoefficient< CoefficientType >::operator= ( ParametricIirCoefficient< CoefficientType > const &  rhs)
default

◆ quality()

template<typename CoefficientType = float>
CoefficientType visr::rbbl::ParametricIirCoefficient< CoefficientType >::quality ( ) const
inline

◆ setFrequency()

template<typename CoefficientType >
void visr::rbbl::ParametricIirCoefficient< CoefficientType >::setFrequency ( CoefficientType  newFrequency)

◆ setGain()

template<typename CoefficientType >
void visr::rbbl::ParametricIirCoefficient< CoefficientType >::setGain ( CoefficientType  newGain)

◆ setQuality()

template<typename CoefficientType >
void visr::rbbl::ParametricIirCoefficient< CoefficientType >::setQuality ( CoefficientType  newQuality)

◆ setType()

template<typename CoefficientType >
void visr::rbbl::ParametricIirCoefficient< CoefficientType >::setType ( Type  newType)

◆ type()

template<typename CoefficientType = float>
Type visr::rbbl::ParametricIirCoefficient< CoefficientType >::type ( ) const
inline

◆ writeJson() [1/3]

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

◆ writeJson() [2/3]

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

◆ writeJson() [3/3]

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

◆ writeXml() [1/3]

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

◆ writeXml() [2/3]

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

◆ writeXml() [3/3]

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

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