industrial::joint_feedback_message::JointFeedbackMessage Class Reference

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

#include <joint_feedback_message.h>

Inheritance diagram for industrial::joint_feedback_message::JointFeedbackMessage:

Public Member Functions
unsigned int	byteLength ()
	Virtual method returns the object size when packed into a ByteArray. More...
bool	getAccelerations (industrial::joint_data::JointData &dest)
bool	getPositions (industrial::joint_data::JointData &dest)
industrial::shared_types::shared_int	getRobotID ()
bool	getTime (industrial::shared_types::shared_real &time)
bool	getVelocities (industrial::joint_data::JointData &dest)
bool	init (industrial::simple_message::SimpleMessage &msg)
	Initializes message from a simple message. More...
void	init (industrial::joint_feedback::JointFeedback &data)
	Initializes message from a joint feedback structure. More...
void	init ()
	Initializes a new message. More...
	JointFeedbackMessage (void)
	Default constructor. More...
bool	load (industrial::byte_array::ByteArray *buffer)
	Virtual method for loading an object into a ByteArray. More...
bool	unload (industrial::byte_array::ByteArray *buffer)
	Virtual method for unloading an object from a ByteArray. More...
	~JointFeedbackMessage (void)
	Destructor. More...
Public Member Functions inherited from industrial::typed_message::TypedMessage
int	getCommType () const
	Gets the communication type of the message. More...
int	getMessageType () const
	gets message type (enumeration) More...
virtual bool	toReply (industrial::simple_message::SimpleMessage &msg, industrial::simple_message::ReplyType reply)
	creates a simple_message reply More...
virtual bool	toRequest (industrial::simple_message::SimpleMessage &msg)
	creates a simple_message request More...
virtual bool	toTopic (industrial::simple_message::SimpleMessage &msg)
	creates a simple_message topic More...

Private Attributes
industrial::joint_feedback::JointFeedback	data_

Additional Inherited Members
Protected Member Functions inherited from industrial::typed_message::TypedMessage
void	setCommType (int comm_type=industrial::simple_message::CommTypes::INVALID)
	Sets the communication type of the message. More...
void	setMessageType (int message_type=industrial::simple_message::StandardMsgTypes::INVALID)
	sets message type More...

Detailed Description

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

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

THIS CLASS IS NOT THREAD-SAFE

Definition at line 65 of file joint_feedback_message.h.

Constructor & Destructor Documentation

JointFeedbackMessage()

industrial::joint_feedback_message::JointFeedbackMessage::JointFeedbackMessage

(

void

)

Default constructor.

This method creates an empty message.

Definition at line 53 of file joint_feedback_message.cpp.

~JointFeedbackMessage()

industrial::joint_feedback_message::JointFeedbackMessage::~JointFeedbackMessage

(

void

)

Destructor.

Definition at line 58 of file joint_feedback_message.cpp.

Member Function Documentation

byteLength()

unsigned int industrial::joint_feedback_message::JointFeedbackMessage::byteLength ( )

inlinevirtual

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_feedback_message.h.

getAccelerations()

bool industrial::joint_feedback_message::JointFeedbackMessage::getAccelerations ( industrial::joint_data::JointData &  dest )

inline

Definition at line 133 of file joint_feedback_message.h.

getPositions()

bool industrial::joint_feedback_message::JointFeedbackMessage::getPositions ( industrial::joint_data::JointData &  dest )

inline

Definition at line 123 of file joint_feedback_message.h.

getRobotID()

industrial::shared_types::shared_int industrial::joint_feedback_message::JointFeedbackMessage::getRobotID ( )

inline

Definition at line 113 of file joint_feedback_message.h.

getTime()

bool industrial::joint_feedback_message::JointFeedbackMessage::getTime ( industrial::shared_types::shared_real &  time )

inline

Definition at line 118 of file joint_feedback_message.h.

getVelocities()

bool industrial::joint_feedback_message::JointFeedbackMessage::getVelocities ( industrial::joint_data::JointData &  dest )

inline

Definition at line 128 of file joint_feedback_message.h.

init() [1/3]

bool industrial::joint_feedback_message::JointFeedbackMessage::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 63 of file joint_feedback_message.cpp.

init() [2/3]

void industrial::joint_feedback_message::JointFeedbackMessage::init

(

industrial::joint_feedback::JointFeedback &

data

)

Initializes message from a joint feedback structure.

Parameters

joint

feedback data structure

Definition at line 80 of file joint_feedback_message.cpp.

init() [3/3]

void industrial::joint_feedback_message::JointFeedbackMessage::init ( )

virtual

Initializes a new message.

Implements industrial::typed_message::TypedMessage.

Definition at line 86 of file joint_feedback_message.cpp.

load()

bool industrial::joint_feedback_message::JointFeedbackMessage::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 92 of file joint_feedback_message.cpp.

unload()

bool industrial::joint_feedback_message::JointFeedbackMessage::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 108 of file joint_feedback_message.cpp.

Member Data Documentation

data_

industrial::joint_feedback::JointFeedback industrial::joint_feedback_message::JointFeedbackMessage::data_

private

Definition at line 140 of file joint_feedback_message.h.

---

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

• joint_feedback_message.h
• joint_feedback_message.cpp