This CStream derived class allow using a memory buffer as a CStream.
This class is useful for storing any required set of variables or objects, and then read them to other objects, or storing them to a file, for example.
Definition at line 26 of file CMemoryStream.h.
#include <mrpt/utils/CMemoryStream.h>
Public Types | |
enum | TSeekOrigin { sFromBeginning = 0, sFromCurrent = 1, sFromEnd = 2 } |
Used in CStream::Seek. More... | |
Public Member Functions | |
CMemoryStream () | |
Default constructor. More... | |
CMemoryStream (const void *data, const uint64_t nBytesInData) | |
Constructor to initilize the data in the stream from a block of memory (which is copied), and sets the current stream position at the beginning of the data. More... | |
void | assignMemoryNotOwn (const void *data, const uint64_t nBytesInData) |
Initilize the data in the stream from a block of memory which is NEITHER OWNED NOR COPIED by the object, so it must exist during the whole live of the object. More... | |
virtual | ~CMemoryStream () |
Destructor. More... | |
void | Clear () |
Clears the memory buffer. More... | |
void | changeSize (uint64_t newSize) |
Change size. This would be rarely used. Use ">>" operators for writing to stream. More... | |
uint64_t | Seek (uint64_t Offset, CStream::TSeekOrigin Origin=sFromBeginning) MRPT_OVERRIDE |
Introduces a pure virtual method for moving to a specified position in the streamed resource. More... | |
uint64_t | getTotalBytesCount () MRPT_OVERRIDE |
Returns the total size of the internal 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... | |
void * | getRawBufferData () |
Method for getting a pointer to the raw stored data. More... | |
bool | saveBufferToFile (const std::string &file_name) |
Saves the entire buffer to a file. More... | |
bool | loadBufferFromFile (const std::string &file_name) |
Loads the entire buffer from a file *. More... | |
void | setAllocBlockSize (uint64_t alloc_block_size) |
Change the size of the additional memory block that is reserved whenever the current block runs too short (default=0x10000 bytes) 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... | |
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) |
template<typename STORED_TYPE , typename CAST_TO_TYPE > | |
void | ReadAsAndCastTo (CAST_TO_TYPE &read_here) |
Read a value from a stream stored in a type different of the target variable, making the conversion via static_cast. 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... | |
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 ('' 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... | |
void | resize (uint64_t newSize) |
Resizes the internal buffer size. More... | |
template<bool EXISTING_OBJ> | |
void | internal_ReadObject (CSerializablePtr &newObj, CSerializable *existingObj=NULL) |
A common template code for both versions of CStream::ReadObject() More... | |
Protected Attributes | |
void_ptr_noncopy | m_memory |
Internal data. More... | |
uint64_t | m_size |
uint64_t | m_position |
uint64_t | m_bytesWritten |
uint64_t | m_alloc_block_size |
bool | m_read_only |
If the memory block does not belong to the object. More... | |
|
inherited |
Used in CStream::Seek.
Enumerator | |
---|---|
sFromBeginning | |
sFromCurrent | |
sFromEnd |
mrpt::utils::CMemoryStream::CMemoryStream | ( | ) |
Default constructor.
mrpt::utils::CMemoryStream::CMemoryStream | ( | const void * | data, |
const uint64_t | nBytesInData | ||
) |
Constructor to initilize the data in the stream from a block of memory (which is copied), and sets the current stream position at the beginning of the data.
|
virtual |
Destructor.
void mrpt::utils::CMemoryStream::assignMemoryNotOwn | ( | const void * | data, |
const uint64_t | nBytesInData | ||
) |
Initilize the data in the stream from a block of memory which is NEITHER OWNED NOR COPIED by the object, so it must exist during the whole live of the object.
After assigning a block of data with this method, the object becomes "read-only", so further attempts to change the size of the buffer will raise an exception. This method resets the write and read positions to the beginning.
Referenced by mrpt::utils::mrpt_recv_from_zmq_buf().
void mrpt::utils::CMemoryStream::changeSize | ( | uint64_t | newSize | ) |
Change size. This would be rarely used. Use ">>" operators for writing to stream.
void mrpt::utils::CMemoryStream::Clear | ( | ) |
Clears the memory buffer.
Referenced by mrpt::utils::mrpt_recv_from_zmq_buf().
|
inherited |
Reads from the stream until a '
' character is found ('' 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.
void* mrpt::utils::CMemoryStream::getRawBufferData | ( | ) |
Method for getting a pointer to the raw stored data.
The lenght in bytes is given by getTotalBytesCount
Referenced by mrpt::utils::mrpt_send_to_zmq().
|
virtual |
Returns the total size of the internal buffer.
Implements mrpt::utils::CStream.
Referenced by mrpt::utils::mrpt_recv_from_zmq_buf(), and mrpt::utils::mrpt_send_to_zmq().
|
protectedinherited |
A common template code for both versions of CStream::ReadObject()
bool mrpt::utils::CMemoryStream::loadBufferFromFile | ( | const std::string & | file_name | ) |
Loads the entire buffer from a file *.
|
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::graphslam::TUncertaintyPath< GRAPH_T >::dumpToTextStream(), mrpt::maps::COctoMapBase< OCTREE, OCTREE_NODE >::TInsertionOptions::dumpToTextStream(), mrpt::graphslam::deciders::CFixedIntervalsNRD< GRAPH_T >::TParams::dumpToTextStream(), mrpt::graphslam::deciders::CRangeScanOps< GRAPH_T >::TParams::dumpToTextStream(), mrpt::maps::COctoMapBase< OCTREE, OCTREE_NODE >::TLikelihoodOptions::dumpToTextStream(), mrpt::graphslam::deciders::CICPCriteriaERD< GRAPH_T >::TParams::dumpToTextStream(), mrpt::graphslam::optimizers::CLevMarqGSO< GRAPH_T >::OptimizationParams::dumpToTextStream(), mrpt::graphslam::deciders::CICPCriteriaNRD< GRAPH_T >::TParams::dumpToTextStream(), mrpt::graphslam::optimizers::CLevMarqGSO< GRAPH_T >::GraphVisualizationParams::dumpToTextStream(), mrpt::graphslam::deciders::CLoopCloserERD< GRAPH_T >::TLaserParams::dumpToTextStream(), and mrpt::graphslam::deciders::CLoopCloserERD< GRAPH_T >::TLoopClosureParams::dumpToTextStream().
|
inlineinherited |
Prints a vector in the format [A,B,C,...] using CStream::printf, and the fmt string for each vector element T
.
CONTAINER_TYPE | can be any vector<T>, deque<T> or alike. |
|
protectedvirtual |
Introduces a pure virtual method responsible for reading from the stream.
Implements mrpt::utils::CStream.
|
inlineinherited |
Read a value from a stream stored in a type different of the target variable, making the conversion via static_cast.
Useful for coding backwards compatible de-serialization blocks
Definition at line 194 of file CStream.h.
References MRPT_printf_format_check.
|
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::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::utils::mrpt_recv_from_zmq(), mrpt::utils::mrpt_recv_from_zmq_into(), 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 |
|
protected |
Resizes the internal buffer size.
bool mrpt::utils::CMemoryStream::saveBufferToFile | ( | const std::string & | file_name | ) |
Saves the entire buffer to a file.
|
virtual |
Introduces a pure virtual method for moving to a specified position in the streamed resource.
he Origin parameter indicates how to interpret the Offset parameter. Origin should be one of the following values:
Implements mrpt::utils::CStream.
Referenced by mrpt::utils::mrpt_recv_from_zmq_buf().
|
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 |
|
inline |
Change the size of the additional memory block that is reserved whenever the current block runs too short (default=0x10000 bytes)
Definition at line 73 of file CMemoryStream.h.
References ASSERT_.
|
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 |
Referenced by mrpt::utils::mrpt_recv_from_zmq_buf().
|
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.
References mrpt::utils::operator<<(), and mrpt::utils::operator>>().
|
inherited |
Writes an object to the stream.
Referenced by mrpt::utils::mrpt_send_to_zmq().
|
protected |
Definition at line 35 of file CMemoryStream.h.
|
protected |
Definition at line 34 of file CMemoryStream.h.
|
protected |
Internal data.
Definition at line 33 of file CMemoryStream.h.
|
protected |
Definition at line 34 of file CMemoryStream.h.
|
protected |
If the memory block does not belong to the object.
Definition at line 36 of file CMemoryStream.h.
|
protected |
Definition at line 34 of file CMemoryStream.h.
Page generated by Doxygen 1.8.13 for MRPT 1.5.3 at Tue Aug 22 01:03:35 UTC 2017 |