Jpp 19.3.0-rc.2
the software that should make you happy
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
JIO::JFileStreamReader Class Reference

Binary buffered file input. More...

#include <JFileStreamIO.hh>

Inheritance diagram for JIO::JFileStreamReader:
JIO::JBufferedReader JIO::JReader JLANG::JBinaryInput JLANG::JAbstractObjectStatus

Public Member Functions

 JFileStreamReader ()
 Default constructor.
 
 JFileStreamReader (const char *file_name, const int size=1048576)
 Constructor.
 
void open (const char *file_name)
 Open file.
 
virtual void clear () override
 Clear status of reader.
 
void rewind ()
 Rewind.
 
bool operator! () const
 Negated status of this object.
 
JReader & operator>> (JSerialisable &object)
 Read serialisable data object.
 
JReader & operator>> (bool &value)
 
JReader & operator>> (char &value)
 
JReader & operator>> (unsigned char &value)
 
JReader & operator>> (short &value)
 
JReader & operator>> (unsigned short &value)
 
JReader & operator>> (int &value)
 
JReader & operator>> (unsigned int &value)
 
JReader & operator>> (long int &value)
 
JReader & operator>> (unsigned long int &value)
 
JReader & operator>> (long long int &value)
 
JReader & operator>> (unsigned long long int &value)
 
JReader & operator>> (float &value)
 
JReader & operator>> (double &value)
 
JReader & operator>> (long double &value)
 
JReader & operator>> (JLANG::JObjectID &value)
 
virtual bool getStatus () const override
 Status of reader.
 
virtual int read (char *zbuf, int n) override
 Read byte array.
 
JReader & load (JSerialisable &object)
 Read object.
 
template<class T >
JReader & load (T &object)
 Read object.
 
 operator bool () const
 Type conversion operator.
 

Protected Member Functions

void reset ()
 Reset.
 

Protected Attributes

JLANG::JSinglePointer< JReader > in
 
char * buffer
 internal buffer
 
int size
 size of internal buffer
 
int pos
 pointer to begin of available data
 
int ls
 pointer to end of available data
 
bool eof
 end of file
 

Detailed Description

Binary buffered file input.

Definition at line 22 of file JFileStreamIO.hh.

Constructor & Destructor Documentation

◆ JFileStreamReader() [1/2]

JIO::JFileStreamReader::JFileStreamReader ( )
inline

Default constructor.

Definition at line 36 of file JFileStreamIO.hh.

36 :
37 std::ifstream(),
38 JBufferedReader(new JStreamReader(static_cast<std::ifstream&>(*this)))
39 {}
JIO::JBufferedReader::JBufferedReader
JBufferedReader(JReader *__in, const int __size=1048576)
Constructor.
Definition JBufferedIO.hh:36

◆ JFileStreamReader() [2/2]

JIO::JFileStreamReader::JFileStreamReader ( const char * file_name,
const int size = 1048576 )
inline

Constructor.

Parameters
file_namefile name
sizesize of internal buffer

Definition at line 48 of file JFileStreamIO.hh.

49 :
50 std::ifstream (),
51 JBufferedReader(new JStreamReader(static_cast<std::ifstream&>(*this)), size)
52 {
53 open(file_name);
54 }
JIO::JBufferedReader::size
int size
size of internal buffer
Definition JBufferedIO.hh:134
JIO::JFileStreamReader::open
void open(const char *file_name)
Open file.
Definition JFileStreamIO.hh:62

Member Function Documentation

◆ open()

void JIO::JFileStreamReader::open ( const char * file_name)
inline

Open file.

Parameters
file_namefile name

Definition at line 62 of file JFileStreamIO.hh.

63 {
64 static_cast<std::ifstream*>(this)->open(file_name, std::ios::binary);
65 }

◆ clear()

virtual void JIO::JFileStreamReader::clear ( )
inlineoverridevirtual

Clear status of reader.

Reimplemented from JIO::JBufferedReader.

Definition at line 71 of file JFileStreamIO.hh.

72 {
73 std::ifstream ::clear();
74 JBufferedReader::clear();
75 }
JIO::JBufferedReader::clear
virtual void clear() override
Clear status of reader.
Definition JBufferedIO.hh:69

◆ rewind()

void JIO::JFileStreamReader::rewind ( )
inline

Rewind.

Definition at line 81 of file JFileStreamIO.hh.

82 {
83 seekg(0); // rewind file stream
84
85 reset(); // reset buffer
86 }

◆ operator!()

bool JLANG::JAbstractObjectStatus::operator! ( ) const
inline

Negated status of this object.

Returns
negated status of this object

Definition at line 44 of file JAbstractObjectStatus.hh.

45 {
46 return !(this->getStatus());
47 }
JIO::JBufferedReader::getStatus
virtual bool getStatus() const override
Status of reader.
Definition JBufferedIO.hh:60

◆ operator>>() [1/16]

JReader & JIO::JReader::operator>> ( JSerialisable & object)
inline

Read serialisable data object.

Parameters
objectserialisable data object
Returns
JReader

Definition at line 81 of file JSerialisable.hh.

82 {
83 return object.read(*this);
84 }

◆ operator>>() [2/16]

JReader & JIO::JReader::operator>> ( bool & value)
inline

Definition at line 87 of file JSerialisable.hh.

87{ read((char*) &value, sizeof(bool)); return *this; }
JIO::JBufferedReader::read
virtual int read(char *zbuf, int n) override
Read byte array.
Definition JBufferedIO.hh:82

◆ operator>>() [3/16]

JReader & JIO::JReader::operator>> ( char & value)
inline

Definition at line 88 of file JSerialisable.hh.

88{ read((char*) &value, sizeof(char)); return *this; }

◆ operator>>() [4/16]

JReader & JIO::JReader::operator>> ( unsigned char & value)
inline

Definition at line 89 of file JSerialisable.hh.

89{ read((char*) &value, sizeof(unsigned char)); return *this; }

◆ operator>>() [5/16]

JReader & JIO::JReader::operator>> ( short & value)
inline

Definition at line 90 of file JSerialisable.hh.

90{ read((char*) &value, sizeof(short)); return *this; }

◆ operator>>() [6/16]

JReader & JIO::JReader::operator>> ( unsigned short & value)
inline

Definition at line 91 of file JSerialisable.hh.

91{ read((char*) &value, sizeof(unsigned short)); return *this; }

◆ operator>>() [7/16]

JReader & JIO::JReader::operator>> ( int & value)
inline

Definition at line 92 of file JSerialisable.hh.

92{ read((char*) &value, sizeof(int)); return *this; }

◆ operator>>() [8/16]

JReader & JIO::JReader::operator>> ( unsigned int & value)
inline

Definition at line 93 of file JSerialisable.hh.

93{ read((char*) &value, sizeof(unsigned int)); return *this; }

◆ operator>>() [9/16]

JReader & JIO::JReader::operator>> ( long int & value)
inline

Definition at line 94 of file JSerialisable.hh.

94{ read((char*) &value, sizeof(long int)); return *this; }

◆ operator>>() [10/16]

JReader & JIO::JReader::operator>> ( unsigned long int & value)
inline

Definition at line 95 of file JSerialisable.hh.

95{ read((char*) &value, sizeof(unsigned long int)); return *this; }

◆ operator>>() [11/16]

JReader & JIO::JReader::operator>> ( long long int & value)
inline

Definition at line 96 of file JSerialisable.hh.

96{ read((char*) &value, sizeof(long long int)); return *this; }

◆ operator>>() [12/16]

JReader & JIO::JReader::operator>> ( unsigned long long int & value)
inline

Definition at line 97 of file JSerialisable.hh.

97{ read((char*) &value, sizeof(unsigned long long int)); return *this; }

◆ operator>>() [13/16]

JReader & JIO::JReader::operator>> ( float & value)
inline

Definition at line 98 of file JSerialisable.hh.

98{ read((char*) &value, sizeof(float)); return *this; }

◆ operator>>() [14/16]

JReader & JIO::JReader::operator>> ( double & value)
inline

Definition at line 99 of file JSerialisable.hh.

99{ read((char*) &value, sizeof(double)); return *this; }

◆ operator>>() [15/16]

JReader & JIO::JReader::operator>> ( long double & value)
inline

Definition at line 100 of file JSerialisable.hh.

100{ read((char*) &value, sizeof(long double)); return *this; }

◆ operator>>() [16/16]

JReader & JIO::JReader::operator>> ( JLANG::JObjectID & value)
inline

Definition at line 101 of file JSerialisable.hh.

101{ return (*this) >> value.getID(); }
JLANG::JObjectID::getID
int getID() const
Get identifier.
Definition JObjectID.hh:50

◆ getStatus()

virtual bool JIO::JBufferedReader::getStatus ( ) const
inlineoverridevirtualinherited

Status of reader.

Returns
status of this reader

Implements JLANG::JAbstractObjectStatus.

Definition at line 60 of file JBufferedIO.hh.

61 {
62 return in->getStatus() || !eof;
63 }
JIO::JBufferedReader::eof
bool eof
end of file
Definition JBufferedIO.hh:137
JIO::JBufferedReader::in
JLANG::JSinglePointer< JReader > in
Definition JBufferedIO.hh:131

◆ read()

virtual int JIO::JBufferedReader::read ( char * zbuf,
int n )
inlineoverridevirtualinherited

Read byte array.

Parameters
zbufpointer to byte array
nnumber of bytes
Returns
number of bytes

Implements JLANG::JBinaryInput.

Definition at line 82 of file JBufferedIO.hh.

83 {
84 for (int i = 0; i != n; ) {
85
86 int m = n - i;
87
88 if (m > ls - pos) {
89
90 memmove(buffer, buffer + pos, ls - pos);
91
92 ls -= pos;
93 pos = 0;
94 ls += in->read(buffer + ls, size - ls);
95
96 if (m > ls) {
97
98 if (ls == 0) {
99
100 eof = true;
101
102 return n - i;
103 }
104
105 m = ls;
106 }
107 }
108
109 memcpy(zbuf + i, buffer + pos, m);
110
111 i += m;
112 pos += m;
113 }
114
115 eof = false;
116
117 return n;
118 }
JIO::JBufferedReader::buffer
char * buffer
internal buffer
Definition JBufferedIO.hh:133
JIO::JBufferedReader::ls
int ls
pointer to end of available data
Definition JBufferedIO.hh:136
JIO::JBufferedReader::pos
int pos
pointer to begin of available data
Definition JBufferedIO.hh:135
JTOOLS::n
const int n
Definition JPolint.hh:791

◆ reset()

void JIO::JBufferedReader::reset ( )
inlineprotectedinherited

Reset.

Definition at line 124 of file JBufferedIO.hh.

125 {
126 pos = 0;
127 ls = 0;
128 eof = true;
129 }

◆ load() [1/2]

JReader & JIO::JReader::load ( JSerialisable & object)
inlineinherited

Read object.

Parameters
objectobject
Returns
this reader

Definition at line 110 of file JSerialisable.hh.

111 {
112 return object.read(*this);
113 }

◆ load() [2/2]

template<class T >
JReader & JIO::JReader::load ( T & object)
inlineinherited

Read object.

Parameters
objectobject
Returns
this reader

Definition at line 123 of file JSerialisable.hh.

124 {
125 return *this >> object;
126 }

◆ operator bool()

JLANG::JAbstractObjectStatus::operator bool ( ) const
inlineinherited

Type conversion operator.

Returns
status of this object

Definition at line 33 of file JAbstractObjectStatus.hh.

34 {
35 return this->getStatus();
36 }
JLANG::JAbstractObjectStatus::getStatus
virtual bool getStatus() const =0
Get status of object.

Member Data Documentation

◆ in

JLANG::JSinglePointer<JReader> JIO::JBufferedReader::in
protectedinherited

Definition at line 131 of file JBufferedIO.hh.

◆ buffer

char* JIO::JBufferedReader::buffer
protectedinherited

internal buffer

Definition at line 133 of file JBufferedIO.hh.

◆ size

int JIO::JBufferedReader::size
protectedinherited

size of internal buffer

Definition at line 134 of file JBufferedIO.hh.

◆ pos

int JIO::JBufferedReader::pos
protectedinherited

pointer to begin of available data

Definition at line 135 of file JBufferedIO.hh.

◆ ls

int JIO::JBufferedReader::ls
protectedinherited

pointer to end of available data

Definition at line 136 of file JBufferedIO.hh.

◆ eof

bool JIO::JBufferedReader::eof
protectedinherited

end of file

Definition at line 137 of file JBufferedIO.hh.

The documentation for this class was generated from the following file:
Generated by doxygen 1.12.0