Essentia  2.1-beta6-dev
Public Member Functions | Private Member Functions | List of all members
SourceProxy< TokenType > Class Template Reference

#include <sourceproxy.h>

Inheritance diagram for SourceProxy< TokenType >:
SourceProxyBase SourceBase Connector TypeProxy StreamConnector

Public Member Functions

 SourceProxy (Algorithm *parent=0, const std::string &name="unnamed")
 
 SourceProxy (const std::string &name)
 
 ~SourceProxy ()
 
const MultiRateBuffer< TokenType > & typedBuffer () const
 
MultiRateBuffer< TokenType > & typedBuffer ()
 
ReaderID addReader ()
 
void removeReader (ReaderID id)
 
virtual void * getTokens ()
 
virtual void * getFirstToken ()
 
virtual int available () const
 
int totalProduced () const
 
virtual void reset ()
 
- Public Member Functions inherited from SourceProxyBase
 SourceProxyBase (Algorithm *parent=0, const std::string &name="unnamed")
 
 SourceProxyBase (const std::string &name)
 
 ~SourceProxyBase ()
 
SourceBase * proxiedSource ()
 
const void * buffer () const
 
void * buffer ()
 
virtual void setBufferType (BufferUsage::BufferUsageType type)
 
virtual BufferInfo bufferInfo () const
 
virtual void setBufferInfo (const BufferInfo &info)
 
void acquire ()
 
virtual bool acquire (int n)
 
virtual int acquireSize () const
 
void release ()
 
virtual void release (int n)
 
virtual int releaseSize () const
 
void detach ()
 
virtual void connect (SinkBase &sink)
 
virtual void disconnect (SinkBase &sink)
 
- Public Member Functions inherited from SourceBase
 SourceBase (Algorithm *parent=0, const std::string &name="unnamed")
 
 SourceBase (const std::string &name)
 
 ~SourceBase ()
 
const std::vector< SinkBase * > & sinks () const
 
std::vector< SinkBase * > & sinks ()
 
bool isProxied () const
 
const std::vector< SinkBase * > & proxiedSinks () const
 
template<typename TokenType >
void push (const TokenType &value)
 
- 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
 
- Public Member Functions inherited from StreamConnector
 StreamConnector ()
 
virtual ~StreamConnector ()
 
bool acquire ()
 
void release ()
 
virtual void setAcquireSize (int n)
 
virtual void setReleaseSize (int n)
 

Private Member Functions

virtual const std::type_info & typeInfo () const
 
virtual const std::type_info & vectorTypeInfo () const
 

Additional Inherited Members

- Protected Member Functions inherited from SourceProxyBase
void attach (SourceBase *source)
 
void detach (SourceBase *source)
 
- Protected Member Functions inherited from SourceBase
void attachProxy (SourceProxyBase *sproxy)
 
void detachProxy (SourceProxyBase *sproxy)
 
- Protected Attributes inherited from SourceProxyBase
SourceBase * _proxiedSource
 
- Protected Attributes inherited from SourceBase
std::vector< SinkBase * > _sinks
 
SourceProxyBase * _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
 

Constructor & Destructor Documentation

◆ SourceProxy() [1/2]

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

◆ SourceProxy() [2/2]

SourceProxy ( const std::string &  name)
inline

◆ ~SourceProxy()

~SourceProxy ( )
inline

Member Function Documentation

◆ addReader()

ReaderID addReader ( )
inlinevirtual

Implements SourceBase.

References SourceBase::_sinks.

◆ available()

virtual int available ( ) const
inlinevirtual

Returns how many tokens are available in the stream.

Implements StreamConnector.

References MultiRateBuffer< T >::availableForWrite(), and SourceProxy< TokenType >::typedBuffer().

◆ getFirstToken()

virtual void* getFirstToken ( )
inlinevirtual

Implements SourceBase.

References Connector::fullName().

◆ getTokens()

virtual void* getTokens ( )
inlinevirtual

Implements SourceBase.

References Connector::fullName().

◆ removeReader()

void removeReader ( ReaderID  id)
inlinevirtual

Implements SourceBase.

◆ reset()

virtual void reset ( )
inlinevirtual

Resets the state of this StreamConnector

Implements StreamConnector.

References SourceProxyBase::_proxiedSource, and StreamConnector::reset().

◆ totalProduced()

int totalProduced ( ) const
inlinevirtual

Implements SourceBase.

References SourceProxyBase::_proxiedSource, Connector::fullName(), and SourceBase::totalProduced().

◆ typedBuffer() [1/2]

MultiRateBuffer<TokenType>& typedBuffer ( )
inline

References SourceProxyBase::buffer().

◆ typedBuffer() [2/2]

const MultiRateBuffer<TokenType>& typedBuffer ( ) const
inline

References SourceProxyBase::buffer().

Referenced by SourceProxy< TokenType >::available().

◆ typeInfo()

virtual const std::type_info& typeInfo ( ) const
inlineprivatevirtual

Implements TypeProxy.

◆ vectorTypeInfo()

virtual const std::type_info& vectorTypeInfo ( ) const
inlineprivatevirtual

Implements TypeProxy.

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