CLAM-Development  1.1
Public Member Functions | Protected Attributes
CLAM::InPort< Token > Class Template Reference

#include <InPort.hxx>

List of all members.

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

Detailed Description

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

Definition at line 63 of file InPort.hxx.


Constructor & Destructor Documentation

template<class Token >
CLAM::InPort< Token >::InPort ( const std::string &  name = "unnamed in port",
Processing proc = 0 
)

Definition at line 106 of file InPort.hxx.

template<class Token >
CLAM::InPort< Token >::~InPort ( ) [virtual]

Definition at line 112 of file InPort.hxx.


Member Function Documentation

template<class Token >
void CLAM::InPort< Token >::AttachRegionToOutPort ( OutPortBase out,
ProperWritingRegion writer 
)

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().

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

template<class Token >
bool CLAM::InPort< Token >::CanConsume ( ) [virtual]

Implements CLAM::InPortBase.

Definition at line 156 of file InPort.hxx.

template<class Token >
void CLAM::InPort< Token >::Consume ( )

Definition at line 150 of file InPort.hxx.

Referenced by CLAM::MIDIFileWriter::Do(), CLAM::AudioSink::Do(), CLAM::MonoAudioFileWriter::Do(), CLAM::TonalAnalysis::Do(), CLAM::FFT_fftw3::Do(), CLAM::LPC_AutoCorrelation::Do(), CLAM::AudioWindowing::Do(), CLAM::SMSPitchDiscretization::Do(), CLAM::SpectralLimiter::Do(), CLAM::FFT_numrec::Do(), CLAM::SpectralReject::Do(), CLAM::RandomPhase::Do(), CLAM::FreqShift::Do(), CLAM::CircularShift::Do(), CLAM::NoSpectralTransformation::Do(), CLAM::SMSFreqShift::Do(), CLAM::SMSOddEvenHarmonicRatio::Do(), CLAM::SpectralAnalysis::Do(), CLAM::CepstralTransform::Do(), CLAM::SynthSineSpectrum::Do(), CLAM::SpectralReverse::Do(), CLAM::FundFreqDetect::Do(), CLAM::EnvelopeModulator::Do(), CLAM::SpectralGate::Do(), CLAM::OverlapAdd::Do(), CLAM::SMSDeesser::Do(), CLAM::SMSResidualGain::Do(), CLAM::SMSTimeStretch::Do(), CLAM::SampleAndHold::Do(), CLAM::SMSSinusoidalGain::Do(), CLAM::SpectralAverage::Do(), CLAM::Robotization::Do(), CLAM::SMSGenderChange::Do(), CLAM::SMSSpectralShapeShift::Do(), CLAM::MelFilterBank::Do(), CLAM::Peakalizer::Do(), CLAM::SpectralCombTriang::Do(), CLAM::Fundamental2Control::Do(), CLAM::SpectralCombDelta::Do(), CLAM::IFFT_fftw3::Do(), CLAM::Partializer::Do(), CLAM::AudioOut::Do(), CLAM::SpectralAmplitudeModulation::Do(), CLAM::SpectralRingModulation::Do(), CLAM::SpectralNotch::Do(), CLAM::SpectralPhaseModulation::Do(), CLAM::SpectralExciter::Do(), CLAM::Fund2MIDI::Do(), CLAM::HumRemover::Do(), CLAM::Deesser::Do(), CLAM::AudioAmplifier::Do(), CLAM::Oscillator::Do(), CLAM::Vocoder::Do(), CLAM::ThreeBandGate::Do(), CLAM::SpectralPeakDetect::Do(), CLAM::SMSMorph::Do(), CLAM::SinTracking::Do(), CLAM::ThreeBandCompressor::Do(), CLAM::SpectralSpread::Do(), CLAM::ThreeBandAM::Do(), CLAM::SpectralShapeShift::Do(), CLAM::SpectralFocus::Do(), CLAM::FFT_ooura::Do(), CLAM::ThreeBandFilter::Do(), CLAM::IFFT_ooura::Do(), CLAM::SMSPitchShift::Do(), CLAM::OscillatingSpectralNotch::Do(), CLAM::SMSHarmonizer::Do(), CLAM::SpectralDelay::Do(), CLAM::BinaryAudioOp< Multiply< TData > >::Do(), CLAM::SinusoidalSynthesis::Do(), CLAM::SMSSynthesis::Do(), CLAM::EnvelopeGenerator::Do(), CLAM::SpectrumProduct::Do(), CLAM::SpectralSynthesis::Do(), CLAM::SpectrumSubstracter2::Do(), CLAM::SpectrumAdder2::Do(), CLAM::SMSSineFilter::Do(), and CLAM::EnvelopeExtractor::Do().

template<class Token >
Token & CLAM::InPort< Token >::GetData ( int  offset = 0)

Definition at line 120 of file InPort.hxx.

Referenced by CLAM::MIDIFileWriter::Do(), CLAM::LPC_AutoCorrelation::Do(), CLAM::SMSPitchDiscretization::Do(), CLAM::SpectralLimiter::Do(), CLAM::FreqShift::Do(), CLAM::NoSpectralTransformation::Do(), CLAM::RandomPhase::Do(), CLAM::SpectralReject::Do(), CLAM::SMSOddEvenHarmonicRatio::Do(), CLAM::SMSFreqShift::Do(), CLAM::CepstralTransform::Do(), CLAM::SynthSineSpectrum::Do(), CLAM::SDIFOut::Do(), CLAM::EnvelopeModulator::Do(), CLAM::SpectralGate::Do(), CLAM::FundFreqDetect::Do(), CLAM::SpectralReverse::Do(), CLAM::SMSResidualGain::Do(), CLAM::SMSTimeStretch::Do(), CLAM::SMSDeesser::Do(), CLAM::SMSSinusoidalGain::Do(), CLAM::SpectralAverage::Do(), CLAM::SampleAndHold::Do(), CLAM::SMSGenderChange::Do(), CLAM::MelFilterBank::Do(), CLAM::SMSSpectralShapeShift::Do(), CLAM::Robotization::Do(), CLAM::SpectralPeakArrayInterpolator::Do(), CLAM::SpectralCombTriang::Do(), CLAM::Peakalizer::Do(), CLAM::SpectralCombDelta::Do(), CLAM::Fundamental2Control::Do(), CLAM::IFFT_fftw3::Do(), CLAM::Partializer::Do(), CLAM::SpectralAmplitudeModulation::Do(), CLAM::SpectralRingModulation::Do(), CLAM::SpectralExciter::Do(), CLAM::SpectralNotch::Do(), CLAM::SpectralPhaseModulation::Do(), CLAM::Fund2MIDI::Do(), CLAM::Deesser::Do(), CLAM::HumRemover::Do(), CLAM::Vocoder::Do(), CLAM::SpectralPeakDetect::Do(), CLAM::ThreeBandGate::Do(), CLAM::SMSMorph::Do(), CLAM::SinTracking::Do(), CLAM::ThreeBandCompressor::Do(), CLAM::SpectralSpread::Do(), CLAM::ThreeBandAM::Do(), CLAM::SpectralShapeShift::Do(), CLAM::SpectralFocus::Do(), CLAM::ThreeBandFilter::Do(), CLAM::IFFT_ooura::Do(), CLAM::SMSPitchShift::Do(), CLAM::SMSHarmonizer::Do(), CLAM::OscillatingSpectralNotch::Do(), CLAM::SpectralDelay::Do(), CLAM::SinusoidalSynthesis::Do(), CLAM::SMSSynthesis::Do(), CLAM::EnvelopeGenerator::Do(), CLAM::SpectrumProduct::Do(), CLAM::SpectralSynthesis::Do(), CLAM::SpectrumSubstracter2::Do(), CLAM::SpectrumAdder2::Do(), CLAM::SMSSineFilter::Do(), and CLAM::EnvelopeExtractor::Do().

template<class Token >
int CLAM::InPort< Token >::GetHop ( ) [virtual]

Implements CLAM::InPortBase.

Definition at line 138 of file InPort.hxx.

template<class Token >
int CLAM::InPort< Token >::GetSize ( ) [virtual]

Implements CLAM::InPortBase.

Definition at line 132 of file InPort.hxx.

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

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.

template<class Token >
void CLAM::InPort< Token >::SetHop ( int  hop) [virtual]
template<class Token >
void CLAM::InPort< Token >::SetSize ( int  newSize) [virtual]
template<class Token >
void CLAM::InPort< Token >::UnAttachRegion ( ) [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.

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


Member Data Documentation

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

Definition at line 96 of file InPort.hxx.


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