svcore  1.9
CSVFeatureWriter Class Reference

#include <CSVFeatureWriter.h>

Inheritance diagram for CSVFeatureWriter:
Collaboration diagram for CSVFeatureWriter:

List of all members.

Public Types

typedef vector< ParameterParameterList

Public Member Functions

 CSVFeatureWriter ()
virtual ~CSVFeatureWriter ()
virtual ParameterList getSupportedParameters () const
virtual void setParameters (map< string, string > &params)
virtual void write (QString trackid, const Transform &transform, const Vamp::Plugin::OutputDescriptor &output, const Vamp::Plugin::FeatureList &features, std::string summaryType="")
virtual QString getWriterTag () const
virtual void testOutputFile (QString trackId, TransformId 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 ()
virtual void setTrackMetadata (QString, TrackMetadata)

Protected Types

enum  FileWriteSupport { SupportOneFilePerTrackTransform = 1, SupportOneFilePerTrack = 2, SupportOneFileTotal = 4 }
typedef pair< QString,
TransformId
TrackTransformPair
typedef map
< TrackTransformPair, QFile * > 
FileMap
typedef map< QFile
*, QTextStream * > 
FileStreamMap

Protected Member Functions

QTextStream * getOutputStream (QString, TransformId)
QString getOutputFilename (QString, TransformId)
QFile * getOutputFile (QString, TransformId)
virtual void reviewFileForAppending (QString)

Protected Attributes

FileMap m_files
FileStreamMap m_streams
QTextStream * m_prevstream
int m_support
QString m_extension
QString m_baseDir
bool m_manyFiles
QString m_singleFileName
bool m_stdout
bool m_append
bool m_force

Private Attributes

QString m_separator
bool m_sampleTiming
QString m_prevPrintedTrackId

Detailed Description

Definition at line 37 of file CSVFeatureWriter.h.


Member Typedef Documentation

typedef pair<QString, TransformId> FileFeatureWriter::TrackTransformPair [protected, inherited]

Definition at line 59 of file FileFeatureWriter.h.

typedef map<TrackTransformPair, QFile *> FileFeatureWriter::FileMap [protected, inherited]

Definition at line 60 of file FileFeatureWriter.h.

typedef map<QFile *, QTextStream *> FileFeatureWriter::FileStreamMap [protected, inherited]

Definition at line 61 of file FileFeatureWriter.h.

typedef vector<Parameter> FeatureWriter::ParameterList [inherited]

Definition at line 47 of file FeatureWriter.h.


Member Enumeration Documentation

enum FileFeatureWriter::FileWriteSupport [protected, inherited]
Enumerator:
SupportOneFilePerTrackTransform 
SupportOneFilePerTrack 
SupportOneFileTotal 

Definition at line 50 of file FileFeatureWriter.h.


Constructor & Destructor Documentation

Definition at line 39 of file CSVFeatureWriter.cpp.


Member Function Documentation

void CSVFeatureWriter::setParameters ( map< string, string > &  params) [virtual]

Reimplemented from FileFeatureWriter.

Definition at line 63 of file CSVFeatureWriter.cpp.

References m_sampleTiming, m_separator, and SVDEBUG.

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

Implements FeatureWriter.

Definition at line 52 of file CSVFeatureWriter.h.

void FileFeatureWriter::testOutputFile ( QString  ,
TransformId   
) [virtual, inherited]

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

Definition at line 227 of file FileFeatureWriter.cpp.

References FileFeatureWriter::getOutputFilename(), FileFeatureWriter::m_singleFileName, and FileFeatureWriter::m_stdout.

void FileFeatureWriter::flush ( ) [virtual, inherited]

Reimplemented from FeatureWriter.

Definition at line 321 of file FileFeatureWriter.cpp.

References FileFeatureWriter::m_prevstream.

QTextStream * FileFeatureWriter::getOutputStream ( QString  trackId,
TransformId  transformId 
) [protected, inherited]
virtual void FileFeatureWriter::reviewFileForAppending ( QString  ) [inline, protected, virtual, inherited]

Reimplemented in RDFFeatureWriter.

Definition at line 70 of file FileFeatureWriter.h.

Referenced by FileFeatureWriter::getOutputFile().

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

Reimplemented in RDFFeatureWriter.

Definition at line 60 of file FeatureWriter.h.


Member Data Documentation

QString CSVFeatureWriter::m_separator [private]

Definition at line 55 of file CSVFeatureWriter.h.

Referenced by setParameters(), and write().

Definition at line 56 of file CSVFeatureWriter.h.

Referenced by setParameters(), and write().

Definition at line 57 of file CSVFeatureWriter.h.

Referenced by write().

QString FileFeatureWriter::m_extension [protected, inherited]
QString FileFeatureWriter::m_baseDir [protected, inherited]
bool FileFeatureWriter::m_force [protected, inherited]

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