head 1.4; access; symbols; locks; strict; comment @# @; 1.4 date 2002.09.07.01.50.37; author curt; state Exp; branches; next 1.3; 1.3 date 2002.08.31.19.01.52; author curt; state Exp; branches; next 1.2; 1.2 date 2002.08.31.18.54.00; author curt; state Exp; branches; next 1.1; 1.1 date 2002.02.15.17.21.55; author curt; state Exp; branches; next ; desc @@ 1.4 log @Updated doxygen docs. @ text @
Main Page Class Hierarchy Compound List File List Compound Members File Members

# sg_gzifstream Class Reference

An envelope class for gzifstream. More...

`#include <sgstream.hxx>`

Inheritance diagram for sg_gzifstream:

List of all members.

## Public Methods
| sg_gzifstream ()
| Default constructor.
| sg_gzifstream (const string &name, ios_openmode io_mode=ios_in|ios_binary)
| Constructor that attempt to open a file with and without ".gz" extension.
| sg_gzifstream (int fd, ios_openmode io_mode=ios_in|ios_binary)
| Constructor that attaches itself to an existing file descriptor.
void | open (const string &name, ios_openmode io_mode=ios_in|ios_binary)
| Attempt to open a file with and without ".gz" extension.
void | attach (int fd, ios_openmode io_mode=ios_in|ios_binary)
| Attach to an existing file descriptor.
void | close ()
| Close the stream.
bool | is_open ()
## Related Functions
(Note that these are not member functions.)
istream & | skipeol (istream &in)
| An istream manipulator that skips to end of line.
istream & | skipws (istream &in)
| An istream manipulator that skips over white space.
istream & | skipcomment (istream &in)
| An istream manipulator that skips comments and white space.

## Detailed Description

An envelope class for gzifstream.

Definition at line 61 of file sgstream.hxx.

## Constructor & Destructor Documentation

sg_gzifstream::sg_gzifstream | ( | const string & | name,
|  | ios_openmode | io_mode = ios_in|ios_binary
| ) |

  | Constructor that attempt to open a file with and without ".gz" extension. Parameters:
  name | name of file
  io_mode | file open mode(s) "or'd" together
Definition at line 43 of file sgstream.cxx. References open().

sg_gzifstream::sg_gzifstream | ( | int | fd,
|  | ios_openmode | io_mode = ios_in|ios_binary
| ) |

  | Constructor that attaches itself to an existing file descriptor. Parameters:
  fd | file descriptor
  io_mode | file open mode(s) "or'd" together
Definition at line 53 of file sgstream.cxx. References gzfilebuf::attach().

## Member Function Documentation

void sg_gzifstream::attach | ( | int | fd,
|  | ios_openmode | io_mode = ios_in|ios_binary
| ) |

  | Attach to an existing file descriptor. Parameters:
  fd | file descriptor
  io_mode | file open mode(s) "or'd" together
Definition at line 92 of file sgstream.cxx. References gzfilebuf::attach().

bool sg_gzifstream::is_open | ( |  | ) | `[inline]`

| Returns: true if the file is successfully opened, false otherwise. Definition at line 104 of file sgstream.hxx. References gzfilebuf::is_open(). Referenced by SGInterpTable::SGInterpTable().

void sg_gzifstream::open | ( | const string & | name,
|  | ios_openmode | io_mode = ios_in|ios_binary
| ) |

  | Attempt to open a file with and without ".gz" extension. Parameters:
  name | name of file
  io_mode | file open mode(s) "or'd" together
Definition at line 68 of file sgstream.cxx. References gzfilebuf::is_open(), and gzfilebuf::open(). Referenced by sg_gzifstream().

## Friends And Related Function Documentation

istream & skipcomment | ( | istream & | in | ) | `[related]`

  | An istream manipulator that skips comments and white space. Ignores comments that start with '#'. Parameters:
  in | input stream
Definition at line 143 of file sgstream.cxx.

istream & skipeol | ( | istream & | in | ) | `[related]`

  | An istream manipulator that skips to end of line. Parameters:
  in | input stream
Definition at line 102 of file sgstream.cxx.

istream & skipws | ( | istream & | in | ) | `[related]`

  | An istream manipulator that skips over white space. Parameters:
  in | input stream
Definition at line 121 of file sgstream.cxx.

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

- sgstream.hxx
- sgstream.cxx

@ 1.3 log @Oops, try again. @ text @d418 1 a418 1