Transparently opens a compressed "gz" file and reads uncompressed data from it.
If the file is not a .gz file, it silently reads data from the file. This class requires compiling MRPT with wxWidgets. If wxWidgets is not available then the class is actually mapped to the standard CFileInputStream
Definition at line 28 of file CFileGZInputStream.h.
#include <mrpt/utils/CFileGZInputStream.h>
Public Types | |
enum | TSeekOrigin { sFromBeginning = 0 , sFromCurrent = 1 , sFromEnd = 2 } |
Used in CStream::Seek. More... | |
Public Member Functions | |
CFileGZInputStream () | |
Constructor without open. | |
CFileGZInputStream (const std::string &fileName) | |
Constructor and open. | |
virtual | ~CFileGZInputStream () |
Dtor. | |
bool | open (const std::string &fileName) |
Opens the file for read. | |
void | close () |
Closes the file. | |
bool | fileOpenCorrectly () |
Returns true if the file was open without errors. | |
bool | is_open () |
Returns true if the file was open without errors. | |
bool | checkEOF () |
Will be true if EOF has been already reached. | |
uint64_t | getTotalBytesCount () MRPT_OVERRIDE |
Method for getting the total number of compressed bytes of in the file (the physical size of the compressed file). | |
uint64_t | getPosition () MRPT_OVERRIDE |
Method for getting the current cursor position in the compressed, where 0 is the first byte and TotalBytesCount-1 the last one. | |
uint64_t | Seek (uint64_t Offset, CStream::TSeekOrigin Origin=sFromBeginning) MRPT_OVERRIDE |
This method is not implemented in this class. | |
size_t | ReadBuffer (void *Buffer, size_t Count) |
Reads a block of bytes from the stream into Buffer. | |
template<typename T > | |
size_t | ReadBufferFixEndianness (T *ptr, size_t ElementCount) |
Reads a sequence of elemental datatypes, taking care of reordering their bytes from the MRPT stream standard (little endianness) to the format of the running architecture. | |
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). | |
void | WriteBuffer (const void *Buffer, size_t Count) |
Writes a block of bytes to the stream from Buffer. | |
template<typename T > | |
void | WriteBufferFixEndianness (const T *ptr, size_t ElementCount) |
Writes a sequence of elemental datatypes, taking care of reordering their bytes from the running architecture to MRPT stream standard (little endianness). | |
size_t | CopyFrom (mrpt::utils::CStream *Source, size_t Count) |
Copies a specified number of bytes from one stream to another. | |
void | WriteObject (const CSerializable *o) |
Writes an object to the stream. | |
CSerializablePtr | ReadObject () |
Reads an object from stream, its class determined at runtime, and returns a smart pointer to the object. | |
void | ReadObject (CSerializable *existingObj) |
Reads an object from stream, where its class must be the same as the supplied object, where the loaded object will be stored in. | |
CStream & | operator<< (const CSerializablePtr &pObj) |
Write an object to a stream in the binary MRPT format. | |
CStream & | operator<< (const CSerializable &obj) |
Write an object to a stream in the binary MRPT format. | |
CStream & | operator>> (CSerializablePtr &pObj) |
CStream & | operator>> (CSerializable &obj) |
virtual int | printf (const char *fmt,...) MRPT_printf_format_check(2 |
Writes a string to the stream in a textual form. | |
template<typename T > | |
virtual int void | printf_vector (const char *fmt, const std::vector< T > &V) |
Prints a vector in the format [A,B,C,...] using CStream::printf, and the fmt string for each vector element. | |
void | sendMessage (const utils::CMessage &msg) |
Send a message to the device. | |
bool | receiveMessage (utils::CMessage &msg) |
Tries to receive a message from the device. | |
bool | getline (std::string &out_str) |
Reads from the stream until a ' ' character is found ('\r' characters are ignored). | |
Protected Member Functions | |
size_t | Read (void *Buffer, size_t Count) MRPT_OVERRIDE |
Introduces a pure virtual method responsible for reading from the stream. | |
size_t | Write (const void *Buffer, size_t Count) MRPT_OVERRIDE |
Introduces a pure virtual method responsible for writing to the stream. | |
template<bool EXISTING_OBJ> | |
CSerializable * | internal_ReadObject (CSerializable *existingObj=NULL) |
A common template code for both versions of CStream::ReadObject() | |
Private Attributes | |
void * | m_f |
uint64_t | m_file_size |
Compressed file size. | |
|
inherited |
Used in CStream::Seek.
Enumerator | |
---|---|
sFromBeginning | |
sFromCurrent | |
sFromEnd |
mrpt::utils::CFileGZInputStream::CFileGZInputStream | ( | ) |
Constructor without open.
mrpt::utils::CFileGZInputStream::CFileGZInputStream | ( | const std::string & | fileName | ) |
Constructor and open.
fileName | The file to be open in this stream |
std::exception | If there's an error opening the file. |
|
virtual |
Dtor.
bool mrpt::utils::CFileGZInputStream::checkEOF | ( | ) |
Will be true if EOF has been already reached.
void mrpt::utils::CFileGZInputStream::close | ( | ) |
Closes the file.
|
inherited |
Copies a specified number of bytes from one stream to another.
bool mrpt::utils::CFileGZInputStream::fileOpenCorrectly | ( | ) |
Returns true if the file was open without errors.
|
inherited |
Reads from the stream until a '
' character is found ('\r' characters are ignored).
|
virtual |
Method for getting the current cursor position in the compressed, where 0 is the first byte and TotalBytesCount-1 the last one.
Implements mrpt::utils::CStream.
|
virtual |
Method for getting the total number of compressed bytes of in the file (the physical size of the compressed file).
Implements mrpt::utils::CStream.
|
protectedinherited |
A common template code for both versions of CStream::ReadObject()
|
inline |
Returns true if the file was open without errors.
Definition at line 55 of file CFileGZInputStream.h.
bool mrpt::utils::CFileGZInputStream::open | ( | const std::string & | fileName | ) |
Opens the file for read.
fileName | The file to be open in this stream |
|
inherited |
Write an object to a stream in the binary MRPT format.
|
inherited |
Write an object to a stream in the binary MRPT format.
|
inherited |
|
inherited |
|
virtualinherited |
Writes a string to the stream in a textual form.
Referenced by mrpt::maps::COctoMapBase< OCTREE, OCTREE_NODE >::TInsertionOptions::dumpToTextStream(), and mrpt::maps::COctoMapBase< OCTREE, OCTREE_NODE >::TLikelihoodOptions::dumpToTextStream().
|
inlineinherited |
Prints a vector in the format [A,B,C,...] using CStream::printf, and the fmt string for each vector element.
|
protectedvirtual |
Introduces a pure virtual method responsible for reading from the stream.
Implements mrpt::utils::CStream.
|
inherited |
Reads a block of bytes from the stream into Buffer.
std::exception | On any error, or if ZERO bytes are read. |
|
inlineinherited |
Reads a sequence of elemental datatypes, taking care of reordering their bytes from the MRPT stream standard (little endianness) to the format of the running architecture.
ElementCount | The number of elements (not bytes) to read. |
ptr | A pointer to the first output element in an array (or std::vector<>, etc...). |
std::exception | On any error, or if ZERO bytes are read. |
Definition at line 95 of file CStream.h.
References mrpt::utils::reverseBytesInPlace().
Referenced by mrpt::math::operator>>().
|
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.
std::exception | On any error, or if ZERO bytes are read. |
Reimplemented in mrpt::hwdrivers::CInterfaceFTDI.
|
inherited |
Reads an object from stream, its class determined at runtime, and returns a smart pointer to the object.
std::exception | On I/O error or undefined class. |
mrpt::utils::CExceptionEOF | On an End-Of-File condition found at a correct place: an EOF that abruptly finishes in the middle of one object raises a plain std::exception instead. |
Referenced by mrpt::math::operator>>(), and mrpt::math::operator>>().
|
inherited |
Reads an object from stream, where its class must be the same as the supplied object, where the loaded object will be stored in.
std::exception | On I/O error or different class found. |
mrpt::utils::CExceptionEOF | On an End-Of-File condition found at a correct place: an EOF that abruptly finishes in the middle of one object raises a plain std::exception instead. |
|
inherited |
Tries to receive a message from the device.
std::exception | On communication errors |
|
inlinevirtual |
This method is not implemented in this class.
Implements mrpt::utils::CStream.
Definition at line 62 of file CFileGZInputStream.h.
References MRPT_UNUSED_PARAM, and THROW_EXCEPTION.
|
inherited |
Send a message to the device.
Note that only the low byte from the "type" field will be used.
For frames of size < 255 the frame format is an array of bytes in this order:
For frames of size > 255 the frame format is an array of bytes in this order:
std::exception | On communication errors |
|
protectedvirtual |
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::utils::CStream.
|
inherited |
Writes a block of bytes to the stream from Buffer.
std::exception | On any error |
|
inlineinherited |
Writes a sequence of elemental datatypes, taking care of reordering their bytes from the running architecture to MRPT stream standard (little endianness).
ElementCount | The number of elements (not bytes) to write. |
ptr | A pointer to the first input element in an array (or std::vector<>, etc...). Example of usage: vector<float> vec = ...
uint32_t N = vec.size();
s << N
if (N)
s.WriteBufferFixEndianness<float>(&vec[0],N);
|
std::exception | On any error |
Definition at line 139 of file CStream.h.
Referenced by mrpt::math::operator<<().
|
inherited |
Writes an object to the stream.
Referenced by mrpt::math::operator<<(), and mrpt::math::operator<<().
|
private |
Definition at line 34 of file CFileGZInputStream.h.
|
private |
Compressed file size.
Definition at line 35 of file CFileGZInputStream.h.
Page generated by Doxygen 1.9.8 for MRPT 1.4.0 SVN: at Wed Dec 6 15:06:50 UTC 2023 |