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

#include <biquad_coefficient.hpp>

Public Types

using Container = typename std::vector< BiquadCoefficient< CoeffType > >
 
using iterator = typename Container::iterator
 
using const_iterator = typename Container::const_iterator
 

Public Member Functions

 BiquadCoefficientList ()=default
 
 BiquadCoefficientList (const std::size_t initialSize)
 
 BiquadCoefficientList (BiquadCoefficientList const &rhs)=default
 
 BiquadCoefficientList (std::initializer_list< BiquadCoefficient< CoeffType > > const &initList)
 
BiquadCoefficientListoperator= (BiquadCoefficientList const &rhs)
 
std::size_t size () const
 
void resize (std::size_t newSize)
 
BiquadCoefficient< CoeffType > const & operator[] (std::size_t idx) const
 
BiquadCoefficient< CoeffType > & operator[] (std::size_t idx)
 
BiquadCoefficient< CoeffType > const & at (std::size_t idx) const
 
BiquadCoefficient< CoeffType > & at (std::size_t idx)
 
iterator begin ()
 
iterator end ()
 
const_iterator begin () const
 
const_iterator end () const
 
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 BiquadCoefficientList fromJson (boost::property_tree::ptree const &tree)
 
static BiquadCoefficientList fromJson (std::basic_istream< char > &stream)
 
static BiquadCoefficientList fromJson (std::string const &str)
 
static BiquadCoefficientList fromXml (boost::property_tree::ptree const &tree)
 
static BiquadCoefficientList fromXml (std::basic_istream< char > &stream)
 
static BiquadCoefficientList fromXml (std::string const &str)
 

Member Typedef Documentation

◆ const_iterator

template<class CoeffType>
using visr::rbbl::BiquadCoefficientList< CoeffType >::const_iterator = typename Container::const_iterator

◆ Container

template<class CoeffType>
using visr::rbbl::BiquadCoefficientList< CoeffType >::Container = typename std::vector< BiquadCoefficient< CoeffType > >

◆ iterator

template<class CoeffType>
using visr::rbbl::BiquadCoefficientList< CoeffType >::iterator = typename Container::iterator

Constructor & Destructor Documentation

◆ BiquadCoefficientList() [1/4]

template<class CoeffType>
visr::rbbl::BiquadCoefficientList< CoeffType >::BiquadCoefficientList ( )
default

Default constructor, creates an empty list of biquad parameters.

◆ BiquadCoefficientList() [2/4]

template<class CoeffType>
visr::rbbl::BiquadCoefficientList< CoeffType >::BiquadCoefficientList ( const std::size_t  initialSize)
inlineexplicit

◆ BiquadCoefficientList() [3/4]

template<class CoeffType>
visr::rbbl::BiquadCoefficientList< CoeffType >::BiquadCoefficientList ( BiquadCoefficientList< CoeffType > const &  rhs)
default

Default copy constructor (required for use within aSTL data structure as, for instance, in BiquadCoefficientList.

◆ BiquadCoefficientList() [4/4]

template<class CoeffType>
visr::rbbl::BiquadCoefficientList< CoeffType >::BiquadCoefficientList ( std::initializer_list< BiquadCoefficient< CoeffType > > const &  initList)
inline

Member Function Documentation

◆ at() [1/2]

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

◆ at() [2/2]

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

◆ begin() [1/2]

template<class CoeffType>
iterator visr::rbbl::BiquadCoefficientList< CoeffType >::begin ( )
inline

◆ begin() [2/2]

template<class CoeffType>
const_iterator visr::rbbl::BiquadCoefficientList< CoeffType >::begin ( ) const
inline

◆ end() [1/2]

template<class CoeffType>
iterator visr::rbbl::BiquadCoefficientList< CoeffType >::end ( )
inline

◆ end() [2/2]

template<class CoeffType>
const_iterator visr::rbbl::BiquadCoefficientList< CoeffType >::end ( ) const
inline

◆ fromJson() [1/3]

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

◆ fromJson() [2/3]

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

◆ fromJson() [3/3]

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

◆ fromXml() [1/3]

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

◆ fromXml() [2/3]

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

◆ fromXml() [3/3]

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

◆ loadJson() [1/3]

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

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

◆ loadJson() [2/3]

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

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

◆ loadJson() [3/3]

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

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

◆ loadXml() [1/3]

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

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

◆ loadXml() [2/3]

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

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

◆ loadXml() [3/3]

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

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

◆ operator=()

template<class CoeffType>
BiquadCoefficientList& visr::rbbl::BiquadCoefficientList< CoeffType >::operator= ( BiquadCoefficientList< CoeffType > const &  rhs)
inline

Assign the content from another BiquadCoefficientList with consistent size.

Exceptions
std::invalid_argumentIf rhs has a different size.

◆ operator[]() [1/2]

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

◆ operator[]() [2/2]

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

◆ resize()

template<class CoeffType>
void visr::rbbl::BiquadCoefficientList< CoeffType >::resize ( std::size_t  newSize)
inline

◆ size()

template<class CoeffType>
std::size_t visr::rbbl::BiquadCoefficientList< CoeffType >::size ( ) const
inline

◆ writeJson() [1/3]

template<typename CoeffType >
void visr::rbbl::BiquadCoefficientList< 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.

◆ writeJson() [2/3]

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

Write an XML representation to an output stream.

◆ writeJson() [3/3]

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

Write an XML representation into a string.

◆ writeXml() [1/3]

template<typename CoeffType >
void visr::rbbl::BiquadCoefficientList< 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.

◆ writeXml() [2/3]

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

Write an XML representation to an output stream.

◆ writeXml() [3/3]

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

Write an XML representation into a string.


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