.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 () 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 \fBabort\fP ()"
.br
.ti -1c
.RI "virtual void \fBwrite\fP (const std::shared_ptr< \fBLogContainer\fP > &logContainer)"
.br
.ti -1c
.RI "virtual void \fBnextLogContainer\fP ()"
.br
.ti -1c
.RI "virtual std::streamsize \fBfileSize\fP () const"
.br
.ti -1c
.RI "virtual void \fBsetFileSize\fP (std::streamsize \fBfileSize\fP)"
.br
.ti -1c
.RI "virtual void \fBsetBufferSize\fP (std::streamsize bufferSize)"
.br
.ti -1c
.RI "virtual void \fBdropOldData\fP ()"
.br
.ti -1c
.RI "virtual uint32_t \fBdefaultLogContainerSize\fP () const"
.br
.ti -1c
.RI "virtual void \fBsetDefaultLogContainerSize\fP (uint32_t \fBdefaultLogContainerSize\fP)"
.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
.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 "void Vector::BLF::UncompressedFile::abort ()\fR [virtual]\fP"
Stop further operations\&. Return from waiting reads\&. 
.SS "uint32_t 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 "void Vector::BLF::UncompressedFile::dropOldData ()\fR [virtual]\fP"
drop old log container, if tellg/tellp are beyond it 
.SS "bool 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 "bool 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 "void Vector::BLF::UncompressedFile::nextLogContainer ()\fR [virtual]\fP"
Close the current logContainer\&. 
.SS "void Vector::BLF::UncompressedFile::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::UncompressedFile::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::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 "void Vector::BLF::UncompressedFile::setDefaultLogContainerSize (uint32_t defaultLogContainerSize)\fR [virtual]\fP"
Set default log container size\&.

.PP
\fBParameters\fP
.RS 4
\fI\fBdefaultLogContainerSize\fP\fP default log container size 
.RE
.PP

.SS "void Vector::BLF::UncompressedFile::setFileSize (std::streamsize fileSize)\fR [virtual]\fP"
Set file size resp\&. end-of-file position\&.

.PP
\fBParameters\fP
.RS 4
\fI\fBfileSize\fP\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 "void Vector::BLF::UncompressedFile::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\&.
.SS "void Vector::BLF::UncompressedFile::write (const 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\&.