A class that contain generic messages, that can be sent and received from a "CClientTCPSocket" object.
A message consists of a "header" (or type), and a "body" (or content). Apart from arbitrary data, specific methods are provided for easing the serialization of MRPT's "CSerializable" objects. This class is also used for passing data to hardware interfaces (see )
Definition at line 32 of file CMessage.h.
#include <mrpt/utils/CMessage.h>
Public Member Functions | |
void | serializeObject (CSerializable *obj) |
A method for serializing a MRPT's object into the content. More... | |
void | deserializeIntoExistingObject (CSerializable *obj) |
A method that parse the data in the message into an existing object. More... | |
void | deserializeIntoNewObject (CSerializablePtr &obj) |
A method that parse the data in the message into a new object of (a priori) unknown class. More... | |
void | setContentFromString (const std::string &str) |
Sets the contents of the message from a string. More... | |
void | getContentAsString (std::string &str) |
Gets the contents of the message as a string. More... | |
void | setContentFromPointer (void *ptr) |
Sets the contents of the message from a "void*" (the pointer itself becomes the message) - This is intended for inter-thread comms only. More... | |
void * | getContentAsPointer () const |
Gets the contents of the message as a "void*" (the pointer itself is the message) - This is intended for inter-thread comms only. More... | |
template<class T > | |
void | setContentFromStruct (const T &data) |
Sets the contents of the message from an arbitary structure - This is intended for inter-thread comms only, the message will be not cross-platform. More... | |
template<class T > | |
void | getContentAsStruct (T &data) const |
Gets the contents of the message as an arbitary structure - This is intended for inter-thread comms only, the message will be not cross-platform. More... | |
Public Attributes | |
uint32_t | type |
An identifier of the message type. More... | |
std::vector< unsigned char > | content |
The contents of the message (memory is automatically handled by the std::vector object) More... | |
void mrpt::utils::CMessage::deserializeIntoExistingObject | ( | CSerializable * | obj | ) |
A method that parse the data in the message into an existing object.
Note that the class of the object must be known and must match the one of the serialized object. std::exception On corrupt data, unknown serialized objects, unknown serialized object version, non-matching classes,...
void mrpt::utils::CMessage::deserializeIntoNewObject | ( | CSerializablePtr & | obj | ) |
A method that parse the data in the message into a new object of (a priori) unknown class.
The pointer will contain on return a copy of the reconstructed object. Deleting this object when no longer required is the responsability of the user. Note that previous contents of the pointer will be ignored (it should be NULL). std::exception On corrupt data, unknown serialized objects, unknown serialized object version,...
void* mrpt::utils::CMessage::getContentAsPointer | ( | ) | const |
Gets the contents of the message as a "void*" (the pointer itself is the message) - This is intended for inter-thread comms only.
void mrpt::utils::CMessage::getContentAsString | ( | std::string & | str | ) |
Gets the contents of the message as a string.
|
inline |
Gets the contents of the message as an arbitary structure - This is intended for inter-thread comms only, the message will be not cross-platform.
Definition at line 98 of file CMessage.h.
References ASSERT_, MRPT_END, and MRPT_START.
void mrpt::utils::CMessage::serializeObject | ( | CSerializable * | obj | ) |
A method for serializing a MRPT's object into the content.
Any modification to data in "content" after this will corrupt the object serialization. Member "type" is unmodified in this method.
void mrpt::utils::CMessage::setContentFromPointer | ( | void * | ptr | ) |
Sets the contents of the message from a "void*" (the pointer itself becomes the message) - This is intended for inter-thread comms only.
void mrpt::utils::CMessage::setContentFromString | ( | const std::string & | str | ) |
Sets the contents of the message from a string.
|
inline |
Sets the contents of the message from an arbitary structure - This is intended for inter-thread comms only, the message will be not cross-platform.
Definition at line 87 of file CMessage.h.
std::vector<unsigned char> mrpt::utils::CMessage::content |
The contents of the message (memory is automatically handled by the std::vector object)
Definition at line 41 of file CMessage.h.
uint32_t mrpt::utils::CMessage::type |
An identifier of the message type.
Definition at line 37 of file CMessage.h.
Page generated by Doxygen 1.8.12 for MRPT 1.3.2 SVN: at Mon Oct 3 19:22:36 UTC 2016 |