igzstream Class Reference

Class to read data from a Gzip compressed file. More...

#include <fileops.h>

Inheritance diagram for igzstream:

Inheritance graph
[legend]
Collaboration diagram for igzstream:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 igzstream ()
 Default constructor.
 igzstream (const string &fname)
 Opens a file for read access.
 ~igzstream ()
 Destructor.
bool open (const string &fname)
 Opens a file for read access.
void get_block (void *to, u_int32 size)
 Reads a block of bytes from the file.
bool get_bool ()
 Reads a boolean.
u_int8 get_uint8 ()
 Reads a u_int8.
s_int8 get_sint8 ()
 Reads a s_int8.
u_int16 get_uint16 ()
 Reads a u_int16.
s_int16 get_sint16 ()
 Reads a s_int16.
u_int32 get_uint32 ()
 Reads a u_int32.
s_int32 get_sint32 ()
 Reads a s_int32.
string get_string ()
 Reads a string.
float get_float ()
 Reads a float.

Friends

bool & operator<< (bool &n, igzstream &gfile)
 Reads a boolean.
char & operator<< (char &n, igzstream &gfile)
 Reads a char.
u_int8 & operator<< (u_int8 &n, igzstream &gfile)
 Reads a u_int8.
s_int8 & operator<< (s_int8 &n, igzstream &gfile)
 Reads a s_int8.
u_int16 & operator<< (u_int16 &n, igzstream &gfile)
 Reads a u_int16.
s_int16 & operator<< (s_int16 &n, igzstream &gfile)
 Reads a s_int16.
u_int32 & operator<< (u_int32 &n, igzstream &gfile)
 Reads a u_int32.
s_int32 & operator<< (s_int32 &n, igzstream &gfile)
 Reads a s_int32.
string & operator<< (string &s, igzstream &gfile)
 Reads a string.
float & operator<< (float &s, igzstream &gfile)
 Reads a float.


Detailed Description

Class to read data from a Gzip compressed file.

Definition at line 131 of file fileops.h.


Constructor & Destructor Documentation

igzstream::igzstream (  ) 

Default constructor.

Definition at line 65 of file fileops.cc.

igzstream::igzstream ( const string &  fname  ) 

Opens a file for read access.

Parameters:
fname name of the file to open.

Definition at line 69 of file fileops.cc.

igzstream::~igzstream (  ) 

Destructor.

Definition at line 73 of file fileops.cc.


Member Function Documentation

bool igzstream::open ( const string &  fname  ) 

Opens a file for read access.

Parameters:
fname name of the file to open.
Returns:
true if succeed, false otherwise.

Definition at line 77 of file fileops.cc.

void igzstream::get_block ( void *  to,
u_int32  size 
)

Reads a block of bytes from the file.

Read a block of size chars.

Parameters:
to pointer to the buffer where to read.
size number of bytes to read.

Definition at line 106 of file fileops.cc.

bool igzstream::get_bool (  ) 

Reads a boolean.

Definition at line 91 of file fileops.cc.

u_int8 igzstream::get_uint8 (  ) 

Reads a u_int8.

Definition at line 119 of file fileops.cc.

s_int8 igzstream::get_sint8 (  ) 

Reads a s_int8.

Definition at line 134 of file fileops.cc.

u_int16 igzstream::get_uint16 (  ) 

Reads a u_int16.

Definition at line 150 of file fileops.cc.

s_int16 igzstream::get_sint16 (  ) 

Reads a s_int16.

Definition at line 166 of file fileops.cc.

u_int32 igzstream::get_uint32 (  ) 

Reads a u_int32.

Definition at line 182 of file fileops.cc.

s_int32 igzstream::get_sint32 (  ) 

Reads a s_int32.

Definition at line 198 of file fileops.cc.

string igzstream::get_string (  ) 

Reads a string.

Definition at line 222 of file fileops.cc.

float igzstream::get_float (  ) 

Reads a float.

Definition at line 242 of file fileops.cc.


Friends And Related Function Documentation

bool& operator<< ( bool &  n,
igzstream gfile 
) [friend]

Reads a boolean.

Definition at line 83 of file fileops.cc.

char& operator<< ( char &  n,
igzstream gfile 
) [friend]

Reads a char.

Definition at line 99 of file fileops.cc.

u_int8& operator<< ( u_int8 &  n,
igzstream gfile 
) [friend]

Reads a u_int8.

Definition at line 112 of file fileops.cc.

s_int8& operator<< ( s_int8 &  n,
igzstream gfile 
) [friend]

Reads a s_int8.

Definition at line 127 of file fileops.cc.

u_int16& operator<< ( u_int16 &  n,
igzstream gfile 
) [friend]

Reads a u_int16.

Definition at line 142 of file fileops.cc.

s_int16& operator<< ( s_int16 &  n,
igzstream gfile 
) [friend]

Reads a s_int16.

Definition at line 158 of file fileops.cc.

u_int32& operator<< ( u_int32 &  n,
igzstream gfile 
) [friend]

Reads a u_int32.

Definition at line 174 of file fileops.cc.

s_int32& operator<< ( s_int32 &  n,
igzstream gfile 
) [friend]

Reads a s_int32.

Definition at line 190 of file fileops.cc.

string& operator<< ( string &  s,
igzstream gfile 
) [friend]

Reads a string.

Definition at line 206 of file fileops.cc.

float& operator<< ( float &  s,
igzstream gfile 
) [friend]

Reads a float.

Definition at line 230 of file fileops.cc.


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

Generated on Wed Jun 18 16:52:01 2008 for Adonthell by  doxygen 1.5.6