industrial::joint_traj_pt_message::JointTrajPtMessage Class Reference

Class encapsulated joint trajectory point message generation methods (either to or from a industrial::simple_message::SimpleMessage type. More...

#include <joint_traj_pt_message.h>

Inheritance diagram for industrial::joint_traj_pt_message::JointTrajPtMessage:

List of all members.

Public Member Functions
unsigned int	byteLength ()
	Virtual method returns the object size when packed into a ByteArray.
bool	init (industrial::simple_message::SimpleMessage &msg)
	Initializes message from a simple message.
void	init (industrial::joint_traj_pt::JointTrajPt &point)
	Initializes message from a joint trajectory point structure.
void	init ()
	Initializes a new message.
	JointTrajPtMessage (void)
	Default constructor.
bool	load (industrial::byte_array::ByteArray *buffer)
	Virtual method for loading an object into a ByteArray.
void	setSequence (industrial::shared_types::shared_int sequence)
	Sets message sequence number.
bool	unload (industrial::byte_array::ByteArray *buffer)
	Virtual method for unloading an object from a ByteArray.
	~JointTrajPtMessage (void)
	Destructor.
Public Attributes
industrial::joint_traj_pt::JointTrajPt	point_

---

Detailed Description

Class encapsulated joint trajectory point message generation methods (either to or from a industrial::simple_message::SimpleMessage type.

This message simply wraps the industrial::joint_traj_pt::JointTrajPt data type. The data portion of this typed message matches JointTrajPt.

THIS CLASS IS NOT THREAD-SAFE

Definition at line 65 of file joint_traj_pt_message.h.

---

Constructor & Destructor Documentation

industrial::joint_traj_pt_message::JointTrajPtMessage::JointTrajPtMessage

(

void

)

Default constructor.

This method creates an empty message.

Definition at line 54 of file joint_traj_pt_message.cpp.

industrial::joint_traj_pt_message::JointTrajPtMessage::~JointTrajPtMessage

(

void

)

Destructor.

Definition at line 59 of file joint_traj_pt_message.cpp.

---

Member Function Documentation

unsigned int industrial::joint_traj_pt_message::JointTrajPtMessage::byteLength

(

)

[inline, virtual]

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

Returns:

object size (in bytes)

Implements industrial::simple_serialize::SimpleSerialize.

Definition at line 108 of file joint_traj_pt_message.h.

bool industrial::joint_traj_pt_message::JointTrajPtMessage::init

(

industrial::simple_message::SimpleMessage &

msg

)

[virtual]

Initializes message from a simple message.

Parameters:

simple

message to construct from

Returns:

true if message successfully initialized, otherwise false

Implements industrial::typed_message::TypedMessage.

Definition at line 64 of file joint_traj_pt_message.cpp.

void industrial::joint_traj_pt_message::JointTrajPtMessage::init

(

industrial::joint_traj_pt::JointTrajPt &

point

)

Initializes message from a joint trajectory point structure.

Parameters:

joint

trajectory point data structure

Definition at line 81 of file joint_traj_pt_message.cpp.

void industrial::joint_traj_pt_message::JointTrajPtMessage::init

(

)

[virtual]

Initializes a new message.

Implements industrial::typed_message::TypedMessage.

Definition at line 87 of file joint_traj_pt_message.cpp.

bool industrial::joint_traj_pt_message::JointTrajPtMessage::load

(

industrial::byte_array::ByteArray *

buffer

)

[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)

Implements industrial::simple_serialize::SimpleSerialize.

Definition at line 94 of file joint_traj_pt_message.cpp.

void industrial::joint_traj_pt_message::JointTrajPtMessage::setSequence

(

industrial::shared_types::shared_int

sequence

)

[inline]

Sets message sequence number.

Parameters:

message

sequence number

Definition at line 118 of file joint_traj_pt_message.h.

bool industrial::joint_traj_pt_message::JointTrajPtMessage::unload

(

industrial::byte_array::ByteArray *

buffer

)

[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)

Implements industrial::simple_serialize::SimpleSerialize.

Definition at line 110 of file joint_traj_pt_message.cpp.

---

Member Data Documentation

industrial::joint_traj_pt::JointTrajPt industrial::joint_traj_pt_message::JointTrajPtMessage::point_

Definition at line 120 of file joint_traj_pt_message.h.

---

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

• joint_traj_pt_message.h
• joint_traj_pt_message.cpp