svcore
1.9
|
#include <FileFeatureWriter.h>
![Inheritance graph](classFileFeatureWriter__inherit__graph.png)
![Collaboration graph](classFileFeatureWriter__coll__graph.png)
Public Types | |
typedef vector< Parameter > | ParameterList |
Public Member Functions | |
virtual | ~FileFeatureWriter () |
ParameterList | getSupportedParameters () const override |
void | setParameters (map< string, string > ¶ms) override |
void | testOutputFile (QString trackId, TransformId transformId) override |
Throw FailedToOpenOutputStream if we can already tell that we will be unable to write to the output file. More... | |
void | flush () override |
void | finish () override |
virtual string | getDescription () const =0 |
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 QString | getWriterTag () const =0 |
Protected Types | |
enum | FileWriteSupport { SupportOneFilePerTrackTransform = 1, SupportOneFilePerTrack = 2, SupportOneFileTotal = 4, SupportStdOut = 8 } |
typedef pair< QString, TransformId > | TrackTransformPair |
typedef map< TrackTransformPair, QString > | FileNameMap |
typedef map< TrackTransformPair, QFile * > | FileMap |
typedef map< QFile *, QTextStream * > | FileStreamMap |
Protected Member Functions | |
FileFeatureWriter (int support, QString extension) | |
QTextStream * | getOutputStream (QString, TransformId, QTextCodec *) |
TrackTransformPair | getFilenameKey (QString, TransformId) |
QString | createOutputFilename (QString, TransformId) |
QString | getOutputFilename (QString, TransformId) |
QFile * | getOutputFile (QString, TransformId) |
virtual void | reviewFileForAppending (QString) |
Protected Attributes | |
FileMap | m_files |
FileNameMap | m_filenames |
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 |
Detailed Description
Definition at line 38 of file FileFeatureWriter.h.
Member Typedef Documentation
|
protected |
Definition at line 61 of file FileFeatureWriter.h.
|
protected |
Definition at line 62 of file FileFeatureWriter.h.
|
protected |
Definition at line 63 of file FileFeatureWriter.h.
|
protected |
Definition at line 64 of file FileFeatureWriter.h.
|
inherited |
Definition at line 51 of file FeatureWriter.h.
Member Enumeration Documentation
|
protected |
Enumerator | |
---|---|
SupportOneFilePerTrackTransform | |
SupportOneFilePerTrack | |
SupportOneFileTotal | |
SupportStdOut |
Definition at line 51 of file FileFeatureWriter.h.
Constructor & Destructor Documentation
|
virtual |
Definition at line 54 of file FileFeatureWriter.cpp.
|
protected |
Definition at line 33 of file FileFeatureWriter.cpp.
References m_extension, m_manyFiles, m_singleFileName, m_support, SupportOneFilePerTrack, SupportOneFilePerTrackTransform, SupportOneFileTotal, and SVCERR.
Member Function Documentation
|
overridevirtual |
Reimplemented from FeatureWriter.
Reimplemented in RDFFeatureWriter.
Definition at line 72 of file FileFeatureWriter.cpp.
References FeatureWriter::Parameter::description, FeatureWriter::Parameter::hasArg, m_support, FeatureWriter::Parameter::name, SupportOneFilePerTrack, SupportOneFilePerTrackTransform, SupportOneFileTotal, and SupportStdOut.
Referenced by CSVFeatureWriter::getSupportedParameters(), and RDFFeatureWriter::getSupportedParameters().
|
overridevirtual |
Reimplemented from FeatureWriter.
Reimplemented in RDFFeatureWriter.
Definition at line 123 of file FileFeatureWriter.cpp.
References m_append, m_baseDir, m_force, m_manyFiles, m_singleFileName, m_stdout, m_support, SupportOneFilePerTrack, SupportOneFilePerTrackTransform, SupportOneFileTotal, SupportStdOut, and SVCERR.
Referenced by CSVFeatureWriter::setParameters(), and RDFFeatureWriter::setParameters().
|
overridevirtual |
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 231 of file FileFeatureWriter.cpp.
References createOutputFilename(), m_singleFileName, and m_stdout.
|
overridevirtual |
Reimplemented from FeatureWriter.
Definition at line 347 of file FileFeatureWriter.cpp.
References m_prevstream.
|
overridevirtual |
Implements FeatureWriter.
Reimplemented in RDFFeatureWriter.
Definition at line 356 of file FileFeatureWriter.cpp.
References m_files, m_prevstream, m_singleFileName, m_stdout, m_streams, and SVDEBUG.
Referenced by RDFFeatureWriter::finish().
|
protected |
Definition at line 317 of file FileFeatureWriter.cpp.
References getOutputFile(), m_prevstream, m_stdout, and m_streams.
Referenced by CSVFeatureWriter::finish(), CSVFeatureWriter::write(), and RDFFeatureWriter::write().
|
protected |
Definition at line 249 of file FileFeatureWriter.cpp.
References m_manyFiles, and m_singleFileName.
Referenced by getOutputFile(), and getOutputFilename().
|
protected |
Definition at line 170 of file FileFeatureWriter.cpp.
References FeatureWriter::getWriterTag(), m_append, m_baseDir, m_extension, m_force, m_manyFiles, m_singleFileName, m_stdout, and SVCERR.
Referenced by getOutputFile(), getOutputFilename(), and testOutputFile().
|
protected |
Definition at line 266 of file FileFeatureWriter.cpp.
References createOutputFilename(), getFilenameKey(), and m_filenames.
|
protected |
Definition at line 277 of file FileFeatureWriter.cpp.
References createOutputFilename(), getFilenameKey(), m_append, m_files, reviewFileForAppending(), SVCERR, and SVDEBUG.
Referenced by getOutputStream().
|
inlineprotectedvirtual |
Reimplemented in RDFFeatureWriter.
Definition at line 85 of file FileFeatureWriter.h.
Referenced by getOutputFile().
|
pure virtualinherited |
Implemented in RDFFeatureWriter, and CSVFeatureWriter.
Referenced by FeatureWriter::~FeatureWriter().
|
inlinevirtualinherited |
Reimplemented in RDFFeatureWriter.
Definition at line 65 of file FeatureWriter.h.
|
inlinevirtualinherited |
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 FeatureWriter::write().
|
pure virtualinherited |
Implemented in RDFFeatureWriter, and CSVFeatureWriter.
Referenced by FeatureWriter::setNofM().
|
pure virtualinherited |
Implemented in RDFFeatureWriter, and CSVFeatureWriter.
Referenced by createOutputFilename(), and FeatureWriter::flush().
Member Data Documentation
|
protected |
Definition at line 65 of file FileFeatureWriter.h.
Referenced by finish(), getOutputFile(), and ~FileFeatureWriter().
|
protected |
Definition at line 66 of file FileFeatureWriter.h.
Referenced by getOutputFilename().
|
protected |
Definition at line 67 of file FileFeatureWriter.h.
Referenced by finish(), getOutputStream(), and ~FileFeatureWriter().
|
protected |
Definition at line 68 of file FileFeatureWriter.h.
Referenced by finish(), flush(), and getOutputStream().
|
protected |
Definition at line 87 of file FileFeatureWriter.h.
Referenced by FileFeatureWriter(), getSupportedParameters(), and setParameters().
|
protected |
Definition at line 88 of file FileFeatureWriter.h.
Referenced by createOutputFilename(), and FileFeatureWriter().
|
protected |
Definition at line 89 of file FileFeatureWriter.h.
Referenced by createOutputFilename(), and setParameters().
|
protected |
Definition at line 90 of file FileFeatureWriter.h.
Referenced by createOutputFilename(), FileFeatureWriter(), getFilenameKey(), and setParameters().
|
protected |
Definition at line 91 of file FileFeatureWriter.h.
Referenced by createOutputFilename(), FileFeatureWriter(), finish(), getFilenameKey(), setParameters(), testOutputFile(), RDFFeatureWriter::write(), and CSVFeatureWriter::writeFeature().
|
protected |
Definition at line 92 of file FileFeatureWriter.h.
Referenced by createOutputFilename(), finish(), getOutputStream(), setParameters(), testOutputFile(), RDFFeatureWriter::write(), and CSVFeatureWriter::writeFeature().
|
protected |
Definition at line 93 of file FileFeatureWriter.h.
Referenced by createOutputFilename(), getOutputFile(), and setParameters().
|
protected |
Definition at line 94 of file FileFeatureWriter.h.
Referenced by createOutputFilename(), and setParameters().
The documentation for this class was generated from the following files:
Generated by
![doxygen](doxygen.png)