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:

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

Detailed Description

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

Definition at line 52 of file simple_serialize.h.

Member Function Documentation

byteLength()

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_traj_pt_full::JointTrajPtFull, industrial::joint_feedback::JointFeedback, industrial::robot_status::RobotStatus, industrial::joint_traj_pt::JointTrajPt, industrial::joint_traj::JointTraj, industrial::joint_message::JointMessage, industrial::joint_data::JointData, industrial::robot_status_message::RobotStatusMessage, industrial::joint_feedback_message::JointFeedbackMessage, industrial::joint_traj_pt_full_message::JointTrajPtFullMessage, industrial::joint_traj_pt_message::JointTrajPtMessage, and industrial::ping_message::PingMessage.

load()

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_traj_pt_full::JointTrajPtFull, industrial::joint_feedback::JointFeedback, industrial::robot_status::RobotStatus, industrial::joint_traj_pt::JointTrajPt, industrial::joint_traj::JointTraj, industrial::joint_message::JointMessage, industrial::joint_data::JointData, industrial::robot_status_message::RobotStatusMessage, industrial::joint_feedback_message::JointFeedbackMessage, industrial::joint_traj_pt_full_message::JointTrajPtFullMessage, industrial::joint_traj_pt_message::JointTrajPtMessage, and industrial::ping_message::PingMessage.

unload()

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_traj_pt_full::JointTrajPtFull, industrial::joint_feedback::JointFeedback, industrial::robot_status::RobotStatus, industrial::joint_traj_pt::JointTrajPt, industrial::joint_traj::JointTraj, industrial::joint_message::JointMessage, industrial::joint_data::JointData, industrial::robot_status_message::RobotStatusMessage, industrial::joint_feedback_message::JointFeedbackMessage, industrial::joint_traj_pt_full_message::JointTrajPtFullMessage, 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