VISR  0.12.0
Versatile Interactive Scene Renderer
visr::pml::TimeFrequencyParameterConfig Class Reference

#include <time_frequency_parameter_config.hpp>

Inheritance diagram for visr::pml::TimeFrequencyParameterConfig:
visr::ParameterConfigBase

Public Member Functions

 TimeFrequencyParameterConfig (std::size_t dftSize, std::size_t hopSize, std::size_t numberOfChannels, std::size_t numberOfDftSamples)
 
virtual ~TimeFrequencyParameterConfig ()
 
std::unique_ptr< ParameterConfigBaseclone () const override
 
bool compare (ParameterConfigBase const &rhs) const override
 
bool compare (TimeFrequencyParameterConfig const &rhs) const
 
std::size_t dftSize () const
 
std::size_t hopSize () const
 
std::size_t numberOfChannels () const
 
std::size_t numberOfDftSamples () const
 
- Public Member Functions inherited from visr::ParameterConfigBase
virtual ~ParameterConfigBase ()
 

Additional Inherited Members

- Protected Member Functions inherited from visr::ParameterConfigBase
 ParameterConfigBase ()
 
 ParameterConfigBase (ParameterConfigBase const &)
 

Constructor & Destructor Documentation

◆ TimeFrequencyParameterConfig()

visr::pml::TimeFrequencyParameterConfig::TimeFrequencyParameterConfig ( std::size_t  dftSize,
std::size_t  hopSize,
std::size_t  numberOfChannels,
std::size_t  numberOfDftSamples 
)

◆ ~TimeFrequencyParameterConfig()

visr::pml::TimeFrequencyParameterConfig::~TimeFrequencyParameterConfig ( )
virtual

Member Function Documentation

◆ clone()

std::unique_ptr< ParameterConfigBase > visr::pml::TimeFrequencyParameterConfig::clone ( ) const
overridevirtual

Clone (virtual copy construction) function. Pure virtual function, must be defined in derived types.

Returns
A shared pointer to an object of the derived type.

Implements visr::ParameterConfigBase.

◆ compare() [1/2]

bool visr::pml::TimeFrequencyParameterConfig::compare ( ParameterConfigBase const &  rhs) const
overridevirtual

Comparison function between parameter configurations. Must only be called between objects of equal dynamic type. Pure virtual function interface, must be implemented by derived parameter config types.

Parameters
rhsThe parameter configuration object to compare with.
Returns
True if the parameter objects are compatible, false otherwise
Exceptions
std::invalid_argumentit the this object and rhs have nonmatching dynamic types.

Implements visr::ParameterConfigBase.

◆ compare() [2/2]

bool visr::pml::TimeFrequencyParameterConfig::compare ( TimeFrequencyParameterConfig const &  rhs) const

◆ dftSize()

std::size_t visr::pml::TimeFrequencyParameterConfig::dftSize ( ) const
inline

◆ hopSize()

std::size_t visr::pml::TimeFrequencyParameterConfig::hopSize ( ) const
inline

◆ numberOfChannels()

std::size_t visr::pml::TimeFrequencyParameterConfig::numberOfChannels ( ) const
inline

◆ numberOfDftSamples()

std::size_t visr::pml::TimeFrequencyParameterConfig::numberOfDftSamples ( ) const
inline

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