CLAM::OutPortPublisher< Token > Class Template Reference

#include <OutPortPublisher.hxx>

List of all members.

Public Member Functions
	OutPortPublisher (const std::string &name="unnamed out port publisher", Processing *proc=0)
virtual	~OutPortPublisher ()
void	DisconnectFromAll ()
void	ConnectToIn (InPortBase &in)
void	PublishOutPort (OutPortBase &out)
void	UnpublishOutPort ()
bool	IsPublisher () const
void	ConcretePublishOutPort (ProperOutPort &out)
void	DisconnectFromIn (InPortBase &in)
bool	IsConnectableTo (InPortBase &in)
bool	IsVisuallyConnectedTo (InPortBase &in)
Token &	GetData (int offset=0)
int	GetSize ()
void	SetSize (int newSize)
int	GetHop ()
void	SetHop (int newHop)
bool	CanProduce ()
void	CenterEvenRegions ()
Token &	GetLastWrittenData (int offset=0)
virtual const std::type_info &	GetTypeId () const
Public Member Functions inherited from CLAM::OutPortBase
	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 ()
bool	HasConnections ()
void	SetPublisher (OutPortBase &publisher)
void	UnsetPublisher ()

Protected Attributes
ProperOutPort *	mPublishedOutPort
Protected Attributes inherited from CLAM::OutPortBase
InPortsList	mVisuallyConnectedPorts
std::string	mName
Processing *	mProcessing
OutPortBase *	mPublisher

Additional Inherited Members
Public Types inherited from CLAM::OutPortBase
typedef std::list< InPortBase * >	InPortsList

---

Detailed Description

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

Definition at line 31 of file OutPortPublisher.hxx.

---

Constructor & Destructor Documentation

template<typename Token>

CLAM::OutPortPublisher< Token >::OutPortPublisher ( const std::string &  name = "unnamed out port publisher", Processing *  proc = 0  )

inline

Definition at line 35 of file OutPortPublisher.hxx.

template<typename Token>

virtual CLAM::OutPortPublisher< Token >::~OutPortPublisher ( )

inlinevirtual

Definition at line 41 of file OutPortPublisher.hxx.

---

Member Function Documentation

template<typename Token>

bool CLAM::OutPortPublisher< Token >::CanProduce ( )

inlinevirtual

Implements CLAM::OutPortBase.

Definition at line 157 of file OutPortPublisher.hxx.

template<typename Token>

void CLAM::OutPortPublisher< Token >::CenterEvenRegions ( )

inlinevirtual

Implements CLAM::OutPortBase.

Definition at line 164 of file OutPortPublisher.hxx.

template<typename Token>

void CLAM::OutPortPublisher< Token >::ConcretePublishOutPort ( ProperOutPort &  out )

inline

Definition at line 93 of file OutPortPublisher.hxx.

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

template<typename Token>

void CLAM::OutPortPublisher< Token >::ConnectToIn ( InPortBase &  in )

inlinevirtual

Implements CLAM::OutPortBase.

Definition at line 64 of file OutPortPublisher.hxx.

template<typename Token>

void CLAM::OutPortPublisher< Token >::DisconnectFromAll ( )

inlinevirtual

Implements CLAM::OutPortBase.

Definition at line 58 of file OutPortPublisher.hxx.

template<typename Token>

void CLAM::OutPortPublisher< Token >::DisconnectFromIn ( InPortBase &  in )

inlinevirtual

Implements CLAM::OutPortBase.

Definition at line 99 of file OutPortPublisher.hxx.

template<typename Token>

Token& CLAM::OutPortPublisher< Token >::GetData ( int  offset = 0 )

inline

Definition at line 121 of file OutPortPublisher.hxx.

template<typename Token>

int CLAM::OutPortPublisher< Token >::GetHop ( )

inlinevirtual

Implements CLAM::OutPortBase.

Definition at line 142 of file OutPortPublisher.hxx.

template<typename Token>

Token& CLAM::OutPortPublisher< Token >::GetLastWrittenData ( int  offset = 0 )

inline

Definition at line 170 of file OutPortPublisher.hxx.

template<typename Token>

int CLAM::OutPortPublisher< Token >::GetSize ( )

inlinevirtual

Implements CLAM::OutPortBase.

Definition at line 128 of file OutPortPublisher.hxx.

template<typename Token>

virtual const std::type_info& CLAM::OutPortPublisher< Token >::GetTypeId ( ) const

inlinevirtual

Implements CLAM::OutPortBase.

Definition at line 175 of file OutPortPublisher.hxx.

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

template<typename Token>

bool CLAM::OutPortPublisher< Token >::IsConnectableTo ( InPortBase &  in )

inlinevirtual

Implements CLAM::OutPortBase.

Definition at line 107 of file OutPortPublisher.hxx.

template<typename Token>

bool CLAM::OutPortPublisher< Token >::IsPublisher ( ) const

inlinevirtual

Reimplemented from CLAM::OutPortBase.

Definition at line 88 of file OutPortPublisher.hxx.

template<typename Token>

bool CLAM::OutPortPublisher< Token >::IsVisuallyConnectedTo ( InPortBase &  in )

inlinevirtual

Implements CLAM::OutPortBase.

Definition at line 114 of file OutPortPublisher.hxx.

template<typename Token>

void CLAM::OutPortPublisher< Token >::PublishOutPort ( OutPortBase &  out )

inline

Definition at line 72 of file OutPortPublisher.hxx.

template<typename Token>

void CLAM::OutPortPublisher< Token >::SetHop ( int  newHop )

inlinevirtual

Implements CLAM::OutPortBase.

Definition at line 149 of file OutPortPublisher.hxx.

template<typename Token>

void CLAM::OutPortPublisher< Token >::SetSize ( int  newSize )

inlinevirtual

Implements CLAM::OutPortBase.

Definition at line 135 of file OutPortPublisher.hxx.

template<typename Token>

void CLAM::OutPortPublisher< Token >::UnpublishOutPort ( )

inlinevirtual

Implements CLAM::OutPortBase.

Definition at line 84 of file OutPortPublisher.hxx.

---

Member Data Documentation

template<typename Token>

ProperOutPort* CLAM::OutPortPublisher< Token >::mPublishedOutPort

protected

Definition at line 178 of file OutPortPublisher.hxx.

Referenced by CLAM::OutPortPublisher< Spectrum >::CanProduce(), CLAM::OutPortPublisher< Spectrum >::CenterEvenRegions(), CLAM::OutPortPublisher< Spectrum >::ConcretePublishOutPort(), CLAM::OutPortPublisher< Spectrum >::ConnectToIn(), CLAM::OutPortPublisher< Spectrum >::DisconnectFromAll(), CLAM::OutPortPublisher< Spectrum >::DisconnectFromIn(), CLAM::OutPortPublisher< Spectrum >::GetData(), CLAM::OutPortPublisher< Spectrum >::GetHop(), CLAM::OutPortPublisher< Spectrum >::GetLastWrittenData(), CLAM::OutPortPublisher< Spectrum >::GetSize(), CLAM::OutPortPublisher< Spectrum >::IsConnectableTo(), CLAM::OutPortPublisher< Spectrum >::IsVisuallyConnectedTo(), CLAM::OutPortPublisher< Spectrum >::SetHop(), CLAM::OutPortPublisher< Spectrum >::SetSize(), CLAM::OutPortPublisher< Spectrum >::UnpublishOutPort(), and CLAM::OutPortPublisher< Spectrum >::~OutPortPublisher().

---

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

• OutPortPublisher.hxx