DARTJoint.hh

Go to the documentation of this file.

/*
 * Copyright (C) 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.
 *
*/

#ifndef _GAZEBO_DARTJOINT_HH_
#define _GAZEBO_DARTJOINT_HH_

#include <boost/any.hpp>
#include <string>

#include "gazebo/common/Exception.hh"
#include "gazebo/physics/Joint.hh"
#include "gazebo/physics/dart/dart_inc.h"
#include "gazebo/physics/dart/DARTPhysics.hh"
#include "gazebo/util/system.hh"

namespace gazebo
{
  namespace physics
  {
    class DARTJointPrivate;


    class GZ_PHYSICS_VISIBLE DARTJoint : public Joint
    {
      public: explicit DARTJoint(BasePtr _parent);

      public: virtual ~DARTJoint();

      // Documentation inherited.
      public: virtual void Load(sdf::ElementPtr _sdf);

      public: virtual void Init();

      // Documentation inherited.
      public: virtual void Reset();

      // Documentation inherited.
      public: virtual LinkPtr GetJointLink(unsigned int _index) const;

      // Documentation inherited.
      public: virtual bool AreConnected(LinkPtr _one, LinkPtr _two) const;

      // Documentation inherited.
      public: virtual void Attach(LinkPtr _parent, LinkPtr _child);

      // Documentation inherited.
      public: virtual void Detach();

      // Documentation inherited
      public: virtual void SetDamping(unsigned int _index, double _damping);

      // Documentation inherited.
      public: virtual void SetStiffnessDamping(unsigned int _index,
        double _stiffness, double _damping, double _reference = 0);

      // Documentation inherited.
      public: virtual void SetStiffness(unsigned int _index,
                  const double _stiffness);

      public: virtual void SetAnchor(const unsigned int /*_index*/,
          const ignition::math::Vector3d &/*_anchor*/);

      public: virtual ignition::math::Vector3d Anchor(
            const unsigned int /*_index*/) const override final;

      // Documentation inherited
      public: virtual void SetVelocity(unsigned int _index, double _vel)
            override final;

      // Documentation inherited
      public: virtual double GetVelocity(unsigned int _index)
            const override;

      // Documentation inherited.
      public: virtual void SetForce(unsigned int _index, double _force);

      // Documentation inherited.
      public: virtual double GetForce(unsigned int _index);

      // Documentation inherited.
      public: virtual JointWrench GetForceTorque(unsigned int _index);

      // Documentation inherited.
      public: virtual bool SetPosition(
                              const unsigned int _index,
                              const double _position,
                              const bool _preserveWorldVelocity = false)
            override final;

      // Documentation inherited.
      public: virtual ignition::math::Vector3d LinkForce(
          const unsigned int _index) const;

      // Documentation inherited.
      public: virtual ignition::math::Vector3d LinkTorque(
          const unsigned int _index) const;

      // Documentation inherited.
      public: virtual bool SetParam(const std::string &_key,
                                        unsigned int _index,
                                        const boost::any &_value);

      // Documentation inherited.
      public: virtual double GetParam(const std::string &_key,
                                          unsigned int _index);

      // Documentation inherited.
      public: virtual double LowerLimit(const unsigned int _index) const;

      // Documentation inherited.
      public: virtual double UpperLimit(const unsigned int _index) const;

      // Documentation inherited.
      public: virtual void SetLowerLimit(const unsigned int _index,
                                         const double _limit);

      // Documentation inherited.
      public: virtual void SetUpperLimit(const unsigned int _index,
                                         const double _limit);

      // Documentation inherited.
      public: virtual void CacheForceTorque();

      // Documentation inherited.
      protected: virtual double PositionImpl(const unsigned int _index = 0)
            const override;

      // Documentation inherited.
      public: virtual void ApplyDamping();

      protected: void SetForceImpl(unsigned int _index, double _force);

      private: void SaveForce(unsigned int _index, double _force);

      public: DARTModelPtr GetDARTModel() const;

      public: DARTJointPropPtr DARTProperties() const;

      public: void SetDARTJoint(dart::dynamics::Joint *_dtJoint);

      public: dart::dynamics::Joint *GetDARTJoint();

      protected: DARTJointPrivate *dataPtr;
    };
  }
}
#endif