industrial::simple_serialize::SimpleSerialize Class Reference

Interface for loading and unloading a class to/from a ByteArray. More...

#include <simple_serialize.h>

Inheritance diagram for industrial::simple_serialize::SimpleSerialize:

[legend]

List of all members.

Public Member Functions
virtual unsigned int	byteLength ()=0
	Virtual method returns the object size when packed into a ByteArray.
virtual bool	load (industrial::byte_array::ByteArray *buffer)=0
	Virtual method for loading an object into a ByteArray.
virtual bool	unload (industrial::byte_array::ByteArray *buffer)=0
	Virtual method for unloading an object from a ByteArray.

---

Detailed Description

Interface for loading and unloading a class to/from a ByteArray.

Definition at line 58 of file simple_serialize.h.

---

Member Function Documentation

virtual unsigned int industrial::simple_serialize::SimpleSerialize::byteLength

(

)

[pure virtual]

Virtual method returns the object size when packed into a ByteArray.

Returns:

object size (in bytes)

Implemented in industrial::joint_data::JointData, industrial::joint_traj::JointTraj, industrial::joint_traj_pt::JointTrajPt, industrial::joint_message::JointMessage, industrial::joint_traj_pt_message::JointTrajPtMessage, and industrial::ping_message::PingMessage.

virtual bool industrial::simple_serialize::SimpleSerialize::load

(

industrial::byte_array::ByteArray *

buffer

)

[pure virtual]

Virtual method for loading an object into a ByteArray.

This method should load all the required data to reconstruct the class object into the buffer

Parameters:

buffer

pointer to ByteArray

Returns:

true on success, false otherwise (buffer not large enough)

Implemented in industrial::joint_data::JointData, industrial::joint_traj::JointTraj, industrial::joint_traj_pt::JointTrajPt, industrial::joint_message::JointMessage, industrial::joint_traj_pt_message::JointTrajPtMessage, and industrial::ping_message::PingMessage.

virtual bool industrial::simple_serialize::SimpleSerialize::unload

(

industrial::byte_array::ByteArray *

buffer

)

[pure virtual]

Virtual method for unloading an object from a ByteArray.

This method should unload all the required data to reconstruct the class object (in place)

Parameters:

buffer

pointer to ByteArray

Returns:

true on success, false otherwise (buffer not large enough)

Implemented in industrial::joint_data::JointData, industrial::joint_traj::JointTraj, industrial::joint_traj_pt::JointTrajPt, industrial::joint_message::JointMessage, industrial::joint_traj_pt_message::JointTrajPtMessage, and industrial::ping_message::PingMessage.

---

The documentation for this class was generated from the following file:

• simple_serialize.h