svcore  1.9
FeatureWriter Class Reference

#include <FeatureWriter.h>

Inheritance diagram for FeatureWriter:

List of all members.

Classes

class  FailedToOpenOutputStream
struct  Parameter
struct  TrackMetadata

Public Types

typedef vector< ParameterParameterList

Public Member Functions

virtual ~FeatureWriter ()
virtual ParameterList getSupportedParameters () const
virtual void setParameters (map< string, string > &)
virtual void setTrackMetadata (QString, TrackMetadata)
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.
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

Definition at line 47 of file FeatureWriter.h.


Constructor & Destructor Documentation

virtual FeatureWriter::~FeatureWriter ( ) [inline, virtual]

Definition at line 40 of file FeatureWriter.h.


Member Function Documentation

virtual ParameterList FeatureWriter::getSupportedParameters ( ) const [inline, virtual]

Reimplemented in RDFFeatureWriter, CSVFeatureWriter, and FileFeatureWriter.

Definition at line 48 of file FeatureWriter.h.

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

Reimplemented in RDFFeatureWriter, CSVFeatureWriter, and FileFeatureWriter.

Definition at line 52 of file FeatureWriter.h.

virtual void FeatureWriter::setTrackMetadata ( QString  ,
TrackMetadata   
) [inline, virtual]

Reimplemented in RDFFeatureWriter.

Definition at line 60 of file FeatureWriter.h.

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.

virtual void FeatureWriter::testOutputFile ( QString  ,
TransformId   
) [inline, virtual]

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 96 of file FeatureWriter.h.

virtual void FeatureWriter::flush ( ) [inline, virtual]

Reimplemented in FileFeatureWriter.

Definition at line 98 of file FeatureWriter.h.

virtual void FeatureWriter::finish ( ) [pure virtual]

Implemented in RDFFeatureWriter, and FileFeatureWriter.

virtual QString FeatureWriter::getWriterTag ( ) const [pure virtual]

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