CLAM::InPort< Token > Class Template Reference

#include <InPort.hxx>

Inheritance diagram for CLAM::InPort< Token >:

List of all members.

---

Detailed Description

template<typename Token>
class CLAM::InPort< Token >

Definition at line 63 of file InPort.hxx.

Public Member Functions
	InPort (const std::string &name="unnamed in port", Processing *proc=0)
virtual	~InPort ()
Token &	GetData (int offset=0)
void	SetSize (int newSize)
int	GetSize ()
int	GetHop ()
void	SetHop (int hop)
void	Consume ()
bool	CanConsume ()
void	AttachRegionToOutPort (OutPortBase *out, ProperWritingRegion &writer)
	This method is intended to be used only for the OutPort.
void	UnAttachRegion ()
	This method is intended to be used only for the OutPort.
virtual const std::type_info &	GetTypeId () const
Protected Attributes
ProperReadingRegion	mRegion

---

Constructor & Destructor Documentation

template<class Token>

CLAM::InPort< Token >::InPort	(	const std::string &	name = "unnamed in port",
		Processing *	proc = 0
	)			[inline]

Definition at line 106 of file InPort.hxx.

template<class Token>

CLAM::InPort< Token >::~InPort

(

)

[inline, virtual]

Definition at line 112 of file InPort.hxx.

References CLAM::InPortBase::Disconnect(), and CLAM::InPortBase::mVisuallyConnectedOutPort.

---

Member Function Documentation

template<class Token>

Token & CLAM::InPort< Token >::GetData

(

int

offset = 0

)

[inline]

Definition at line 120 of file InPort.hxx.

References CLAM::InPort< Token >::mRegion.

Referenced by CLAM::TokenDelay< T >::Do().

template<class Token>

void CLAM::InPort< Token >::SetSize

(

int

newSize

)

[inline, virtual]

Implements CLAM::InPortBase.

Definition at line 126 of file InPort.hxx.

References CLAM::InPort< Token >::mRegion.

Referenced by CLAM::AudioInPort::AudioInPort(), CLAM::TonalAnalysis::ConcreteConfigure(), CLAM::FFT_base::ConcreteConfigure(), CLAM::AudioOut::ConcreteConfigure(), CLAM::AudioSink::SetExternalBuffer(), and CLAM::AudioSink::SetFrameAndHopSize().

template<class Token>

int CLAM::InPort< Token >::GetSize

(

)

[inline, virtual]

Implements CLAM::InPortBase.

Definition at line 132 of file InPort.hxx.

References CLAM::InPort< Token >::mRegion.

Referenced by CLAM::FFT_ooura::Do(), CLAM::FFT_numrec::Do(), and CLAM::FFT_fftw3::Do().

template<class Token>

int CLAM::InPort< Token >::GetHop

(

)

[inline, virtual]

Implements CLAM::InPortBase.

Definition at line 138 of file InPort.hxx.

References CLAM::InPort< Token >::mRegion.

template<class Token>

void CLAM::InPort< Token >::SetHop

(

int

hop

)

[inline, virtual]

Implements CLAM::InPortBase.

Definition at line 144 of file InPort.hxx.

References CLAM::InPort< Token >::mRegion.

Referenced by CLAM::AudioInPort::AudioInPort(), CLAM::TonalAnalysis::ConcreteConfigure(), CLAM::FFT_base::ConcreteConfigure(), CLAM::AudioSink::SetExternalBuffer(), and CLAM::AudioSink::SetFrameAndHopSize().

template<class Token>

void CLAM::InPort< Token >::Consume

(

)

[inline]

Definition at line 150 of file InPort.hxx.

References CLAM::InPort< Token >::mRegion.

Referenced by CLAM::TonalAnalysis::Do(), CLAM::TokenDelay< T >::Do(), CLAM::SpectralAnalysis::Do(), CLAM::OverlapAdd::Do(), CLAM::Oscillator::Do(), CLAM::MonoAudioFileWriter::Do(), CLAM::FFT_ooura::Do(), CLAM::FFT_numrec::Do(), CLAM::FFT_fftw3::Do(), CLAM::CircularShift::Do(), CLAM::BinaryAudioOp< CLAM::Multiply< float > >::Do(), CLAM::AudioWindowing::Do(), CLAM::AudioSink::Do(), CLAM::AudioOut::Do(), and CLAM::AudioAmplifier::Do().

template<class Token>

bool CLAM::InPort< Token >::CanConsume

(

)

[inline, virtual]

Implements CLAM::InPortBase.

Definition at line 156 of file InPort.hxx.

References CLAM::InPort< Token >::mRegion.

template<class Token>

void CLAM::InPort< Token >::AttachRegionToOutPort	(	OutPortBase *	out,
		ProperWritingRegion &	writer
	)			[inline]

This method is intended to be used only for the OutPort.

A user shouldn't call it directly. Instead , use ConnectToIn method in OutPortBase.

Definition at line 162 of file InPort.hxx.

References CLAM::WritingRegion< Token, DataStructure >::LinkRegions(), CLAM::InPort< Token >::mRegion, and CLAM::InPortBase::mVisuallyConnectedOutPort.

Referenced by CLAM::OutPort< Token >::ConnectToConcreteIn().

template<class Token>

void CLAM::InPort< Token >::UnAttachRegion

(

)

[inline, virtual]

This method is intended to be used only for the OutPort.

A user shouldn't call it directly. Instead , use DisconnectFromIn method in OutPortBase.

Implements CLAM::InPortBase.

Definition at line 169 of file InPort.hxx.

References CLAM_DEBUG_ASSERT, CLAM::InPort< Token >::mRegion, and CLAM::InPortBase::mVisuallyConnectedOutPort.

Referenced by CLAM::OutPort< Token >::DisconnectFromConcreteIn().

template<typename Token>

virtual const std::type_info& CLAM::InPort< Token >::GetTypeId

(

)

const [inline, virtual]

Implements CLAM::InPortBase.

Definition at line 93 of file InPort.hxx.

---

Member Data Documentation

template<typename Token>

ProperReadingRegion CLAM::InPort< Token >::mRegion [protected]

Definition at line 96 of file InPort.hxx.

Referenced by CLAM::InPort< Token >::AttachRegionToOutPort(), CLAM::InPort< Token >::CanConsume(), CLAM::InPort< Token >::Consume(), CLAM::AudioInPort::GetAudio(), CLAM::InPort< Token >::GetData(), CLAM::InPort< Token >::GetHop(), CLAM::InPort< Token >::GetSize(), CLAM::InPort< Token >::SetHop(), CLAM::InPort< Token >::SetSize(), and CLAM::InPort< Token >::UnAttachRegion().

---

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

• InPort.hxx