joint_message.h
Go to the documentation of this file.
1 /*
2  * Software License Agreement (BSD License)
3  *
4  * Copyright (c) 2011, 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_MESSAGE_H
33 #define JOINT_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_data.h"
45 #endif
46 
47 namespace industrial
48 {
49 namespace joint_message
50 {
51 
56 namespace SpecialSeqValues
57 {
59 {
61 };
62 }
64 
86 {
87 public:
94  JointMessage(void);
99  ~JointMessage(void);
108 
117 
122  void init();
123 
130 
137  {
138  return sequence_;
139  }
140 
147  {
148  return this->joints_;
149  }
150 
151  // Overrides - SimpleSerialize
154 
155  unsigned int byteLength()
156  {
158  }
159 
160 private:
169 
170 };
171 
172 }
173 }
174 
175 #endif /* JOINT_MESSAGE_H */
industrial::joint_message::SpecialSeqValues::STOP_TRAJECTORY
@ STOP_TRAJECTORY
Definition: joint_message.h:60
industrial::joint_data::JointData
Class encapsulated joint data (positions, accelerations, velocity, torque, and/or effort).
Definition: joint_data.h:68
industrial::joint_message::JointMessage::JointMessage
JointMessage(void)
Default constructor.
Definition: joint_message.cpp:54
industrial::joint_message::JointMessage::unload
bool unload(industrial::byte_array::ByteArray *buffer)
Virtual method for unloading an object from a ByteArray.
Definition: joint_message.cpp:133
industrial::joint_message::SpecialSeqValues::END_TRAJECTORY
@ END_TRAJECTORY
Definition: joint_message.h:60
industrial::joint_message::JointMessage::joints_
industrial::joint_data::JointData joints_
maximum number of joints positions that can be held in the message.
Definition: joint_message.h:168
industrial
Definition: byte_array.h:45
simple_message.h
industrial::joint_message::SpecialSeqValues::SpecialSeqValue
SpecialSeqValue
Definition: joint_message.h:58
industrial::joint_data::JointData::byteLength
unsigned int byteLength()
Virtual method returns the object size when packed into a ByteArray.
Definition: joint_data.h:147
industrial::simple_message::SimpleMessage
This class defines a simple messaging protocol for communicating with an industrial robot controller.
Definition: simple_message.h:164
industrial::byte_array::ByteArray
The byte array wraps a dynamic array of bytes (i.e. char).
Definition: byte_array.h:80
industrial::joint_message::SpecialSeqValue
SpecialSeqValues::SpecialSeqValue SpecialSeqValue
Definition: joint_message.h:63
industrial::joint_message::JointMessage::byteLength
unsigned int byteLength()
Virtual method returns the object size when packed into a ByteArray.
Definition: joint_message.h:155
industrial::joint_message::JointMessage::~JointMessage
~JointMessage(void)
Destructor.
Definition: joint_message.cpp:60
industrial::joint_message::JointMessage
Class encapsulated joint message generation methods (either to or from a SimpleMessage type....
Definition: joint_message.h:85
shared_types.h
industrial::shared_types::shared_int
int shared_int
Definition: shared_types.h:62
industrial::joint_message::JointMessage::getSequence
industrial::shared_types::shared_int getSequence()
returns the maximum message sequence number
Definition: joint_message.h:136
industrial::joint_message::JointMessage::setSequence
void setSequence(industrial::shared_types::shared_int sequence)
Sets message sequence number.
Definition: joint_message.cpp:91
industrial::joint_message::JointMessage::load
bool load(industrial::byte_array::ByteArray *buffer)
Virtual method for loading an object into a ByteArray.
Definition: joint_message.cpp:108
joint_data.h
industrial::joint_message::JointMessage::getJoints
industrial::joint_data::JointData & getJoints()
returns reference to underlying joint class
Definition: joint_message.h:146
industrial::typed_message::TypedMessage
Message interface for typed messages built from SimpleMessage.
Definition: typed_message.h:74
industrial::joint_message::JointMessage::sequence_
industrial::shared_types::shared_int sequence_
sequence number (for those joints messages that require it)
Definition: joint_message.h:164
typed_message.h
industrial::joint_message::JointMessage::init
void init()
Initializes a new joint message.
Definition: joint_message.cpp:102


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