.TH "Vector::BLF::CompressedFile" 3 "Vector BLF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Vector::BLF::CompressedFile
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <CompressedFile\&.h>\fP
.PP
Inherits \fBVector::BLF::AbstractFile\fP\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBCompressedFile\fP (const CompressedFile &)=delete"
.br
.ti -1c
.RI "CompressedFile & \fBoperator=\fP (const CompressedFile &)=delete"
.br
.ti -1c
.RI "\fBCompressedFile\fP (CompressedFile &&)=delete"
.br
.ti -1c
.RI "CompressedFile & \fBoperator=\fP (CompressedFile &&)=delete"
.br
.ti -1c
.RI "std::streamsize \fBgcount\fP () const override"
.br
.ti -1c
.RI "void \fBread\fP (char *s, std::streamsize n) override"
.br
.ti -1c
.RI "std::streampos \fBtellg\fP () override"
.br
.ti -1c
.RI "void \fBseekg\fP (std::streamoff off, const std::ios_base::seekdir way=std::ios_base::cur) override"
.br
.ti -1c
.RI "void \fBwrite\fP (const char *s, std::streamsize n) override"
.br
.ti -1c
.RI "std::streampos \fBtellp\fP () override"
.br
.ti -1c
.RI "bool \fBgood\fP () const override"
.br
.ti -1c
.RI "bool \fBeof\fP () const override"
.br
.ti -1c
.RI "virtual void \fBopen\fP (const char *filename, std::ios_base::openmode openMode)"
.br
.ti -1c
.RI "virtual bool \fBis_open\fP () const"
.br
.ti -1c
.RI "virtual void \fBclose\fP ()"
.br
.ti -1c
.RI "virtual void \fBseekp\fP (std::streampos pos)"
.br
.in -1c

Public Member Functions inherited from \fBVector::BLF::AbstractFile\fP
.in +1c
.ti -1c
.RI "\fBAbstractFile\fP (const AbstractFile &)=default"
.br
.ti -1c
.RI "AbstractFile & \fBoperator=\fP (const AbstractFile &)=default"
.br
.ti -1c
.RI "\fBAbstractFile\fP (AbstractFile &&)=default"
.br
.ti -1c
.RI "AbstractFile & \fBoperator=\fP (AbstractFile &&)=default"
.br
.ti -1c
.RI "virtual void \fBskipp\fP (std::streamsize s) final"
.br
.in -1c
.SH "Detailed Description"
.PP 
\fBCompressedFile\fP (Input/output file stream)

.PP
This class is thread-safe\&. 
.SH "Member Function Documentation"
.PP 
.SS "void Vector::BLF::CompressedFile::close ()\fR [virtual]\fP"
Close file\&. 
.SS "bool Vector::BLF::CompressedFile::eof () const\fR [override]\fP, \fR [virtual]\fP"
Check whether eofbit is set\&.

.PP
\fBReturns\fP
.RS 4
true if eofbit is set 
.RE
.PP

.PP
Implements \fBVector::BLF::AbstractFile\fP\&.
.SS "std::streamsize Vector::BLF::CompressedFile::gcount () const\fR [override]\fP, \fR [virtual]\fP"
Get characters returned by last read operation\&.

.PP
\fBReturns\fP
.RS 4
Number of characters 
.RE
.PP

.PP
Implements \fBVector::BLF::AbstractFile\fP\&.
.SS "bool Vector::BLF::CompressedFile::good () const\fR [override]\fP, \fR [virtual]\fP"
Check whether state of stream is good\&.

.PP
\fBReturns\fP
.RS 4
true if no error flags are set 
.RE
.PP

.PP
Implements \fBVector::BLF::AbstractFile\fP\&.
.SS "bool Vector::BLF::CompressedFile::is_open () const\fR [virtual]\fP"
is file open?

.PP
\fBReturns\fP
.RS 4
true if file is open 
.RE
.PP

.SS "void Vector::BLF::CompressedFile::open (const char * filename, std::ios_base::openmode openMode)\fR [virtual]\fP"
open file

.PP
\fBParameters\fP
.RS 4
\fIfilename\fP file name 
.br
\fIopenMode\fP open in read or write mode 
.RE
.PP

.SS "void Vector::BLF::CompressedFile::read (char * s, std::streamsize n)\fR [override]\fP, \fR [virtual]\fP"
Read block of data\&.

.PP
This operation blocks until the data is available\&.

.PP
\fBParameters\fP
.RS 4
\fIs\fP Pointer to data 
.br
\fIn\fP Requested size of data 
.RE
.PP

.PP
Implements \fBVector::BLF::AbstractFile\fP\&.
.SS "void Vector::BLF::CompressedFile::seekg (std::streamoff off, const std::ios_base::seekdir way = \fRstd::ios_base::cur\fP)\fR [override]\fP, \fR [virtual]\fP"
Set position in input sequence\&.

.PP
\fBParameters\fP
.RS 4
\fIoff\fP Offset 
.br
\fIway\fP Direction 
.RE
.PP

.PP
Implements \fBVector::BLF::AbstractFile\fP\&.
.SS "void Vector::BLF::CompressedFile::seekp (std::streampos pos)\fR [virtual]\fP"
Set position in output sequence\&.

.PP
\fBParameters\fP
.RS 4
\fIpos\fP Position 
.RE
.PP

.SS "std::streampos Vector::BLF::CompressedFile::tellg ()\fR [override]\fP, \fR [virtual]\fP"
Get position in input sequence\&.

.PP
\fBReturns\fP
.RS 4
Read position 
.RE
.PP

.PP
Implements \fBVector::BLF::AbstractFile\fP\&.
.SS "std::streampos Vector::BLF::CompressedFile::tellp ()\fR [override]\fP, \fR [virtual]\fP"
Get position in output sequence\&.

.PP
\fBReturns\fP
.RS 4
Write position 
.RE
.PP

.PP
Implements \fBVector::BLF::AbstractFile\fP\&.
.SS "void Vector::BLF::CompressedFile::write (const char * s, std::streamsize n)\fR [override]\fP, \fR [virtual]\fP"
Write block of data\&.

.PP
\fBParameters\fP
.RS 4
\fIs\fP Pointer to data 
.br
\fIn\fP Size of data 
.RE
.PP

.PP
Implements \fBVector::BLF::AbstractFile\fP\&.

.SH "Author"
.PP 
Generated automatically by Doxygen for Vector BLF from the source code\&.