.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 (\fBconst\fP \fBCompressedFile\fP &)=\fBdelete\fP"
.br
.ti -1c
.RI "\fBCompressedFile\fP & \fBoperator=\fP (\fBconst\fP \fBCompressedFile\fP &)=\fBdelete\fP"
.br
.ti -1c
.RI "\fBCompressedFile\fP (\fBCompressedFile\fP &&)=\fBdelete\fP"
.br
.ti -1c
.RI "\fBCompressedFile\fP & \fBoperator=\fP (\fBCompressedFile\fP &&)=\fBdelete\fP"
.br
.ti -1c
.RI "std::streamsize \fBgcount\fP () \fBconst\fP \fBoverride\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBread\fP (\fBchar\fP *\fBs\fP, std::streamsize \fBn\fP) \fBoverride\fP"
.br
.ti -1c
.RI "std::streampos \fBtellg\fP () \fBoverride\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBseekg\fP (std::streamoff \fBoff\fP, \fBconst\fP std::ios_base::seekdir \fBway\fP=std::ios_base::cur) \fBoverride\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBwrite\fP (\fBconst\fP \fBchar\fP *\fBs\fP, std::streamsize \fBn\fP) \fBoverride\fP"
.br
.ti -1c
.RI "std::streampos \fBtellp\fP () \fBoverride\fP"
.br
.ti -1c
.RI "\fBbool\fP \fBgood\fP () \fBconst\fP \fBoverride\fP"
.br
.ti -1c
.RI "\fBbool\fP \fBeof\fP () \fBconst\fP \fBoverride\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBopen\fP (\fBconst\fP \fBchar\fP *\fBfilename\fP, std::ios_base::openmode \fBopenMode\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBbool\fP \fBis_open\fP () \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBclose\fP ()"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBseekp\fP (std::streampos \fBpos\fP)"
.br
.in -1c

Public Member Functions inherited from \fBVector::BLF::AbstractFile\fP
.in +1c
.ti -1c
.RI "\fBAbstractFile\fP (\fBconst\fP \fBAbstractFile\fP &)=\fBdefault\fP"
.br
.ti -1c
.RI "\fBAbstractFile\fP & \fBoperator=\fP (\fBconst\fP \fBAbstractFile\fP &)=\fBdefault\fP"
.br
.ti -1c
.RI "\fBAbstractFile\fP (\fBAbstractFile\fP &&)=\fBdefault\fP"
.br
.ti -1c
.RI "\fBAbstractFile\fP & \fBoperator=\fP (\fBAbstractFile\fP &&)=\fBdefault\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBskipp\fP (std::streamsize \fBs\fP) \fBfinal\fP"
.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 "\fBvoid\fP Vector::BLF::CompressedFile::close ()\fR [virtual]\fP"
Close file\&. 
.SS "\fBbool\fP 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 "\fBbool\fP 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 "\fBbool\fP 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 "\fBvoid\fP Vector::BLF::CompressedFile::open (\fBconst\fP \fBchar\fP * 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 "\fBvoid\fP Vector::BLF::CompressedFile::read (\fBchar\fP * 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 "\fBvoid\fP Vector::BLF::CompressedFile::seekg (std::streamoff off, \fBconst\fP 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 "\fBvoid\fP 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 "\fBvoid\fP Vector::BLF::CompressedFile::write (\fBconst\fP \fBchar\fP * 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\&.