File.h

Go to the documentation of this file.

//Copyright (c) 2013-2014, The MercuryDPM Developers Team. All rights reserved.
//For the list of developers, see <http://www.MercuryDPM.org/Team>.
//
//Redistribution and use in source and binary forms, with or without
//modification, are permitted provided that the following conditions are met:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//  * Neither the name MercuryDPM nor the
//    names of its contributors may be used to endorse or promote products
//    derived from this software without specific prior written permission.
//
//THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
//ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
//WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
//DISCLAIMED. IN NO EVENT SHALL THE MERCURYDPM DEVELOPERS TEAM BE LIABLE FOR ANY
//DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
//(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
//LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
//ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
//(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
//SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


#ifndef FILE_H
#define FILE_H
#include <fstream>
#include <cstdlib>

enum class FileType : unsigned char
{
    NO_FILE = 0,
    ONE_FILE = 1,
    MULTIPLE_FILES = 2,
    MULTIPLE_FILES_PADDED = 3
};



std::string to_string_padded(unsigned int value);


std::ostream& operator<<(std::ostream&os, FileType fileType);

std::istream& operator>>(std::istream&is, FileType&fileType);


class File
{
public:
    
//constructors
    File();

    virtual ~File();

    //set and get functions
    std::fstream& getFstream();

    const std::string& getName() const;

    const std::string getFullName() const;

    void setName(const std::string& name);

    FileType getFileType() const;

    void setFileType(FileType fileType);

    unsigned int getCounter() const;

    void setCounter(unsigned int counter);

    std::fstream::openmode getOpenMode() const;

    void setOpenMode(std::fstream::openmode openMode);

    unsigned int getSaveCount() const;

    void setSaveCount(unsigned int saveCount);

    unsigned int getNextSavedTimeStep() const;

    void setNextSavedTimeStep(unsigned int nextSavedTimeStep);

    bool saveCurrentTimestep(unsigned int ntimeSteps);

    void read(std::istream& is);

    void write(std::ostream& os) const;
    
    friend std::ostream& operator <<(std::ostream& os, const File& o);

    friend std::istream& operator >>(std::istream& is, File &o);

//member functions (other than set/get)
    
    bool open();

    bool open(std::fstream::openmode openMode);

    bool openNextFile();

    bool openNextFile(std::fstream::openmode openMode);

    void close();

private:
    std::string name_;

    std::fstream fstream_;

    FileType fileType_;

    unsigned int counter_;

    std::fstream::openmode openMode_;
   
    unsigned int saveCount_;

    unsigned int nextSavedTimeStep_;
};

#endif /* FILE_H */