$search

industrial::joint_traj_pt::JointTrajPt Class Reference

Class encapsulated joint trajectory point data. The point data serves as a waypoint along a trajectory. This point differs from the ROS trajectory point in that is specifies the joint velocity in an industrial robot standard way (as a single value). More...

#include <joint_traj_pt.h>

Inheritance diagram for industrial::joint_traj_pt::JointTrajPt:
Inheritance graph
[legend]

List of all members.

Public Member Functions

unsigned int byteLength ()
 Virtual method returns the object size when packed into a ByteArray.
void copyFrom (JointTrajPt &src)
 Copies the passed in value.
void getJointPosition (industrial::joint_data::JointData &dest)
 Returns a copy of the position data.
industrial::shared_types::shared_int getSequence ()
 Returns joint trajectory point sequence number.
industrial::shared_types::shared_real getVelocity ()
 Returns joint trajectory point velocity.
void init (industrial::shared_types::shared_int sequence, industrial::joint_data::JointData position, industrial::shared_types::shared_real velocity)
 Initializes a complete trajectory point.
void init ()
 Initializes a empty joint trajectory point.
 JointTrajPt (void)
 Default constructor.
bool load (industrial::byte_array::ByteArray *buffer)
 Virtual method for loading an object into a ByteArray.
bool operator== (JointTrajPt &rhs)
 == operator implementation
void setJointPosition (industrial::joint_data::JointData &position)
 Sets joint position data.
void setSequence (industrial::shared_types::shared_int sequence)
 Sets joint trajectory point sequence number.
void setVelocity (industrial::shared_types::shared_real velocity)
 Sets joint trajectory point velocity.
bool unload (industrial::byte_array::ByteArray *buffer)
 Virtual method for unloading an object from a ByteArray.
 ~JointTrajPt (void)
 Destructor.

Private Attributes

industrial::joint_data::JointData joint_position_
 joint point positional data
industrial::shared_types::shared_int sequence_
 trajectory sequence number
industrial::shared_types::shared_real velocity_
 joint point velocity

Detailed Description

Class encapsulated joint trajectory point data. The point data serves as a waypoint along a trajectory. This point differs from the ROS trajectory point in that is specifies the joint velocity in an industrial robot standard way (as a single value).

THIS CLASS IS NOT THREAD-SAFE

Definition at line 83 of file joint_traj_pt.h.


Constructor & Destructor Documentation

industrial::joint_traj_pt::JointTrajPt::JointTrajPt ( void   ) 

Default constructor.

This method creates empty data.

Definition at line 51 of file joint_traj_pt.cpp.

industrial::joint_traj_pt::JointTrajPt::~JointTrajPt ( void   ) 

Destructor.

Definition at line 55 of file joint_traj_pt.cpp.


Member Function Documentation

unsigned int industrial::joint_traj_pt::JointTrajPt::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 192 of file joint_traj_pt.h.

void industrial::joint_traj_pt::JointTrajPt::copyFrom ( JointTrajPt src  ) 

Copies the passed in value.

Parameters:
src (value to copy)

Definition at line 75 of file joint_traj_pt.cpp.

void industrial::joint_traj_pt::JointTrajPt::getJointPosition ( industrial::joint_data::JointData dest  )  [inline]

Returns a copy of the position data.

Parameters:
joint position dest

Definition at line 128 of file joint_traj_pt.h.

industrial::shared_types::shared_int industrial::joint_traj_pt::JointTrajPt::getSequence (  )  [inline]

Returns joint trajectory point sequence number.

Returns:
joint trajectory sequence number

Definition at line 148 of file joint_traj_pt.h.

industrial::shared_types::shared_real industrial::joint_traj_pt::JointTrajPt::getVelocity (  )  [inline]

Returns joint trajectory point velocity.

Returns:
joint trajectory velocity

Definition at line 168 of file joint_traj_pt.h.

void industrial::joint_traj_pt::JointTrajPt::init ( industrial::shared_types::shared_int  sequence,
industrial::joint_data::JointData  position,
industrial::shared_types::shared_real  velocity 
)

Initializes a complete trajectory point.

void industrial::joint_traj_pt::JointTrajPt::init (  ) 

Initializes a empty joint trajectory point.

Definition at line 60 of file joint_traj_pt.cpp.

bool industrial::joint_traj_pt::JointTrajPt::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 90 of file joint_traj_pt.cpp.

bool industrial::joint_traj_pt::JointTrajPt::operator== ( JointTrajPt rhs  ) 

== operator implementation

Returns:
true if equal

Definition at line 82 of file joint_traj_pt.cpp.

void industrial::joint_traj_pt::JointTrajPt::setJointPosition ( industrial::joint_data::JointData position  )  [inline]

Sets joint position data.

Parameters:
joint position data

Definition at line 118 of file joint_traj_pt.h.

void industrial::joint_traj_pt::JointTrajPt::setSequence ( industrial::shared_types::shared_int  sequence  )  [inline]

Sets joint trajectory point sequence number.

Parameters:
sequence value

Definition at line 138 of file joint_traj_pt.h.

void industrial::joint_traj_pt::JointTrajPt::setVelocity ( industrial::shared_types::shared_real  velocity  )  [inline]

Sets joint trajectory point velocity.

Parameters:
velocity value

Definition at line 158 of file joint_traj_pt.h.

bool industrial::joint_traj_pt::JointTrajPt::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 127 of file joint_traj_pt.cpp.


Member Data Documentation

joint point positional data

Definition at line 204 of file joint_traj_pt.h.

industrial::shared_types::shared_int industrial::joint_traj_pt::JointTrajPt::sequence_ [private]

trajectory sequence number

Definition at line 212 of file joint_traj_pt.h.

industrial::shared_types::shared_real industrial::joint_traj_pt::JointTrajPt::velocity_ [private]

joint point velocity

Definition at line 208 of file joint_traj_pt.h.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends


simple_message
Author(s): Shaun Edwards
autogenerated on Mon Mar 4 11:36:29 2013