mrpt::io::CFileGZOutputStream Class Reference

Detailed Description

Saves data to a file and transparently compress the data using the given compression level.

The generated files are in gzip format ("file.gz"). This class requires compiling MRPT with wxWidgets. If wxWidgets is not available then the class is actually mapped to the standard CFileOutputStream

See also

CFileOutputStream

Definition at line 26 of file io/CFileGZOutputStream.h.

#include <mrpt/io/CFileGZOutputStream.h>

Inheritance diagram for mrpt::io::CFileGZOutputStream:

Classes
struct	Impl

Public Types
enum	TSeekOrigin { sFromBeginning = 0, sFromCurrent = 1, sFromEnd = 2 }
	Used in CStream::Seek. More...

Public Member Functions
	CFileGZOutputStream (const std::string &fileName)
	Constructor: opens an output file with compression level = 1 (minimum, fastest). More...
	CFileGZOutputStream ()
	Constructor, without opening the file. More...
	CFileGZOutputStream (const CFileGZOutputStream &)=delete
CFileGZOutputStream &	operator= (const CFileGZOutputStream &)=delete
	~CFileGZOutputStream () override
	Destructor. More...
bool	open (const std::string &fileName, int compress_level=1, mrpt::optional_ref< std::string > error_msg=std::nullopt)
	Open a file for write, choosing the compression level. More...
void	close ()
	Close the file. More...
bool	fileOpenCorrectly () const
	Returns true if the file was open without errors. More...
bool	is_open ()
	Returns true if the file was open without errors. More...
uint64_t	getPosition () const override
	Method for getting the current cursor position, where 0 is the first byte and TotalBytesCount-1 the last one. More...
uint64_t	Seek (int64_t, CStream::TSeekOrigin=sFromBeginning) override
	This method is not implemented in this class. More...
uint64_t	getTotalBytesCount () const override
	This method is not implemented in this class. More...
size_t	Read (void *Buffer, size_t Count) override
	Introduces a pure virtual method responsible for reading from the stream. More...
size_t	Write (const void *Buffer, size_t Count) override
	Introduces a pure virtual method responsible for writing to the stream. More...
virtual size_t	ReadBufferImmediate (void *Buffer, size_t Count)
	Reads a block of bytes from the stream into Buffer, and returns the amound of bytes actually read, without waiting for more extra bytes to arrive (just those already enqued in the stream). More...
virtual int	printf (const char *fmt,...) MRPT_printf_format_check(2
	Writes a string to the stream in a textual form. More...
template<typename CONTAINER_TYPE >
virtual int void	printf_vector (const char *fmt, const CONTAINER_TYPE &V, char separator=',')
	Prints a vector in the format [A,B,C,...] using CStream::printf, and the fmt string for each vector element T. More...
bool	getline (std::string &out_str)
	Reads from the stream until a ' ' character is found ('' characters are ignored). More...

Private Attributes
mrpt::pimpl< Impl >	m_f

Member Enumeration Documentation

TSeekOrigin

enum mrpt::io::CStream::TSeekOrigin

inherited

Used in CStream::Seek.

Enumerator
sFromBeginning
sFromCurrent
sFromEnd

Definition at line 32 of file io/CStream.h.

Constructor & Destructor Documentation

CFileGZOutputStream() [1/3]

CFileGZOutputStream::CFileGZOutputStream

(

const std::string &

fileName

)

Constructor: opens an output file with compression level = 1 (minimum, fastest).

Parameters

fileName

The file to be open in this stream

See also

open

Definition at line 32 of file CFileGZOutputStream.cpp.

References mrpt::format(), MRPT_END, MRPT_START, open(), and THROW_EXCEPTION.

Here is the call graph for this function:

CFileGZOutputStream() [2/3]

CFileGZOutputStream::CFileGZOutputStream

(

)

Constructor, without opening the file.

See also

open

Definition at line 27 of file CFileGZOutputStream.cpp.

CFileGZOutputStream() [3/3]

mrpt::io::CFileGZOutputStream::CFileGZOutputStream ( const CFileGZOutputStream &  )

delete

~CFileGZOutputStream()

CFileGZOutputStream::~CFileGZOutputStream ( )

override

Destructor.

Definition at line 61 of file CFileGZOutputStream.cpp.

References close().

Here is the call graph for this function:

Member Function Documentation

close()

void CFileGZOutputStream::close

(

)

Close the file.

Definition at line 62 of file CFileGZOutputStream.cpp.

References m_f.

Referenced by mrpt::apps::RawlogGrabberApp::runImpl(), and ~CFileGZOutputStream().

Here is the caller graph for this function:

fileOpenCorrectly()

bool CFileGZOutputStream::fileOpenCorrectly

(

)

const

Returns true if the file was open without errors.

Definition at line 94 of file CFileGZOutputStream.cpp.

References m_f.

Referenced by mrpt::io::zip::compress_gz_file(), is_open(), mrpt::maps::CGasConcentrationGridMap2D::save_Gaussian_Wind_Grid_To_File(), and mrpt::nav::CPTG_DiffDrive_CollisionGridBased::saveColGridsToFile().

Here is the caller graph for this function:

getline()

bool CStream::getline ( std::string &  out_str )

inherited

Reads from the stream until a '
' character is found ('' characters are ignored).

Returns

false on EOF or any other read error.

Definition at line 69 of file CStream.cpp.

getPosition()

uint64_t CFileGZOutputStream::getPosition ( ) const

overridevirtual

Method for getting the current cursor position, where 0 is the first byte and TotalBytesCount-1 the last one.

Implements mrpt::io::CStream.

Definition at line 85 of file CFileGZOutputStream.cpp.

References m_f, and THROW_EXCEPTION.

getTotalBytesCount()

uint64_t CFileGZOutputStream::getTotalBytesCount ( ) const

overridevirtual

This method is not implemented in this class.

Implements mrpt::io::CStream.

Definition at line 103 of file CFileGZOutputStream.cpp.

References THROW_EXCEPTION.

is_open()

bool mrpt::io::CFileGZOutputStream::is_open ( )

inline

Returns true if the file was open without errors.

Definition at line 64 of file io/CFileGZOutputStream.h.

References fileOpenCorrectly().

Here is the call graph for this function:

open()

bool CFileGZOutputStream::open	(	const std::string &	fileName,
		int	compress_level = 1,
		mrpt::optional_ref< std::string >	error_msg = std::nullopt
	)

Open a file for write, choosing the compression level.

Parameters

fileName	The file to be open in this stream
compress_level	0:no compression, 1:fastest, 9:best

Returns

true on success, false on any error.

Definition at line 44 of file CFileGZOutputStream.cpp.

References mrpt::format(), m_f, MRPT_END, and MRPT_START.

Referenced by CFileGZOutputStream(), mrpt::io::zip::compress_gz_file(), mrpt::nav::CAbstractPTGBasedReactive::enableLogFile(), mrpt::apps::RawlogGrabberApp::runImpl(), and TEST().

Here is the call graph for this function:

Here is the caller graph for this function:

operator=()

CFileGZOutputStream& mrpt::io::CFileGZOutputStream::operator= ( const CFileGZOutputStream &  )

delete

printf()

int CStream::printf ( const char *  fmt,   ...  )

virtualinherited

Writes a string to the stream in a textual form.

See also

CStdOutStream

Definition at line 30 of file CStream.cpp.

References MRPT_END, MRPT_START, and mrpt::system::os::vsnprintf().

Referenced by mrpt::hmtslam::CTopLCDetector_GridMatching::computeTopologicalObservationModel(), mrpt::apps::MonteCarloLocalization_Base::do_pf_localization(), mrpt::io::CStream::printf_vector(), mrpt::apps::CGridMapAlignerApp::run(), mrpt::apps::RBPF_SLAM_App_Base::run(), and mrpt::apps::ICP_SLAM_App_Base::run().

Here is the call graph for this function:

Here is the caller graph for this function:

printf_vector()

template<typename CONTAINER_TYPE >

virtual int void mrpt::io::CStream::printf_vector ( const char *  fmt, const CONTAINER_TYPE &  V, char  separator = ','  )

inlineinherited

Prints a vector in the format [A,B,C,...] using CStream::printf, and the fmt string for each vector element T.

Template Parameters

CONTAINER_TYPE

can be any vector<T>, deque<T> or alike.

Definition at line 102 of file io/CStream.h.

References mrpt::io::CStream::printf().

Referenced by mrpt::hmtslam::CTopLCDetector_GridMatching::computeTopologicalObservationModel().

Here is the call graph for this function:

Here is the caller graph for this function:

Read()

size_t CFileGZOutputStream::Read ( void *  Buffer, size_t  Count  )

overridevirtual

Introduces a pure virtual method responsible for reading from the stream.

Implements mrpt::io::CStream.

Definition at line 71 of file CFileGZOutputStream.cpp.

References THROW_EXCEPTION.

ReadBufferImmediate()

virtual size_t mrpt::io::CStream::ReadBufferImmediate ( void *  Buffer, size_t  Count  )

inlinevirtualinherited

Reads a block of bytes from the stream into Buffer, and returns the amound of bytes actually read, without waiting for more extra bytes to arrive (just those already enqued in the stream).

Note that this method will fallback to ReadBuffer() in most CStream classes but in some hardware-related classes.

Exceptions

std::exception

On any error, or if ZERO bytes are read.

Reimplemented in mrpt::comms::CInterfaceFTDI.

Definition at line 62 of file io/CStream.h.

References mrpt::io::CStream::Read().

Here is the call graph for this function:

Seek()

uint64_t CFileGZOutputStream::Seek ( int64_t  , CStream::TSeekOrigin  = sFromBeginning  )

overridevirtual

This method is not implemented in this class.

Implements mrpt::io::CStream.

Definition at line 98 of file CFileGZOutputStream.cpp.

References THROW_EXCEPTION.

Write()

size_t CFileGZOutputStream::Write ( const void *  Buffer, size_t  Count  )

overridevirtual

Introduces a pure virtual method responsible for writing to the stream.

Write attempts to write up to Count bytes to Buffer, and returns the number of bytes actually written.

Implements mrpt::io::CStream.

Definition at line 76 of file CFileGZOutputStream.cpp.

References m_f, and THROW_EXCEPTION.

Referenced by mrpt::io::zip::compress_gz_file(), mrpt::maps::CPointsMapXYZI::saveToKittiVelodyneFile(), and TEST().

Here is the caller graph for this function:

Member Data Documentation

m_f

mrpt::pimpl<Impl> mrpt::io::CFileGZOutputStream::m_f

private

Definition at line 29 of file io/CFileGZOutputStream.h.

Referenced by close(), fileOpenCorrectly(), getPosition(), open(), and Write().