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

.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 std::streamsize \fBgcount\fP () const =0"
.br
.ti -1c
.RI "virtual void \fBread\fP (char *s, std::streamsize n)=0"
.br
.ti -1c
.RI "virtual std::streampos \fBtellg\fP ()=0"
.br
.ti -1c
.RI "virtual void \fBseekg\fP (std::streamoff off, const std::ios_base::seekdir way=std::ios_base::cur)=0"
.br
.ti -1c
.RI "virtual void \fBwrite\fP (const char *s, std::streamsize n)=0"
.br
.ti -1c
.RI "virtual std::streampos \fBtellp\fP ()=0"
.br
.ti -1c
.RI "virtual bool \fBgood\fP () const =0"
.br
.ti -1c
.RI "virtual bool \fBeof\fP () const =0"
.br
.ti -1c
.RI "virtual void \fBskipp\fP (std::streamsize s) final"
.br
.in -1c
.SH "Detailed Description"
.PP 
Generic interface to access \fBCompressedFile\fP and \fBUncompressedFile\fP in the same way\&. 
.SH "Member Function Documentation"
.PP 
.SS "virtual bool Vector::BLF::AbstractFile::eof () const\fR [pure virtual]\fP"
Check whether eofbit is set\&.

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

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

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

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

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

.PP
Implemented in \fBVector::BLF::CompressedFile\fP, and \fBVector::BLF::UncompressedFile\fP\&.
.SS "virtual void Vector::BLF::AbstractFile::read (char * s, std::streamsize n)\fR [pure 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
Implemented in \fBVector::BLF::CompressedFile\fP, and \fBVector::BLF::UncompressedFile\fP\&.
.SS "virtual void Vector::BLF::AbstractFile::seekg (std::streamoff off, const std::ios_base::seekdir way = \fRstd::ios_base::cur\fP)\fR [pure virtual]\fP"
Set position in input sequence\&.

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

.PP
Implemented in \fBVector::BLF::CompressedFile\fP, and \fBVector::BLF::UncompressedFile\fP\&.
.SS "void Vector::BLF::AbstractFile::skipp (std::streamsize s)\fR [final]\fP, \fR [virtual]\fP"
Write padding null bytes\&.

.PP
\fBParameters\fP
.RS 4
\fIs\fP Number of padding bytes\&. 
.RE
.PP

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

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

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

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

.PP
Implemented in \fBVector::BLF::CompressedFile\fP, and \fBVector::BLF::UncompressedFile\fP\&.
.SS "virtual void Vector::BLF::AbstractFile::write (const char * s, std::streamsize n)\fR [pure 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
Implemented in \fBVector::BLF::CompressedFile\fP, and \fBVector::BLF::UncompressedFile\fP\&.

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