Fstream Interface Facade for Binary Streams. More...
#include <itpp/base/binfile.h>
Public Member Functions | |
Fstream_Binfile_Facade () | |
Default Constructor. | |
Fstream_Binfile_Facade (const char *filename, std::ios_base::openmode mode=std::ios_base::in|std::ios_base::out|std::ios_base::binary) | |
Constructor from filename and stream mode. | |
bool | is_open () |
Open state. | |
void | open (const char *filename, std::ios_base::openmode mode=std::ios_base::in|std::ios_base::out|std::ios_base::binary) |
Method to open corresponding file. | |
void | close () |
Method to close corresponding file. | |
Fstream_Binfile_Facade & | write (const char *c, std::streamsize n) |
Output multiple characters. | |
Fstream_Binfile_Facade & | put (const char c) |
Output single char. | |
std::streampos | tellp () |
Get position. | |
Fstream_Binfile_Facade & | seekp (std::streampos pos) |
Set position. | |
Fstream_Binfile_Facade & | seekp (std::streamoff pos, std::ios_base::seekdir way) |
Set relative position. | |
Fstream_Binfile_Facade & | flush () |
Flushes stream buffer. | |
std::streamsize | gcount () const |
Last extracted chars count. | |
int | get () |
Get single char. | |
Fstream_Binfile_Facade & | get (char &c) |
Get single char. | |
Fstream_Binfile_Facade & | get (char *s, std::streamsize n) |
Get multiple chars to c-string and add trailing 0. | |
Fstream_Binfile_Facade & | get (char *s, std::streamsize n, char delim) |
Get multiple chars to c-string without trailing 0. | |
Fstream_Binfile_Facade & | getline (char *s, std::streamsize n) |
Get multiple chars to c-string without trailing 0. | |
Fstream_Binfile_Facade & | getline (char *s, std::streamsize n, char delim) |
Fstream_Binfile_Facade & | ignore (std::streamsize n=1, int delim=EOF) |
Extract and ignore chars. | |
int | peek () |
Peak single char from the top of the buffer. | |
Fstream_Binfile_Facade & | read (char *s, std::streamsize n) |
Read n chars from stream. | |
std::streamsize | readsome (char *s, std::streamsize n) |
Read up to n available chars from stream. | |
Fstream_Binfile_Facade & | putback (char c) |
This method attempts to put back single char. | |
Fstream_Binfile_Facade & | unget () |
Unget last extracted char. | |
std::streampos | tellg () |
Get position. | |
Fstream_Binfile_Facade & | seekg (std::streampos pos) |
Set position. | |
Fstream_Binfile_Facade & | seekg (std::streamoff pos, std::ios_base::seekdir way) |
Set relative position. | |
bool | good () const |
This method returns true is stream state is good. | |
bool | eof () const |
This method returns true if eof is reached. | |
bool | fail () const |
This method returns true if either failbit or badbit is set. | |
bool | bad () const |
This method returns true if badbit is set. | |
bool | operator! () const |
Unary not operator to check the stream state. | |
operator bool () const | |
Conversion to bool to validate stream state. | |
std::ios_base::iostate | rdstate () const |
Method to read stream state flags. | |
void | setstate (std::ios_base::iostate state) |
Method to set the stream state (combines already set flags with flags provide by user) | |
void | clear (std::ios_base::iostate state=std::ios_base::goodbit) |
Method to set stream state (overwrites stream state flags) | |
std::ios_base::iostate | exceptions () const |
Method to get the exceptions mask. | |
void | exceptions (std::ios_base::iostate except) |
Method to set the exceptions mask. | |
virtual | ~Fstream_Binfile_Facade () |
Destructor. | |
Protected Member Functions | |
std::fstream * | stream () |
Access to internal stream for derived classes. | |
Fstream Interface Facade for Binary Streams.
This class implements std::fstream facade to make ITPP binary file streams exportable from dll. This facade implements basic functionality only. It does not provide an access to the following stream facilities (all of them are useless for binary streams)
itpp::binfile_details::Fstream_Binfile_Facade::Fstream_Binfile_Facade | ( | ) |
Default Constructor.
Definition at line 62 of file binfile.cpp.
|
explicit |
Constructor from filename and stream mode.
Definition at line 64 of file binfile.cpp.
|
virtual |
Destructor.
Definition at line 67 of file binfile.cpp.
|
inline |
Open state.
Definition at line 367 of file binfile.h.
Referenced by itpp::it_file::open(), itpp::it_file_old::open(), and itpp::it_file::pack().
|
inline |
Method to open corresponding file.
Definition at line 369 of file binfile.h.
Referenced by itpp::bfstream::open(), and itpp::bfstream::open_readonly().
|
inline |
Method to close corresponding file.
Definition at line 373 of file binfile.h.
Referenced by itpp::it_file::close(), itpp::it_file_old::close(), itpp::it_ifile::close(), itpp::it_ifile_old::close(), itpp::it_file::open(), itpp::it_file_old::open(), itpp::it_ifile::open(), itpp::it_ifile_old::open(), and itpp::it_file::pack().
|
inline |
Output multiple characters.
Definition at line 376 of file binfile.h.
References write().
Referenced by itpp::bfstream::operator<<(), itpp::bfstream::operator<<(), write(), itpp::it_file::write_file_header(), and itpp::it_file_old::write_file_header().
|
inline |
Output single char.
Definition at line 379 of file binfile.h.
References put().
Referenced by itpp::bfstream::operator<<(), itpp::bfstream::operator<<(), itpp::bfstream::operator<<(), itpp::it_file::pack(), put(), and itpp::it_file::write_file_header().
|
inline |
Get position.
Definition at line 382 of file binfile.h.
Referenced by itpp::it_file::remove(), itpp::it_file_old::remove(), itpp::it_file::write_data_header(), and itpp::it_file_old::write_data_header().
|
inline |
Set position.
Definition at line 384 of file binfile.h.
References seekp().
Referenced by itpp::it_file::pack(), itpp::it_file::remove(), itpp::it_file_old::remove(), seekp(), seekp(), itpp::it_file::write_data_header(), and itpp::it_file_old::write_data_header().
|
inline |
|
inline |
Flushes stream buffer.
Definition at line 390 of file binfile.h.
References flush().
Referenced by flush(), itpp::it_file::flush(), and itpp::it_file_old::flush().
|
inline |
|
inline |
Get single char.
Definition at line 394 of file binfile.h.
Referenced by get(), get(), get(), itpp::bfstream::operator>>(), itpp::bfstream::operator>>(), itpp::bfstream::operator>>(), and itpp::it_file::pack().
|
inline |
|
inline |
|
inline |
|
inline |
Get multiple chars to c-string without trailing 0.
Definition at line 404 of file binfile.h.
References getline().
Referenced by getline(), and itpp::bfstream::operator>>().
|
inline |
|
inline |
|
inline |
|
inline |
Read n chars from stream.
Definition at line 414 of file binfile.h.
References read().
Referenced by read(), itpp::it_ifile::read_check_file_header(), and itpp::it_ifile_old::read_check_file_header().
|
inline |
|
inline |
|
inline |
|
inline |
Get position.
Definition at line 426 of file binfile.h.
Referenced by itpp::it_ifile::info(), itpp::it_ifile_old::info(), itpp::bfstream::length(), itpp::it_file::pack(), itpp::it_ifile_old::read_data_header(), itpp::it_ifile::seek(), itpp::it_ifile::seek(), itpp::it_ifile_old::seek(), and itpp::it_ifile_old::seek().
|
inline |
Set position.
Definition at line 428 of file binfile.h.
References seekg().
Referenced by itpp::it_ifile::info(), itpp::it_ifile_old::info(), itpp::bfstream::length(), itpp::it_file::pack(), itpp::it_ifile_old::read_data_header(), itpp::it_ifile::seek(), itpp::it_ifile::seek(), itpp::it_ifile_old::seek(), itpp::it_ifile_old::seek(), seekg(), seekg(), itpp::it_file::write_data_header(), and itpp::it_file_old::write_data_header().
|
inline |
|
inline |
|
inline |
This method returns true if eof is reached.
Definition at line 437 of file binfile.h.
Referenced by itpp::it_file::pack(), itpp::it_ifile_old::read_data_header(), itpp::it_ifile::seek(), itpp::it_ifile::seek(), itpp::it_ifile_old::seek(), itpp::it_ifile_old::seek(), itpp::it_file::write_data_header(), and itpp::it_file_old::write_data_header().
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
Method to set stream state (overwrites stream state flags)
Definition at line 453 of file binfile.h.
Referenced by itpp::it_file::pack(), itpp::it_ifile::read_data_header(), itpp::it_ifile_old::read_data_header(), itpp::it_ifile::seek(), itpp::it_ifile::seek(), itpp::it_ifile_old::seek(), itpp::it_ifile_old::seek(), itpp::it_file::write_data_header(), and itpp::it_file_old::write_data_header().
|
inline |
|
inline |
|
inlineprotected |
Access to internal stream for derived classes.
Definition at line 464 of file binfile.h.
Referenced by itpp::bfstream::operator>>().
Generated on Tue Dec 10 2024 04:49:37 for IT++ by Doxygen 1.12.0