BinaryReader.h
Go to the documentation of this file.
1 //Copyright (c) 2013-2023, The MercuryDPM Developers Team. All rights reserved.
2 //For the list of developers, see <http://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 #ifndef BinaryReader_H
27 #define BinaryReader_H
28 #include<fstream>
29 #include<iostream>
30 #include<string>
31 
37 {
38 public:
39 
43  explicit BinaryReader(std::string);
44 
48  ~BinaryReader();
49 
53  std::string readString(unsigned int numChar);
54 
58  double readDouble(unsigned int size);
59 
63  unsigned int readUnsignedInt(unsigned int size);
64 
68  double readFloat(unsigned int size);
69 
73  void ignoreChar(unsigned int size);
74 
75 private:
76 
80  void openFile(std::string fileName);
81 
85  void closeFile();
86 
88  std::ifstream binaryFile_;
89 
90 };
91 #endif
This gives functionality to read information from binary formats like STL etc. This class is complete...
Definition: BinaryReader.h:37
double readFloat(unsigned int size)
read the next so many bytes as a double (not in this case they were saves as a float orgainlly)
Definition: BinaryReader.cc:108
void ignoreChar(unsigned int size)
read and ignore the next number of characters
Definition: BinaryReader.cc:133
~BinaryReader()
Destructor, simple closes the file.
Definition: BinaryReader.cc:49
std::ifstream binaryFile_
The pointer for the binary file.
Definition: BinaryReader.h:88
BinaryReader(std::string)
Default constuction, requires to users to prove the name of the file that will be opened.
Definition: BinaryReader.cc:41
unsigned int readUnsignedInt(unsigned int size)
read the next so many bytes as a unsined int
Definition: BinaryReader.cc:121
void closeFile()
close the file with fileName
Definition: BinaryReader.cc:57
double readDouble(unsigned int size)
read the next so many bytes as a double
Definition: BinaryReader.cc:94
std::string readString(unsigned int numChar)
reads the next so many Characters (bytes) as a std::string
Definition: BinaryReader.cc:80
void openFile(std::string fileName)
opens the file with fileName
Definition: BinaryReader.cc:66