joint_traj.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_TRAJ_H
33 #define JOINT_TRAJ_H
34 
35 #ifndef FLATHEADERS
40 #else
41 #include "simple_message.h"
42 #include "simple_serialize.h"
43 #include "shared_types.h"
44 #include "joint_traj_pt.h"
45 #endif
46 
47 
48 
49 namespace industrial
50 {
51 namespace joint_traj
52 {
53 
63 //* JointTraj
71 {
72 public:
79  JointTraj(void);
84  ~JointTraj(void);
85 
90  void init();
91 
100 
117  {
118  return this->size_;
119  }
120 
126  bool isFull()
127  {
128  return this->size_ >= this->getMaxNumPoints();
129  }
130 
136  int getMaxNumPoints() const
137  {
138  return MAX_NUM_POINTS;
139  }
140 
146  void copyFrom(JointTraj &src);
147 
153  bool operator==(JointTraj &rhs);
154 
155  // Overrides - SimpleSerialize
158  unsigned int byteLength()
159  {
161  return this->size() * pt.byteLength();
162  }
163 
164 private:
165 
178 
179 };
180 
181 }
182 }
183 
184 #endif /* JOINT_TRAJ_H */
industrial::joint_traj::JointTraj::size_
industrial::shared_types::shared_int size_
size of trajectory
Definition: joint_traj.h:177
industrial::joint_traj_pt::JointTrajPt
Class encapsulated joint trajectory point data. The point data serves as a waypoint along a trajector...
Definition: joint_traj_pt.h:92
industrial::joint_traj::JointTraj::copyFrom
void copyFrom(JointTraj &src)
Copies the passed in value.
Definition: joint_traj.cpp:105
industrial::joint_traj::JointTraj::byteLength
unsigned int byteLength()
Virtual method returns the object size when packed into a ByteArray.
Definition: joint_traj.h:158
industrial::joint_traj::JointTraj::getMaxNumPoints
int getMaxNumPoints() const
returns the maximum number of points the message holds
Definition: joint_traj.h:136
industrial
Definition: byte_array.h:45
simple_message.h
industrial::joint_traj::JointTraj
Class encapsulated joint trajectory. A joint trajectory includes an array of JointTrajPt data types....
Definition: joint_traj.h:70
industrial::joint_traj::JointTraj::JointTraj
JointTraj(void)
Default constructor.
Definition: joint_traj.cpp:49
industrial::joint_traj::JointTraj::getPoint
bool getPoint(industrial::shared_types::shared_int index, industrial::joint_traj_pt::JointTrajPt &point)
Gets a point value within the buffer.
Definition: joint_traj.cpp:88
industrial::joint_traj::JointTraj::operator==
bool operator==(JointTraj &rhs)
== operator implementation
Definition: joint_traj.cpp:117
joint_traj_pt.h
industrial::joint_traj::JointTraj::load
bool load(industrial::byte_array::ByteArray *buffer)
Virtual method for loading an object into a ByteArray.
Definition: joint_traj.cpp:149
industrial::byte_array::ByteArray
The byte array wraps a dynamic array of bytes (i.e. char).
Definition: byte_array.h:80
industrial::joint_traj::JointTraj::size
industrial::shared_types::shared_int size()
Gets a size of trajectory.
Definition: joint_traj.h:116
industrial::joint_traj::JointTraj::MAX_NUM_POINTS
static const industrial::shared_types::shared_int MAX_NUM_POINTS
maximum number of joints positions that can be held in the message.
Definition: joint_traj.h:169
industrial::joint_traj::JointTraj::~JointTraj
~JointTraj(void)
Destructor.
Definition: joint_traj.cpp:53
industrial::joint_traj::JointTraj::addPoint
bool addPoint(industrial::joint_traj_pt::JointTrajPt &point)
Adds a point value to the end of the buffer.
Definition: joint_traj.cpp:69
shared_types.h
industrial::simple_serialize::SimpleSerialize
Interface for loading and unloading a class to/from a ByteArray.
Definition: simple_serialize.h:52
industrial::joint_traj::JointTraj::init
void init()
Initializes a empty joint data.
Definition: joint_traj.cpp:58
industrial::shared_types::shared_int
int shared_int
Definition: shared_types.h:62
industrial::joint_traj::JointTraj::isFull
bool isFull()
returns True if buffer is full
Definition: joint_traj.h:126
industrial::joint_traj_pt::JointTrajPt::byteLength
unsigned int byteLength()
Virtual method returns the object size when packed into a ByteArray.
Definition: joint_traj_pt.h:218
industrial::joint_traj::JointTraj::unload
bool unload(industrial::byte_array::ByteArray *buffer)
Virtual method for unloading an object from a ByteArray.
Definition: joint_traj.cpp:175
industrial::joint_traj::JointTraj::points_
industrial::joint_traj_pt::JointTrajPt points_[MAX_NUM_POINTS]
internal data buffer
Definition: joint_traj.h:173
simple_serialize.h


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