ThingWorx C SDK
Public Member Functions | List of all members
gzofstream Class Reference

Gzipped file output stream class. More...

#include <zfstream.h>

Inheritance diagram for gzofstream:
gzfilestream_common

Public Member Functions

 gzofstream (const char *name, int io_mode=ios::out)
 
 gzofstream (int fd, int io_mode=ios::out)
 
 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...
 
gzfilebufrdbuf () const
 
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...
 
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...
 
- Public Member Functions inherited from gzfilestream_common
void attach (int fd, int io_mode)
 
void open (const char *name, int io_mode)
 
void close ()
 

Detailed Description

Gzipped file output stream class.

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

Constructor & Destructor Documentation

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

Construct stream on gzipped file to be opened.

Parameters
nameFile name.
modeOpen mode flags (forced to contain ios::out).
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).

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

void gzofstream::close ( )

Close gzipped file.

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

bool gzofstream::is_open ( )
inline

Check if file is open.

Returns
True if file is open.
void gzofstream::open ( const char *  name,
std::ios_base::openmode  mode = std::ios_base::out 
)

Open gzipped file.

Parameters
nameFile name.
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.

gzfilebuf* gzofstream::rdbuf ( ) const
inline

Obtain underlying stream buffer.


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