CLAM::SpecTypeFlags Struct Reference

This class tells which formats are instantiated in a Spectrum. More...

#include <SpecTypeFlags.hxx>

List of all members.

Public Types
enum	tFlags { eComplex = 0, ePolar = 1, eMagPhase = 2, eMagPhaseBPF = 3 }
Public Member Functions
virtual Component *	Species () const
	Returns a new object of the same class than the receiver object.
	SpecTypeFlags ()
	SpecTypeFlags (const SpecTypeFlags &t)
Public Attributes
reference	bComplex
reference	bPolar
reference	bMagPhase
reference	bMagPhaseBPF
Static Public Attributes
static tFlagValue	sFlagValues []
static tValue	sDefault

---

Detailed Description

This class tells which formats are instantiated in a Spectrum.

It could be:

• Complex: Array of Complex objects
• Polar: Array of Polar objects
• MagPhase: Array of magnitude/phase pairs
• MagPhaseBPF: BPF of magnitude/phase pairs

It can be used as any other class derived from Flags: you can use the std::bit interface and Flags added functionalities.

See also:

Flags

Definition at line 42 of file SpecTypeFlags.hxx.

---

Member Enumeration Documentation

enum CLAM::SpecTypeFlags::tFlags

Enumerator:

eComplex
ePolar
eMagPhase
eMagPhaseBPF

Definition at line 50 of file SpecTypeFlags.hxx.

---

Constructor & Destructor Documentation

CLAM::SpecTypeFlags::SpecTypeFlags

(

)

[inline]

Definition at line 57 of file SpecTypeFlags.hxx.

References bComplex, bMagPhase, bMagPhaseBPF, and bPolar.

Referenced by Species().

CLAM::SpecTypeFlags::SpecTypeFlags

(

const SpecTypeFlags &

t

)

[inline]

Definition at line 71 of file SpecTypeFlags.hxx.

---

Member Function Documentation

virtual Component* CLAM::SpecTypeFlags::Species

(

)

const [inline, virtual]

Returns a new object of the same class than the receiver object.

To be reimplemented by subclasses.

Returns:

a new allocated component. The pointer belongs to the caller.

Implements CLAM::Flags< 4 >.

Definition at line 47 of file SpecTypeFlags.hxx.

References SpecTypeFlags().

---

Member Data Documentation

reference CLAM::SpecTypeFlags::bComplex

Definition at line 77 of file SpecTypeFlags.hxx.

Referenced by CLAM::SynthSineSpectrum::Do(), CLAM::SDIFOut::Do(), CLAM::Spectrum::GetConfig(), CLAM::Spectrum::GetMag(), CLAM::Spectrum::GetPhase(), CLAM::Spectrum::GetType(), CLAM::SDIFFileReader::ReadFrame(), CLAM::Spectrum::SetMag(), CLAM::Spectrum::SetPhase(), CLAM::SpectrumInterpolator::SetPrototypes(), CLAM::SpectrumAdder2::SetPrototypes(), CLAM::IFFT_ooura::SetPrototypes(), CLAM::Spectrum::SetTypeSynchronize(), SpecTypeFlags(), CLAM::Spectrum::SynchronizeTo(), CLAM::Spectrum::ToDB(), and CLAM::Spectrum::ToLinear().

reference CLAM::SpecTypeFlags::bMagPhase

Definition at line 91 of file SpecTypeFlags.hxx.

Referenced by CLAM::SynthSineSpectrum::Do(), CLAM::Spectrum::GetConfig(), CLAM::Spectrum::GetMag(), CLAM::Spectrum::GetPhase(), CLAM::Spectrum::GetType(), CLAM::SDIFFileReader::ReadFrame(), CLAM::Spectrum::SetMag(), CLAM::Spectrum::SetPhase(), CLAM::SpectrumInterpolator::SetPrototypes(), CLAM::SpectrumAdder2::SetPrototypes(), CLAM::IFFT_ooura::SetPrototypes(), CLAM::Spectrum::SetTypeSynchronize(), CLAM::SpectralFocus::SpectralFocus(), CLAM::SpectralSpread::SpectralSpread(), SpecTypeFlags(), CLAM::Spectrum::SynchronizeTo(), CLAM::Spectrum::ToDB(), CLAM::Spectrum::ToLinear(), and CLAM::IFFT_fftw3::UnsetPrototypes().

reference CLAM::SpecTypeFlags::bMagPhaseBPF

Definition at line 92 of file SpecTypeFlags.hxx.

Referenced by CLAM::SynthSineSpectrum::Do(), CLAM::Spectrum::GetConfig(), CLAM::Spectrum::GetMag(), CLAM::Spectrum::GetPhase(), CLAM::Spectrum::GetType(), CLAM::Spectrum::SetMag(), CLAM::Spectrum::SetPhase(), CLAM::SpectrumInterpolator::SetPrototypes(), CLAM::SpectrumAdder2::SetPrototypes(), CLAM::IFFT_ooura::SetPrototypes(), CLAM::Spectrum::SetTypeSynchronize(), CLAM::SpectralFocus::SpectralFocus(), CLAM::SpectralSpread::SpectralSpread(), SpecTypeFlags(), CLAM::Spectrum::SynchronizeTo(), CLAM::Spectrum::ToDB(), CLAM::Spectrum::ToLinear(), and CLAM::IFFT_fftw3::UnsetPrototypes().

reference CLAM::SpecTypeFlags::bPolar

Definition at line 90 of file SpecTypeFlags.hxx.

Referenced by CLAM::SynthSineSpectrum::Do(), CLAM::Spectrum::GetConfig(), CLAM::Spectrum::GetMag(), CLAM::Spectrum::GetPhase(), CLAM::Spectrum::GetType(), CLAM::Spectrum::SetMag(), CLAM::Spectrum::SetPhase(), CLAM::SpectrumInterpolator::SetPrototypes(), CLAM::SpectrumAdder2::SetPrototypes(), CLAM::IFFT_ooura::SetPrototypes(), CLAM::Spectrum::SetTypeSynchronize(), SpecTypeFlags(), CLAM::Spectrum::SynchronizeTo(), CLAM::Spectrum::ToDB(), CLAM::Spectrum::ToLinear(), and CLAM::IFFT_fftw3::UnsetPrototypes().

tValue CLAM::SpecTypeFlags::sDefault [static]

Definition at line 46 of file SpecTypeFlags.hxx.

Flags< 4 >::tFlagValue SpecTypeFlags::sFlagValues [static]

Initial value:

 {
        {SpecTypeFlags::eComplex, "Complex"},
        {SpecTypeFlags::ePolar, "Polar"},
        {SpecTypeFlags::eMagPhase, "MagPhase"},
        {SpecTypeFlags::eMagPhaseBPF, "MagPhaseBPF"},
        {0,NULL}
}

Definition at line 45 of file SpecTypeFlags.hxx.

---

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

• SpecTypeFlags.hxx
• Spectrum.cxx