Developer documentation
Version 3.0.3-105-gd3941f44
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
MR::File::GZ Class Reference

#include "file/gz.h"

Public Member Functions

 GZ ()
 
 GZ (const std::string &fname, const char *mode)
 
 ~GZ ()
 
const std::string & name () const
 
void open (const std::string &fname, const char *mode)
 
void close ()
 
bool is_open () const
 
bool eof () const
 
int64_t tell () const
 
int64_t tellg () const
 
void seek (int64_t offset)
 
int read (char *s, size_t n)
 
void write (const char *s, size_t n)
 
void write (const std::string &s)
 
std::string getline ()
 
template<typename T >
T get ()
 
template<typename T >
T get (int64_t offset)
 
template<typename T >
T * get (T *buf, size_t n)
 
template<typename T >
T * get (int64_t offset, T *buf, size_t n)
 

Protected Member Functions

const char * error ()
 

Protected Attributes

gzFile gz
 
std::string filename
 

Detailed Description

Definition at line 39 of file gz.h.

Constructor & Destructor Documentation

◆ GZ() [1/2]

MR::File::GZ::GZ ( )
inline

Definition at line 41 of file gz.h.

◆ GZ() [2/2]

MR::File::GZ::GZ ( const std::string &  fname,
const char *  mode 
)
inline

Definition at line 42 of file gz.h.

◆ ~GZ()

MR::File::GZ::~GZ ( )
inline

Definition at line 45 of file gz.h.

Member Function Documentation

◆ close()

void MR::File::GZ::close ( )
inline

Definition at line 69 of file gz.h.

◆ eof()

bool MR::File::GZ::eof ( ) const
inline

Definition at line 81 of file gz.h.

◆ error()

const char * MR::File::GZ::error ( )
inlineprotected

Definition at line 165 of file gz.h.

◆ get() [1/4]

template<typename T >
T MR::File::GZ::get ( )
inline

Definition at line 138 of file gz.h.

◆ get() [2/4]

template<typename T >
T MR::File::GZ::get ( int64_t  offset)
inline

Definition at line 145 of file gz.h.

◆ get() [3/4]

template<typename T >
T * MR::File::GZ::get ( int64_t  offset,
T *  buf,
size_t  n 
)
inline

Definition at line 156 of file gz.h.

◆ get() [4/4]

template<typename T >
T * MR::File::GZ::get ( T *  buf,
size_t  n 
)
inline

Definition at line 150 of file gz.h.

◆ getline()

std::string MR::File::GZ::getline ( )
inline

Definition at line 120 of file gz.h.

◆ is_open()

bool MR::File::GZ::is_open ( ) const
inline

Definition at line 78 of file gz.h.

◆ name()

const std::string & MR::File::GZ::name ( ) const
inline

Definition at line 54 of file gz.h.

◆ open()

void MR::File::GZ::open ( const std::string &  fname,
const char *  mode 
)
inline

Definition at line 58 of file gz.h.

◆ read()

int MR::File::GZ::read ( char *  s,
size_t  n 
)
inline

Definition at line 100 of file gz.h.

◆ seek()

void MR::File::GZ::seek ( int64_t  offset)
inline

Definition at line 93 of file gz.h.

◆ tell()

int64_t MR::File::GZ::tell ( ) const
inline

Definition at line 85 of file gz.h.

◆ tellg()

int64_t MR::File::GZ::tellg ( ) const
inline

Definition at line 89 of file gz.h.

◆ write() [1/2]

void MR::File::GZ::write ( const char *  s,
size_t  n 
)
inline

Definition at line 108 of file gz.h.

◆ write() [2/2]

void MR::File::GZ::write ( const std::string &  s)
inline

Definition at line 114 of file gz.h.

Member Data Documentation

◆ filename

std::string MR::File::GZ::filename
protected

Definition at line 163 of file gz.h.

◆ gz

gzFile MR::File::GZ::gz
protected

Definition at line 162 of file gz.h.

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