svcore
1.9
|
#include <FileFeatureWriter.h>
Public Types | |
typedef vector< Parameter > | ParameterList |
Public Member Functions | |
virtual | ~FileFeatureWriter () |
virtual ParameterList | getSupportedParameters () const |
virtual void | setParameters (map< string, string > ¶ms) |
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) |
virtual void | write (QString trackid, const Transform &transform, const Vamp::Plugin::OutputDescriptor &output, const Vamp::Plugin::FeatureList &features, std::string summaryType="")=0 |
virtual QString | getWriterTag () const =0 |
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 | |
FileFeatureWriter (int support, QString extension) | |
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 |
Definition at line 37 of file FileFeatureWriter.h.
typedef pair<QString, TransformId> FileFeatureWriter::TrackTransformPair [protected] |
Definition at line 59 of file FileFeatureWriter.h.
typedef map<TrackTransformPair, QFile *> FileFeatureWriter::FileMap [protected] |
Definition at line 60 of file FileFeatureWriter.h.
typedef map<QFile *, QTextStream *> FileFeatureWriter::FileStreamMap [protected] |
Definition at line 61 of file FileFeatureWriter.h.
typedef vector<Parameter> FeatureWriter::ParameterList [inherited] |
Definition at line 47 of file FeatureWriter.h.
enum FileFeatureWriter::FileWriteSupport [protected] |
Definition at line 50 of file FileFeatureWriter.h.
FileFeatureWriter::~FileFeatureWriter | ( | ) | [virtual] |
Definition at line 54 of file FileFeatureWriter.cpp.
FileFeatureWriter::FileFeatureWriter | ( | int | support, |
QString | extension | ||
) | [protected] |
Definition at line 33 of file FileFeatureWriter.cpp.
References m_extension, m_manyFiles, m_singleFileName, m_support, SupportOneFilePerTrack, SupportOneFilePerTrackTransform, SupportOneFileTotal, and SVDEBUG.
FileFeatureWriter::ParameterList FileFeatureWriter::getSupportedParameters | ( | ) | const [virtual] |
Reimplemented from FeatureWriter.
Reimplemented in RDFFeatureWriter, and CSVFeatureWriter.
Definition at line 72 of file FileFeatureWriter.cpp.
References FeatureWriter::Parameter::description, FeatureWriter::Parameter::hasArg, m_support, FeatureWriter::Parameter::name, SupportOneFilePerTrack, SupportOneFilePerTrackTransform, and SupportOneFileTotal.
void FileFeatureWriter::setParameters | ( | map< string, string > & | params | ) | [virtual] |
Reimplemented from FeatureWriter.
Reimplemented in RDFFeatureWriter, and CSVFeatureWriter.
Definition at line 121 of file FileFeatureWriter.cpp.
References m_append, m_baseDir, m_force, m_manyFiles, m_singleFileName, m_stdout, m_support, SupportOneFilePerTrack, SupportOneFilePerTrackTransform, SupportOneFileTotal, and SVDEBUG.
void FileFeatureWriter::testOutputFile | ( | QString | , |
TransformId | |||
) | [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 from FeatureWriter.
Definition at line 227 of file FileFeatureWriter.cpp.
References getOutputFilename(), m_singleFileName, and m_stdout.
void FileFeatureWriter::flush | ( | ) | [virtual] |
Reimplemented from FeatureWriter.
Definition at line 321 of file FileFeatureWriter.cpp.
References m_prevstream.
void FileFeatureWriter::finish | ( | ) | [virtual] |
Implements FeatureWriter.
Reimplemented in RDFFeatureWriter.
Definition at line 330 of file FileFeatureWriter.cpp.
References m_files, m_prevstream, m_singleFileName, m_stdout, m_streams, and SVDEBUG.
QTextStream * FileFeatureWriter::getOutputStream | ( | QString | trackId, |
TransformId | transformId | ||
) | [protected] |
Definition at line 293 of file FileFeatureWriter.cpp.
References getOutputFile(), m_prevstream, m_stdout, and m_streams.
Referenced by CSVFeatureWriter::write(), and RDFFeatureWriter::write().
QString FileFeatureWriter::getOutputFilename | ( | QString | trackId, |
TransformId | transformId | ||
) | [protected] |
Definition at line 168 of file FileFeatureWriter.cpp.
References FeatureWriter::getWriterTag(), m_append, m_baseDir, m_extension, m_force, m_manyFiles, m_singleFileName, m_stdout, and SVDEBUG.
Referenced by getOutputFile(), and testOutputFile().
QFile * FileFeatureWriter::getOutputFile | ( | QString | trackId, |
TransformId | transformId | ||
) | [protected] |
Definition at line 245 of file FileFeatureWriter.cpp.
References getOutputFilename(), m_append, m_files, m_manyFiles, m_singleFileName, reviewFileForAppending(), and SVDEBUG.
Referenced by getOutputStream().
virtual void FileFeatureWriter::reviewFileForAppending | ( | QString | ) | [inline, protected, virtual] |
Reimplemented in RDFFeatureWriter.
Definition at line 70 of file FileFeatureWriter.h.
Referenced by getOutputFile().
virtual void FeatureWriter::setTrackMetadata | ( | QString | , |
TrackMetadata | |||
) | [inline, virtual, inherited] |
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, inherited] |
Implemented in RDFFeatureWriter, and CSVFeatureWriter.
virtual QString FeatureWriter::getWriterTag | ( | ) | const [pure virtual, inherited] |
Implemented in RDFFeatureWriter, and CSVFeatureWriter.
Referenced by getOutputFilename().
FileMap FileFeatureWriter::m_files [protected] |
Definition at line 62 of file FileFeatureWriter.h.
Referenced by finish(), getOutputFile(), and ~FileFeatureWriter().
FileStreamMap FileFeatureWriter::m_streams [protected] |
Definition at line 63 of file FileFeatureWriter.h.
Referenced by finish(), getOutputStream(), and ~FileFeatureWriter().
QTextStream* FileFeatureWriter::m_prevstream [protected] |
Definition at line 64 of file FileFeatureWriter.h.
Referenced by finish(), flush(), and getOutputStream().
int FileFeatureWriter::m_support [protected] |
Definition at line 72 of file FileFeatureWriter.h.
Referenced by FileFeatureWriter(), getSupportedParameters(), and setParameters().
QString FileFeatureWriter::m_extension [protected] |
Definition at line 73 of file FileFeatureWriter.h.
Referenced by FileFeatureWriter(), and getOutputFilename().
QString FileFeatureWriter::m_baseDir [protected] |
Definition at line 74 of file FileFeatureWriter.h.
Referenced by getOutputFilename(), and setParameters().
bool FileFeatureWriter::m_manyFiles [protected] |
Definition at line 75 of file FileFeatureWriter.h.
Referenced by FileFeatureWriter(), getOutputFile(), getOutputFilename(), and setParameters().
QString FileFeatureWriter::m_singleFileName [protected] |
Definition at line 76 of file FileFeatureWriter.h.
Referenced by FileFeatureWriter(), finish(), getOutputFile(), getOutputFilename(), setParameters(), testOutputFile(), CSVFeatureWriter::write(), and RDFFeatureWriter::write().
bool FileFeatureWriter::m_stdout [protected] |
Definition at line 77 of file FileFeatureWriter.h.
Referenced by finish(), getOutputFilename(), getOutputStream(), setParameters(), testOutputFile(), CSVFeatureWriter::write(), and RDFFeatureWriter::write().
bool FileFeatureWriter::m_append [protected] |
Definition at line 78 of file FileFeatureWriter.h.
Referenced by getOutputFile(), getOutputFilename(), and setParameters().
bool FileFeatureWriter::m_force [protected] |
Definition at line 79 of file FileFeatureWriter.h.
Referenced by getOutputFilename(), and setParameters().