CLAM::OutPort< Token > Class Template Reference

#include <OutPort.hxx>

List of all members.

Public Member Functions

 OutPort (const std::string &name="unnamed out port", Processing *proc=0)
virtual ~OutPort ()
void DisconnectFromAll ()
void ConnectToIn (InPortBase &in)
void ConnectToConcreteIn (InPort< Token > &in)
void DisconnectFromIn (InPortBase &in)
void DisconnectFromConcreteIn (InPort< Token > &in)
bool IsConnectableTo (InPortBase &in)
bool IsVisuallyConnectedTo (InPortBase &in)
bool IsPhysicallyConnectedToIn (InPort< Token > &)
InPortPublisher< Token > * GetPublisherContaining (InPort< Token > &)
Token & GetData (int offset=0)
void SetSize (int newSize)
int GetSize ()
int GetHop ()
void SetHop (int hop)
void Produce ()
bool CanProduce ()
void CenterEvenRegions ()
void UnpublishOutPort ()
virtual const std::type_info & GetTypeId () const
Token & GetLastWrittenData (int offset=0)

Protected Member Functions

bool ConnectToPublisher (ProperInPortPublisher &in)
bool TryDisconnectFromPublisher (InPortBase &in)
bool TryDisconnectFromConcreteIn (InPortBase &in)

Protected Attributes

ProperWritingRegion mRegion

Detailed Description

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

Definition at line 74 of file OutPort.hxx.

Constructor & Destructor Documentation

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

Definition at line 121 of file OutPort.hxx.

template<class Token >
CLAM::OutPort< Token >::~OutPort (  )  [inline, virtual]

Definition at line 138 of file OutPort.hxx.

References CLAM::OutPort< Token >::DisconnectFromAll().

Member Function Documentation

template<class Token >
bool CLAM::OutPort< Token >::CanProduce (  )  [inline, virtual]

Implements CLAM::OutPortBase.

Definition at line 279 of file OutPort.hxx.

References CLAM::WritingRegion< Token, DataStructure >::CanProduce(), and CLAM::OutPort< Token >::mRegion.

Referenced by CLAM::OutPortPublisher< Spectrum >::CanProduce().

template<class Token >
void CLAM::OutPort< Token >::CenterEvenRegions (  )  [inline, virtual]

Implements CLAM::OutPortBase.

Definition at line 323 of file OutPort.hxx.

References CLAM::WritingRegion< Token, DataStructure >::CenterEvenRegions(), and CLAM::OutPort< Token >::mRegion.

Referenced by CLAM::OutPortPublisher< Spectrum >::CenterEvenRegions().

template<class Token>
void CLAM::OutPort< Token >::ConnectToConcreteIn ( InPort< Token > &  in  )  [inline]

Definition at line 173 of file OutPort.hxx.

References CLAM::InPort< Token >::AttachRegionToOutPort(), CLAM_ASSERT, CLAM::InPortBase::GetVisuallyConnectedOutPort(), CLAM::OutPort< Token >::IsVisuallyConnectedTo(), CLAM::OutPort< Token >::mRegion, and CLAM::OutPortBase::mVisuallyConnectedPorts.

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

template<class Token >
void CLAM::OutPort< Token >::ConnectToIn ( InPortBase &  in  )  [inline, virtual]

Implements CLAM::OutPortBase.

Definition at line 161 of file OutPort.hxx.

References CLAM_ASSERT, CLAM::OutPort< Token >::ConnectToConcreteIn(), CLAM::OutPort< Token >::ConnectToPublisher(), CLAM::OutPort< Token >::IsConnectableTo(), and CLAM::InPortBase::IsPublisher().

Referenced by CLAM::OutPortPublisher< Spectrum >::ConnectToIn().

template<typename Token>
bool CLAM::OutPort< Token >::ConnectToPublisher ( ProperInPortPublisher &  in  )  [protected]

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

template<class Token >
void CLAM::OutPort< Token >::DisconnectFromAll (  )  [inline, virtual]

Implements CLAM::OutPortBase.

Definition at line 127 of file OutPort.hxx.

References CLAM::OutPortBase::BeginVisuallyConnectedInPorts(), CLAM::OutPortBase::EndVisuallyConnectedInPorts(), and CLAM::OutPortBase::mVisuallyConnectedPorts.

Referenced by CLAM::OutPortPublisher< Spectrum >::DisconnectFromAll(), CLAM::OutPort< Token >::~OutPort(), and CLAM::OutPortPublisher< Spectrum >::~OutPortPublisher().

template<class Token>
void CLAM::OutPort< Token >::DisconnectFromConcreteIn ( InPort< Token > &  in  )  [inline]

Definition at line 224 of file OutPort.hxx.

References CLAM_ASSERT, CLAM_DEBUG_ASSERT, CLAM::OutPort< Token >::GetPublisherContaining(), CLAM::OutPort< Token >::IsPhysicallyConnectedToIn(), CLAM::OutPort< Token >::IsVisuallyConnectedTo(), CLAM::OutPortBase::mVisuallyConnectedPorts, CLAM::InPort< Token >::UnAttachRegion(), and CLAM::InPortPublisher< Token >::UnPublishInPort().

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

template<class Token >
void CLAM::OutPort< Token >::DisconnectFromIn ( InPortBase &  in  )  [inline, virtual]

Implements CLAM::OutPortBase.

Definition at line 184 of file OutPort.hxx.

References CLAM_ASSERT, CLAM::OutPort< Token >::IsConnectableTo(), CLAM::InPortBase::IsPublisher(), CLAM::OutPort< Token >::TryDisconnectFromConcreteIn(), and CLAM::OutPort< Token >::TryDisconnectFromPublisher().

Referenced by CLAM::OutPortPublisher< Spectrum >::DisconnectFromIn().

template<class Token >
Token & CLAM::OutPort< Token >::GetData ( int  offset = 0  )  [inline]

Definition at line 243 of file OutPort.hxx.

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

Referenced by CLAM::WaveGenerator::Do(), CLAM::Vocoder::Do(), CLAM::TokenDelay< T >::Do(), CLAM::SynthSineSpectrum::Do(), CLAM::SpectrumAdder2::Do(), CLAM::SpectralSpread::Do(), CLAM::SpectralShapeShift::Do(), CLAM::SpectralRingModulation::Do(), CLAM::SpectralReverse::Do(), CLAM::SpectralReject::Do(), CLAM::SpectralPhaseModulation::Do(), CLAM::SpectralPeakDetect::Do(), CLAM::SpectralPeakArrayInterpolator::Do(), CLAM::SpectralNotch::Do(), CLAM::SpectralLimiter::Do(), CLAM::SpectralGate::Do(), CLAM::SpectralFocus::Do(), CLAM::SpectralExciter::Do(), CLAM::SpectralDelay::Do(), CLAM::SpectralCombTriang::Do(), CLAM::SpectralCombDelta::Do(), CLAM::SpectralAverage::Do(), CLAM::SpectralAnalysis::Do(), CLAM::SpectralAmplitudeModulation::Do(), CLAM::SMSTranspose::Do(), CLAM::SMSTimeStretch::Do(), CLAM::SMSSpectralShapeShift::Do(), CLAM::SMSSinusoidalGain::Do(), CLAM::SMSSineFilter::Do(), CLAM::SMSResidualGain::Do(), CLAM::SMSPitchShift::Do(), CLAM::SMSPitchDiscretization::Do(), CLAM::SMSOddEvenHarmonicRatio::Do(), CLAM::SMSMorph::Do(), CLAM::SMSHarmonizer::Do(), CLAM::SMSGenderChange::Do(), CLAM::SMSFreqShift::Do(), CLAM::SMSDeesser::Do(), CLAM::SinTracking::Do(), CLAM::SDIFIn::Do(), CLAM::SampleAndHold::Do(), CLAM::Robotization::Do(), CLAM::RandomPhase::Do(), CLAM::Peakalizer::Do(), CLAM::Partializer::Do(), CLAM::OscillatingSpectralNotch::Do(), CLAM::NoSpectralTransformation::Do(), CLAM::HumRemover::Do(), CLAM::FundFreqDetect::Do(), CLAM::FreqShift::Do(), CLAM::FFT_ooura::Do(), CLAM::FFT_fftw3::Do(), CLAM::EnvelopeGenerator::Do(), CLAM::Deesser::Do(), CLAM::ThreeBandAM::Do(), CLAM::ThreeBandGate::Do(), CLAM::ThreeBandFilter::Do(), CLAM::ThreeBandCompressor::Do(), CLAM::MIDI2Melody::GenerateOutputData(), and CLAM::OutPortPublisher< Spectrum >::GetData().

template<class Token >
int CLAM::OutPort< Token >::GetHop (  )  [inline, virtual]

Implements CLAM::OutPortBase.

Definition at line 261 of file OutPort.hxx.

References CLAM::Region::Hop(), and CLAM::OutPort< Token >::mRegion.

Referenced by CLAM::OutPortPublisher< Spectrum >::GetHop().

template<class Token >
Token & CLAM::OutPort< Token >::GetLastWrittenData ( int  offset = 0  )  [inline]

Definition at line 329 of file OutPort.hxx.

References CLAM_DEBUG_ASSERT, CLAM::WritingRegion< Token, DataStructure >::GetLastWrittenData(), CLAM::OutPort< Token >::GetSize(), and CLAM::OutPort< Token >::mRegion.

Referenced by CLAM::OutPortPublisher< Spectrum >::GetLastWrittenData().

template<class Token>
InPortPublisher< Token > * CLAM::OutPort< Token >::GetPublisherContaining ( InPort< Token > &  in  )  [inline]

Definition at line 301 of file OutPort.hxx.

References CLAM::OutPortBase::mVisuallyConnectedPorts.

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

template<class Token >
int CLAM::OutPort< Token >::GetSize (  )  [inline, virtual]

Implements CLAM::OutPortBase.

Definition at line 255 of file OutPort.hxx.

References CLAM::OutPort< Token >::mRegion, and CLAM::Region::Size().

Referenced by CLAM::OutPort< Token >::GetLastWrittenData(), and CLAM::OutPortPublisher< Spectrum >::GetSize().

template<typename Token>
virtual const std::type_info& CLAM::OutPort< Token >::GetTypeId (  )  const [inline, virtual]

Implements CLAM::OutPortBase.

Definition at line 104 of file OutPort.hxx.

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

template<class Token >
bool CLAM::OutPort< Token >::IsConnectableTo ( InPortBase &  in  )  [inline, virtual]

Implements CLAM::OutPortBase.

Definition at line 285 of file OutPort.hxx.

References CLAM::OutPort< Token >::GetTypeId(), CLAM::InPortBase::GetTypeId(), and CLAM::SameType().

Referenced by CLAM::OutPort< Token >::ConnectToIn(), CLAM::OutPort< Token >::DisconnectFromIn(), CLAM::OutPortPublisher< Spectrum >::IsConnectableTo(), CLAM::OutPort< Token >::TryDisconnectFromConcreteIn(), and CLAM::OutPort< Token >::TryDisconnectFromPublisher().

template<class Token>
bool CLAM::OutPort< Token >::IsPhysicallyConnectedToIn ( InPort< Token > &  in  )  [inline]

Definition at line 291 of file OutPort.hxx.

References CLAM::OutPort< Token >::GetPublisherContaining(), and CLAM::OutPort< Token >::IsVisuallyConnectedTo().

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

template<class Token >
bool CLAM::OutPort< Token >::IsVisuallyConnectedTo ( InPortBase &  in  )  [inline, virtual]

Implements CLAM::OutPortBase.

Definition at line 314 of file OutPort.hxx.

References CLAM::OutPortBase::mVisuallyConnectedPorts.

Referenced by CLAM::OutPort< Token >::ConnectToConcreteIn(), CLAM::OutPort< Token >::DisconnectFromConcreteIn(), CLAM::OutPort< Token >::IsPhysicallyConnectedToIn(), and CLAM::OutPortPublisher< Spectrum >::IsVisuallyConnectedTo().

template<class Token >
void CLAM::OutPort< Token >::Produce (  )  [inline]

Definition at line 273 of file OutPort.hxx.

References CLAM::OutPort< Token >::mRegion, and CLAM::WritingRegion< Token, DataStructure >::Produce().

Referenced by CLAM::WindowGenerator::Do(), CLAM::WaveGenerator::Do(), CLAM::Vocoder::Do(), CLAM::TokenDelay< T >::Do(), CLAM::SynthSineSpectrum::Do(), CLAM::SpectrumAdder2::Do(), CLAM::SpectralSynthesis::Do(), CLAM::SpectralSpread::Do(), CLAM::SpectralShapeShift::Do(), CLAM::SpectralRingModulation::Do(), CLAM::SpectralReverse::Do(), CLAM::SpectralReject::Do(), CLAM::SpectralPhaseModulation::Do(), CLAM::SpectralPeakDetect::Do(), CLAM::SpectralNotch::Do(), CLAM::SpectralLimiter::Do(), CLAM::SpectralGate::Do(), CLAM::SpectralFocus::Do(), CLAM::SpectralExciter::Do(), CLAM::SpectralDelay::Do(), CLAM::SpectralCombTriang::Do(), CLAM::SpectralCombDelta::Do(), CLAM::SpectralAverage::Do(), CLAM::SpectralAnalysis::Do(), CLAM::SpectralAmplitudeModulation::Do(), CLAM::SMSTranspose::Do(), CLAM::SMSTimeStretch::Do(), CLAM::SMSSpectralShapeShift::Do(), CLAM::SMSSinusoidalGain::Do(), CLAM::SMSSineFilter::Do(), CLAM::SMSResidualGain::Do(), CLAM::SMSPitchShift::Do(), CLAM::SMSPitchDiscretization::Do(), CLAM::SMSOddEvenHarmonicRatio::Do(), CLAM::SMSMorph::Do(), CLAM::SMSHarmonizer::Do(), CLAM::SMSGenderChange::Do(), CLAM::SMSFreqShift::Do(), CLAM::SMSDeesser::Do(), CLAM::SimpleOscillator::Do(), CLAM::SampleAndHold::Do(), CLAM::Robotization::Do(), CLAM::RandomPhase::Do(), CLAM::Peakalizer::Do(), CLAM::Partializer::Do(), CLAM::OverlapAdd::Do(), CLAM::Oscillator::Do(), CLAM::OscillatingSpectralNotch::Do(), CLAM::NoSpectralTransformation::Do(), CLAM::Instrument::Do(), CLAM::IFFT_ooura::Do(), CLAM::HumRemover::Do(), CLAM::FundFreqDetect::Do(), CLAM::FreqShift::Do(), CLAM::FFT_ooura::Do(), CLAM::FFT_fftw3::Do(), CLAM::EnvelopeGenerator::Do(), CLAM::Deesser::Do(), CLAM::CircularShift::Do(), CLAM::BinaryAudioOp< Multiply< TData > >::Do(), CLAM::AudioMixer::Do(), CLAM::ThreeBandAM::Do(), CLAM::ThreeBandGate::Do(), CLAM::ThreeBandFilter::Do(), CLAM::ThreeBandCompressor::Do(), and CLAM::IFFT_fftw3::SetPrototypes().

template<class Token >
void CLAM::OutPort< Token >::SetHop ( int  hop  )  [inline, virtual]

Implements CLAM::OutPortBase.

Definition at line 267 of file OutPort.hxx.

References CLAM::Region::Hop(), and CLAM::OutPort< Token >::mRegion.

Referenced by CLAM::OutPortPublisher< Spectrum >::SetHop().

template<class Token >
void CLAM::OutPort< Token >::SetSize ( int  newSize  )  [inline, virtual]

Implements CLAM::OutPortBase.

Definition at line 249 of file OutPort.hxx.

References CLAM::OutPort< Token >::mRegion, and CLAM::Region::Size().

Referenced by CLAM::OutPortPublisher< Spectrum >::SetSize().

template<class Token >
bool CLAM::OutPort< Token >::TryDisconnectFromConcreteIn ( InPortBase &  in  )  [inline, protected]

Definition at line 197 of file OutPort.hxx.

References CLAM_ASSERT, CLAM::OutPort< Token >::DisconnectFromConcreteIn(), and CLAM::OutPort< Token >::IsConnectableTo().

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

template<class Token >
bool CLAM::OutPort< Token >::TryDisconnectFromPublisher ( InPortBase &  in  )  [inline, protected]

Definition at line 207 of file OutPort.hxx.

References CLAM::InPortPublisher< Token >::BeginPublishedInPortsList(), CLAM_ASSERT, CLAM::InPortPublisher< Token >::EndPublishedInPortsList(), CLAM::OutPort< Token >::IsConnectableTo(), CLAM::OutPortBase::mVisuallyConnectedPorts, and CLAM::InPortPublisher< Token >::UnAttachRegion().

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

template<typename Token>
void CLAM::OutPort< Token >::UnpublishOutPort (  )  [inline, virtual]

Implements CLAM::OutPortBase.

Definition at line 103 of file OutPort.hxx.

Member Data Documentation

template<typename Token>
ProperWritingRegion CLAM::OutPort< Token >::mRegion [protected]

Definition at line 116 of file OutPort.hxx.

Referenced by CLAM::OutPort< Token >::CanProduce(), CLAM::OutPort< Token >::CenterEvenRegions(), CLAM::OutPort< Token >::ConnectToConcreteIn(), CLAM::OutPort< Token >::GetData(), CLAM::OutPort< Token >::GetHop(), CLAM::OutPort< Token >::GetLastWrittenData(), CLAM::OutPort< Token >::GetSize(), CLAM::OutPort< Token >::Produce(), CLAM::OutPort< Token >::SetHop(), and CLAM::OutPort< Token >::SetSize().

The documentation for this class was generated from the following file:
Generated by  doxygen 1.6.3