Detailed Description
|
Modules | |
| Serialization functions for ZMQ (v3 or above) (in #include <mrpt/utils/serialization_zmq.h>) | |
Functions | |
| std::string BASE_IMPEXP | mrpt::utils::ObjectToString (const CSerializable *o) |
| Used to pass MRPT objects into a CORBA-like object (strings). More... | |
| void BASE_IMPEXP | mrpt::utils::StringToObject (const std::string &str, CSerializablePtr &obj) |
| Used to pass CORBA-like objects (strings) into a MRPT object. More... | |
| void BASE_IMPEXP | mrpt::utils::ObjectToOctetVector (const CSerializable *o, vector_byte &out_vector) |
| Converts (serializes) an MRPT object into an array of bytes. More... | |
| void BASE_IMPEXP | mrpt::utils::OctetVectorToObject (const vector_byte &in_data, CSerializablePtr &obj) |
| Converts back (de-serializes) a sequence of binary data into a MRPT object, without prior information about the object's class. More... | |
| void BASE_IMPEXP | mrpt::utils::ObjectToRawString (const CSerializable *o, std::string &out_str) |
| Converts (serializes) an MRPT object into an array of bytes within a std::string, without codifying to avoid NULL characters. More... | |
| void BASE_IMPEXP | mrpt::utils::RawStringToObject (const std::string &in_str, CSerializablePtr &obj) |
| Converts back (de-serializes) a sequence of binary data within a std::string into a MRPT object, without prior information about the object's class. More... | |
Function Documentation
◆ ObjectToOctetVector()
| void mrpt::utils::ObjectToOctetVector | ( | const CSerializable * | o, |
| vector_byte & | out_vector | ||
| ) |
Converts (serializes) an MRPT object into an array of bytes.
- Parameters
-
o The object to be serialized. out_vector The vector which at return will contain the data. Size will be set automatically.
- See also
- OctetVectorToObject, ObjectToString
Definition at line 158 of file CSerializable.cpp.
References mrpt::system::os::fprintf(), mrpt::utils::CMemoryStream::getRawBufferData(), mrpt::utils::CMemoryStream::getTotalBytesCount(), mrpt::system::os::memcpy(), and mrpt::utils::CStream::WriteObject().
Referenced by TEST().
◆ ObjectToRawString()
| void mrpt::utils::ObjectToRawString | ( | const CSerializable * | o, |
| std::string & | out_str | ||
| ) |
Converts (serializes) an MRPT object into an array of bytes within a std::string, without codifying to avoid NULL characters.
This is therefore more efficient than ObjectToString
- Parameters
-
o The object to be serialized. out_vector The string which at return will contain the data. Size will be set automatically.
- See also
- RawStringToObject, ObjectToOctetVector
Definition at line 218 of file CSerializable.cpp.
References mrpt::system::os::fprintf(), mrpt::utils::CMemoryStream::getRawBufferData(), mrpt::utils::CMemoryStream::getTotalBytesCount(), mrpt::system::os::memcpy(), and mrpt::utils::CStream::WriteObject().
◆ ObjectToString()
| std::string mrpt::utils::ObjectToString | ( | const CSerializable * | o | ) |
Used to pass MRPT objects into a CORBA-like object (strings).
See doc about "Integration with BABEL".
- Parameters
-
o The object to be serialized.
- Returns
- The string containing the binay version of object.
- See also
- StringToObject, Integration with BABEL
Definition at line 31 of file CSerializable.cpp.
References mrpt::system::os::fprintf(), mrpt::utils::CMemoryStream::getRawBufferData(), mrpt::utils::CMemoryStream::getTotalBytesCount(), mrpt::system::os::memcpy(), mrpt::utils::CStream::WriteBuffer(), and mrpt::utils::CStream::WriteObject().
Referenced by mrpt::hmtslam::CHierarchicalMHMap::dumpAsXMLfile().
◆ OctetVectorToObject()
| void mrpt::utils::OctetVectorToObject | ( | const vector_byte & | in_data, |
| CSerializablePtr & | obj | ||
| ) |
Converts back (de-serializes) a sequence of binary data into a MRPT object, without prior information about the object's class.
- Parameters
-
in_data The serialized input data representing the object. obj The newly created object will be stored in this smart pointer.
- Exceptions
-
None On any internal exception, this function returns a NULL pointer.
- See also
- ObjectToOctetVector, StringToObject
Definition at line 189 of file CSerializable.cpp.
References mrpt::utils::CMemoryStream::assignMemoryNotOwn(), mrpt::system::os::fprintf(), and mrpt::utils::CStream::ReadObject().
Referenced by TEST().
◆ RawStringToObject()
| void mrpt::utils::RawStringToObject | ( | const std::string & | in_str, |
| CSerializablePtr & | obj | ||
| ) |
Converts back (de-serializes) a sequence of binary data within a std::string into a MRPT object, without prior information about the object's class.
- Parameters
-
in_data The serialized input data representing the object. obj The newly created object will be stored in this smart pointer.
- Exceptions
-
None On any internal exception, this function returns a NULL pointer.
- See also
- ObjectToRawString
Definition at line 249 of file CSerializable.cpp.
References mrpt::utils::CMemoryStream::assignMemoryNotOwn(), mrpt::system::os::fprintf(), and mrpt::utils::CStream::ReadObject().
◆ StringToObject()
| void mrpt::utils::StringToObject | ( | const std::string & | str, |
| CSerializablePtr & | obj | ||
| ) |
Used to pass CORBA-like objects (strings) into a MRPT object.
- Parameters
-
str An string generated with ObjectToString obj A currently empty pointer, where a pointer to the newly created object will be stored.
- Exceptions
-
None On any internal exception, this function returns NULL.
- See also
- ObjectToString, Integration with BABEL
Definition at line 100 of file CSerializable.cpp.
References mrpt::utils::CMemoryStream::getRawBufferData(), mrpt::utils::CMemoryStream::getTotalBytesCount(), MRPT_END, MRPT_START, mrpt::utils::CStream::ReadObject(), mrpt::utils::CMemoryStream::Seek(), mrpt::utils::CStream::sFromBeginning, and mrpt::utils::CStream::WriteBuffer().