DiskWriter< T > Class Template Reference

#include <diskwriter.h>

Inheritance diagram for DiskWriter< T >:

Public Member Functions
	DiskWriter (const std::string &filename)
	~DiskWriter ()
void	declareParameters ()
AlgorithmStatus	process ()
Public Member Functions inherited from Algorithm
	Algorithm ()
virtual	~Algorithm ()
SinkBase &	input (const std::string &name)
SourceBase &	output (const std::string &name)
SinkBase &	input (int idx)
SourceBase &	output (int idx)
const InputMap &	inputs () const
const OutputMap &	outputs () const
std::vector< std::string >	inputNames () const
std::vector< std::string >	outputNames () const
virtual void	shouldStop (bool stop)
virtual bool	shouldStop () const
void	disconnectAll ()
AlgorithmStatus	acquireData ()
void	releaseData ()
virtual void	reset ()
Public Member Functions inherited from Configurable
virtual	~Configurable ()
const std::string &	name () const
void	setName (const std::string &name)
virtual void	setParameters (const ParameterMap &params)
virtual void	configure (const ParameterMap &params)
virtual void	configure ()
const ParameterMap &	defaultParameters () const
const Parameter &	parameter (const std::string &key) const

Protected Attributes
Sink< T >	_data
std::string	_filename
std::ostream *	_out
Protected Attributes inherited from Algorithm
bool	_shouldStop
OutputMap	_outputs
InputMap	_inputs
int	nProcess
Protected Attributes inherited from Configurable
std::string	_name
ParameterMap	_params
ParameterMap	_defaultParams

Additional Inherited Members
Public Types inherited from Algorithm
typedef OrderedMap< SinkBase >	InputMap
typedef OrderedMap< SourceBase >	OutputMap
Public Attributes inherited from Algorithm
DescriptionMap	inputDescription
DescriptionMap	outputDescription
Public Attributes inherited from Configurable
DescriptionMap	parameterDescription
DescriptionMap	parameterRange
Static Public Attributes inherited from Algorithm
static const std::string	processingMode
Protected Member Functions inherited from Algorithm
void	declareInput (SinkBase &sink, const std::string &name, const std::string &desc)
void	declareInput (SinkBase &sink, int n, const std::string &name, const std::string &desc)
void	declareInput (SinkBase &sink, int acquireSize, int releaseSize, const std::string &name, const std::string &desc)
void	declareOutput (SourceBase &source, const std::string &name, const std::string &desc)
void	declareOutput (SourceBase &source, int n, const std::string &name, const std::string &desc)
void	declareOutput (SourceBase &source, int acquireSize, int releaseSize, const std::string &name, const std::string &desc)
Protected Member Functions inherited from Configurable
void	declareParameter (const std::string &name, const std::string &desc, const std::string &range, const Parameter &defaultValue)

Constructor & Destructor Documentation

DiskWriter()

DiskWriter ( const std::string &  filename )

inline

References DiskWriter< T >::_data, DiskWriter< T >::_filename, Configurable::_name, DiskWriter< T >::_out, and Algorithm::declareInput().

~DiskWriter()

~DiskWriter ( )

inline

References DiskWriter< T >::_out.

Member Function Documentation

declareParameters()

void declareParameters ( )

inlinevirtual

Declare the parameters that this Configurable can accept. You have to implement this method in derived classes, even though you don't need any parameters. In that case, just define it as empty.

In this method you should only be calling the declareParameter method, once for each parameter, with optional default values.

Implements Configurable.

process()

AlgorithmStatus process ( )

inlinevirtual

Implements Algorithm.

References DiskWriter< T >::_data, DiskWriter< T >::_out, Algorithm::acquireData(), EXEC_DEBUG, Sink< TokenType >::firstToken(), essentia::streaming::OK, and Algorithm::releaseData().

Member Data Documentation

_data

Sink<T> _data

protected

Referenced by DiskWriter< T >::DiskWriter(), and DiskWriter< T >::process().

_filename

std::string _filename

protected

Referenced by DiskWriter< T >::DiskWriter().

_out

std::ostream* _out

protected

Referenced by DiskWriter< T >::DiskWriter(), DiskWriter< T >::process(), and DiskWriter< T >::~DiskWriter().

---

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

• src/essentia/streaming/algorithms/diskwriter.h