This CStream derived class allow using a file as a read/write binary stream, creating it if the file didn't exist.
The default behavior can be change to open as read, write, read and write,... in the constructor.
Definition at line 42 of file CFileStream.h.
#include <mrpt/utils/CFileStream.h>
Public Types | |
enum | TSeekOrigin { sFromBeginning = 0 , sFromCurrent = 1 , sFromEnd = 2 } |
Used in CStream::Seek. More... | |
Public Member Functions | |
CFileStream (const std::string &fileName, TFileOpenModes mode=fomRead|fomWrite) | |
Constructor and open a file. More... | |
CFileStream () | |
Constructor. More... | |
virtual | ~CFileStream () |
Destructor. More... | |
bool | open (const std::string &fileName, TFileOpenModes mode=fomRead|fomWrite) |
Opens the file, returning true on success. More... | |
void | close () |
Closes the file. More... | |
bool | fileOpenCorrectly () |
Returns true if the file was open without errors. More... | |
bool | is_open () |
Returns true if the file was open without errors. More... | |
bool | checkEOF () |
Will be true if EOF has been already reached. More... | |
uint64_t | Seek (uint64_t Offset, CStream::TSeekOrigin Origin=sFromBeginning) MRPT_OVERRIDE |
Method for moving to a specified position in the streamed resource. More... | |
uint64_t | getTotalBytesCount () MRPT_OVERRIDE |
Method for getting the total number of bytes writen to buffer. More... | |
uint64_t | getPosition () MRPT_OVERRIDE |
Method for getting the current cursor position, where 0 is the first byte and TotalBytesCount-1 the last one. More... | |
uint64_t | getPositionI () |
The current Input cursor position, where 0 is the first byte. More... | |
uint64_t | getPositionO () |
The current Input cursor position, where 0 is the first byte. More... | |
bool | readLine (std::string &str) |
Reads one string line from the file (until a new-line character) More... | |
size_t | ReadBuffer (void *Buffer, size_t Count) |
Reads a block of bytes from the stream into Buffer. More... | |
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. 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... | |
void | WriteBuffer (const void *Buffer, size_t Count) |
Writes a block of bytes to the stream from Buffer. More... | |
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). More... | |
size_t | CopyFrom (mrpt::utils::CStream *Source, size_t Count) |
Copies a specified number of bytes from one stream to another. More... | |
void | WriteObject (const CSerializable *o) |
Writes an object to the stream. More... | |
CSerializablePtr | ReadObject () |
Reads an object from stream, its class determined at runtime, and returns a smart pointer to the object. More... | |
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. More... | |
CStream & | operator<< (const CSerializablePtr &pObj) |
Write an object to a stream in the binary MRPT format. More... | |
CStream & | operator<< (const CSerializable &obj) |
Write an object to a stream in the binary MRPT format. More... | |
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. More... | |
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. More... | |
void | sendMessage (const utils::CMessage &msg) |
Send a message to the device. More... | |
bool | receiveMessage (utils::CMessage &msg) |
Tries to receive a message from the device. More... | |
bool | getline (std::string &out_str) |
Reads from the stream until a ' ' character is found ('\r' characters are ignored). More... | |
Protected Member Functions | |
size_t | Read (void *Buffer, size_t Count) MRPT_OVERRIDE |
Introduces a pure virtual method responsible for reading from the stream. More... | |
size_t | Write (const void *Buffer, size_t Count) MRPT_OVERRIDE |
Introduces a pure virtual method responsible for writing to the stream. More... | |
template<bool EXISTING_OBJ> | |
CSerializable * | internal_ReadObject (CSerializable *existingObj=NULL) |
A common template code for both versions of CStream::ReadObject() More... | |
Private Attributes | |
std::fstream | m_f |
The actual input file stream. More... | |
|
inherited |
Used in CStream::Seek.
Enumerator | |
---|---|
sFromBeginning | |
sFromCurrent | |
sFromEnd |
mrpt::utils::CFileStream::CFileStream | ( | const std::string & | fileName, |
TFileOpenModes | mode = fomRead|fomWrite |
||
) |
Constructor and open a file.
fileName | The file to be open in this stream |
mode | The open mode: can be an or'd conbination of different values. |
std::exception | On error creating or accessing the file. By default the file is opened for open and write and created if not found. |
mrpt::utils::CFileStream::CFileStream | ( | ) |
Constructor.
|
virtual |
Destructor.
bool mrpt::utils::CFileStream::checkEOF | ( | ) |
Will be true if EOF has been already reached.
void mrpt::utils::CFileStream::close | ( | ) |
Closes the file.
|
inherited |
Copies a specified number of bytes from one stream to another.
bool mrpt::utils::CFileStream::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, where 0 is the first byte and TotalBytesCount-1 the last one.
Implements mrpt::utils::CStream.
uint64_t mrpt::utils::CFileStream::getPositionI | ( | ) |
The current Input cursor position, where 0 is the first byte.
uint64_t mrpt::utils::CFileStream::getPositionO | ( | ) |
The current Input cursor position, where 0 is the first byte.
|
virtual |
Method for getting the total number of bytes writen to buffer.
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 69 of file CFileStream.h.
bool mrpt::utils::CFileStream::open | ( | const std::string & | fileName, |
TFileOpenModes | mode = fomRead|fomWrite |
||
) |
Opens the file, returning true on success.
fileName | The file to be open in this stream |
mode | The open mode: can be an or'd conbination of different values. By default the file is opened for open and write and created if not found. |
|
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.
bool mrpt::utils::CFileStream::readLine | ( | std::string & | str | ) |
Reads one string line from the file (until a new-line character)
|
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>>().
|
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 |
|
virtual |
Method for moving to a specified position in the streamed resource.
See documentation of CStream::Seek
Implements mrpt::utils::CStream.
|
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<<().
|
private |
The actual input file stream.
Definition at line 48 of file CFileStream.h.
Page generated by Doxygen 1.9.2 for MRPT 1.4.0 SVN: at Mon Sep 20 00:21:40 UTC 2021 |