#include <connector.h>
Public Member Functions | |
| 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 () |
| virtual bool | acquire (int n)=0 |
| void | release () |
| virtual void | release (int n)=0 |
| virtual int | acquireSize () const |
| virtual int | releaseSize () const |
| virtual void | setAcquireSize (int n) |
| virtual void | setReleaseSize (int n) |
| virtual void | reset ()=0 |
Protected Attributes | |
| Algorithm * | _parent |
| Protected Attributes inherited from TypeProxy | |
| std::string | _name |
| Protected Attributes inherited from StreamConnector | |
| int | _acquireSize |
| int | _releaseSize |
Detailed Description
This is the base class for connectors in Essentia. It is the highest-level class which is shared both by Sources and Sinks, and is a slightly better StreamConnector which has a parent Algorithm and is aware (through TypeProxy) of which type of data is supposed to flow through it.
Constructor & Destructor Documentation
◆ Connector() [1/2]
◆ Connector() [2/2]
|
inline |
Member Function Documentation
◆ fullName()
| std::string fullName | ( | ) | const |
Return a fully qualified name consisting of: "<Parent name>::<Connector name>".
Referenced by Sink< TokenType >::acquire(), SinkProxyBase::acquire(), SourceProxyBase::acquire(), SinkProxyBase::acquireSize(), SourceProxyBase::acquireSize(), SinkProxyBase::attach(), SourceProxyBase::attach(), Sink< TokenType >::available(), Sink< TokenType >::buffer(), SinkProxyBase::buffer(), SourceProxyBase::buffer(), SourceProxyBase::connect(), SinkProxy< TokenType >::connect(), SinkProxyBase::detach(), SourceProxyBase::detach(), SourceProxyBase::disconnect(), SourceProxy< TokenType >::getFirstToken(), SinkProxy< TokenType >::getFirstToken(), SourceProxy< TokenType >::getTokens(), SinkProxy< TokenType >::getTokens(), PhantomBuffer< T >::lastTokenProduced(), essentia::streaming::lastTokenProduced(), Sink< TokenType >::pop(), SourceBase::push(), Sink< TokenType >::release(), SinkProxyBase::release(), SourceProxyBase::release(), SinkProxyBase::releaseSize(), SourceProxyBase::releaseSize(), SourceProxy< TokenType >::totalProduced(), SinkProxyBase::updateProxiedSink(), SinkBase::~SinkBase(), SinkProxyBase::~SinkProxyBase(), and SourceProxyBase::~SourceProxyBase().
◆ parent() [1/2]
|
inline |
References Connector::_parent.
◆ parent() [2/2]
|
inline |
References Connector::_parent.
Referenced by Connector::setParent().
◆ parentName()
| std::string parentName | ( | ) | const |
Return parent's name if parent is set, "<NoParent>" otherwise.
◆ setParent()
|
inline |
References Connector::_parent, and Connector::parent().
Member Data Documentation
◆ _parent
|
protected |
Referenced by Connector::parent(), and Connector::setParent().
The documentation for this class was generated from the following file:
- src/essentia/connector.h
