CLAM::OutPort< Token > Class Template Reference

#include <OutPort.hxx>

Inheritance diagram for CLAM::OutPort< Token >:

CLAM::OutPortBase CLAM::AudioOutPort

List of all members.

Detailed Description

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

Definition at line 73 of file OutPort.hxx.


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

Static Public Member Functions

static Token & GetLastWrittenData (OutPortBase &, int offset=0)

Protected Member Functions

bool TryConnectToPublisher (InPortBase &in)
bool TryConnectToConcreteIn (InPortBase &in)
bool TryDisconnectFromPublisher (InPortBase &in)
bool TryDisconnectFromConcreteIn (InPortBase &in)
Token & GetLastWrittenData (int offset=0)

Protected Attributes

ProperWritingRegion mRegion

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>
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< CLAM::Fundamental >::DisconnectFromAll(), CLAM::OutPort< Token >::~OutPort(), and CLAM::OutPortPublisher< CLAM::Fundamental >::~OutPortPublisher().

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

Implements CLAM::OutPortBase.

Definition at line 175 of file OutPort.hxx.

References CLAM_ASSERT, CLAM::OutPort< Token >::TryConnectToConcreteIn(), and CLAM::OutPort< Token >::TryConnectToPublisher().

Referenced by CLAM::OutPortPublisher< CLAM::Fundamental >::ConnectToIn(), and CLAM::SMSAnalysis::SMSAnalysis().

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

Definition at line 185 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 >::TryConnectToConcreteIn().

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

Implements CLAM::OutPortBase.

Definition at line 196 of file OutPort.hxx.

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

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

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

Definition at line 234 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>
bool CLAM::OutPort< Token >::IsConnectableTo ( InPortBase &  in  )  [inline, virtual]

Implements CLAM::OutPortBase.

Definition at line 295 of file OutPort.hxx.

Referenced by CLAM::OutPortPublisher< CLAM::Fundamental >::IsConnectableTo().

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

Implements CLAM::OutPortBase.

Definition at line 330 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< CLAM::Fundamental >::IsVisuallyConnectedTo().

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

Definition at line 302 of file OutPort.hxx.

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

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

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

Definition at line 312 of file OutPort.hxx.

References CLAM_DEBUG_ASSERT, and CLAM::OutPortBase::mVisuallyConnectedPorts.

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

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

Definition at line 253 of file OutPort.hxx.

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

Referenced by CLAM::TokenDelay< T >::Do(), CLAM::EnvelopeGenerator::Do(), CLAM::AudioOutPortPublisher::GetAudio(), and CLAM::OutPortPublisher< CLAM::Fundamental >::GetData().

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

Implements CLAM::OutPortBase.

Definition at line 259 of file OutPort.hxx.

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

Referenced by CLAM::AudioOutPort::AudioOutPort(), CLAM::AudioIn::ConcreteConfigure(), CLAM::AudioSource::SetExternalBuffer(), CLAM::AudioSource::SetFrameAndHopSize(), and CLAM::OutPortPublisher< CLAM::Fundamental >::SetSize().

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

Implements CLAM::OutPortBase.

Definition at line 265 of file OutPort.hxx.

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

Referenced by CLAM::AudioOutPortPublisher::GetAudio(), CLAM::AudioOutPort::GetLastWrittenAudio(), CLAM::OutPort< Token >::GetLastWrittenData(), and CLAM::OutPortPublisher< CLAM::Fundamental >::GetSize().

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

Implements CLAM::OutPortBase.

Definition at line 271 of file OutPort.hxx.

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

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

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

Implements CLAM::OutPortBase.

Definition at line 277 of file OutPort.hxx.

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

Referenced by CLAM::AudioOutPort::AudioOutPort(), CLAM::AudioSource::SetExternalBuffer(), CLAM::AudioSource::SetFrameAndHopSize(), and CLAM::OutPortPublisher< CLAM::Fundamental >::SetHop().

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

Definition at line 283 of file OutPort.hxx.

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

Referenced by CLAM::WindowGenerator::Do(), CLAM::TokenDelay< T >::Do(), CLAM::SpectralSynthesis::Do(), CLAM::SMSSynthesis::Do(), CLAM::SMSAnalysis::Do(), CLAM::SinusoidalSynthesis::Do(), CLAM::SimpleOscillator::Do(), CLAM::OverlapAdd::Do(), CLAM::Oscillator::Do(), CLAM::MonoAudioFileReader::Do(), CLAM::Instrument::Do(), CLAM::IFFT_ooura::Do(), CLAM::IFFT_fftw3::Do(), CLAM::EnvelopeGenerator::Do(), CLAM::CircularShift::Do(), CLAM::BinaryAudioOp< CLAM::Multiply< float > >::Do(), CLAM::AudioSource::Do(), CLAM::AudioMixer::Do(), CLAM::AudioIn::Do(), CLAM::AudioFileMemoryLoader::Do(), CLAM::AudioAmplifier::Do(), and CLAM::ADSR::Do().

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

Implements CLAM::OutPortBase.

Definition at line 289 of file OutPort.hxx.

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

Referenced by CLAM::OutPortPublisher< CLAM::Fundamental >::CanProduce(), and CLAM::SMSAnalysis::Do().

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

Implements CLAM::OutPortBase.

Definition at line 339 of file OutPort.hxx.

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

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

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

Definition at line 353 of file OutPort.hxx.

References CLAM_ASSERT, CLAM::OutPort< Token >::GetLastWrittenData(), and NULL.

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

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

Implements CLAM::OutPortBase.

Definition at line 102 of file OutPort.hxx.

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

Implements CLAM::OutPortBase.

Definition at line 103 of file OutPort.hxx.

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

Definition at line 158 of file OutPort.hxx.

References CLAM::InPortPublisher< Token >::BeginPublishedInPortsList(), CLAM::InPortPublisher< Token >::EndPublishedInPortsList(), CLAM::OutPort< Token >::mRegion, CLAM::OutPortBase::mVisuallyConnectedPorts, and CLAM::InPortBase::SetVisuallyConnectedOutPort().

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

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

Definition at line 144 of file OutPort.hxx.

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

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

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

Definition at line 217 of file OutPort.hxx.

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

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

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

Definition at line 206 of file OutPort.hxx.

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

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

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

Definition at line 345 of file OutPort.hxx.

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

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::AudioOutPort::GetAudio(), CLAM::OutPort< Token >::GetData(), CLAM::OutPort< Token >::GetHop(), CLAM::AudioOutPort::GetLastWrittenAudio(), CLAM::OutPort< Token >::GetLastWrittenData(), CLAM::OutPort< Token >::GetSize(), CLAM::OutPort< Token >::Produce(), CLAM::OutPort< Token >::SetHop(), CLAM::OutPort< Token >::SetSize(), and CLAM::OutPort< Token >::TryConnectToPublisher().

The documentation for this class was generated from the following file:
Generated on Tue Aug 12 22:33:48 2008 for CLAM by  doxygen 1.5.5