VISR  0.11.8
Versatile Interactive Scene Renderer
visr::rbbl::BiquadCoefficientMatrix< CoeffType > Class Template Reference

#include <LoudspeakerArray.h>

Inheritance diagram for visr::rbbl::BiquadCoefficientMatrix< CoeffType >:
visr::pml::BiquadParameterMatrix< CoeffType >

Public Member Functions

 BiquadCoefficientMatrix (std::size_t numberOfFilters, std::size_t numberOfBiquads)
 
 ~BiquadCoefficientMatrix ()
 
std::size_t numberOfFilters () const
 
std::size_t numberOfSections () const
 
void resize (std::size_t numberOfFilters, std::size_t numberOfBiquads)
 
BiquadCoefficientList< CoeffType > const & operator[] (std::size_t rowIdx) const
 
BiquadCoefficientList< CoeffType > & operator[] (std::size_t rowIdx)
 
BiquadCoefficient< CoeffType > const & operator() (std::size_t rowIdx, std::size_t colIdx) const
 
BiquadCoefficient< CoeffType > & operator() (std::size_t rowIdx, std::size_t colIdx)
 
void setFilter (std::size_t filterIdx, BiquadCoefficientList< CoeffType > const &newFilter)
 
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 BiquadCoefficientMatrix fromJson (boost::property_tree::ptree const &tree)
 
static BiquadCoefficientMatrix fromJson (std::basic_istream< char > &stream)
 
static BiquadCoefficientMatrix fromJson (std::string const &str)
 
static BiquadCoefficientMatrix fromXml (boost::property_tree::ptree const &tree)
 
static BiquadCoefficientMatrix fromXml (std::basic_istream< char > &stream)
 
static BiquadCoefficientMatrix fromXml (std::string const &str)
 

Constructor & Destructor Documentation

template<typename CoeffType >
visr::rbbl::BiquadCoefficientMatrix< CoeffType >::BiquadCoefficientMatrix ( std::size_t  numberOfFilters,
std::size_t  numberOfBiquads 
)
explicit
template<typename CoeffType >
visr::rbbl::BiquadCoefficientMatrix< CoeffType >::~BiquadCoefficientMatrix ( )

Member Function Documentation

template<typename CoeffType >
BiquadCoefficientMatrix< CoeffType > visr::rbbl::BiquadCoefficientMatrix< CoeffType >::fromJson ( boost::property_tree::ptree const &  tree)
static
template<typename CoeffType >
BiquadCoefficientMatrix< CoeffType > visr::rbbl::BiquadCoefficientMatrix< CoeffType >::fromJson ( std::basic_istream< char > &  stream)
static
template<typename CoeffType >
BiquadCoefficientMatrix< CoeffType > visr::rbbl::BiquadCoefficientMatrix< CoeffType >::fromJson ( std::string const &  str)
static
template<typename CoeffType >
BiquadCoefficientMatrix< CoeffType > visr::rbbl::BiquadCoefficientMatrix< CoeffType >::fromXml ( boost::property_tree::ptree const &  tree)
static
template<typename CoeffType >
BiquadCoefficientMatrix< CoeffType > visr::rbbl::BiquadCoefficientMatrix< CoeffType >::fromXml ( std::basic_istream< char > &  stream)
static
template<typename CoeffType >
BiquadCoefficientMatrix< CoeffType > visr::rbbl::BiquadCoefficientMatrix< CoeffType >::fromXml ( std::string const &  str)
static
template<typename CoeffType >
void visr::rbbl::BiquadCoefficientMatrix< CoeffType >::loadJson ( boost::property_tree::ptree const &  tree)

Deserialisation from text formats. Initialise from a JSON representation, provided as a Boost property tree ptree object.

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

Initialise from a JSON representation, provided as an input stream containing JSON text data.

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

Initialise from a JSON representation, provided as a string containing JSON text data.

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

Initialise from an XML representation, provided as a Boost property tree ptree object.

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

Initialise from an XML representation, provided as an input stream containing JSON text data.

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

Initialise from an XML representation, provided as a string containing JSON text data.

template<typename CoeffType>
std::size_t visr::rbbl::BiquadCoefficientMatrix< CoeffType >::numberOfFilters ( ) const
inline
template<typename CoeffType>
std::size_t visr::rbbl::BiquadCoefficientMatrix< CoeffType >::numberOfSections ( ) const
inline
template<typename CoeffType>
BiquadCoefficient<CoeffType> const& visr::rbbl::BiquadCoefficientMatrix< CoeffType >::operator() ( std::size_t  rowIdx,
std::size_t  colIdx 
) const
inline
template<typename CoeffType>
BiquadCoefficient<CoeffType>& visr::rbbl::BiquadCoefficientMatrix< CoeffType >::operator() ( std::size_t  rowIdx,
std::size_t  colIdx 
)
inline
template<typename CoeffType>
BiquadCoefficientList<CoeffType> const& visr::rbbl::BiquadCoefficientMatrix< CoeffType >::operator[] ( std::size_t  rowIdx) const
inline
template<typename CoeffType>
BiquadCoefficientList<CoeffType>& visr::rbbl::BiquadCoefficientMatrix< CoeffType >::operator[] ( std::size_t  rowIdx)
inline
template<typename CoeffType >
void visr::rbbl::BiquadCoefficientMatrix< CoeffType >::resize ( std::size_t  numberOfFilters,
std::size_t  numberOfBiquads 
)
template<typename CoeffType >
void visr::rbbl::BiquadCoefficientMatrix< CoeffType >::setFilter ( std::size_t  filterIdx,
BiquadCoefficientList< CoeffType > const &  newFilter 
)

Set the biquad sections for a complete filter specification (a row in the matrix) If newFilter has fewer sections than the matrix, the rest is filled with default values.

Exceptions
std::out_of_rangeIf filterIdx exceeds the number of biquad sections.
std::invalid_argumentIf nnewFilters has more elements than the column number of the matrix.
template<typename CoeffType >
void visr::rbbl::BiquadCoefficientMatrix< CoeffType >::writeJson ( boost::property_tree::ptree &  tree) const

Serialisation into textual formats. Write to a boost property tree object (ptree) that can be serialised to an XML document (or part thereof)

Note
the ptree representations for XML and JSON differ slightly, so different implementations are needed.
template<typename CoeffType >
void visr::rbbl::BiquadCoefficientMatrix< CoeffType >::writeJson ( std::basic_ostream< char > &  stream) const

Write an XML representation to an output stream.

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

Write an XML representation into a string.

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

Write to a boost property tree object (ptree) that can be serialised to an XML document (or part thereof)

Note
the ptree representations for XML and JSON differ slightly, so different implementations are needed.
template<typename CoeffType >
void visr::rbbl::BiquadCoefficientMatrix< CoeffType >::writeXml ( std::basic_ostream< char > &  stream) const

Write an XML representation to an output stream.

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

Write an XML representation into a string.


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