CLAM::Region Class Reference

#include <Region.hxx>

Inheritance diagram for CLAM::Region:

List of all members.

---

Detailed Description

Definition at line 30 of file Region.hxx.

Public Types
typedef std::list< Region * >	ReadingRegionsList
typedef ReadingRegionsList::iterator	ReadingRegionsIterator
Public Member Functions
	Region ()
virtual	~Region ()
const long &	Pos () const
const int &	Size () const
const int &	Hop () const
const int &	BeginDistance ()
void	Pos (const long &pos)
void	Size (const int &size)
void	Hop (const int &hop)
void	BeginDistance (const int &dist)
virtual void	RemoveProducer ()
virtual Region *	ProducerRegion ()=0
virtual ReadingRegionsIterator	BeginReaders ()=0
virtual ReadingRegionsIterator	EndReaders ()=0
virtual void	RemoveRegion (Region &Region)
Protected Member Functions
virtual void	SizeChanged (const int &newSize)=0

---

Member Typedef Documentation

typedef std::list<Region*> CLAM::Region::ReadingRegionsList

Definition at line 33 of file Region.hxx.

typedef ReadingRegionsList::iterator CLAM::Region::ReadingRegionsIterator

Definition at line 34 of file Region.hxx.

---

Constructor & Destructor Documentation

CLAM::Region::Region

(

)

Definition at line 28 of file Region.cxx.

CLAM::Region::~Region

(

)

[virtual]

Definition at line 33 of file Region.cxx.

---

Member Function Documentation

const long & CLAM::Region::Pos

(

)

const

Definition at line 37 of file Region.cxx.

Referenced by CLAM::ReadingRegion< WritingRegion >::CanConsume(), CLAM::WritingRegion< Token, DataStructure >::CanProduce(), CLAM::WritingRegion< Token, DataStructure >::CenterEvenRegions(), CLAM::ReadingRegion< WritingRegion >::Consume(), CLAM::WritingRegion< Token, DataStructure >::FulfilsInvariant(), CLAM::ReadingRegion< WritingRegion >::LinkProducerRegion(), CLAM::WritingRegion< Token, DataStructure >::Produce(), and CLAM::WritingRegion< Token, DataStructure >::RearmostReadingPos().

const int & CLAM::Region::Size

(

)

const

Definition at line 42 of file Region.cxx.

Referenced by CLAM::ReadingRegion< WritingRegion >::CanConsume(), CLAM::WritingRegion< Token, DataStructure >::CanProduce(), CLAM::WritingRegion< Token, DataStructure >::CenterEvenRegions(), CLAM::WritingRegion< Token, DataStructure >::ClearData(), CLAM::WritingRegion< Token, DataStructure >::FulfilsInvariant(), CLAM::AudioOutPort::GetAudio(), CLAM::AudioOutPort::GetLastWrittenAudio(), CLAM::OutPort< Token >::GetSize(), CLAM::CLAM::StreamImpl< Token, PhantomBuffer >::NewWritingRegionSize(), CLAM::StreamImpl< Token, DataStructure >::NewWritingRegionSize(), CLAM::WritingRegion< Token, DataStructure >::operator[](), CLAM::ReadingRegion< WritingRegion >::operator[](), CLAM::OutPort< Token >::SetSize(), CLAM::CLAM::StreamImpl< Token, PhantomBuffer >::WriterHasAdvanced(), and CLAM::WritingRegion< Token, DataStructure >::WritingRegion().

const int & CLAM::Region::Hop

(

)

const

Definition at line 47 of file Region.cxx.

Referenced by CLAM::WritingRegion< Token, DataStructure >::CenterEvenRegions(), CLAM::ReadingRegion< WritingRegion >::Consume(), CLAM::OutPort< Token >::GetHop(), CLAM::WritingRegion< Token, DataStructure >::Produce(), CLAM::OutPort< Token >::SetHop(), and CLAM::StreamImpl< Token, DataStructure >::WriterHasAdvanced().

const int & CLAM::Region::BeginDistance

(

)

Definition at line 52 of file Region.cxx.

Referenced by CLAM::WritingRegion< Token, DataStructure >::CenterEvenRegions(), CLAM::ReadingRegion< WritingRegion >::LinkProducerRegion(), CLAM::WritingRegion< Token, DataStructure >::operator[](), CLAM::ReadingRegion< WritingRegion >::operator[](), and CLAM::CLAM::StreamImpl< Token, PhantomBuffer >::WriterHasAdvanced().

void CLAM::Region::Pos

(

const long &

pos

)

Definition at line 62 of file Region.cxx.

void CLAM::Region::Size

(

const int &

size

)

Definition at line 67 of file Region.cxx.

References SizeChanged().

void CLAM::Region::Hop

(

const int &

hop

)

Definition at line 73 of file Region.cxx.

References CLAM_ASSERT.

void CLAM::Region::BeginDistance

(

const int &

dist

)

Definition at line 57 of file Region.cxx.

virtual void CLAM::Region::RemoveProducer

(

)

[inline, virtual]

Reimplemented in CLAM::ReadingRegion< WritingRegion >, CLAM::ReadingRegion< CLAM::WritingRegion< CLAM::MIDISong, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< T, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< Token, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< CLAM::DiscontinuousSegmentation, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< CLAM::LPModel, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< CLAM::Fundamental, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< CLAM::Frame, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< CLAM::MIDIMelody, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< CLAM::Segment, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< CLAM::MelSpectrum, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< CLAM::Envelope, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< CLAM::MelCepstrum, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< CLAM::Spectrum, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< std::vector< float >, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< std::vector< std::pair< CLAM::float, CLAM::float > >, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< CLAM::SpectralPeakArray, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< Token, DataStructure > >, CLAM::ReadingRegion< CLAM::WritingRegion< float, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< CLAM::Audio, CLAM::PhantomBuffer< T > > >, and CLAM::ReadingRegion< CLAM::WritingRegion< std::pair< CLAM::float, CLAM::float >, CLAM::PhantomBuffer< T > > >.

Definition at line 49 of file Region.hxx.

Referenced by CLAM::WritingRegion< Token, DataStructure >::RemoveRegion().

virtual Region* CLAM::Region::ProducerRegion

(

)

[pure virtual]

Implemented in CLAM::ReadingRegion< WritingRegion >, CLAM::WritingRegion< Token, DataStructure >, CLAM::ReadingRegion< CLAM::WritingRegion< CLAM::MIDISong, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< T, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< Token, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< CLAM::DiscontinuousSegmentation, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< CLAM::LPModel, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< CLAM::Fundamental, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< CLAM::Frame, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< CLAM::MIDIMelody, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< CLAM::Segment, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< CLAM::MelSpectrum, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< CLAM::Envelope, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< CLAM::MelCepstrum, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< CLAM::Spectrum, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< std::vector< float >, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< std::vector< std::pair< CLAM::float, CLAM::float > >, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< CLAM::SpectralPeakArray, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< Token, DataStructure > >, CLAM::ReadingRegion< CLAM::WritingRegion< float, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< CLAM::Audio, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< std::pair< CLAM::float, CLAM::float >, CLAM::PhantomBuffer< T > > >, CLAM::WritingRegion< Token >, CLAM::WritingRegion< CLAM::Segment >, CLAM::WritingRegion< std::pair< CLAM::float, CLAM::float > >, CLAM::WritingRegion< CLAM::Spectrum >, CLAM::WritingRegion< std::vector< float > >, CLAM::WritingRegion< float >, CLAM::WritingRegion< T >, CLAM::WritingRegion< CLAM::Envelope >, CLAM::WritingRegion< CLAM::MelCepstrum >, CLAM::WritingRegion< CLAM::MIDIMelody >, CLAM::WritingRegion< CLAM::DiscontinuousSegmentation >, CLAM::WritingRegion< CLAM::LPModel >, CLAM::WritingRegion< CLAM::Frame >, CLAM::WritingRegion< CLAM::MIDISong >, CLAM::WritingRegion< CLAM::MelSpectrum >, CLAM::WritingRegion< CLAM::Audio >, CLAM::WritingRegion< CLAM::SpectralPeakArray >, CLAM::WritingRegion< CLAM::Fundamental >, and CLAM::WritingRegion< std::vector< std::pair< CLAM::float, CLAM::float > > >.

Referenced by CLAM::CLAM::StreamImpl< Token, PhantomBuffer >::NewReadingRegionSize(), CLAM::CLAM::StreamImpl< Token, PhantomBuffer >::NewWritingRegionSize(), and CLAM::WritingRegion< Token, DataStructure >::RemoveRegion().

virtual ReadingRegionsIterator CLAM::Region::BeginReaders

(

)

[pure virtual]

Implemented in CLAM::ReadingRegion< WritingRegion >, CLAM::WritingRegion< Token, DataStructure >, CLAM::ReadingRegion< CLAM::WritingRegion< CLAM::MIDISong, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< T, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< Token, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< CLAM::DiscontinuousSegmentation, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< CLAM::LPModel, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< CLAM::Fundamental, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< CLAM::Frame, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< CLAM::MIDIMelody, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< CLAM::Segment, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< CLAM::MelSpectrum, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< CLAM::Envelope, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< CLAM::MelCepstrum, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< CLAM::Spectrum, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< std::vector< float >, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< std::vector< std::pair< CLAM::float, CLAM::float > >, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< CLAM::SpectralPeakArray, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< Token, DataStructure > >, CLAM::ReadingRegion< CLAM::WritingRegion< float, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< CLAM::Audio, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< std::pair< CLAM::float, CLAM::float >, CLAM::PhantomBuffer< T > > >, CLAM::WritingRegion< Token >, CLAM::WritingRegion< CLAM::Segment >, CLAM::WritingRegion< std::pair< CLAM::float, CLAM::float > >, CLAM::WritingRegion< CLAM::Spectrum >, CLAM::WritingRegion< std::vector< float > >, CLAM::WritingRegion< float >, CLAM::WritingRegion< T >, CLAM::WritingRegion< CLAM::Envelope >, CLAM::WritingRegion< CLAM::MelCepstrum >, CLAM::WritingRegion< CLAM::MIDIMelody >, CLAM::WritingRegion< CLAM::DiscontinuousSegmentation >, CLAM::WritingRegion< CLAM::LPModel >, CLAM::WritingRegion< CLAM::Frame >, CLAM::WritingRegion< CLAM::MIDISong >, CLAM::WritingRegion< CLAM::MelSpectrum >, CLAM::WritingRegion< CLAM::Audio >, CLAM::WritingRegion< CLAM::SpectralPeakArray >, CLAM::WritingRegion< CLAM::Fundamental >, and CLAM::WritingRegion< std::vector< std::pair< CLAM::float, CLAM::float > > >.

virtual ReadingRegionsIterator CLAM::Region::EndReaders

(

)

[pure virtual]

Implemented in CLAM::ReadingRegion< WritingRegion >, CLAM::WritingRegion< Token, DataStructure >, CLAM::ReadingRegion< CLAM::WritingRegion< CLAM::MIDISong, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< T, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< Token, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< CLAM::DiscontinuousSegmentation, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< CLAM::LPModel, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< CLAM::Fundamental, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< CLAM::Frame, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< CLAM::MIDIMelody, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< CLAM::Segment, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< CLAM::MelSpectrum, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< CLAM::Envelope, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< CLAM::MelCepstrum, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< CLAM::Spectrum, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< std::vector< float >, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< std::vector< std::pair< CLAM::float, CLAM::float > >, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< CLAM::SpectralPeakArray, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< Token, DataStructure > >, CLAM::ReadingRegion< CLAM::WritingRegion< float, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< CLAM::Audio, CLAM::PhantomBuffer< T > > >, CLAM::ReadingRegion< CLAM::WritingRegion< std::pair< CLAM::float, CLAM::float >, CLAM::PhantomBuffer< T > > >, CLAM::WritingRegion< Token >, CLAM::WritingRegion< CLAM::Segment >, CLAM::WritingRegion< std::pair< CLAM::float, CLAM::float > >, CLAM::WritingRegion< CLAM::Spectrum >, CLAM::WritingRegion< std::vector< float > >, CLAM::WritingRegion< float >, CLAM::WritingRegion< T >, CLAM::WritingRegion< CLAM::Envelope >, CLAM::WritingRegion< CLAM::MelCepstrum >, CLAM::WritingRegion< CLAM::MIDIMelody >, CLAM::WritingRegion< CLAM::DiscontinuousSegmentation >, CLAM::WritingRegion< CLAM::LPModel >, CLAM::WritingRegion< CLAM::Frame >, CLAM::WritingRegion< CLAM::MIDISong >, CLAM::WritingRegion< CLAM::MelSpectrum >, CLAM::WritingRegion< CLAM::Audio >, CLAM::WritingRegion< CLAM::SpectralPeakArray >, CLAM::WritingRegion< CLAM::Fundamental >, and CLAM::WritingRegion< std::vector< std::pair< CLAM::float, CLAM::float > > >.

virtual void CLAM::Region::RemoveRegion

(

Region &

Region

)

[inline, virtual]

Reimplemented in CLAM::WritingRegion< Token, DataStructure >, CLAM::WritingRegion< Token >, CLAM::WritingRegion< CLAM::Segment >, CLAM::WritingRegion< std::pair< CLAM::float, CLAM::float > >, CLAM::WritingRegion< CLAM::Spectrum >, CLAM::WritingRegion< std::vector< float > >, CLAM::WritingRegion< float >, CLAM::WritingRegion< T >, CLAM::WritingRegion< CLAM::Envelope >, CLAM::WritingRegion< CLAM::MelCepstrum >, CLAM::WritingRegion< CLAM::MIDIMelody >, CLAM::WritingRegion< CLAM::DiscontinuousSegmentation >, CLAM::WritingRegion< CLAM::LPModel >, CLAM::WritingRegion< CLAM::Frame >, CLAM::WritingRegion< CLAM::MIDISong >, CLAM::WritingRegion< CLAM::MelSpectrum >, CLAM::WritingRegion< CLAM::Audio >, CLAM::WritingRegion< CLAM::SpectralPeakArray >, CLAM::WritingRegion< CLAM::Fundamental >, and CLAM::WritingRegion< std::vector< std::pair< CLAM::float, CLAM::float > > >.

Definition at line 53 of file Region.hxx.

Referenced by CLAM::ReadingRegion< WritingRegion >::~ReadingRegion().

virtual void CLAM::Region::SizeChanged

(

const int &

newSize

)

[protected, pure virtual]

Referenced by Size().

---

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

• Region.hxx
• Region.cxx