A memory buffer (implements CStream) which can be itself serialized.
Definition at line 30 of file CMemoryChunk.h.
#include <mrpt/utils/CMemoryChunk.h>
Public Types | |
enum | TSeekOrigin { sFromBeginning = 0, sFromCurrent = 1, sFromEnd = 2 } |
Used in CStream::Seek. More... | |
Public Member Functions | |||
void * | operator new (size_t size) | ||
void * | operator new[] (size_t size) | ||
void | operator delete (void *ptr) throw () | ||
void | operator delete[] (void *ptr) throw () | ||
void | operator delete (void *memory, void *ptr) throw () | ||
void * | operator new (size_t size, const std::nothrow_t &) throw () | ||
void | operator delete (void *ptr, const std::nothrow_t &) throw () | ||
virtual mxArray * | writeToMatlab () const | ||
Introduces a pure virtual method responsible for writing to a mxArray Matlab object, typically a MATLAB struct whose contents are documented in each derived class. More... | |||
mrpt::utils::CObjectPtr | duplicateGetSmartPtr () const | ||
Returns a copy of the object, indepently of its class, as a smart pointer (the newly created object will exist as long as any copy of this smart pointer). More... | |||
CObject * | clone () const | ||
Cloning interface for smart pointers. 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... | |||
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
| |||
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 ('' characters are ignored). More... | |||
Static Public Member Functions | |
static void * | operator new (size_t size, void *ptr) |
Static Public Attributes | |
static const mrpt::utils::TRuntimeClassId | classCObject |
RTTI stuff | |
static const mrpt::utils::TRuntimeClassId | classCSerializable |
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> | |
CSerializable * | internal_ReadObject (CSerializable *existingObj=NULL) |
A common template code for both versions of CStream::ReadObject() More... | |
CSerializable virtual methods | |
void | writeToStream (mrpt::utils::CStream &out, int *getVersion) const |
Introduces a pure virtual method responsible for writing to a CStream. More... | |
void | readFromStream (mrpt::utils::CStream &in, int version) |
Introduces a pure virtual method responsible for loading from a CStream This can not be used directly be users, instead use "stream >> object;" for reading it from a stream or "stream >> object_ptr;" if the class is unknown apriori. 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... | |
RTTI stuff | |
typedef CMemoryChunkPtr | SmartPtr |
static mrpt::utils::CLASSINIT | _init_CMemoryChunk |
static mrpt::utils::TRuntimeClassId | classCMemoryChunk |
static const mrpt::utils::TRuntimeClassId * | classinfo |
static const mrpt::utils::TRuntimeClassId * | _GetBaseClass () |
virtual const mrpt::utils::TRuntimeClassId * | GetRuntimeClass () const |
Returns information about the class of an object in runtime. More... | |
virtual mrpt::utils::CObject * | duplicate () const |
Returns a copy of the object, indepently of its class. More... | |
static mrpt::utils::CObject * | CreateObject () |
static CMemoryChunkPtr | Create () |
typedef CMemoryChunkPtr mrpt::utils::CMemoryChunk::SmartPtr |
A typedef for the associated smart pointer
Definition at line 33 of file CMemoryChunk.h.
|
inherited |
Used in CStream::Seek.
Enumerator | |
---|---|
sFromBeginning | |
sFromCurrent | |
sFromEnd |
|
staticprotected |
|
inherited |
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.
|
inherited |
Change size. This would be rarely used. Use ">>" operators for writing to stream.
|
inherited |
Clears the memory buffer.
|
inlineinherited |
|
inherited |
Copies a specified number of bytes from one stream to another.
|
static |
|
static |
|
virtual |
Returns a copy of the object, indepently of its class.
Implements mrpt::utils::CObject.
|
inlineinherited |
|
inherited |
Reads from the stream until a '
' character is found ('' characters are ignored).
|
virtualinherited |
Method for getting the current cursor position, where 0 is the first byte and TotalBytesCount-1 the last one.
Implements mrpt::utils::CStream.
|
inherited |
Method for getting a pointer to the raw stored data.
The lenght in bytes is given by getTotalBytesCount
|
virtual |
Returns information about the class of an object in runtime.
Reimplemented from mrpt::utils::CSerializable.
|
virtualinherited |
Returns the total size of the internal buffer.
Implements mrpt::utils::CStream.
|
protectedinherited |
A common template code for both versions of CStream::ReadObject()
|
inherited |
Loads the entire buffer from a file *.
|
inline |
Definition at line 33 of file CMemoryChunk.h.
|
inline |
Definition at line 33 of file CMemoryChunk.h.
|
inline |
Definition at line 33 of file CMemoryChunk.h.
|
inline |
Definition at line 33 of file CMemoryChunk.h.
|
inlinestatic |
Definition at line 33 of file CMemoryChunk.h.
|
inline |
Definition at line 33 of file CMemoryChunk.h.
|
inline |
Definition at line 33 of file CMemoryChunk.h.
|
inline |
Definition at line 33 of file CMemoryChunk.h.
|
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.
|
protectedvirtualinherited |
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::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.
|
protectedvirtual |
Introduces a pure virtual method responsible for loading from a CStream This can not be used directly be users, instead use "stream >> object;" for reading it from a stream or "stream >> object_ptr;" if the class is unknown apriori.
in | The input binary stream where the object data must read from. |
version | The version of the object stored in the stream: use this version number in your code to know how to read the incoming data. |
std::exception | On any error, see CStream::ReadBuffer |
Implements mrpt::utils::CSerializable.
|
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 |
|
protectedinherited |
Resizes the internal buffer size.
|
inherited |
Saves the entire buffer to a file.
|
virtualinherited |
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.
|
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 |
|
inlineinherited |
Change the size of the additional memory block that is reserved whenever the current block runs too short (default=0x10000 bytes)
Definition at line 76 of file CMemoryStream.h.
References ASSERT_.
|
protectedvirtualinherited |
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.
References MRPT_printf_format_check, mrpt::utils::operator<<(), and mrpt::utils::operator>>().
|
inherited |
Writes an object to the stream.
|
inlinevirtualinherited |
Introduces a pure virtual method responsible for writing to a mxArray
Matlab object, typically a MATLAB struct
whose contents are documented in each derived class.
mxArray
(caller is responsible of memory freeing) or NULL is class does not support conversion to MATLAB. Definition at line 79 of file CSerializable.h.
References BASE_IMPEXP, DEFINE_MRPT_OBJECT_POST, mrpt::utils::ObjectToOctetVector(), mrpt::utils::ObjectToRawString(), mrpt::utils::ObjectToString(), mrpt::utils::OctetVectorToObject(), mrpt::utils::RawStringToObject(), and mrpt::utils::StringToObject().
|
protectedvirtual |
Introduces a pure virtual method responsible for writing to a CStream.
This can not be used directly be users, instead use "stream << object;" for writing it to a stream.
out | The output binary stream where object must be dumped. |
getVersion | If NULL, the object must be dumped. If not, only the version of the object dump must be returned in this pointer. This enables the versioning of objects dumping and backward compatibility with previously stored data. |
std::exception | On any error, see CStream::WriteBuffer |
Implements mrpt::utils::CSerializable.
|
staticprotected |
Definition at line 33 of file CMemoryChunk.h.
|
static |
Definition at line 33 of file CMemoryChunk.h.
|
staticinherited |
|
staticinherited |
Definition at line 42 of file CSerializable.h.
|
static |
Definition at line 33 of file CMemoryChunk.h.
|
protectedinherited |
Definition at line 38 of file CMemoryStream.h.
|
protectedinherited |
Definition at line 37 of file CMemoryStream.h.
|
protectedinherited |
Internal data.
Definition at line 36 of file CMemoryStream.h.
|
protectedinherited |
Definition at line 37 of file CMemoryStream.h.
|
protectedinherited |
If the memory block does not belong to the object.
Definition at line 39 of file CMemoryStream.h.
|
protectedinherited |
Definition at line 37 of file CMemoryStream.h.
Page generated by Doxygen 1.8.11 for MRPT 1.4.0 SVN: at Mon Aug 15 11:50:21 UTC 2016 |