SinkProxyBase Class Reference

#include <sinkproxy.h>

Inheritance diagram for SinkProxyBase:

Public Member Functions
	SinkProxyBase (Algorithm *parent=0, const std::string &name="unnamed")
	SinkProxyBase (const std::string &name)
	~SinkProxyBase ()
const void *	buffer () const
void *	buffer ()
void	setId (ReaderID id)
void	setSource (SourceBase *source)
void	acquire ()
virtual bool	acquire (int n)
virtual int	acquireSize () const
void	release ()
virtual void	release (int n)
virtual int	releaseSize () const
void	updateProxiedSink ()
void	detach ()
Public Member Functions inherited from SinkBase
	SinkBase (Algorithm *parent=0, const std::string &name="unnamed")
	SinkBase (const std::string &name)
	~SinkBase ()
const SourceBase *	source () const
SourceBase *	source ()
ReaderID	id () const
virtual const void *	getTokens () const =0
virtual const void *	getFirstToken () const =0
Public Member Functions inherited from Connector
	Connector (Algorithm *parent=0, const std::string &name="Unnamed")
	Connector (const std::string &name)
const Algorithm *	parent () const
Algorithm *	parent ()
void	setParent (Algorithm *parent)
std::string	parentName () const
std::string	fullName () const
Public Member Functions inherited from TypeProxy
	TypeProxy ()
	TypeProxy (const std::string &name)
virtual	~TypeProxy ()
const std::string &	name () const
void	setName (const std::string &name)
void	checkType (const std::type_info &received, const std::type_info &expected) const
template<typename Type >
void	checkType () const
void	checkSameTypeAs (const TypeProxy &obj) const
void	checkVectorSameTypeAs (const TypeProxy &obj) const
virtual const std::type_info &	typeInfo () const =0
virtual const std::type_info &	vectorTypeInfo () const =0
Public Member Functions inherited from StreamConnector
	StreamConnector ()
virtual	~StreamConnector ()
virtual int	available () const =0
bool	acquire ()
void	release ()
virtual void	setAcquireSize (int n)
virtual void	setReleaseSize (int n)
virtual void	reset ()=0

Protected Member Functions
void	attach (SinkBase *sink)
void	detach (SinkBase *sink)
Protected Member Functions inherited from SinkBase
virtual void	connect (SourceBase &source)
virtual void	disconnect (SourceBase &source)
void	attachProxy (SinkProxyBase *sproxy)
void	detachProxy (SinkProxyBase *sproxy)

Protected Attributes
SinkBase *	_proxiedSink
Protected Attributes inherited from SinkBase
SourceBase *	_source
ReaderID	_id
SinkProxyBase *	_sproxy
Protected Attributes inherited from Connector
Algorithm *	_parent
Protected Attributes inherited from TypeProxy
std::string	_name
Protected Attributes inherited from StreamConnector
int	_acquireSize
int	_releaseSize

Friends
void	attach (SinkProxyBase &proxy, SinkBase &innerSink)
void	detach (SinkProxyBase &proxy, SinkBase &innerSink)

Constructor & Destructor Documentation

SinkProxyBase() [1/2]

SinkProxyBase ( Algorithm *  parent = 0, const std::string &  name = "unnamed"  )

inline

SinkProxyBase() [2/2]

SinkProxyBase ( const std::string &  name )

inline

~SinkProxyBase()

~SinkProxyBase ( )

inline

References SinkProxyBase::_proxiedSink, essentia::streaming::detach(), E_DEBUG, essentia::EMemory, and Connector::fullName().

Member Function Documentation

acquire() [1/2]

void acquire ( )

inline

References StreamConnector::acquire().

Referenced by Sink< TokenType >::acquire().

acquire() [2/2]

virtual bool acquire ( int  n )

inlinevirtual

Acquire (consume) the requested number of tokens.

Implements StreamConnector.

References Connector::fullName().

acquireSize()

virtual int acquireSize ( ) const

inlinevirtual

Returns the default number of tokens to be acquired.

Reimplemented from StreamConnector.

References SinkProxyBase::_proxiedSink, StreamConnector::acquireSize(), and Connector::fullName().

attach()

void attach ( SinkBase *  sink )

inlineprotected

Set to which SourceBase we should proxy the SourceBase calls

References SinkProxyBase::_proxiedSink, TypeProxy::checkSameTypeAs(), E_DEBUG, essentia::EConnectors, and Connector::fullName().

buffer() [1/2]

void* buffer ( )

inline

References SinkBase::_source, SourceBase::buffer(), and Connector::fullName().

buffer() [2/2]

const void* buffer ( ) const

inline

References SinkBase::_source, SourceBase::buffer(), and Connector::fullName().

Referenced by Sink< TokenType >::buffer(), and SinkProxy< TokenType >::buffer().

detach() [1/2]

void detach ( )

inline

References SinkProxyBase::_proxiedSink, and essentia::streaming::detach().

detach() [2/2]

void detach ( SinkBase *  sink )

inlineprotected

References SinkProxyBase::_proxiedSink, E_DEBUG, E_WARNING, essentia::EConnectors, and Connector::fullName().

release() [1/2]

void release ( )

inline

References StreamConnector::release().

Referenced by Sink< TokenType >::release().

release() [2/2]

virtual void release ( int  n )

inlinevirtual

Release (produce) the requested number of tokens.

Implements StreamConnector.

References Connector::fullName().

releaseSize()

virtual int releaseSize ( ) const

inlinevirtual

Returns the default number of tokens to be released.

Reimplemented from StreamConnector.

References SinkProxyBase::_proxiedSink, Connector::fullName(), and StreamConnector::releaseSize().

setId()

void setId ( ReaderID  id )

inlinevirtual

Reimplemented from SinkBase.

References SinkProxyBase::_proxiedSink, and SinkBase::setId().

setSource()

void setSource ( SourceBase *  source )

inlinevirtual

Reimplemented from SinkBase.

References SinkProxyBase::_proxiedSink, SinkBase::setSource(), and SinkBase::source().

updateProxiedSink()

void updateProxiedSink ( )

inline

References SinkBase::_id, SinkProxyBase::_proxiedSink, SinkBase::_source, E_DEBUG, essentia::EConnectors, Connector::fullName(), SinkBase::setId(), SinkBase::setSource(), and SinkProxyBase::updateProxiedSink().

Referenced by SinkProxy< TokenType >::connect(), and SinkProxyBase::updateProxiedSink().

Friends And Related Function Documentation

attach

void attach ( SinkProxyBase &  proxy, SinkBase &  innerSink  )

friend

detach

void detach ( SinkProxyBase &  proxy, SinkBase &  innerSink  )

friend

Member Data Documentation

_proxiedSink

SinkBase* _proxiedSink

protected

Referenced by SinkProxyBase::acquireSize(), SinkProxyBase::attach(), SinkProxyBase::detach(), SinkProxy< TokenType >::disconnect(), SinkProxyBase::releaseSize(), SinkProxyBase::setId(), SinkProxyBase::setSource(), SinkProxyBase::updateProxiedSink(), and SinkProxyBase::~SinkProxyBase().

---

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

• src/essentia/streaming/sinkproxy.h