/***********************************************************************************
 *                                                                                 *
 * Voreen - The Volume Rendering Engine                                            *
 *                                                                                 *
 * Copyright (C) 2005-2013 University of Muenster, Germany.                        *
 * Visualization and Computer Graphics Group <http://viscg.uni-muenster.de>        *
 * For a list of authors please refer to the file "CREDITS.txt".                   *
 *                                                                                 *
 * This file is part of the Voreen software package. Voreen is free software:      *
 * you can redistribute it and/or modify it under the terms of the GNU General     *
 * Public License version 2 as published by the Free Software Foundation.          *
 *                                                                                 *
 * Voreen is distributed in the hope that it will be useful, but WITHOUT ANY       *
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR   *
 * A PARTICULAR PURPOSE. See the GNU General Public License for more details.      *
 *                                                                                 *
 * You should have received a copy of the GNU General Public License in the file   *
 * "LICENSE.txt" along with this file. If not, see <http://www.gnu.org/licenses/>. *
 *                                                                                 *
 * For non-commercial academic use see the license exception specified in the file *
 * "LICENSE-academic.txt". To get information about commercial licensing please    *
 * contact the authors.                                                            *
 *                                                                                 *
 ***********************************************************************************/

#ifndef VRN_FLOWREADER_H
#define VRN_FLOWREADER_H

#include "voreen/core/io/volumereader.h"

namespace voreen {

class VolumeFlow3D;     // make use of pimpl-idiom

class FlowReader : public VolumeReader {
public:
    FlowReader(ProgressBar* const progress = 0);
    virtual ~FlowReader() {}
    virtual VolumeReader* create(ProgressBar* progress = 0) const;

    virtual std::string getClassName() const   { return "FlowReader"; }
    virtual std::string getFormatDescription() const { return "Voreen flow format"; }

    virtual VolumeList* read(const std::string& url)
        throw(tgt::FileException, std::bad_alloc);

    virtual VolumeList* readSlices(const std::string& url, size_t/* firstSlice = 0*/, size_t /*lastSlice = 0*/)
        throw(tgt::FileException, std::bad_alloc) {
            return read(url);
    }

private:
    typedef unsigned char BYTE;

private:
    VolumeFlow3D* readConvert(const tgt::ivec3& dimensions,
        const BYTE orientation, std::fstream& ifs);
    void reverseSlices(VolumeFlow3D* const volume, const BYTE sliceOrder) const ;

private:
    static const std::string loggerCat_;
};

}   // namespace

#endif  // VRN_FLOWREADER_H
