ScrewJoint.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2012-2014 Open Source Robotics Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
*/
/* Desc: A screw or primastic/rotational joint
 * Author: Nate Koenig, John Hsu
 * Date: 21 May 2003
 */

#ifndef _SCREWJOINT_HH_
#define _SCREWJOINT_HH_

#include "gazebo/physics/Joint.hh"
#include "gazebo/common/Console.hh"
#include "gazebo/util/system.hh"

namespace gazebo
{
  namespace physics
  {

    template<class T>
    class GAZEBO_VISIBLE ScrewJoint : public T
    {
      public: explicit ScrewJoint(BasePtr _parent) : T(_parent), threadPitch(0)
              {this->AddType(Base::SCREW_JOINT);}

      public: virtual ~ScrewJoint()
              { }

      // Documentation inherited.
      public: virtual unsigned int GetAngleCount() const
              {return 2;}

      public: virtual void Load(sdf::ElementPtr _sdf)
                 {
                   T::Load(_sdf);

                   this->threadPitch =
                     _sdf->GetElement("thread_pitch")->Get<double>();
                 }

      public: virtual void SetThreadPitch(unsigned int _index,
                  double _threadPitch) GAZEBO_DEPRECATED(3.0) = 0;

      public: virtual void SetThreadPitch(double _threadPitch) = 0;

      public: virtual double GetThreadPitch(unsigned int _index)
        GAZEBO_DEPRECATED(3.0) = 0;

      public: virtual double GetThreadPitch() = 0;

      protected: double threadPitch;

      protected: virtual void Init()
                 {
                   T::Init();
                 }
    };
  }
}
#endif