File.h

Go to the documentation of this file.

//Copyright (c) 2013-2023, 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 "GeneralDefine.h"
 
// A value of File::lastSavedTimeStep_ = NEVER indicates a file was never been written
const unsigned NEVER = static_cast<const unsigned int>(-1);
 
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();
    
    File(const File&);
    
    virtual ~File();
    
    
    //set and get functions
    std::fstream& getFstream();
    
    const std::string& getName() const;
    
    const std::string getFullName() const;
    
    const std::string getFullName(unsigned) const;
    
    void setName(const std::string& name);
    
    FileType getFileType() const;
    
    void setFileType(FileType fileType);
    
    unsigned int getCounter() const;
    
    void setCounter(unsigned int counter);
 
    void increaseCounter() {counter_++;}
 
    void decreaseCounter() {counter_--;}
 
    std::fstream::openmode getOpenMode() const;
    
    void setOpenMode(std::fstream::openmode openMode);
    
    unsigned int getSaveCount() const;
 
    void writeFirstAndLastTimeStep();
 
    void setSaveCount(unsigned int saveCount);
    
    unsigned int getLastSavedTimeStep() const;
    
    void setLastSavedTimeStep(unsigned int lastSavedTimeStep);
    
    bool saveCurrentTimeStep(unsigned int ntimeSteps);
    bool saveCurrentTimeStepNoFileTypeCheck(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 openWrite(unsigned);
    
    bool openWriteNoAppend(unsigned);
    
    bool open(std::fstream::openmode openMode);
    
    void close();
    
    void setlogarithmicSaveCount(const Mdouble logarithmicSaveCountBase);
 
private:
    std::string name_;
    
    std::fstream fstream_;
    
    FileType fileType_;
    
    unsigned int counter_;
    
    std::fstream::openmode openMode_;
    
    unsigned int saveCount_;
    
    Mdouble logarithmicSaveCountBase_;
    
    unsigned int lastSavedTimeStep_;
};
 
#endif /* FILE_H */