joint_data.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_DATA_H
33 #define JOINT_DATA_H
34 
35 #ifndef FLATHEADERS
39 #else
40 #include "simple_message.h"
41 #include "simple_serialize.h"
42 #include "shared_types.h"
43 #endif
44 
45 namespace industrial
46 {
47 namespace joint_data
48 {
49 
69 {
70 public:
77  JointData(void);
82  ~JointData(void);
83 
88  void init();
89 
99 
109 
119 
125  void copyFrom(JointData &src);
126 
132  int getMaxNumJoints() const
133  {
134  return MAX_NUM_JOINTS;
135  }
136 
142  bool operator==(JointData &rhs);
143 
144  // Overrides - SimpleSerialize
147  unsigned int byteLength()
148  {
150  }
151 
152 private:
153 
162 
163 };
164 
165 }
166 }
167 
168 #endif /* JOINT_DATA_H */
industrial::joint_data::JointData::getJoint
bool getJoint(industrial::shared_types::shared_int index, industrial::shared_types::shared_real &value) const
Gets a joint value within the buffer.
Definition: joint_data.cpp:82
industrial::joint_data::JointData
Class encapsulated joint data (positions, accelerations, velocity, torque, and/or effort).
Definition: joint_data.h:68
industrial::joint_data::JointData::~JointData
~JointData(void)
Destructor.
Definition: joint_data.cpp:52
industrial
Definition: byte_array.h:45
simple_message.h
industrial::joint_data::JointData::unload
bool unload(industrial::byte_array::ByteArray *buffer)
Virtual method for unloading an object from a ByteArray.
Definition: joint_data.cpp:157
industrial::joint_data::JointData::JointData
JointData(void)
Default constructor.
Definition: joint_data.cpp:48
industrial::joint_data::JointData::joints_
industrial::shared_types::shared_real joints_[MAX_NUM_JOINTS]
internal data buffer
Definition: joint_data.h:161
industrial::shared_types::shared_real
float shared_real
Definition: shared_types.h:66
industrial::joint_data::JointData::operator==
bool operator==(JointData &rhs)
== operator implementation
Definition: joint_data.cpp:118
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::joint_data::JointData::load
bool load(industrial::byte_array::ByteArray *buffer)
Virtual method for loading an object into a ByteArray.
Definition: joint_data.cpp:138
industrial::byte_array::ByteArray
The byte array wraps a dynamic array of bytes (i.e. char).
Definition: byte_array.h:80
industrial::joint_data::JointData::MAX_NUM_JOINTS
static const industrial::shared_types::shared_int MAX_NUM_JOINTS
maximum number of joints positions that can be held in the message.
Definition: joint_data.h:157
industrial::joint_data::JointData::init
void init()
Initializes a empty joint data.
Definition: joint_data.cpp:57
shared_types.h
industrial::simple_serialize::SimpleSerialize
Interface for loading and unloading a class to/from a ByteArray.
Definition: simple_serialize.h:52
industrial::shared_types::shared_int
int shared_int
Definition: shared_types.h:62
industrial::joint_data::JointData::getMaxNumJoints
int getMaxNumJoints() const
returns the maximum number of joints the message holds
Definition: joint_data.h:132
industrial::joint_data::JointData::copyFrom
void copyFrom(JointData &src)
Copies the passed in value.
Definition: joint_data.cpp:107
simple_serialize.h
industrial::joint_data::JointData::setJoint
bool setJoint(industrial::shared_types::shared_int index, industrial::shared_types::shared_real value)
Sets a joint value within the buffer.
Definition: joint_data.cpp:65


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