CLAM::OutPortPublisher< Token > Class Template Reference

#include <OutPortPublisher.hxx>

Inheritance diagram for CLAM::OutPortPublisher< Token >:

List of all members.

---

Detailed Description

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

Definition at line 31 of file OutPortPublisher.hxx.

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 ()
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
Static Public Member Functions
static Token &	GetLastWrittenData (OutPortBase &, int offset=0)
Protected Attributes
ProperOutPort *	mPublishedOutPort

---

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

(

)

[inline, virtual]

Definition at line 41 of file OutPortPublisher.hxx.

---

Member Function Documentation

template<typename Token>

void CLAM::OutPortPublisher< Token >::DisconnectFromAll

(

)

[inline, virtual]

Implements CLAM::OutPortBase.

Definition at line 58 of file OutPortPublisher.hxx.

template<typename Token>

void CLAM::OutPortPublisher< Token >::ConnectToIn

(

InPortBase &

in

)

[inline, virtual]

Implements CLAM::OutPortBase.

Definition at line 64 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 >::UnpublishOutPort

(

)

[inline, virtual]

Implements CLAM::OutPortBase.

Definition at line 85 of file OutPortPublisher.hxx.

template<typename Token>

void CLAM::OutPortPublisher< Token >::ConcretePublishOutPort

(

ProperOutPort &

out

)

[inline]

Definition at line 89 of file OutPortPublisher.hxx.

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

template<typename Token>

void CLAM::OutPortPublisher< Token >::DisconnectFromIn

(

InPortBase &

in

)

[inline, virtual]

Implements CLAM::OutPortBase.

Definition at line 95 of file OutPortPublisher.hxx.

template<typename Token>

bool CLAM::OutPortPublisher< Token >::IsConnectableTo

(

InPortBase &

in

)

[inline, virtual]

Implements CLAM::OutPortBase.

Definition at line 103 of file OutPortPublisher.hxx.

template<typename Token>

bool CLAM::OutPortPublisher< Token >::IsVisuallyConnectedTo

(

InPortBase &

in

)

[inline, virtual]

Implements CLAM::OutPortBase.

Definition at line 110 of file OutPortPublisher.hxx.

template<typename Token>

Token& CLAM::OutPortPublisher< Token >::GetData

(

int

offset = 0

)

[inline]

Definition at line 117 of file OutPortPublisher.hxx.

template<typename Token>

int CLAM::OutPortPublisher< Token >::GetSize

(

)

[inline, virtual]

Implements CLAM::OutPortBase.

Definition at line 124 of file OutPortPublisher.hxx.

template<typename Token>

void CLAM::OutPortPublisher< Token >::SetSize

(

int

newSize

)

[inline, virtual]

Implements CLAM::OutPortBase.

Definition at line 131 of file OutPortPublisher.hxx.

template<typename Token>

int CLAM::OutPortPublisher< Token >::GetHop

(

)

[inline, virtual]

Implements CLAM::OutPortBase.

Definition at line 138 of file OutPortPublisher.hxx.

template<typename Token>

void CLAM::OutPortPublisher< Token >::SetHop

(

int

newHop

)

[inline, virtual]

Implements CLAM::OutPortBase.

Definition at line 145 of file OutPortPublisher.hxx.

template<typename Token>

bool CLAM::OutPortPublisher< Token >::CanProduce

(

)

[inline, virtual]

Implements CLAM::OutPortBase.

Definition at line 153 of file OutPortPublisher.hxx.

template<typename Token>

void CLAM::OutPortPublisher< Token >::CenterEvenRegions

(

)

[inline, virtual]

Implements CLAM::OutPortBase.

Definition at line 160 of file OutPortPublisher.hxx.

template<typename Token>

Token& CLAM::OutPortPublisher< Token >::GetLastWrittenData

(

int

offset = 0

)

[inline]

Definition at line 166 of file OutPortPublisher.hxx.

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

template<class Token>

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

Definition at line 183 of file OutPortPublisher.hxx.

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

template<typename Token>

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

(

)

const [inline, virtual]

Implements CLAM::OutPortBase.

Definition at line 172 of file OutPortPublisher.hxx.

---

Member Data Documentation

template<typename Token>

ProperOutPort* CLAM::OutPortPublisher< Token >::mPublishedOutPort [protected]

Definition at line 175 of file OutPortPublisher.hxx.

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

---

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

• OutPortPublisher.hxx