#include <CSVFeatureWriter.h>

Inheritance diagram for CSVFeatureWriter:

Collaboration diagram for CSVFeatureWriter:

[legend]

Public Types
typedef vector< Parameter >	ParameterList

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

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

◆ TrackTransformPair

typedef pair<QString, TransformId> FileFeatureWriter::TrackTransformPair

protectedinherited

Definition at line 59 of file FileFeatureWriter.h.

◆ FileMap

typedef map<TrackTransformPair, QFile *> FileFeatureWriter::FileMap

protectedinherited

Definition at line 60 of file FileFeatureWriter.h.

◆ FileStreamMap

typedef map<QFile *, QTextStream *> FileFeatureWriter::FileStreamMap

protectedinherited

Definition at line 61 of file FileFeatureWriter.h.

◆ ParameterList

typedef vector<Parameter> FeatureWriter::ParameterList

inherited

Definition at line 47 of file FeatureWriter.h.

Member Enumeration Documentation

◆ FileWriteSupport

enum FileFeatureWriter::FileWriteSupport

protectedinherited

Enumerator
SupportOneFilePerTrackTransform
SupportOneFilePerTrack
SupportOneFileTotal

Definition at line 50 of file FileFeatureWriter.h.

Constructor & Destructor Documentation

◆ CSVFeatureWriter()

CSVFeatureWriter::CSVFeatureWriter ( )

Definition at line 30 of file CSVFeatureWriter.cpp.

◆ ~CSVFeatureWriter()

CSVFeatureWriter::~CSVFeatureWriter ( )

virtual

Definition at line 39 of file CSVFeatureWriter.cpp.

Member Function Documentation

◆ getSupportedParameters()

CSVFeatureWriter::ParameterList CSVFeatureWriter::getSupportedParameters ( ) const

virtual

Reimplemented from FileFeatureWriter.

Definition at line 44 of file CSVFeatureWriter.cpp.

References FeatureWriter::Parameter::description, FileFeatureWriter::getSupportedParameters(), FeatureWriter::Parameter::hasArg, and FeatureWriter::Parameter::name.

◆ setParameters()

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

virtual

Reimplemented from FileFeatureWriter.

Definition at line 63 of file CSVFeatureWriter.cpp.

References m_sampleTiming, m_separator, FileFeatureWriter::setParameters(), and SVDEBUG.

◆ write()

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

virtual

Implements FeatureWriter.

Definition at line 80 of file CSVFeatureWriter.cpp.

References Transform::getIdentifier(), FileFeatureWriter::getOutputStream(), Transform::getSampleRate(), m_prevPrintedTrackId, m_sampleTiming, m_separator, FileFeatureWriter::m_singleFileName, and FileFeatureWriter::m_stdout.

◆ getWriterTag()

virtual QString CSVFeatureWriter::getWriterTag ( ) const

inlinevirtual

Implements FeatureWriter.

Definition at line 52 of file CSVFeatureWriter.h.

◆ testOutputFile()

void FileFeatureWriter::testOutputFile	(	QString	,
		TransformId
	)

virtualinherited

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.