CLAM-Development: CLAM::OutPortBase Class Reference

CLAM-Development 1.4.0

#include <OutPort.hxx>

List of all members.

Public Types
typedef std::list< InPortBase * >	InPortsList

Public Member Functions
	OutPortBase (const std::string &name="unnamed out port", Processing *proc=0)
virtual	~OutPortBase ()
const std::string &	GetName ()
Processing *	GetProcessing ()
InPortsList::iterator	BeginVisuallyConnectedInPorts ()
InPortsList::iterator	EndVisuallyConnectedInPorts ()
virtual void	ConnectToIn (InPortBase &in)=0
virtual void	DisconnectFromIn (InPortBase &in)=0
virtual void	DisconnectFromAll ()=0
virtual bool	IsVisuallyConnectedTo (InPortBase &in)=0
virtual bool	IsConnectableTo (InPortBase &)=0
virtual bool	CanProduce ()=0
virtual int	GetSize ()=0
virtual void	SetSize (int newSize)=0
virtual int	GetHop ()=0
virtual void	SetHop (int newHop)=0
bool	HasConnections ()
virtual void	CenterEvenRegions ()=0
void	SetPublisher (OutPortBase &publisher)
void	UnsetPublisher ()
virtual bool	IsPublisher () const
virtual void	UnpublishOutPort ()=0
virtual const std::type_info &	GetTypeId () const =0

Protected Attributes
InPortsList	mVisuallyConnectedPorts
std::string	mName
Processing *	mProcessing
OutPortBase *	mPublisher

Detailed Description

Definition at line 37 of file OutPort.hxx.

Member Typedef Documentation

typedef std::list<InPortBase*> CLAM::OutPortBase::InPortsList

Definition at line 40 of file OutPort.hxx.

Constructor & Destructor Documentation

CLAM::OutPortBase::OutPortBase	(	const std::string &	name = `"unnamed out port"`,
		Processing *	proc = `0`
	)

Definition at line 28 of file OutPort.cxx.

References CLAM::Processing::RegisterOutPort().

CLAM::OutPortBase::~OutPortBase ( )

virtual

Definition at line 37 of file OutPort.cxx.

References CLAM::Processing::GetOutPorts(), mProcessing, mPublisher, CLAM::OutPortRegistry::ProcessingInterface_Unregister(), and UnpublishOutPort().

Member Function Documentation

OutPortBase::InPortsList::iterator CLAM::OutPortBase::BeginVisuallyConnectedInPorts ( )

Definition at line 55 of file OutPort.cxx.

References mVisuallyConnectedPorts.

Referenced by CLAM::Network::GetInPortsConnectedTo(), and CLAM::OutPortPublisher< Spectrum >::~OutPortPublisher().

virtual bool CLAM::OutPortBase::CanProduce ( )

pure virtual

virtual void CLAM::OutPortBase::CenterEvenRegions ( )

pure virtual

Implemented in CLAM::OutPortPublisher< Token >, CLAM::OutPortPublisher< TData >, CLAM::OutPortPublisher< SpectralPeakArray >, CLAM::OutPortPublisher< Fundamental >, CLAM::OutPortPublisher< Spectrum >, CLAM::OutPort< Token >, CLAM::OutPort< TData >, CLAM::OutPort< MelCepstrum >, CLAM::OutPort< MIDIMelody >, CLAM::OutPort< std::pair< CLAM::TData, CLAM::TData > >, CLAM::OutPort< T >, CLAM::OutPort< Envelope >, CLAM::OutPort< std::vector< std::pair< CLAM::TData, CLAM::TData > > >, CLAM::OutPort< Segment >, CLAM::OutPort< DiscontinuousSegmentation >, CLAM::OutPort< MIDISong >, CLAM::OutPort< SpectralPeakArray >, CLAM::OutPort< LPModel >, CLAM::OutPort< Frame >, CLAM::OutPort< Fundamental >, CLAM::OutPort< std::vector< CLAM::TData > >, CLAM::OutPort< Spectrum >, CLAM::OutPort< Audio >, and CLAM::OutPort< MelSpectrum >.

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

virtual void CLAM::OutPortBase::ConnectToIn ( InPortBase & in )

pure virtual

Implemented in CLAM::OutPort< Token >, CLAM::OutPort< TData >, CLAM::OutPort< MelCepstrum >, CLAM::OutPort< MIDIMelody >, CLAM::OutPort< std::pair< CLAM::TData, CLAM::TData > >, CLAM::OutPort< T >, CLAM::OutPort< Envelope >, CLAM::OutPort< std::vector< std::pair< CLAM::TData, CLAM::TData > > >, CLAM::OutPort< Segment >, CLAM::OutPort< DiscontinuousSegmentation >, CLAM::OutPort< MIDISong >, CLAM::OutPort< SpectralPeakArray >, CLAM::OutPort< LPModel >, CLAM::OutPort< Frame >, CLAM::OutPort< Fundamental >, CLAM::OutPort< std::vector< CLAM::TData > >, CLAM::OutPort< Spectrum >, CLAM::OutPort< Audio >, CLAM::OutPort< MelSpectrum >, CLAM::OutPortPublisher< Token >, CLAM::OutPortPublisher< TData >, CLAM::OutPortPublisher< SpectralPeakArray >, CLAM::OutPortPublisher< Fundamental >, and CLAM::OutPortPublisher< Spectrum >.

Referenced by CLAM::ConnectPorts(), and CLAM::Network::ConnectPorts().

virtual void CLAM::OutPortBase::DisconnectFromAll ( )

pure virtual

virtual void CLAM::OutPortBase::DisconnectFromIn ( InPortBase & in )

pure virtual

Implemented in CLAM::OutPortPublisher< Token >, CLAM::OutPortPublisher< TData >, CLAM::OutPortPublisher< SpectralPeakArray >, CLAM::OutPortPublisher< Fundamental >, CLAM::OutPortPublisher< Spectrum >, CLAM::OutPort< Token >, CLAM::OutPort< TData >, CLAM::OutPort< MelCepstrum >, CLAM::OutPort< MIDIMelody >, CLAM::OutPort< std::pair< CLAM::TData, CLAM::TData > >, CLAM::OutPort< T >, CLAM::OutPort< Envelope >, CLAM::OutPort< std::vector< std::pair< CLAM::TData, CLAM::TData > > >, CLAM::OutPort< Segment >, CLAM::OutPort< DiscontinuousSegmentation >, CLAM::OutPort< MIDISong >, CLAM::OutPort< SpectralPeakArray >, CLAM::OutPort< LPModel >, CLAM::OutPort< Frame >, CLAM::OutPort< Fundamental >, CLAM::OutPort< std::vector< CLAM::TData > >, CLAM::OutPort< Spectrum >, CLAM::OutPort< Audio >, and CLAM::OutPort< MelSpectrum >.

Referenced by CLAM::InPortBase::Disconnect(), and CLAM::Network::DisconnectPorts().

OutPortBase::InPortsList::iterator CLAM::OutPortBase::EndVisuallyConnectedInPorts ( )

Definition at line 60 of file OutPort.cxx.

References mVisuallyConnectedPorts.

Referenced by CLAM::Network::GetInPortsConnectedTo(), and CLAM::OutPortPublisher< Spectrum >::~OutPortPublisher().

virtual int CLAM::OutPortBase::GetHop ( )

pure virtual

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

Definition at line 45 of file OutPort.cxx.

References mName.

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

Processing * CLAM::OutPortBase::GetProcessing ( )

Definition at line 50 of file OutPort.cxx.

References mProcessing.

virtual int CLAM::OutPortBase::GetSize ( )

pure virtual

Implemented in CLAM::OutPortPublisher< Token >, CLAM::OutPortPublisher< TData >, CLAM::OutPortPublisher< SpectralPeakArray >, CLAM::OutPortPublisher< Fundamental >, CLAM::OutPortPublisher< Spectrum >, CLAM::OutPort< Token >, CLAM::OutPort< TData >, CLAM::OutPort< MelCepstrum >, CLAM::OutPort< MIDIMelody >, CLAM::OutPort< std::pair< CLAM::TData, CLAM::TData > >, CLAM::OutPort< T >, CLAM::OutPort< Envelope >, CLAM::OutPort< std::vector< std::pair< CLAM::TData, CLAM::TData > > >, CLAM::OutPort< Segment >, CLAM::OutPort< DiscontinuousSegmentation >, CLAM::OutPort< MIDISong >, CLAM::OutPort< SpectralPeakArray >, CLAM::OutPort< LPModel >, CLAM::OutPort< Frame >, CLAM::OutPort< Fundamental >, CLAM::OutPort< std::vector< CLAM::TData > >, CLAM::OutPort< Spectrum >, CLAM::OutPort< Audio >, and CLAM::OutPort< MelSpectrum >.

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

virtual const std::type_info& CLAM::OutPortBase::GetTypeId ( ) const

pure virtual

Implemented in CLAM::OutPortPublisher< Token >, CLAM::OutPortPublisher< TData >, CLAM::OutPortPublisher< SpectralPeakArray >, CLAM::OutPortPublisher< Fundamental >, CLAM::OutPortPublisher< Spectrum >, CLAM::OutPort< Token >, CLAM::OutPort< TData >, CLAM::OutPort< MelCepstrum >, CLAM::OutPort< MIDIMelody >, CLAM::OutPort< std::pair< CLAM::TData, CLAM::TData > >, CLAM::OutPort< T >, CLAM::OutPort< Envelope >, CLAM::OutPort< std::vector< std::pair< CLAM::TData, CLAM::TData > > >, CLAM::OutPort< Segment >, CLAM::OutPort< DiscontinuousSegmentation >, CLAM::OutPort< MIDISong >, CLAM::OutPort< SpectralPeakArray >, CLAM::OutPort< LPModel >, CLAM::OutPort< Frame >, CLAM::OutPort< Fundamental >, CLAM::OutPort< std::vector< CLAM::TData > >, CLAM::OutPort< Spectrum >, CLAM::OutPort< Audio >, and CLAM::OutPort< MelSpectrum >.

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

bool CLAM::OutPortBase::HasConnections ( )

inline

Definition at line 58 of file OutPort.hxx.

References mVisuallyConnectedPorts.

Referenced by CLAM::SMSSynthesis::Do(), CLAM::Network::GetInPortsConnectedTo(), and CLAM::Network::StoreOn().

virtual bool CLAM::OutPortBase::IsConnectableTo ( InPortBase & )

pure virtual

Implemented in CLAM::OutPortPublisher< Token >, CLAM::OutPortPublisher< TData >, CLAM::OutPortPublisher< SpectralPeakArray >, CLAM::OutPortPublisher< Fundamental >, CLAM::OutPortPublisher< Spectrum >, CLAM::OutPort< Token >, CLAM::OutPort< TData >, CLAM::OutPort< MelCepstrum >, CLAM::OutPort< MIDIMelody >, CLAM::OutPort< std::pair< CLAM::TData, CLAM::TData > >, CLAM::OutPort< T >, CLAM::OutPort< Envelope >, CLAM::OutPort< std::vector< std::pair< CLAM::TData, CLAM::TData > > >, CLAM::OutPort< Segment >, CLAM::OutPort< DiscontinuousSegmentation >, CLAM::OutPort< MIDISong >, CLAM::OutPort< SpectralPeakArray >, CLAM::OutPort< LPModel >, CLAM::OutPort< Frame >, CLAM::OutPort< Fundamental >, CLAM::OutPort< std::vector< CLAM::TData > >, CLAM::OutPort< Spectrum >, CLAM::OutPort< Audio >, and CLAM::OutPort< MelSpectrum >.

Referenced by CLAM::Network::ConnectPorts().

virtual bool CLAM::OutPortBase::IsPublisher ( ) const

inlinevirtual

Reimplemented in CLAM::OutPortPublisher< Token >, CLAM::OutPortPublisher< TData >, CLAM::OutPortPublisher< SpectralPeakArray >, CLAM::OutPortPublisher< Fundamental >, and CLAM::OutPortPublisher< Spectrum >.

Definition at line 62 of file OutPort.hxx.

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

virtual bool CLAM::OutPortBase::IsVisuallyConnectedTo ( InPortBase & in )

pure virtual

Implemented in CLAM::OutPortPublisher< Token >, CLAM::OutPortPublisher< TData >, CLAM::OutPortPublisher< SpectralPeakArray >, CLAM::OutPortPublisher< Fundamental >, CLAM::OutPortPublisher< Spectrum >, CLAM::OutPort< Token >, CLAM::OutPort< TData >, CLAM::OutPort< MelCepstrum >, CLAM::OutPort< MIDIMelody >, CLAM::OutPort< std::pair< CLAM::TData, CLAM::TData > >, CLAM::OutPort< T >, CLAM::OutPort< Envelope >, CLAM::OutPort< std::vector< std::pair< CLAM::TData, CLAM::TData > > >, CLAM::OutPort< Segment >, CLAM::OutPort< DiscontinuousSegmentation >, CLAM::OutPort< MIDISong >, CLAM::OutPort< SpectralPeakArray >, CLAM::OutPort< LPModel >, CLAM::OutPort< Frame >, CLAM::OutPort< Fundamental >, CLAM::OutPort< std::vector< CLAM::TData > >, CLAM::OutPort< Spectrum >, CLAM::OutPort< Audio >, and CLAM::OutPort< MelSpectrum >.

Referenced by CLAM::Network::ConnectPorts(), and CLAM::Network::DisconnectPorts().

virtual void CLAM::OutPortBase::SetHop ( int newHop )

pure virtual

Implemented in CLAM::OutPortPublisher< Token >, CLAM::OutPortPublisher< TData >, CLAM::OutPortPublisher< SpectralPeakArray >, CLAM::OutPortPublisher< Fundamental >, CLAM::OutPortPublisher< Spectrum >, CLAM::OutPort< Token >, CLAM::OutPort< TData >, CLAM::OutPort< MelCepstrum >, CLAM::OutPort< MIDIMelody >, CLAM::OutPort< std::pair< CLAM::TData, CLAM::TData > >, CLAM::OutPort< T >, CLAM::OutPort< Envelope >, CLAM::OutPort< std::vector< std::pair< CLAM::TData, CLAM::TData > > >, CLAM::OutPort< Segment >, CLAM::OutPort< DiscontinuousSegmentation >, CLAM::OutPort< MIDISong >, CLAM::OutPort< SpectralPeakArray >, CLAM::OutPort< LPModel >, CLAM::OutPort< Frame >, CLAM::OutPort< Fundamental >, CLAM::OutPort< std::vector< CLAM::TData > >, CLAM::OutPort< Spectrum >, CLAM::OutPort< Audio >, and CLAM::OutPort< MelSpectrum >.

Referenced by CLAM::SMSAnalysisCore::ConcreteStart(), and CLAM::MonoOfflineNetworkPlayer::Start().

void CLAM::OutPortBase::SetPublisher ( OutPortBase & publisher )

Definition at line 65 of file OutPort.cxx.

References mPublisher.

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

virtual void CLAM::OutPortBase::SetSize ( int newSize )

pure virtual

Implemented in CLAM::OutPortPublisher< Token >, CLAM::OutPortPublisher< TData >, CLAM::OutPortPublisher< SpectralPeakArray >, CLAM::OutPortPublisher< Fundamental >, CLAM::OutPortPublisher< Spectrum >, CLAM::OutPort< Token >, CLAM::OutPort< TData >, CLAM::OutPort< MelCepstrum >, CLAM::OutPort< MIDIMelody >, CLAM::OutPort< std::pair< CLAM::TData, CLAM::TData > >, CLAM::OutPort< T >, CLAM::OutPort< Envelope >, CLAM::OutPort< std::vector< std::pair< CLAM::TData, CLAM::TData > > >, CLAM::OutPort< Segment >, CLAM::OutPort< DiscontinuousSegmentation >, CLAM::OutPort< MIDISong >, CLAM::OutPort< SpectralPeakArray >, CLAM::OutPort< LPModel >, CLAM::OutPort< Frame >, CLAM::OutPort< Fundamental >, CLAM::OutPort< std::vector< CLAM::TData > >, CLAM::OutPort< Spectrum >, CLAM::OutPort< Audio >, and CLAM::OutPort< MelSpectrum >.

Referenced by CLAM::SMSAnalysisCore::ConcreteStart(), and CLAM::MonoOfflineNetworkPlayer::Start().

virtual void CLAM::OutPortBase::UnpublishOutPort ( )

pure virtual

Implemented in CLAM::OutPort< Token >, CLAM::OutPort< TData >, CLAM::OutPort< MelCepstrum >, CLAM::OutPort< MIDIMelody >, CLAM::OutPort< std::pair< CLAM::TData, CLAM::TData > >, CLAM::OutPort< T >, CLAM::OutPort< Envelope >, CLAM::OutPort< std::vector< std::pair< CLAM::TData, CLAM::TData > > >, CLAM::OutPort< Segment >, CLAM::OutPort< DiscontinuousSegmentation >, CLAM::OutPort< MIDISong >, CLAM::OutPort< SpectralPeakArray >, CLAM::OutPort< LPModel >, CLAM::OutPort< Frame >, CLAM::OutPort< Fundamental >, CLAM::OutPort< std::vector< CLAM::TData > >, CLAM::OutPort< Spectrum >, CLAM::OutPort< Audio >, CLAM::OutPort< MelSpectrum >, CLAM::OutPortPublisher< Token >, CLAM::OutPortPublisher< TData >, CLAM::OutPortPublisher< SpectralPeakArray >, CLAM::OutPortPublisher< Fundamental >, and CLAM::OutPortPublisher< Spectrum >.

Referenced by ~OutPortBase().

void CLAM::OutPortBase::UnsetPublisher ( )

Definition at line 69 of file OutPort.cxx.

References mPublisher.

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

Member Data Documentation

std::string CLAM::OutPortBase::mName

protected

Definition at line 67 of file OutPort.hxx.

Referenced by GetName().

Processing* CLAM::OutPortBase::mProcessing

protected

Definition at line 68 of file OutPort.hxx.

Referenced by GetProcessing(), and ~OutPortBase().

OutPortBase* CLAM::OutPortBase::mPublisher

protected

Definition at line 69 of file OutPort.hxx.

Referenced by SetPublisher(), UnsetPublisher(), and ~OutPortBase().

InPortsList CLAM::OutPortBase::mVisuallyConnectedPorts

protected

Definition at line 66 of file OutPort.hxx.

Referenced by BeginVisuallyConnectedInPorts(), CLAM::OutPortPublisher< Spectrum >::ConnectToIn(), CLAM::OutPortPublisher< Spectrum >::DisconnectFromAll(), CLAM::OutPortPublisher< Spectrum >::DisconnectFromIn(), EndVisuallyConnectedInPorts(), and HasConnections().

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