All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
DARTScrewJoint.hh
Go to the documentation of this file.
1 /*
2  * Copyright 2014 Open Source Robotics Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *
16 */
17 
18 #ifndef _GAZEBO_DARTSCREWJOINT_HH_
19 #define _GAZEBO_DARTSCREWJOINT_HH_
20 
23 #include "gazebo/util/system.hh"
24 
25 namespace gazebo
26 {
27  namespace physics
28  {
30  class GAZEBO_VISIBLE DARTScrewJoint : public ScrewJoint<DARTJoint>
31  {
34  public: DARTScrewJoint(BasePtr _parent);
35 
37  public: virtual ~DARTScrewJoint();
38 
39  // Documentation inherited.
40  public: virtual void Load(sdf::ElementPtr _sdf);
41 
42  // Documentation inherited
43  public: virtual math::Vector3 GetAnchor(unsigned int _index) const;
44 
45  // Documentation inherited
46  public: virtual void SetAnchor(unsigned int _index,
47  const math::Vector3 &_anchor);
48 
49  // Documentation inherited.
50  public: virtual void Init();
51 
52  // Documentation inherited
53  public: virtual math::Vector3 GetGlobalAxis(unsigned int _index) const;
54 
55  // Documentation inherited
56  public: virtual void SetAxis(unsigned int _index,
57  const math::Vector3 &_axis);
58 
59  // Documentation inherited
60  public: virtual void SetThreadPitch(unsigned int _index,
61  double _threadPitch);
62 
64  public: virtual void SetThreadPitch(double _threadPitch);
65 
66  // Documentation inherited
67  public: virtual double GetThreadPitch(unsigned int _index);
68 
70  public: virtual double GetThreadPitch();
71 
72  // Documentation inherited
73  public: virtual math::Angle GetAngleImpl(unsigned int _index) const;
74 
75  // Documentation inherited
76  public: virtual double GetVelocity(unsigned int _index) const;
77 
78  // Documentation inherited
79  public: virtual void SetVelocity(unsigned int _index, double _vel);
80 
81  // Documentation inherited
82  public: virtual void SetMaxForce(unsigned int _index, double _force);
83 
84  // Documentation inherited
85  public: virtual double GetMaxForce(unsigned int _index);
86 
87  // Documentation inherited.
88  public: virtual math::Angle GetHighStop(unsigned int _index);
89 
90  // Documentation inherited.
91  public: virtual math::Angle GetLowStop(unsigned int _index);
92 
93  // Documentation inherited.
94  protected: virtual void SetForceImpl(unsigned int _index, double _effort);
95 
97  protected: dart::dynamics::ScrewJoint *dartScrewJoint;
98  };
99  }
100 }
101 #endif