joint_feedback_message.h
Go to the documentation of this file.
1 /*
2  * Software License Agreement (BSD License)
3  *
4  * Copyright (c) 2013, Southwest Research Institute
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions are met:
9  *
10  * * Redistributions of source code must retain the above copyright
11  * notice, this list of conditions and the following disclaimer.
12  * * Redistributions in binary form must reproduce the above copyright
13  * notice, this list of conditions and the following disclaimer in the
14  * documentation and/or other materials provided with the distribution.
15  * * Neither the name of the Southwest Research Institute, nor the names
16  * of its contributors may be used to endorse or promote products derived
17  * from this software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
23  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 #ifndef JOINT_FEEDBACK_MESSAGE_H
33 #define JOINT_FEEDBACK_MESSAGE_H
34 
35 #ifndef FLATHEADERS
40 #else
41 #include "typed_message.h"
42 #include "simple_message.h"
43 #include "shared_types.h"
44 #include "joint_feedback.h"
45 #endif
46 
47 namespace industrial
48 {
49 namespace joint_feedback_message
50 {
51 
52 
66 
67 {
68 public:
89 
97 
102  void init();
103 
104  // Overrides - SimpleSerialize
107 
108  unsigned int byteLength()
109  {
110  return this->data_.byteLength();
111  }
112 
114  {
115  return this->data_.getRobotID();
116  }
117 
119  {
120  return this->data_.getTime(time);
121  }
122 
124  {
125  return this->data_.getPositions(dest);
126  }
127 
129  {
130  return this->data_.getVelocities(dest);
131  }
132 
134  {
135  return this->data_.getAccelerations(dest);
136  }
137 
138 private:
139 
141 
142 };
143 
144 }
145 }
146 
147 #endif /* JOINT_FEEDBACK_MESSAGE_H */
industrial::joint_feedback::JointFeedback
Class encapsulated joint feedback data. This data represents the current state of each robot joint,...
Definition: joint_feedback.h:83
industrial::joint_feedback::JointFeedback::getAccelerations
bool getAccelerations(industrial::joint_data::JointData &dest)
Returns a copy of the acceleration data.
Definition: joint_feedback.h:251
industrial::joint_feedback_message::JointFeedbackMessage::unload
bool unload(industrial::byte_array::ByteArray *buffer)
Virtual method for unloading an object from a ByteArray.
Definition: joint_feedback_message.cpp:108
industrial::joint_data::JointData
Class encapsulated joint data (positions, accelerations, velocity, torque, and/or effort).
Definition: joint_data.h:68
industrial::joint_feedback::JointFeedback::getVelocities
bool getVelocities(industrial::joint_data::JointData &dest)
Returns a copy of the velocity data.
Definition: joint_feedback.h:220
industrial
Definition: byte_array.h:45
simple_message.h
industrial::joint_feedback_message::JointFeedbackMessage::getPositions
bool getPositions(industrial::joint_data::JointData &dest)
Definition: joint_feedback_message.h:123
joint_feedback.h
industrial::joint_feedback_message::JointFeedbackMessage::getAccelerations
bool getAccelerations(industrial::joint_data::JointData &dest)
Definition: joint_feedback_message.h:133
industrial::joint_feedback::JointFeedback::getRobotID
industrial::shared_types::shared_int getRobotID()
Gets robot_id. Robot group # (0-based), for controllers with multiple axis-groups.
Definition: joint_feedback.h:134
industrial::shared_types::shared_real
float shared_real
Definition: shared_types.h:66
industrial::joint_feedback_message::JointFeedbackMessage::JointFeedbackMessage
JointFeedbackMessage(void)
Default constructor.
Definition: joint_feedback_message.cpp:53
industrial::joint_feedback::JointFeedback::getTime
bool getTime(industrial::shared_types::shared_real &time)
Returns joint feedback timestamp.
Definition: joint_feedback.h:156
industrial::simple_message::SimpleMessage
This class defines a simple messaging protocol for communicating with an industrial robot controller.
Definition: simple_message.h:164
industrial::joint_feedback_message::JointFeedbackMessage::data_
industrial::joint_feedback::JointFeedback data_
Definition: joint_feedback_message.h:140
industrial::byte_array::ByteArray
The byte array wraps a dynamic array of bytes (i.e. char).
Definition: byte_array.h:80
industrial::joint_feedback_message::JointFeedbackMessage::getTime
bool getTime(industrial::shared_types::shared_real &time)
Definition: joint_feedback_message.h:118
industrial::joint_feedback::JointFeedback::byteLength
unsigned int byteLength()
Virtual method returns the object size when packed into a ByteArray.
Definition: joint_feedback.h:294
industrial::joint_feedback_message::JointFeedbackMessage::load
bool load(industrial::byte_array::ByteArray *buffer)
Virtual method for loading an object into a ByteArray.
Definition: joint_feedback_message.cpp:92
industrial::joint_feedback::JointFeedback::getPositions
bool getPositions(industrial::joint_data::JointData &dest)
Returns a copy of the position data.
Definition: joint_feedback.h:188
shared_types.h
industrial::shared_types::shared_int
int shared_int
Definition: shared_types.h:62
industrial::joint_feedback_message::JointFeedbackMessage
Class encapsulated joint feedback message generation methods (either to or from a industrial::simple_...
Definition: joint_feedback_message.h:65
industrial::joint_feedback_message::JointFeedbackMessage::byteLength
unsigned int byteLength()
Virtual method returns the object size when packed into a ByteArray.
Definition: joint_feedback_message.h:108
industrial::typed_message::TypedMessage
Message interface for typed messages built from SimpleMessage.
Definition: typed_message.h:74
industrial::joint_feedback_message::JointFeedbackMessage::init
void init()
Initializes a new message.
Definition: joint_feedback_message.cpp:86
typed_message.h
industrial::joint_feedback_message::JointFeedbackMessage::~JointFeedbackMessage
~JointFeedbackMessage(void)
Destructor.
Definition: joint_feedback_message.cpp:58
industrial::joint_feedback_message::JointFeedbackMessage::getVelocities
bool getVelocities(industrial::joint_data::JointData &dest)
Definition: joint_feedback_message.h:128
industrial::joint_feedback_message::JointFeedbackMessage::getRobotID
industrial::shared_types::shared_int getRobotID()
Definition: joint_feedback_message.h:113


simple_message
Author(s): Shaun Edwards
autogenerated on Wed Mar 2 2022 00:24:53