IT++ Logo
Public Member Functions | Protected Attributes | Static Protected Attributes | List of all members
itpp::it_ifile Class Reference

The IT++ file format reading class. More...

#include <itpp/base/itfile.h>

Inheritance diagram for itpp::it_ifile:
itpp::it_file_base itpp::it_file

Public Member Functions

 it_ifile ()
 Default constructor.
 
 it_ifile (const std::string &filename)
 Constructor that calls open(filename)
 
virtual ~it_ifile ()
 Destructor.
 
void open (const std::string &filename)
 Open an existing file in read-only mode.
 
virtual void close ()
 Close the file.
 
bfstreamlow_level ()
 Returns pointer to the underlying bfstream used.
 
bool read_check_file_header ()
 Read and check the file header. Return true if the header is valid and false otherwise.
 
void read_data_header (it_file_base::data_header &h)
 Read data header and return the result in the variable h.
 
void low_level_read (char &x)
 Read a char value at the current file pointer position.
 
void low_level_read (uint64_t &x)
 Read a 64-bit unsigned integer value at the current file pointer position.
 
void low_level_read (bool &x)
 Read a bool value at the current file pointer position.
 
void low_level_read (bin &x)
 Read a binary value at the current file pointer position.
 
void low_level_read (short &x)
 Read a short value at the current file pointer position.
 
void low_level_read (int &x)
 Read an integer value at the current file pointer position.
 
void low_level_read (float &x)
 Read a float value at the current file pointer position.
 
void low_level_read (double &x)
 Read a double value at the current file pointer position.
 
void low_level_read (std::complex< float > &x)
 Read a float complex value at the current file pointer position.
 
void low_level_read (std::complex< double > &x)
 Read a double complex value at the current file pointer position.
 
void low_level_read (bvec &v)
 Read a vector of binary values at the current file pointer position.
 
void low_level_read (svec &v)
 Read a vector of short integer values at the current file pointer position.
 
void low_level_read (ivec &v)
 Read a vector of integer values at the current file pointer position.
 
void low_level_read_lo (vec &v)
 Read a vector of float values at the current file pointer position.
 
void low_level_read_hi (vec &v)
 Read a vector of double values at the current file pointer position.
 
void low_level_read_lo (cvec &v)
 Read a vector of float complex values at the current file pointer position.
 
void low_level_read_hi (cvec &v)
 Read a vector of double complex values at the current file pointer position.
 
void low_level_read (std::string &str)
 Read a string at the current file pointer position.
 
void low_level_read (bmat &m)
 Read a matrix of binary values at the current file pointer position.
 
void low_level_read (smat &m)
 Read a matrix of short integer values at the current file pointer position.
 
void low_level_read (imat &m)
 Read a matrix of integer values at the current file pointer position.
 
void low_level_read_lo (mat &m)
 Read a matrix of float values at the current file pointer position.
 
void low_level_read_hi (mat &m)
 Read a matrix of double values at the current file pointer position.
 
void low_level_read_lo (cmat &m)
 Read a matrix of float complex values at the current file pointer position.
 
void low_level_read_hi (cmat &m)
 Read a matrix of double complex values at the current file pointer position.
 
void low_level_read (Array< bin > &v)
 Read an Array of binary values at the current file pointer position.
 
void low_level_read (Array< short > &v)
 Read an Array of short integer values at the current file pointer position.
 
void low_level_read (Array< int > &v)
 Read an Array of integer values at the current file pointer position.
 
void low_level_read (Array< float > &v)
 Read an Array of float values at the current file pointer position.
 
void low_level_read_lo (Array< double > &v)
 Read an Array of float values at the current file pointer position.
 
void low_level_read_hi (Array< double > &v)
 Read an Array of double values at the current file pointer position.
 
void low_level_read (Array< std::complex< float > > &v)
 Read an Array of float complex values at the current file pointer position.
 
void low_level_read_lo (Array< std::complex< double > > &v)
 Read an Array of float complex values at the current file pointer position.
 
void low_level_read_hi (Array< std::complex< double > > &v)
 Read an Array of double complex values at the current file pointer position.
 
bool seek (const std::string &name)
 Find the variable name.
 
bool seek (int n)
 Find the variable number n.
 
void info (std::string &name, std::string &type, std::string &desc, uint64_t &bytes)
 Get information about the current variable.
 

Protected Attributes

bfstream s
 Protected binary file stream.
 

Static Protected Attributes

static char file_magic [4] = { 'I', 'T', '+', '+' }
 IT++ file marker: "IT++".
 
static char file_version = 3
 IT++ file version.
 

Detailed Description

The IT++ file format reading class.

Definition at line 132 of file itfile.h.


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

Generated on Sat Jul 6 2013 10:54:30 for IT++ by Doxygen 1.8.2