CLAM-Development  1.4.0
Public Member Functions | Protected Attributes
CLAM::InPortBase Class Reference

#include <InPort.hxx>

List of all members.

Public Member Functions

 InPortBase (const std::string &name="unnamed in port", Processing *proc=0)
virtual ~InPortBase ()
OutPortBase * GetVisuallyConnectedOutPort ()
void SetVisuallyConnectedOutPort (OutPortBase *)
const std::string & GetName ()
bool HasProcessing ()
Processing * GetProcessing ()
virtual bool CanConsume ()=0
virtual int GetSize ()=0
virtual void SetSize (int newSize)=0
virtual int GetHop ()=0
virtual void SetHop (int newHop)=0
virtual void UnAttachRegion ()=0
void Disconnect ()
virtual bool IsPublisherOf (InPortBase &) const
virtual bool IsPublisher () const
virtual const std::type_info & GetTypeId () const =0

Protected Attributes

OutPortBase * mVisuallyConnectedOutPort
std::string mName
Processing * mProcessing

Detailed Description

Definition at line 36 of file InPort.hxx.

Constructor & Destructor Documentation

CLAM::InPortBase::InPortBase ( const std::string &  name = "unnamed in port",
Processing *  proc = 0 
)

Definition at line 29 of file InPort.cxx.

References CLAM::Processing::RegisterInPort().

CLAM::InPortBase::~InPortBase ( )
virtual

Definition at line 38 of file InPort.cxx.

References CLAM::Processing::GetInPorts(), mProcessing, and CLAM::InPortRegistry::ProcessingInterface_Unregister().

Member Function Documentation

virtual bool CLAM::InPortBase::CanConsume ( )
pure virtual

Implemented in CLAM::InPortPublisher< Token >, CLAM::InPortPublisher< TData >, CLAM::InPort< Token >, CLAM::InPort< TData >, CLAM::InPort< T >, CLAM::InPort< Envelope >, CLAM::InPort< MIDISong >, CLAM::InPort< SpectralPeakArray >, CLAM::InPort< Frame >, CLAM::InPort< Fundamental >, CLAM::InPort< Spectrum >, CLAM::InPort< MelSpectrum >, and CLAM::InPort< Audio >.

void CLAM::InPortBase::Disconnect ( )

Definition at line 70 of file InPort.cxx.

References CLAM_DEBUG_ASSERT, CLAM::OutPortBase::DisconnectFromIn(), and mVisuallyConnectedOutPort.

Referenced by CLAM::InPortPublisher< TData >::~InPortPublisher().

virtual int CLAM::InPortBase::GetHop ( )
pure virtual

Implemented in CLAM::InPort< Token >, CLAM::InPort< TData >, CLAM::InPort< T >, CLAM::InPort< Envelope >, CLAM::InPort< MIDISong >, CLAM::InPort< SpectralPeakArray >, CLAM::InPort< Frame >, CLAM::InPort< Fundamental >, CLAM::InPort< Spectrum >, CLAM::InPort< MelSpectrum >, and CLAM::InPort< Audio >.

const std::string & CLAM::InPortBase::GetName ( )

Definition at line 54 of file InPort.cxx.

References mName.

Referenced by CLAM::NetworkPlayer::CacheSourcesAndSinks(), and CLAM::Network::GetUnconnectedInPorts().

Processing * CLAM::InPortBase::GetProcessing ( )

Definition at line 64 of file InPort.cxx.

References CLAM_ASSERT, and mProcessing.

virtual int CLAM::InPortBase::GetSize ( )
pure virtual

Implemented in CLAM::InPort< Token >, CLAM::InPort< TData >, CLAM::InPort< T >, CLAM::InPort< Envelope >, CLAM::InPort< MIDISong >, CLAM::InPort< SpectralPeakArray >, CLAM::InPort< Frame >, CLAM::InPort< Fundamental >, CLAM::InPort< Spectrum >, CLAM::InPort< MelSpectrum >, and CLAM::InPort< Audio >.

Referenced by CLAM::SMSAnalysisCore::ConcreteStart().

virtual const std::type_info& CLAM::InPortBase::GetTypeId ( ) const
pure virtual

Implemented in CLAM::InPortPublisher< Token >, CLAM::InPortPublisher< TData >, CLAM::InPort< Token >, CLAM::InPort< TData >, CLAM::InPort< T >, CLAM::InPort< Envelope >, CLAM::InPort< MIDISong >, CLAM::InPort< SpectralPeakArray >, CLAM::InPort< Frame >, CLAM::InPort< Fundamental >, CLAM::InPort< Spectrum >, CLAM::InPort< MelSpectrum >, and CLAM::InPort< Audio >.

Referenced by CLAM::OutPort< Token >::IsConnectableTo(), and CLAM::InPortPublisher< TData >::PublishInPort().

OutPortBase * CLAM::InPortBase::GetVisuallyConnectedOutPort ( )

Definition at line 44 of file InPort.cxx.

References mVisuallyConnectedOutPort.

Referenced by CLAM::SMSAnalysisCore::ConcreteStart(), CLAM::Network::ConnectPorts(), CLAM::OutPort< Token >::ConnectToConcreteIn(), CLAM::Network::GetUnconnectedInPorts(), CLAM::Network::HasUnconnectedInPorts(), and CLAM::InPortPublisher< TData >::~InPortPublisher().

bool CLAM::InPortBase::HasProcessing ( )

Definition at line 59 of file InPort.cxx.

References mProcessing.

virtual bool CLAM::InPortBase::IsPublisher ( ) const
inlinevirtual

Reimplemented in CLAM::InPortPublisher< Token >, and CLAM::InPortPublisher< TData >.

Definition at line 54 of file InPort.hxx.

Referenced by CLAM::OutPort< Token >::ConnectToIn(), CLAM::OutPort< Token >::DisconnectFromIn(), and CLAM::InPortPublisher< TData >::PublishInPort().

virtual bool CLAM::InPortBase::IsPublisherOf ( InPortBase &  ) const
inlinevirtual

Reimplemented in CLAM::InPortPublisher< Token >, and CLAM::InPortPublisher< TData >.

Definition at line 53 of file InPort.hxx.

virtual void CLAM::InPortBase::SetHop ( int  newHop)
pure virtual

Implemented in CLAM::InPort< Token >, CLAM::InPort< TData >, CLAM::InPort< T >, CLAM::InPort< Envelope >, CLAM::InPort< MIDISong >, CLAM::InPort< SpectralPeakArray >, CLAM::InPort< Frame >, CLAM::InPort< Fundamental >, CLAM::InPort< Spectrum >, CLAM::InPort< MelSpectrum >, and CLAM::InPort< Audio >.

virtual void CLAM::InPortBase::SetSize ( int  newSize)
pure virtual

Implemented in CLAM::InPort< Token >, CLAM::InPort< TData >, CLAM::InPort< T >, CLAM::InPort< Envelope >, CLAM::InPort< MIDISong >, CLAM::InPort< SpectralPeakArray >, CLAM::InPort< Frame >, CLAM::InPort< Fundamental >, CLAM::InPort< Spectrum >, CLAM::InPort< MelSpectrum >, and CLAM::InPort< Audio >.

void CLAM::InPortBase::SetVisuallyConnectedOutPort ( OutPortBase *  out)

Definition at line 49 of file InPort.cxx.

References mVisuallyConnectedOutPort.

Referenced by CLAM::OutPortPublisher< Spectrum >::ConnectToIn(), CLAM::OutPort< Token >::ConnectToPublisher(), and CLAM::InPortPublisher< TData >::UnAttachRegion().

virtual void CLAM::InPortBase::UnAttachRegion ( )
pure virtual

Implemented in CLAM::InPortPublisher< Token >, CLAM::InPortPublisher< TData >, CLAM::InPort< Token >, CLAM::InPort< TData >, CLAM::InPort< T >, CLAM::InPort< Envelope >, CLAM::InPort< MIDISong >, CLAM::InPort< SpectralPeakArray >, CLAM::InPort< Frame >, CLAM::InPort< Fundamental >, CLAM::InPort< Spectrum >, CLAM::InPort< MelSpectrum >, and CLAM::InPort< Audio >.

Member Data Documentation

std::string CLAM::InPortBase::mName
protected

Definition at line 58 of file InPort.hxx.

Referenced by GetName().

Processing* CLAM::InPortBase::mProcessing
protected

Definition at line 59 of file InPort.hxx.

Referenced by GetProcessing(), HasProcessing(), and ~InPortBase().

OutPortBase* CLAM::InPortBase::mVisuallyConnectedOutPort
protected

Definition at line 57 of file InPort.hxx.

Referenced by Disconnect(), GetVisuallyConnectedOutPort(), and SetVisuallyConnectedOutPort().

The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.1