GNU Octave  4.2.1
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
Public Member Functions | Private Attributes | List of all members
gzofstream Class Reference

Gzipped file output stream class. More...

#include "zfstream.h"

Inheritance diagram for gzofstream:
Inheritance graph
[legend]
Collaboration diagram for gzofstream:
Collaboration graph
[legend]

Public Member Functions

 gzofstream ()
 
 gzofstream (const char *name, std::ios_base::openmode mode=std::ios_base::out)
 Construct stream on gzipped file to be opened. More...
 
 gzofstream (int fd, std::ios_base::openmode mode=std::ios_base::out)
 Construct stream on already open gzipped file. More...
 
void attach (int fd, std::ios_base::openmode mode=std::ios_base::out)
 Attach to already open gzipped file. More...
 
void close ()
 Close gzipped file. More...
 
bool is_open ()
 Check if file is open. More...
 
void open (const char *name, std::ios_base::openmode mode=std::ios_base::out)
 Open gzipped file. More...
 
gzfilebufrdbuf () const
 Obtain underlying stream buffer. More...
 

Private Attributes

gzfilebuf sb
 Underlying stream buffer. More...
 

Detailed Description

Gzipped file output stream class.

This class implements ofstream for gzipped files. Seeking and putback is not supported yet.

Definition at line 366 of file zfstream.h.

Constructor & Destructor Documentation

gzofstream::gzofstream ( )

Definition at line 567 of file zfstream.cc.

References Range::init(), and sb.

gzofstream::gzofstream ( const char *  name,
std::ios_base::openmode  mode = std::ios_base::out 
)
explicit

Construct stream on gzipped file to be opened.

Parameters
nameFilename.
modeOpen mode flags (forced to contain ios::out).

Definition at line 572 of file zfstream.cc.

References Range::init(), open(), and sb.

gzofstream::gzofstream ( int  fd,
std::ios_base::openmode  mode = std::ios_base::out 
)
explicit

Construct stream on already open gzipped file.

Parameters
fdFile descriptor.
modeOpen mode flags (forced to contain ios::out).

Definition at line 580 of file zfstream.cc.

References attach(), Range::init(), and sb.

Member Function Documentation

void gzofstream::attach ( int  fd,
std::ios_base::openmode  mode = std::ios_base::out 
)

Attach to already open gzipped file.

Parameters
fdFile descriptor.
modeOpen mode flags (forced to contain ios::out).

Stream will be in state good() if attach succeeded; otherwise in state fail().

Definition at line 599 of file zfstream.cc.

References gzfilebuf::attach(), clear(), and sb.

Referenced by gzofstream().

void gzofstream::close ( void  )

Close gzipped file.

Stream will be in state fail() if close failed.

Definition at line 609 of file zfstream.cc.

References gzfilebuf::close(), and sb.

Referenced by dump_octave_core().

bool gzofstream::is_open ( void  )
inline

Check if file is open.

Returns
True if file is open.

Definition at line 402 of file zfstream.h.

References gzfilebuf::is_open(), and sb.

void gzofstream::open ( const char *  name,
std::ios_base::openmode  mode = std::ios_base::out 
)

Open gzipped file.

Parameters
nameFilename.
modeOpen mode flags (forced to contain ios::out).

Stream will be in state good() if file opens successfully; otherwise in state fail(). This differs from the behavior of ofstream, which never sets the state to good() and therefore won't allow you to reuse the stream for a second file unless you manually clear() the state. The choice is a matter of convenience.

Definition at line 589 of file zfstream.cc.

References clear(), gzfilebuf::open(), and sb.

Referenced by gzofstream().

gzfilebuf* gzofstream::rdbuf ( void  ) const
inline

Obtain underlying stream buffer.

Definition at line 394 of file zfstream.h.

References sb.

Referenced by setcompression().

Member Data Documentation

gzfilebuf gzofstream::sb
private

Underlying stream buffer.

Definition at line 444 of file zfstream.h.

Referenced by attach(), close(), gzofstream(), is_open(), open(), and rdbuf().


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