annotate data/fileio/DataFileReaderFactory.h @ 282:d9319859a4cf tip

(none)
author benoitrigolleau
date Fri, 31 Oct 2008 11:00:24 +0000
parents fc9323a41f5a
children
rev   line source
lbajardsilogic@0 1 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */
lbajardsilogic@0 2
lbajardsilogic@0 3 /*
lbajardsilogic@0 4 Sonic Visualiser
lbajardsilogic@0 5 An audio file viewer and annotation editor.
lbajardsilogic@0 6 Centre for Digital Music, Queen Mary, University of London.
lbajardsilogic@0 7 This file copyright 2006 Chris Cannam.
lbajardsilogic@0 8
lbajardsilogic@0 9 This program is free software; you can redistribute it and/or
lbajardsilogic@0 10 modify it under the terms of the GNU General Public License as
lbajardsilogic@0 11 published by the Free Software Foundation; either version 2 of the
lbajardsilogic@0 12 License, or (at your option) any later version. See the file
lbajardsilogic@0 13 COPYING included with this distribution for more information.
lbajardsilogic@0 14 */
lbajardsilogic@0 15
lbajardsilogic@0 16 #ifndef _DATA_FILE_READER_FACTORY_H_
lbajardsilogic@0 17 #define _DATA_FILE_READER_FACTORY_H_
lbajardsilogic@0 18
lbajardsilogic@0 19 #include <QString>
lbajardsilogic@0 20
lbajardsilogic@0 21 class DataFileReader;
lbajardsilogic@0 22 class Model;
lbajardsilogic@0 23
lbajardsilogic@0 24 class DataFileReaderFactory
lbajardsilogic@0 25 {
lbajardsilogic@0 26 public:
lbajardsilogic@0 27 /**
lbajardsilogic@0 28 * Return the file extensions that we have data file readers for,
lbajardsilogic@0 29 * in a format suitable for use with QFileDialog. For example,
lbajardsilogic@0 30 * "*.csv *.xml".
lbajardsilogic@0 31 */
lbajardsilogic@0 32 static QString getKnownExtensions();
lbajardsilogic@0 33
lbajardsilogic@0 34 /**
lbajardsilogic@0 35 * Return a data file reader initialised to the file at the
lbajardsilogic@0 36 * given path, or NULL if no suitable reader for this path is
lbajardsilogic@0 37 * available or the file cannot be opened.
lbajardsilogic@0 38 * Caller owns the returned object and must delete it after use.
lbajardsilogic@0 39 */
lbajardsilogic@0 40 static DataFileReader *createReader(QString path,
lbajardsilogic@0 41 size_t mainModelSampleRate);
lbajardsilogic@0 42
lbajardsilogic@0 43 /**
lbajardsilogic@0 44 * Read the given path, if a suitable reader is available.
lbajardsilogic@0 45 * Return NULL if no reader succeeded in reading this file.
lbajardsilogic@0 46 */
lbajardsilogic@0 47 static Model *load(QString path, size_t mainModelSampleRate);
lbajardsilogic@0 48 };
lbajardsilogic@0 49
lbajardsilogic@0 50 #endif
lbajardsilogic@0 51