#include <FeatureWriter.h>

Inheritance diagram for FeatureWriter:

Classes
class	FailedToOpenOutputStream

struct	Parameter

struct	TrackMetadata

Public Types
typedef vector< Parameter >	ParameterList

Public Member Functions
virtual	~FeatureWriter ()

virtual string	getDescription () const =0

virtual ParameterList	getSupportedParameters () const

virtual void	setParameters (map< string, string > &)

virtual void	setTrackMetadata (QString, TrackMetadata)

virtual void	setNofM (int, int)
	Notify the writer that we are about to start extraction for input file N of M (where N is 1..M). More...

virtual void	write (QString trackid, const Transform &transform, const Vamp::Plugin::OutputDescriptor &output, const Vamp::Plugin::FeatureList &features, std::string summaryType="")=0

virtual void	testOutputFile (QString, TransformId)
	Throw FailedToOpenOutputStream if we can already tell that we will be unable to write to the output file. More...

virtual void	flush ()

virtual void	finish ()=0

virtual QString	getWriterTag () const =0

Detailed Description

Definition at line 37 of file FeatureWriter.h.

Member Typedef Documentation

typedef vector<Parameter> FeatureWriter::ParameterList

Definition at line 51 of file FeatureWriter.h.

Constructor & Destructor Documentation

virtual FeatureWriter::~FeatureWriter ( )

inlinevirtual

Definition at line 40 of file FeatureWriter.h.

References getDescription().

Member Function Documentation

virtual string FeatureWriter::getDescription ( ) const

pure virtual

Implemented in RDFFeatureWriter, and CSVFeatureWriter.

Referenced by ~FeatureWriter().

virtual ParameterList FeatureWriter::getSupportedParameters ( ) const

inlinevirtual

Reimplemented in RDFFeatureWriter, CSVFeatureWriter, and FileFeatureWriter.

Definition at line 52 of file FeatureWriter.h.

virtual void FeatureWriter::setParameters ( map< string, string > & )

inlinevirtual

Reimplemented in RDFFeatureWriter, CSVFeatureWriter, and FileFeatureWriter.

Definition at line 56 of file FeatureWriter.h.

virtual void FeatureWriter::setTrackMetadata	(	QString	,
		TrackMetadata
	)

inlinevirtual

Reimplemented in RDFFeatureWriter.

Definition at line 65 of file FeatureWriter.h.

virtual void FeatureWriter::setNofM	(	int	,
		int
	)

inlinevirtual

Notify the writer that we are about to start extraction for input file N of M (where N is 1..M).

May be useful when writing multiple outputs into a single file where some syntactic element is needed to connect them.

Definition at line 93 of file FeatureWriter.h.

References write().

virtual void FeatureWriter::write	(	QString	trackid,
		const Transform &	transform,
		const Vamp::Plugin::OutputDescriptor &	output,
		const Vamp::Plugin::FeatureList &	features,
		std::string	summaryType = `""`
	)

pure virtual

Implemented in RDFFeatureWriter, and CSVFeatureWriter.

Referenced by setNofM().

virtual void FeatureWriter::testOutputFile	(	QString	,
		TransformId
	)

inlinevirtual

Throw FailedToOpenOutputStream if we can already tell that we will be unable to write to the output file.

This is called to test the output stream before processing begins. The writer may legitimately succeed here but still fail later – this is really an optimisation to ensure that easy-to-recognise failure cases fail early.

Reimplemented in FileFeatureWriter.

Definition at line 110 of file FeatureWriter.h.

virtual void FeatureWriter::flush ( )

inlinevirtual

Reimplemented in FileFeatureWriter.

Definition at line 112 of file FeatureWriter.h.

References finish(), and getWriterTag().

virtual void FeatureWriter::finish ( )

pure virtual

Implemented in RDFFeatureWriter, CSVFeatureWriter, and FileFeatureWriter.

Referenced by flush().

virtual QString FeatureWriter::getWriterTag ( ) const