MercuryDPM  Trunk
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
File.h
Go to the documentation of this file.
1 //Copyright (c) 2013-2020, The MercuryDPM Developers Team. All rights reserved.
2 //For the list of developers, see <http://www.MercuryDPM.org/Team>.
3 //
4 //Redistribution and use in source and binary forms, with or without
5 //modification, are permitted provided that the following conditions are met:
6 // * Redistributions of source code must retain the above copyright
7 // notice, this list of conditions and the following disclaimer.
8 // * Redistributions in binary form must reproduce the above copyright
9 // notice, this list of conditions and the following disclaimer in the
10 // documentation and/or other materials provided with the distribution.
11 // * Neither the name MercuryDPM nor the
12 // names of its contributors may be used to endorse or promote products
13 // derived from this software without specific prior written permission.
14 //
15 //THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
16 //ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
17 //WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18 //DISCLAIMED. IN NO EVENT SHALL THE MERCURYDPM DEVELOPERS TEAM BE LIABLE FOR ANY
19 //DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
20 //(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
21 //LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
22 //ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 //(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
24 //SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 
26 
27 #ifndef FILE_H
28 #define FILE_H
29 
30 #include <fstream>
31 #include "GeneralDefine.h"
32 
33 // A value of File::lastSavedTimeStep_ = NEVER indicates a file was never been written
35 const unsigned NEVER = static_cast<const unsigned int>(-1);
36 
40 enum class FileType : unsigned char
41 {
45  NO_FILE = 0,
49  ONE_FILE = 1,
53  MULTIPLE_FILES = 2,
58 };
59 
60 
61 std::string to_string_padded(unsigned int value);
62 
66 std::ostream& operator<<(std::ostream& os, FileType fileType);
67 
71 std::istream& operator>>(std::istream& is, FileType& fileType);
72 
80 class File
81 {
82 public:
83 
84  //constructors
88  File();
89 
93  File(const File&);
94 
98  virtual ~File();
99 
100 
101  //set and get functions
105  std::fstream& getFstream();
106 
110  const std::string& getName() const;
111 
115  const std::string getFullName() const;
116 
120  const std::string getFullName(unsigned) const;
121 
126  void setName(const std::string& name);
127 
131  FileType getFileType() const;
132 
136  void setFileType(FileType fileType);
137 
141  unsigned int getCounter() const;
142 
146  void setCounter(unsigned int counter);
147 
149 
151 
155  std::fstream::openmode getOpenMode() const;
156 
160  void setOpenMode(std::fstream::openmode openMode);
161 
165  unsigned int getSaveCount() const;
166 
171 
175  void setSaveCount(unsigned int saveCount);
176 
180  unsigned int getLastSavedTimeStep() const;
181 
185  void setLastSavedTimeStep(unsigned int lastSavedTimeStep);
186 
190  bool saveCurrentTimeStep(unsigned int ntimeSteps);
191  bool saveCurrentTimeStepNoFileTypeCheck(unsigned int ntimeSteps);
192 
196  void read(std::istream& is);
197 
201  void write(std::ostream& os) const;
202 
207  friend std::ostream& operator<<(std::ostream& os, const File& o);
208 
213  friend std::istream& operator>>(std::istream& is, File& o);
214 
215  //member functions (other than set/get)
216 
221  bool open();
222 
226  bool openWrite(unsigned);
227 
228  bool openWriteNoAppend(unsigned);
229 
233  bool open(std::fstream::openmode openMode);
234 
238  void close();
239 
243  void setlogarithmicSaveCount(const Mdouble logarithmicSaveCountBase);
244 
245 private:
249  std::string name_;
250 
254  std::fstream fstream_;
255 
261 
265  unsigned int counter_;
266 
270  std::fstream::openmode openMode_;
271 
276  unsigned int saveCount_;
277 
283 
287  unsigned int lastSavedTimeStep_;
288 };
289 
290 #endif /* FILE_H */
FileType fileType_
fileType_ indicates the type of the files. Whether it is No file, one file or multiple file as descri...
Definition: File.h:260
each time-step will be written into/read from separate files numbered consecutively, with numbers padded by zeros to a minimum of four digits: name_.0000, name_.0001, ..
bool saveCurrentTimeStep(unsigned int ntimeSteps)
determined if this time step has to be written; if so, opens the output file
Definition: File.cc:313
FileType getFileType() const
Gets the file type e.g. NOFILE, ONEFILE and MULTIPLE FILES. File::fileType_.
Definition: File.cc:208
double Mdouble
Definition: GeneralDefine.h:34
std::fstream::openmode getOpenMode() const
Allows the user to know the file mode i.e. gets File::openMode_.
Definition: File.cc:240
std::string to_string_padded(unsigned int value)
Pads the number This function tries to pad the number to 4 digits, which is used when you create mult...
Definition: File.cc:44
void read(std::istream &is)
read function, which accepts an input stream std::istream.
Definition: File.cc:418
void setLastSavedTimeStep(unsigned int lastSavedTimeStep)
Sets File::nextSavedTimeStep_.
Definition: File.cc:303
void setCounter(unsigned int counter)
Allows the user to set the file counter according to his need. Sets File::counter_.
Definition: File.cc:232
const std::string getFullName() const
Also allows to access the file name, however with additional information which is the file counter...
Definition: File.cc:171
unsigned int lastSavedTimeStep_
the time step at which the next write or read operation has to happen.
Definition: File.h:287
void increaseCounter()
Definition: File.h:148
void writeFirstAndLastTimeStep()
Sets File::saveCount_ to the highest possible value such that only the first and last time step is wr...
Definition: File.cc:265
bool openWrite(unsigned)
First sets openmode to write (and append in some cases), then calls open().
Definition: File.cc:382
FileType
With FileType options, one is able to choose if data is to be read/written from/into no or single or ...
Definition: File.h:40
unsigned int counter_
counts the number of already opened files, i.e. counter=1 means .0000 exists
Definition: File.h:265
const unsigned NEVER
Definition: File.h:35
unsigned int getSaveCount() const
Gets File::saveCount_.
Definition: File.cc:256
void close()
Closes the file by calling fstream_.close()
Definition: File.cc:408
std::istream & operator>>(std::istream &is, FileType &fileType)
Reads the FileType from an input stream 'is'.
Definition: File.cc:79
std::fstream::openmode openMode_
A variable to indicate how the file should be opened i.e. in, out, ... see http://en.cppreference.com (std::fstream::out by default)
Definition: File.h:270
unsigned int getCounter() const
In case of multiple files, File::getCounter() returns the the number (FILE::Counter_) of the next fil...
Definition: File.cc:224
std::ostream & operator<<(std::ostream &os, FileType fileType)
Writes the FileType as a human-readable string into the output stream 'os'.
Definition: File.cc:56
file will not be created/read
void setlogarithmicSaveCount(const Mdouble logarithmicSaveCountBase)
the function to set the user input base of logarithmic saving count
Definition: File.cc:284
std::fstream & getFstream()
Allows to access the member variable File::fstream_.
Definition: File.cc:154
File()
constructor
Definition: File.cc:102
all data will be written into/ read from a single file called name_
bool saveCurrentTimeStepNoFileTypeCheck(unsigned int ntimeSteps)
Definition: File.cc:318
unsigned int saveCount_
Allows one to define the number of time steps to be skipped to make a snap shot. E.g. TMax = 100, saveCount_ = 10, timeStep = 1; It stores data at t={0,10,20,30,40...100}. And if TMax =101, it stores data at t={0,10,20,30,...100,101}.
Definition: File.h:276
bool openWriteNoAppend(unsigned)
Definition: File.cc:399
void setSaveCount(unsigned int saveCount)
Sets File::saveCount_.
Definition: File.cc:274
friend std::ostream & operator<<(std::ostream &os, const File &o)
Operator overloading used to write data obtained from an object of class File into an output stream...
Definition: File.cc:463
void setFileType(FileType fileType)
Sets the type of file needed to write into or read from. File::fileType_.
Definition: File.cc:216
Mdouble logarithmicSaveCountBase_
the switch allow user to set saveCount in logarithmic timescale with equal distance ...
Definition: File.h:282
unsigned int getLastSavedTimeStep() const
Gets File::nextSavedTimeStep_.
Definition: File.cc:294
bool open()
Checks if the file stream fstream_ has any issues while opening. Alongside, it also increments the ne...
Definition: File.cc:348
friend std::istream & operator>>(std::istream &is, File &o)
Operator overloading used to read data from the input stream into member variables of an object of cl...
Definition: File.cc:474
std::string name_
name of the file.
Definition: File.h:249
virtual ~File()
destructor
void decreaseCounter()
Definition: File.h:150
each time-step will be written into/read from separate files numbered consecutively: name_...
void setName(const std::string &name)
Sets the file name, e.g. "Name.data".
Definition: File.cc:199
Definition: File.h:80
void write(std::ostream &os) const
print function, which accepts an std::stringstream as input.
Definition: File.cc:443
const std::string & getName() const
Allows to access the file name, e.g., "problem.data".
Definition: File.cc:166
std::fstream fstream_
Stream object used to read/write data files.
Definition: File.h:254
void setOpenMode(std::fstream::openmode openMode)
Allows the user to Sets File::openMode_.
Definition: File.cc:248