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

.in +1c
.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 \fBabort\fP ()"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBwrite\fP (\fBconst\fP std::shared_ptr< \fBLogContainer\fP > &\fBlogContainer\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBnextLogContainer\fP ()"
.br
.ti -1c
.RI "\fBvirtual\fP std::streamsize \fBfileSize\fP () \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBsetFileSize\fP (std::streamsize \fBfileSize\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBsetBufferSize\fP (std::streamsize \fBbufferSize\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBdropOldData\fP ()"
.br
.ti -1c
.RI "\fBvirtual\fP \fBuint32_t\fP \fBdefaultLogContainerSize\fP () \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBsetDefaultLogContainerSize\fP (\fBuint32_t\fP \fBdefaultLogContainerSize\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
.SS "Public Attributes"

.in +1c
.ti -1c
.RI "std::condition_variable \fBtellgChanged\fP"
.br
.ti -1c
.RI "std::condition_variable \fBtellpChanged\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
\fBUncompressedFile\fP (Input/output memory stream)
.PP
This class is like a virtual file buffer\&. It only sees the fragments that are contained in m_data and addresses by the underlying uncompressed LogContainers\&. Read is done at position m_tellg and write position is at m_tellp\&. Write or seek operations exceeding the end of the file, will automatically create new logContainers\&. An explicit dropOldData drops logContainers that have already been processed\&.
.PP
This class is thread-safe\&. 
.SH "Member Function Documentation"
.PP 
.SS "\fBvoid\fP Vector::BLF::UncompressedFile::abort ()\fR [virtual]\fP"
Stop further operations\&. Return from waiting reads\&. 
.SS "\fBuint32_t\fP Vector::BLF::UncompressedFile::defaultLogContainerSize () const\fR [virtual]\fP"
Get default log container size\&.
.PP
\fBReturns\fP
.RS 4
default log container size 
.RE
.PP

.SS "\fBvoid\fP Vector::BLF::UncompressedFile::dropOldData ()\fR [virtual]\fP"
drop old log container, if tellg/tellp are beyond it 
.SS "\fBbool\fP Vector::BLF::UncompressedFile::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::UncompressedFile::fileSize () const\fR [virtual]\fP"
Return current file size resp\&. end-of-file position\&.
.PP
\fBReturns\fP
.RS 4
file size 
.RE
.PP

.SS "std::streamsize Vector::BLF::UncompressedFile::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::UncompressedFile::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 "\fBvoid\fP Vector::BLF::UncompressedFile::nextLogContainer ()\fR [virtual]\fP"
Close the current logContainer\&. 
.SS "\fBvoid\fP Vector::BLF::UncompressedFile::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::UncompressedFile::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::UncompressedFile::setBufferSize (std::streamsize bufferSize)\fR [virtual]\fP"
Sets the maximum file size\&. Write operations block, if the size is reached\&.
.PP
\fBParameters\fP
.RS 4
\fIbufferSize\fP maximum file size 
.RE
.PP

.SS "\fBvoid\fP Vector::BLF::UncompressedFile::setDefaultLogContainerSize (\fBuint32_t\fP defaultLogContainerSize)\fR [virtual]\fP"
Set default log container size\&.
.PP
\fBParameters\fP
.RS 4
\fIdefaultLogContainerSize\fP default log container size 
.RE
.PP

.SS "\fBvoid\fP Vector::BLF::UncompressedFile::setFileSize (std::streamsize fileSize)\fR [virtual]\fP"
Set file size resp\&. end-of-file position\&.
.PP
\fBParameters\fP
.RS 4
\fIfileSize\fP file size 
.RE
.PP

.SS "std::streampos Vector::BLF::UncompressedFile::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::UncompressedFile::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::UncompressedFile::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\&.
.SS "\fBvoid\fP Vector::BLF::UncompressedFile::write (\fBconst\fP std::shared_ptr< \fBLogContainer\fP > & logContainer)\fR [virtual]\fP"
write \fBLogContainer\fP
.PP
\fBParameters\fP
.RS 4
\fIlogContainer\fP log container 
.RE
.PP

.SH "Member Data Documentation"
.PP 
.SS "std::condition_variable Vector::BLF::UncompressedFile::tellgChanged"
tellg was changed (after read or seekg) 
.SS "std::condition_variable Vector::BLF::UncompressedFile::tellpChanged"
tellp was changed (after write or seekp) 

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