$search

industrial::gripper_message::GripperMessage Class Reference

Class encapsulated armadillo robot gripper message. More...

#include <gripper_message.h>

Inheritance diagram for industrial::gripper_message::GripperMessage:
Inheritance graph
[legend]

List of all members.

Public Member Functions

unsigned int byteLength ()
 GripperMessage (void)
 Default constructor.
void init ()
 Initializes a new message.
void init (GripperOperationType operation)
 Initializes message from a joint trajectory point structure.
bool init (industrial::simple_message::SimpleMessage &msg)
 Initializes message from a simple message.
bool load (industrial::byte_array::ByteArray *buffer)
bool unload (industrial::byte_array::ByteArray *buffer)
 ~GripperMessage (void)
 Destructor.

Public Attributes

GripperOperationType operation_

Detailed Description

Class encapsulated armadillo robot gripper message.

THIS CLASS IS NOT THREAD-SAFE

Definition at line 81 of file gripper_message.h.


Constructor & Destructor Documentation

industrial::gripper_message::GripperMessage::GripperMessage ( void   ) 

Default constructor.

This method creates an empty message.

Definition at line 56 of file gripper_message.cpp.

industrial::gripper_message::GripperMessage::~GripperMessage ( void   ) 

Destructor.

Definition at line 62 of file gripper_message.cpp.


Member Function Documentation

unsigned int industrial::gripper_message::GripperMessage::byteLength (  )  [inline, virtual]

Implements industrial::simple_serialize::SimpleSerialize.

Definition at line 124 of file gripper_message.h.

void industrial::gripper_message::GripperMessage::init (  )  [virtual]

Initializes a new message.

Implements industrial::typed_message::TypedMessage.

Definition at line 83 of file gripper_message.cpp.

void industrial::gripper_message::GripperMessage::init ( GripperOperationType  operation  ) 

Initializes message from a joint trajectory point structure.

Parameters:
gripper operation enumeration

Definition at line 78 of file gripper_message.cpp.

bool industrial::gripper_message::GripperMessage::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 67 of file gripper_message.cpp.

bool industrial::gripper_message::GripperMessage::load ( industrial::byte_array::ByteArray buffer  )  [virtual]

Implements industrial::simple_serialize::SimpleSerialize.

Definition at line 88 of file gripper_message.cpp.

bool industrial::gripper_message::GripperMessage::unload ( industrial::byte_array::ByteArray buffer  )  [virtual]

Member Data Documentation

Definition at line 129 of file gripper_message.h.


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


armadillo
Author(s): Shaun Edwards
autogenerated on Mon Mar 4 11:41:12 2013