Files.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 OUTPUTFILES_H_
#define OUTPUTFILES_H_
#include "File.h"
#include "GeneralDefine.h"

class Files
{
public:
    
//Constructors
    Files();

    virtual ~Files();

    Files(const Files& other);
            
    //setters and getters
    
    MERCURY_DEPRECATED
    File& getDataFile();

    MERCURY_DEPRECATED
    File& getEneFile();

    MERCURY_DEPRECATED
    File& getFStatFile();

    MERCURY_DEPRECATED
    File& getRestartFile();

    MERCURY_DEPRECATED
    File& getStatFile();
    
    MERCURY_DEPRECATED
    const File& getDataFile() const;

    MERCURY_DEPRECATED
    const File& getEneFile() const;

    MERCURY_DEPRECATED
    const File& getFStatFile() const;

    MERCURY_DEPRECATED
    const File& getRestartFile() const;

    MERCURY_DEPRECATED
    const File& getStatFile() const;

    const std::string& getName() const;

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

    void setName(const char* name);

    void setSaveCount(unsigned int saveCount);

    void setFileType(FileType fileType);

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

    //other member functions
    
    void resetFileCounter();
    void read(std::istream& is);
    void write(std::ostream& os) const;
    void openFiles();
    void closeFiles();
    void setNextSavedTimeStep(unsigned int nextSavedTimeStep);

    File dataFile;

    File fStatFile;

    File eneFile;

    File restartFile;

    File statFile;
    
private:
    std::string name_;
    
};

#endif /* OUTPUTFILES_H_ */