svcore  1.9
Classes | Public Types | Public Member Functions | List of all members
FeatureWriter Class Referenceabstract

#include <FeatureWriter.h>

Inheritance diagram for FeatureWriter:
Inheritance graph
[legend]

Classes

class  FailedToOpenOutputStream
 
struct  Parameter
 
struct  TrackMetadata
 

Public Types

typedef vector< Parameter > ParameterList
 

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. 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

◆ ParameterList

typedef vector<Parameter> FeatureWriter::ParameterList

Definition at line 47 of file FeatureWriter.h.

Constructor & Destructor Documentation

◆ ~FeatureWriter()

virtual FeatureWriter::~FeatureWriter ( )
inlinevirtual

Definition at line 40 of file FeatureWriter.h.

Member Function Documentation

◆ getSupportedParameters()

virtual ParameterList FeatureWriter::getSupportedParameters ( ) const
inlinevirtual

Reimplemented in RDFFeatureWriter, CSVFeatureWriter, and FileFeatureWriter.

Definition at line 48 of file FeatureWriter.h.

◆ setParameters()

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

Reimplemented in RDFFeatureWriter, CSVFeatureWriter, and FileFeatureWriter.

Definition at line 52 of file FeatureWriter.h.

◆ setTrackMetadata()

virtual void FeatureWriter::setTrackMetadata ( QString  ,
TrackMetadata   
)
inlinevirtual

Reimplemented in RDFFeatureWriter.

Definition at line 60 of file FeatureWriter.h.

◆ 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.

◆ testOutputFile()

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

◆ flush()

virtual void FeatureWriter::flush ( )
inlinevirtual

Reimplemented in FileFeatureWriter.

Definition at line 98 of file FeatureWriter.h.

◆ finish()

virtual void FeatureWriter::finish ( )
pure virtual

Implemented in RDFFeatureWriter, and FileFeatureWriter.

◆ getWriterTag()

virtual QString FeatureWriter::getWriterTag ( ) const
pure virtual

Implemented in RDFFeatureWriter, and CSVFeatureWriter.

Referenced by FileFeatureWriter::getOutputFilename().

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