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

.in +1c
.ti -1c
.RI "virtual void \fBopen\fP (const char *filename, const std::ios_base::openmode mode=std::ios_base::in)"
.br
.ti -1c
.RI "virtual void \fBopen\fP (const std::string &filename, const std::ios_base::openmode mode=std::ios_base::in)"
.br
.ti -1c
.RI "virtual bool \fBis_open\fP () const"
.br
.ti -1c
.RI "virtual bool \fBgood\fP () const"
.br
.ti -1c
.RI "virtual bool \fBeof\fP () const"
.br
.ti -1c
.RI "virtual \fBObjectHeaderBase\fP * \fBread\fP ()"
.br
.ti -1c
.RI "virtual void \fBwrite\fP (\fBObjectHeaderBase\fP *ohb)"
.br
.ti -1c
.RI "virtual void \fBclose\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
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "static \fBObjectHeaderBase\fP * \fBcreateObject\fP (ObjectType type)"
.br
.in -1c
.SS "Public Attributes"

.in +1c
.ti -1c
.RI "\fBFileStatistics\fP \fBfileStatistics\fP {}"
.br
.ti -1c
.RI "uint64_t \fBcurrentUncompressedFileSize\fP {}"
.br
.ti -1c
.RI "std::atomic< uint32_t > \fBcurrentObjectCount\fP {}"
.br
.ti -1c
.RI "int \fBcompressionLevel\fP {1}"
.br
.ti -1c
.RI "bool \fBwriteRestorePoints\fP {true}"
.br
.in -1c
.SH "Detailed Description"
.PP 
\fBFile\fP

.PP
This is similar to std::fstream for BLFs 
.SH "Member Function Documentation"
.PP 
.SS "void Vector::BLF::File::close ()\fR [virtual]\fP"
close file 
.SS "\fBObjectHeaderBase\fP * Vector::BLF::File::createObject (ObjectType type)\fR [static]\fP"
create object of given type

.PP
\fBParameters\fP
.RS 4
\fItype\fP object type 
.RE
.PP
\fBReturns\fP
.RS 4
new object 
.RE
.PP

.SS "uint32_t Vector::BLF::File::defaultLogContainerSize () const\fR [virtual]\fP"
Get default log container size\&.

.PP
\fBReturns\fP
.RS 4
default log container size 
.RE
.PP

.SS "bool Vector::BLF::File::eof () const\fR [virtual]\fP"
Check whether eofbit is set\&.

.PP
\fBReturns\fP
.RS 4
true if end-of-file reached 
.RE
.PP

.SS "bool Vector::BLF::File::good () const\fR [virtual]\fP"
Check whether state of stream is good\&.

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

.SS "bool Vector::BLF::File::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::File::open (const char * filename, const std::ios_base::openmode mode = \fRstd::ios_base::in\fP)\fR [virtual]\fP"
open file

.PP
\fBParameters\fP
.RS 4
\fIfilename\fP file name 
.br
\fImode\fP open mode, either in (read) or out (write) 
.RE
.PP

.SS "void Vector::BLF::File::open (const std::string & filename, const std::ios_base::openmode mode = \fRstd::ios_base::in\fP)\fR [virtual]\fP"
open file

.PP
\fBParameters\fP
.RS 4
\fIfilename\fP file name 
.br
\fImode\fP open mode, either in (read) or out (write) 
.RE
.PP

.SS "\fBObjectHeaderBase\fP * Vector::BLF::File::read ()\fR [virtual]\fP"
Read object from file\&.

.PP
Ownership is taken over from the library to the user\&. The user has to take care to delete the object\&.

.PP
\fBTodo\fP
.RS 4
Use std::unique_ptr in future versions\&.
.RE
.PP

.PP
\fBReturns\fP
.RS 4
read object or nullptr 
.RE
.PP

.SS "void Vector::BLF::File::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::File::write (\fBObjectHeaderBase\fP * ohb)\fR [virtual]\fP"
Write object to file\&.

.PP
Ownership is taken over from the user to the library\&. The object should not be further accessed any more\&.

.PP
\fBTodo\fP
.RS 4
Use std::unique_ptr in future versions\&.
.RE
.PP

.PP
\fBParameters\fP
.RS 4
\fIohb\fP write object 
.RE
.PP

.SH "Member Data Documentation"
.PP 
.SS "int Vector::BLF::File::compressionLevel {1}"
compression level

.PP
zlib compression levels:
.IP "\(bu" 2
0: Z_NO_COMPRESSION
.IP "\(bu" 2
1: Z_BEST_SPEED
.IP "\(bu" 2
9: Z_BEST_COMPRESSION
.PP

.PP
Vector BLF compression levels:
.IP "\(bu" 2
0: no compression
.IP "\(bu" 2
6: default compression
.IP "\(bu" 2
10: maximum compression 
.PP

.SS "std::atomic<uint32_t> Vector::BLF::File::currentObjectCount {}"
Current number of objects read

.PP
Unknown115 is not counted\&. 
.SS "uint64_t Vector::BLF::File::currentUncompressedFileSize {}"
Current uncompressed file size

.PP
This includes the \fBLogContainer\fP headers, and the uncompressed content\&. 
.SS "\fBFileStatistics\fP Vector::BLF::File::fileStatistics {}"
\fBFile\fP statistics from file header\&. contains total counts/sizes 
.SS "bool Vector::BLF::File::writeRestorePoints {true}"
Write restore points at file close\&. 

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