itpp::bfstream Class Reference
Base Module » IT++ File Format

Binary in/out-file Class. More...

`#include <itpp/base/binfile.h>`

Inheritance diagram for itpp::bfstream:

## Public Types

enum | endian { l_endian , b_endian }
| Definition of the endian data type. More...

## Public Member Functions

| bfstream (const std::string &name, endian e=b_endian)
| Class constructor that opens a file and sets the endianity.
| bfstream ()
| Class Constructor.
| ~bfstream ()
| Class Destructor.
void | open (const std::string &name, bool trunc=false, endian e=b_endian)
| Open a file for reading and writing and set the endianity.
void | open_readonly (const std::string &name, endian e=b_endian)
| Open a file for reading only and set the endianity.
int | length ()
| Returns the length in bytes of the file.
bfstream & | operator<< (char a)
| Writes an char variable to the binary file.
bfstream & | operator<< (int8_t a)
| Writes a 8-bit signed integer variable to the binary file.
bfstream & | operator<< (uint8_t a)
| Writes a 8-bit unsigned integer variable to the binary file.
bfstream & | operator<< (int16_t a)
| Writes a 16-bit signed integer variable to the binary file.
bfstream & | operator<< (uint16_t a)
| Writes a 16-bit unsigned integer variable to the binary file.
bfstream & | operator<< (int32_t a)
| Writes a 32-bit signed integer variable to the binary file.
bfstream & | operator<< (uint32_t a)
| Writes a 32-bit unsigned integer variable to the binary file.
bfstream & | operator<< (int64_t a)
| Writes a 64-bit signed integer variable to the binary file.
bfstream & | operator<< (uint64_t a)
| Writes a 64-bit unsigned ingeger variable to the binary file.
bfstream & | operator<< (float a)
| Writes a float variable to the binary file.
bfstream & | operator<< (double a)
| Writes a double variable to the binary file.
bfstream & | operator<< (bin a)
| Writes a binary variable to the binary file.
bfstream & | operator<< (const char *a)
| Writes a char* string to the binary file.
bfstream & | operator<< (const std::string &a)
| Writes a string variable to the binary file.
bfstream & | operator>> (char &a)
| Reads a char variable from the binary file.
bfstream & | operator>> (int8_t &a)
| Reads a 8-bit signed integer variable from the binary file.
bfstream & | operator>> (uint8_t &a)
| Reads a 8-bit unsigned integer variable from the binary file.
bfstream & | operator>> (int16_t &a)
| Reads a 16-bit signed integer variable from the binary file.
bfstream & | operator>> (uint16_t &a)
| Reads a 16-bit unsigned integer variable from the binary file.
bfstream & | operator>> (int32_t &a)
| Reads a 32-bit signed integer variable from the binary file.
bfstream & | operator>> (uint32_t &a)
| Reads a 32-bit unsigned integer variable from the binary file.
bfstream & | operator>> (int64_t &a)
| Reads a 64-bit signed integer variable from the binary file.
bfstream & | operator>> (uint64_t &a)
| Reads a 64-bit unsigned ingeger variable from the binary file.
bfstream & | operator>> (float &a)
| Reads a float variable from the binary file.
bfstream & | operator>> (double &a)
| Reads a double variable from the binary file.
bfstream & | operator>> (bin &a)
| Reads a binary variable from the binary file.
bfstream & | operator>> (char *a)
| Reads a char* string from the binary file.
bfstream & | operator>> (std::string &a)
| Reads a string variable from the binary file.
endian | get_endianity () const
| Returns the endianity of the class.
endian | get_native_endianity () const
| Returns the native endianity for this computer architecture.
void | set_endianity (endian e)
| Set the endianity for this class.
void | set_native_endianity ()
| Set the endianity of this class to the native endianity for this computer architecture.
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.

## Protected Member Functions

std::fstream * | stream ()
| Access to internal stream for derived classes.

## Protected Attributes

bool | switch_endianity
| Indicates if the endianity of the processed data needs to be changed.
endian | native_endianity
| The native endianity for this computer architecture.

## Detailed Description

Binary in/out-file Class.

Definition at line 603 of file binfile.h.

## Member Enumeration Documentation

## endian

enum itpp::bfstream_base::endian

inherited

Definition of the endian data type.

The Endianness defines the order in which multibyte numbers are stored in the file. The two orders are called "Little Endian" (`l_endian` ) and "Big Endian" (`b_endian` ).

"Little Endian" means that the low-order byte of the number is stored at the lowest address (i.e. the little end comes first). "Big Endian" means that the high-order byte of the number is stored in memory at the lowest address (i.e. the big end comes first)

Definition at line 74 of file binfile.h.

## Constructor & Destructor Documentation

## bfstream() [1/2]

itpp::bfstream::bfstream | ( | const std::string & | name,
|  | endian | e = `b_endian`
| ) |  |

Class constructor that opens a file and sets the endianity.

Parameters

  name | The name of the file to open
  e | Defines the endianity of the class. Possible values are `l_endian` for "Little Endian" or `b_endian` for "Big Endian". The default value is `b_endian`.

Definition at line 353 of file binfile.cpp.

## bfstream() [2/2]

itpp::bfstream::bfstream | ( |  | ) |

Class Constructor.

Definition at line 357 of file binfile.cpp.

## ~bfstream()

itpp::bfstream::~bfstream | ( |  | ) |

inline

Class Destructor.

Definition at line 620 of file binfile.h.

## Member Function Documentation

## open() [1/2]

void itpp::bfstream::open | ( | const std::string & | name,
|  | bool | trunc = `false`,
|  | endian | e = `b_endian`
| ) |  |

Open a file for reading and writing and set the endianity.

Parameters

  name | The name of the file to open
  trunc | Rewrite the file if it exists (default value is `false`)
  e | Defines the endianity of the class (default value is `b_endian` )

Definition at line 359 of file binfile.cpp.

References itpp::bfstream_base::native_endianity, itpp::binfile_details::Fstream_Binfile_Facade::open(), and itpp::bfstream_base::switch_endianity.

Referenced by itpp::it_file::open(), itpp::it_file_old::open(), and itpp::it_file::pack().

## open_readonly()

void itpp::bfstream::open_readonly | ( | const std::string & | name,
|  | endian | e = `b_endian`
| ) |  |

Open a file for reading only and set the endianity.

Parameters

  name | The name of the file to open
  e | Defines the endianity of the class (default value is `b_endian` )

Definition at line 373 of file binfile.cpp.

References itpp::bfstream_base::native_endianity, itpp::binfile_details::Fstream_Binfile_Facade::open(), and itpp::bfstream_base::switch_endianity.

Referenced by itpp::it_ifile::open(), and itpp::it_ifile_old::open().

## length()

int itpp::bfstream::length | ( |  | ) |

Returns the length in bytes of the file.

Definition at line 382 of file binfile.cpp.

References itpp::binfile_details::Fstream_Binfile_Facade::seekg(), and itpp::binfile_details::Fstream_Binfile_Facade::tellg().

## operator<<() [1/14]

bfstream & itpp::bfstream::operator<< | ( | char | a | ) |

Writes an char variable to the binary file.

Definition at line 392 of file binfile.cpp.

References itpp::binfile_details::Fstream_Binfile_Facade::put().

## operator<<() [2/14]

bfstream & itpp::bfstream::operator<< | ( | int8_t | a | ) |

Writes a 8-bit signed integer variable to the binary file.

Definition at line 398 of file binfile.cpp.

References it_assert, and itpp::binfile_details::Fstream_Binfile_Facade::put().

## operator<<() [3/14]

bfstream & itpp::bfstream::operator<< | ( | uint8_t | a | ) |

Writes a 8-bit unsigned integer variable to the binary file.

Definition at line 405 of file binfile.cpp.

References it_assert, and itpp::binfile_details::Fstream_Binfile_Facade::put().

## operator<<() [4/14]

bfstream & itpp::bfstream::operator<< | ( | int16_t | a | ) |

Writes a 16-bit signed integer variable to the binary file.

Definition at line 412 of file binfile.cpp.

References itpp::bfstream_base::switch_endianity.

## operator<<() [5/14]

bfstream & itpp::bfstream::operator<< | ( | uint16_t | a | ) |

Writes a 16-bit unsigned integer variable to the binary file.

Definition at line 418 of file binfile.cpp.

References itpp::bfstream_base::switch_endianity.

## operator<<() [6/14]

bfstream & itpp::bfstream::operator<< | ( | int32_t | a | ) |

Writes a 32-bit signed integer variable to the binary file.

Definition at line 424 of file binfile.cpp.

References itpp::bfstream_base::switch_endianity.

## operator<<() [7/14]

bfstream & itpp::bfstream::operator<< | ( | uint32_t | a | ) |

Writes a 32-bit unsigned integer variable to the binary file.

Definition at line 430 of file binfile.cpp.

References itpp::bfstream_base::switch_endianity.

## operator<<() [8/14]

bfstream & itpp::bfstream::operator<< | ( | int64_t | a | ) |

Writes a 64-bit signed integer variable to the binary file.

Definition at line 436 of file binfile.cpp.

References itpp::bfstream_base::switch_endianity.

## operator<<() [9/14]

bfstream & itpp::bfstream::operator<< | ( | uint64_t | a | ) |

Writes a 64-bit unsigned ingeger variable to the binary file.

Definition at line 442 of file binfile.cpp.

References itpp::bfstream_base::switch_endianity.

## operator<<() [10/14]

bfstream & itpp::bfstream::operator<< | ( | float | a | ) |

Writes a float variable to the binary file.

Definition at line 448 of file binfile.cpp.

References itpp::bfstream_base::switch_endianity.

## operator<<() [11/14]

bfstream & itpp::bfstream::operator<< | ( | double | a | ) |

Writes a double variable to the binary file.

Definition at line 454 of file binfile.cpp.

References itpp::bfstream_base::switch_endianity.

## operator<<() [12/14]

bfstream & itpp::bfstream::operator<< | ( | bin | a | ) |

Writes a binary variable to the binary file.

Definition at line 460 of file binfile.cpp.

References itpp::bfstream_base::switch_endianity.

## operator<<() [13/14]

bfstream & itpp::bfstream::operator<< | ( | const char * | a | ) |

Writes a char* string to the binary file.

Definition at line 466 of file binfile.cpp.

References itpp::binfile_details::Fstream_Binfile_Facade::write().

## operator<<() [14/14]

bfstream & itpp::bfstream::operator<< | ( | const std::string & | a | ) |

Writes a string variable to the binary file.

Definition at line 472 of file binfile.cpp.

References itpp::Array< T >::size(), and itpp::binfile_details::Fstream_Binfile_Facade::write().

## operator>>() [1/14]

bfstream & itpp::bfstream::operator>> | ( | char & | a | ) |

Reads a char variable from the binary file.

Definition at line 479 of file binfile.cpp.

References itpp::binfile_details::Fstream_Binfile_Facade::get().

## operator>>() [2/14]

bfstream & itpp::bfstream::operator>> | ( | int8_t & | a | ) |

Reads a 8-bit signed integer variable from the binary file.

Definition at line 485 of file binfile.cpp.

References itpp::binfile_details::Fstream_Binfile_Facade::get(), and it_assert.

## operator>>() [3/14]

bfstream & itpp::bfstream::operator>> | ( | uint8_t & | a | ) |

Reads a 8-bit unsigned integer variable from the binary file.

Definition at line 494 of file binfile.cpp.

References itpp::binfile_details::Fstream_Binfile_Facade::get(), and it_assert.

## operator>>() [4/14]

bfstream & itpp::bfstream::operator>> | ( | int16_t & | a | ) |

Reads a 16-bit signed integer variable from the binary file.

Definition at line 503 of file binfile.cpp.

References itpp::bfstream_base::switch_endianity.

## operator>>() [5/14]

bfstream & itpp::bfstream::operator>> | ( | uint16_t & | a | ) |

Reads a 16-bit unsigned integer variable from the binary file.

Definition at line 509 of file binfile.cpp.

References itpp::bfstream_base::switch_endianity.

## operator>>() [6/14]

bfstream & itpp::bfstream::operator>> | ( | int32_t & | a | ) |

Reads a 32-bit signed integer variable from the binary file.

Definition at line 515 of file binfile.cpp.

References itpp::bfstream_base::switch_endianity.

## operator>>() [7/14]

bfstream & itpp::bfstream::operator>> | ( | uint32_t & | a | ) |

Reads a 32-bit unsigned integer variable from the binary file.

Definition at line 521 of file binfile.cpp.

References itpp::bfstream_base::switch_endianity.

## operator>>() [8/14]

bfstream & itpp::bfstream::operator>> | ( | int64_t & | a | ) |

Reads a 64-bit signed integer variable from the binary file.

Definition at line 527 of file binfile.cpp.

References itpp::bfstream_base::switch_endianity.

## operator>>() [9/14]

bfstream & itpp::bfstream::operator>> | ( | uint64_t & | a | ) |

Reads a 64-bit unsigned ingeger variable from the binary file.

Definition at line 533 of file binfile.cpp.

References itpp::bfstream_base::switch_endianity.

## operator>>() [10/14]

bfstream & itpp::bfstream::operator>> | ( | float & | a | ) |

Reads a float variable from the binary file.

Definition at line 539 of file binfile.cpp.

References itpp::bfstream_base::switch_endianity.

## operator>>() [11/14]

bfstream & itpp::bfstream::operator>> | ( | double & | a | ) |

Reads a double variable from the binary file.

Definition at line 545 of file binfile.cpp.

References itpp::bfstream_base::switch_endianity.

## operator>>() [12/14]

bfstream & itpp::bfstream::operator>> | ( | bin & | a | ) |

Reads a binary variable from the binary file.

Definition at line 551 of file binfile.cpp.

References it_assert, and itpp::bfstream_base::switch_endianity.

## operator>>() [13/14]

bfstream & itpp::bfstream::operator>> | ( | char * | a | ) |

Reads a char* string from the binary file.

Definition at line 561 of file binfile.cpp.

References itpp::binfile_details::Fstream_Binfile_Facade::getline().

## operator>>() [14/14]

bfstream & itpp::bfstream::operator>> | ( | std::string & | a | ) |

Reads a string variable from the binary file.

Definition at line 567 of file binfile.cpp.

References itpp::binfile_details::Fstream_Binfile_Facade::stream().

## get_endianity()

endian itpp::bfstream_base::get_endianity | ( |  | ) | const

inlineinherited

Returns the endianity of the class.

Definition at line 88 of file binfile.h.

## get_native_endianity()

endian itpp::bfstream_base::get_native_endianity | ( |  | ) | const

inlineinherited

Returns the native endianity for this computer architecture.

Intel processors use "Little Endian" byte ordering while e.g. Motorola processors use "Big Endian" byte ordering.

Definition at line 105 of file binfile.h.

Referenced by itpp::it_file_old::write_data_header().

## set_endianity()

void itpp::bfstream_base::set_endianity | ( | endian | e | ) |

inlineinherited

Set the endianity for this class.

Definition at line 110 of file binfile.h.

Referenced by itpp::it_ifile_old::read_data_header(), and itpp::it_file_old::write_data_header_here().

## set_native_endianity()

void itpp::bfstream_base::set_native_endianity | ( |  | ) |

inlineinherited

Set the endianity of this class to the native endianity for this computer architecture.

Definition at line 121 of file binfile.h.

## is_open()

bool itpp::binfile_details::Fstream_Binfile_Facade::is_open | ( |  | ) |

inlineinherited

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().

## open() [2/2]

void itpp::binfile_details::Fstream_Binfile_Facade::open | ( | const char * | filename,
|  | std::ios_base::openmode | mode = `std::ios_base::in | std::ios_base::out | std::ios_base::binary`
| ) |  |

inlineinherited

Method to open corresponding file.

Definition at line 369 of file binfile.h.

Referenced by open(), and open_readonly().

## close()

void itpp::binfile_details::Fstream_Binfile_Facade::close | ( |  | ) |

inlineinherited

Method to close corresponding file.

Definition at line 373 of file binfile.h.

Referenced by itpp::it_ifile::close(), itpp::it_file::close(), itpp::it_ifile_old::close(), itpp::it_file_old::close(), itpp::it_ifile::open(), itpp::it_file::open(), itpp::it_ifile_old::open(), itpp::it_file_old::open(), and itpp::it_file::pack().

## write()

Fstream_Binfile_Facade & itpp::binfile_details::Fstream_Binfile_Facade::write | ( | const char * | c,
|  | std::streamsize | n
| ) |  |

inlineinherited

Output multiple characters.

Definition at line 376 of file binfile.h.

References itpp::binfile_details::Fstream_Binfile_Facade::write().

Referenced by operator<<(), operator<<(), itpp::binfile_details::Fstream_Binfile_Facade::write(), itpp::it_file::write_file_header(), and itpp::it_file_old::write_file_header().

## put()

Fstream_Binfile_Facade & itpp::binfile_details::Fstream_Binfile_Facade::put | ( | const char | c | ) |

inlineinherited

Output single char.

Definition at line 379 of file binfile.h.

References itpp::binfile_details::Fstream_Binfile_Facade::put().

Referenced by operator<<(), operator<<(), operator<<(), itpp::it_file::pack(), itpp::binfile_details::Fstream_Binfile_Facade::put(), and itpp::it_file::write_file_header().

## tellp()

std::streampos itpp::binfile_details::Fstream_Binfile_Facade::tellp | ( |  | ) |

inlineinherited

Get position.

Definition at line 382 of file binfile.h.

Referenced by itpp::it_file::remove(), itpp::it_file_old::remove(), itpp::it_file_old::write_data_header(), and itpp::it_file::write_data_header().

## seekp() [1/2]

Fstream_Binfile_Facade & itpp::binfile_details::Fstream_Binfile_Facade::seekp | ( | std::streampos | pos | ) |

inlineinherited

Set position.

Definition at line 384 of file binfile.h.

References itpp::binfile_details::Fstream_Binfile_Facade::seekp().

Referenced by itpp::it_file::pack(), itpp::it_file::remove(), itpp::it_file_old::remove(), itpp::binfile_details::Fstream_Binfile_Facade::seekp(), itpp::binfile_details::Fstream_Binfile_Facade::seekp(), itpp::it_file_old::write_data_header(), and itpp::it_file::write_data_header().

## seekp() [2/2]

Fstream_Binfile_Facade & itpp::binfile_details::Fstream_Binfile_Facade::seekp | ( | std::streamoff | pos,
|  | std::ios_base::seekdir | way
| ) |  |

inlineinherited

Set relative position.

Definition at line 387 of file binfile.h.

References itpp::binfile_details::Fstream_Binfile_Facade::seekp().

## flush()

Fstream_Binfile_Facade & itpp::binfile_details::Fstream_Binfile_Facade::flush | ( |  | ) |

inlineinherited

Flushes stream buffer.

Definition at line 390 of file binfile.h.

References itpp::binfile_details::Fstream_Binfile_Facade::flush().

Referenced by itpp::binfile_details::Fstream_Binfile_Facade::flush(), itpp::it_file::flush(), and itpp::it_file_old::flush().

## gcount()

std::streamsize itpp::binfile_details::Fstream_Binfile_Facade::gcount | ( |  | ) | const

inlineinherited

Last extracted chars count.

Definition at line 392 of file binfile.h.

## get() [1/4]

int itpp::binfile_details::Fstream_Binfile_Facade::get | ( |  | ) |

inlineinherited

Get single char.

Definition at line 394 of file binfile.h.

Referenced by itpp::binfile_details::Fstream_Binfile_Facade::get(), itpp::binfile_details::Fstream_Binfile_Facade::get(), itpp::binfile_details::Fstream_Binfile_Facade::get(), operator>>(), operator>>(), operator>>(), and itpp::it_file::pack().

## get() [2/4]

Fstream_Binfile_Facade & itpp::binfile_details::Fstream_Binfile_Facade::get | ( | char & | c | ) |

inlineinherited

Get single char.

Definition at line 396 of file binfile.h.

References itpp::binfile_details::Fstream_Binfile_Facade::get().

## get() [3/4]

Fstream_Binfile_Facade & itpp::binfile_details::Fstream_Binfile_Facade::get | ( | char * | s,
|  | std::streamsize | n
| ) |  |

inlineinherited

Get multiple chars to c-string and add trailing 0.

Definition at line 398 of file binfile.h.

References itpp::binfile_details::Fstream_Binfile_Facade::get().

## get() [4/4]

Fstream_Binfile_Facade & itpp::binfile_details::Fstream_Binfile_Facade::get | ( | char * | s,
|  | std::streamsize | n,
|  | char | delim
| ) |  |

inlineinherited

Get multiple chars to c-string without trailing 0.

Definition at line 401 of file binfile.h.

References itpp::binfile_details::Fstream_Binfile_Facade::get().

## getline() [1/2]

Fstream_Binfile_Facade & itpp::binfile_details::Fstream_Binfile_Facade::getline | ( | char * | s,
|  | std::streamsize | n
| ) |  |

inlineinherited

Get multiple chars to c-string without trailing 0.

Definition at line 404 of file binfile.h.

References itpp::binfile_details::Fstream_Binfile_Facade::getline().

Referenced by itpp::binfile_details::Fstream_Binfile_Facade::getline(), and operator>>().

## getline() [2/2]

Fstream_Binfile_Facade & itpp::binfile_details::Fstream_Binfile_Facade::getline | ( | char * | s,
|  | std::streamsize | n,
|  | char | delim
| ) |  |

inlineinherited

Definition at line 406 of file binfile.h.

## ignore()

Fstream_Binfile_Facade & itpp::binfile_details::Fstream_Binfile_Facade::ignore | ( | std::streamsize | n = `1`,
|  | int | delim = `EOF`
| ) |  |

inlineinherited

Extract and ignore chars.

Definition at line 409 of file binfile.h.

References itpp::binfile_details::Fstream_Binfile_Facade::ignore().

Referenced by itpp::binfile_details::Fstream_Binfile_Facade::ignore().

## peek()

int itpp::binfile_details::Fstream_Binfile_Facade::peek | ( |  | ) |

inlineinherited

Peak single char from the top of the buffer.

Definition at line 412 of file binfile.h.

## read()

Fstream_Binfile_Facade & itpp::binfile_details::Fstream_Binfile_Facade::read | ( | char * | s,
|  | std::streamsize | n
| ) |  |

inlineinherited

Read n chars from stream.

Definition at line 414 of file binfile.h.

References itpp::binfile_details::Fstream_Binfile_Facade::read().

Referenced by itpp::binfile_details::Fstream_Binfile_Facade::read(), itpp::it_ifile::read_check_file_header(), and itpp::it_ifile_old::read_check_file_header().

## readsome()

std::streamsize itpp::binfile_details::Fstream_Binfile_Facade::readsome | ( | char * | s,
|  | std::streamsize | n
| ) |  |

inlineinherited

Read up to n available chars from stream.

Definition at line 417 of file binfile.h.

## putback()

Fstream_Binfile_Facade & itpp::binfile_details::Fstream_Binfile_Facade::putback | ( | char | c | ) |

inlineinherited

This method attempts to put back single char.

Definition at line 420 of file binfile.h.

References itpp::binfile_details::Fstream_Binfile_Facade::putback().

Referenced by itpp::binfile_details::Fstream_Binfile_Facade::putback().

## unget()

Fstream_Binfile_Facade & itpp::binfile_details::Fstream_Binfile_Facade::unget | ( |  | ) |

inlineinherited

Unget last extracted char.

Definition at line 423 of file binfile.h.

References itpp::binfile_details::Fstream_Binfile_Facade::unget().

Referenced by itpp::binfile_details::Fstream_Binfile_Facade::unget().

## tellg()

std::streampos itpp::binfile_details::Fstream_Binfile_Facade::tellg | ( |  | ) |

inlineinherited

Get position.

Definition at line 426 of file binfile.h.

Referenced by itpp::it_ifile_old::info(), itpp::it_ifile::info(), length(), itpp::it_file::pack(), itpp::it_ifile_old::read_data_header(), itpp::it_ifile::seek(), itpp::it_ifile_old::seek(), itpp::it_ifile::seek(), and itpp::it_ifile_old::seek().

## seekg() [1/2]

Fstream_Binfile_Facade & itpp::binfile_details::Fstream_Binfile_Facade::seekg | ( | std::streampos | pos | ) |

inlineinherited

Set position.

Definition at line 428 of file binfile.h.

References itpp::binfile_details::Fstream_Binfile_Facade::seekg().

Referenced by itpp::it_ifile_old::info(), itpp::it_ifile::info(), length(), itpp::it_file::pack(), itpp::it_ifile_old::read_data_header(), itpp::it_ifile::seek(), itpp::it_ifile_old::seek(), itpp::it_ifile::seek(), itpp::it_ifile_old::seek(), itpp::binfile_details::Fstream_Binfile_Facade::seekg(), itpp::binfile_details::Fstream_Binfile_Facade::seekg(), itpp::it_file_old::write_data_header(), and itpp::it_file::write_data_header().

## seekg() [2/2]

Fstream_Binfile_Facade & itpp::binfile_details::Fstream_Binfile_Facade::seekg | ( | std::streamoff | pos,
|  | std::ios_base::seekdir | way
| ) |  |

inlineinherited

Set relative position.

Definition at line 431 of file binfile.h.

References itpp::binfile_details::Fstream_Binfile_Facade::seekg().

## good()

bool itpp::binfile_details::Fstream_Binfile_Facade::good | ( |  | ) | const

inlineinherited

This method returns true is stream state is good.

Definition at line 435 of file binfile.h.

## eof()

bool itpp::binfile_details::Fstream_Binfile_Facade::eof | ( |  | ) | const

inlineinherited

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_old::seek(), itpp::it_ifile::seek(), itpp::it_ifile_old::seek(), itpp::it_file_old::write_data_header(), and itpp::it_file::write_data_header().

## fail()

bool itpp::binfile_details::Fstream_Binfile_Facade::fail | ( |  | ) | const

inlineinherited

This method returns true if either failbit or badbit is set.

Definition at line 439 of file binfile.h.

## bad()

bool itpp::binfile_details::Fstream_Binfile_Facade::bad | ( |  | ) | const

inlineinherited

This method returns true if badbit is set.

Definition at line 441 of file binfile.h.

## operator!()

bool itpp::binfile_details::Fstream_Binfile_Facade::operator! | ( |  | ) | const

inlineinherited

Unary not operator to check the stream state.

Definition at line 444 of file binfile.h.

## operator bool()

itpp::binfile_details::Fstream_Binfile_Facade::operator bool | ( |  | ) | const

inlineinherited

Conversion to bool to validate stream state.

Definition at line 446 of file binfile.h.

## rdstate()

std::ios_base::iostate itpp::binfile_details::Fstream_Binfile_Facade::rdstate | ( |  | ) | const

inlineinherited

Method to read stream state flags.

Definition at line 449 of file binfile.h.

## setstate()

void itpp::binfile_details::Fstream_Binfile_Facade::setstate | ( | std::ios_base::iostate | state | ) |

inlineinherited

Method to set the stream state (combines already set flags with flags provide by user)

Definition at line 451 of file binfile.h.

## clear()

void itpp::binfile_details::Fstream_Binfile_Facade::clear | ( | std::ios_base::iostate | state = `std::ios_base::goodbit` | ) |

inlineinherited

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_old::read_data_header(), itpp::it_ifile::read_data_header(), itpp::it_ifile::seek(), itpp::it_ifile_old::seek(), itpp::it_ifile::seek(), itpp::it_ifile_old::seek(), itpp::it_file_old::write_data_header(), and itpp::it_file::write_data_header().

## exceptions() [1/2]

std::ios_base::iostate itpp::binfile_details::Fstream_Binfile_Facade::exceptions | ( |  | ) | const

inlineinherited

Method to get the exceptions mask.

Definition at line 456 of file binfile.h.

## exceptions() [2/2]

void itpp::binfile_details::Fstream_Binfile_Facade::exceptions | ( | std::ios_base::iostate | except | ) |

inlineinherited

Method to set the exceptions mask.

Definition at line 458 of file binfile.h.

## stream()

std::fstream * itpp::binfile_details::Fstream_Binfile_Facade::stream | ( |  | ) |

inlineprotectedinherited

Access to internal stream for derived classes.

Definition at line 464 of file binfile.h.

Referenced by operator>>().

## Member Data Documentation

## switch_endianity

bool itpp::bfstream_base::switch_endianity

protectedinherited

Indicates if the endianity of the processed data needs to be changed.

Definition at line 125 of file binfile.h.

Referenced by itpp::bfstream_base::bfstream_base(), itpp::bofstream::open(), open(), itpp::bifstream::open(), open_readonly(), itpp::bofstream::operator<<(), operator<<(), itpp::bofstream::operator<<(), operator<<(), itpp::bofstream::operator<<(), operator<<(), itpp::bofstream::operator<<(), operator<<(), itpp::bofstream::operator<<(), operator<<(), itpp::bofstream::operator<<(), operator<<(), itpp::bofstream::operator<<(), operator<<(), itpp::bofstream::operator<<(), operator<<(), itpp::bofstream::operator<<(), operator<<(), itpp::bifstream::operator>>(), operator>>(), itpp::bifstream::operator>>(), operator>>(), itpp::bifstream::operator>>(), operator>>(), itpp::bifstream::operator>>(), operator>>(), itpp::bifstream::operator>>(), operator>>(), itpp::bifstream::operator>>(), operator>>(), itpp::bifstream::operator>>(), operator>>(), itpp::bifstream::operator>>(), operator>>(), itpp::bifstream::operator>>(), and operator>>().

## native_endianity

endian itpp::bfstream_base::native_endianity

protectedinherited

The native endianity for this computer architecture.

Definition at line 127 of file binfile.h.

Referenced by itpp::bfstream_base::bfstream_base(), itpp::bofstream::open(), open(), itpp::bifstream::open(), and open_readonly().

The documentation for this class was generated from the following files:

- itpp/base/binfile.h
- itpp/base/binfile.cpp

Generated on Mon Jun 10 2024 11:49:33 for IT++ by Doxygen 1.9.8