Joint.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.
 *
*/
#ifndef _GAZEBO_JOINT_HH_
#define _GAZEBO_JOINT_HH_

#include <string>
#include <vector>

#include <boost/any.hpp>

#include "gazebo/common/Event.hh"
#include "gazebo/common/Events.hh"
#include "gazebo/math/Angle.hh"
#include "gazebo/math/Vector3.hh"
#include "gazebo/msgs/MessageTypes.hh"

#include "gazebo/physics/JointState.hh"
#include "gazebo/physics/Base.hh"
#include "gazebo/physics/JointWrench.hh"
#include "gazebo/util/system.hh"

#define MAX_JOINT_AXIS 2

namespace gazebo
{
  namespace physics
  {

    class GAZEBO_VISIBLE Joint : public Base
    {
      public: enum Attribute
              {
                FUDGE_FACTOR,

                SUSPENSION_ERP,

                SUSPENSION_CFM,

                STOP_ERP,

                STOP_CFM,

                ERP,

                CFM,

                FMAX,

                VEL,

                HI_STOP,

                LO_STOP
              };

      public: explicit Joint(BasePtr _parent);

      public: virtual ~Joint();

      public: void Load(LinkPtr _parent, LinkPtr _child,
                        const math::Pose &_pose);

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

      public: virtual void Init();

      public: virtual void Fini();

      public: void Update();

      public: virtual void UpdateParameters(sdf::ElementPtr _sdf);

      public: virtual void Reset();

      public: void SetState(const JointState &_state);

      public: void SetModel(ModelPtr _model);

      public: virtual LinkPtr GetJointLink(unsigned int _index) const = 0;

      public: virtual bool AreConnected(LinkPtr _one, LinkPtr _two) const = 0;

      public: virtual void Attach(LinkPtr _parent, LinkPtr _child);

      public: virtual void Detach();

      public: virtual void SetAxis(unsigned int _index,
                  const math::Vector3 &_axis) = 0;

      public: virtual void SetDamping(unsigned int _index, double _damping) = 0;

      public: double GetDamping(unsigned int _index);

      public: virtual void ApplyDamping() GAZEBO_DEPRECATED(3.0);

      public: virtual void ApplyStiffnessDamping();

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

      public: virtual void SetStiffness(unsigned int _index,
                                        double _stiffness) = 0;

      public: double GetStiffness(unsigned int _index);

      public: double GetSpringReferencePosition(unsigned int _index) const;

      public: template<typename T>
              event::ConnectionPtr ConnectJointUpdate(T _subscriber)
              {return jointUpdate.Connect(_subscriber);}

      public: void DisconnectJointUpdate(event::ConnectionPtr &_conn)
              {jointUpdate.Disconnect(_conn);}

      public: math::Vector3 GetLocalAxis(unsigned int _index) const;

      public: virtual math::Vector3 GetGlobalAxis(
                  unsigned int _index) const = 0;

      public: virtual void SetAnchor(unsigned int _index,
                                     const math::Vector3 &_anchor) = 0;

      public: virtual math::Vector3 GetAnchor(unsigned int _index) const = 0;

      public: virtual bool SetHighStop(unsigned int _index,
                                       const math::Angle &_angle);

      public: virtual bool SetLowStop(unsigned int _index,
                                      const math::Angle &_angle);

      public: virtual math::Angle GetHighStop(unsigned int _index) = 0;

      public: virtual math::Angle GetLowStop(unsigned int _index) = 0;

      public: virtual double GetEffortLimit(unsigned int _index);

      public: virtual void SetEffortLimit(unsigned int _index, double _effort);

      public: virtual double GetVelocityLimit(unsigned int _index);

      public: virtual void SetVelocity(unsigned int _index, double _vel) = 0;

      public: virtual double GetVelocity(unsigned int _index) const = 0;

      public: virtual void SetForce(unsigned int _index, double _effort) = 0;

      public: double CheckAndTruncateForce(unsigned int _index, double _effort);

      public: virtual double GetForce(unsigned int _index);

      public: virtual JointWrench GetForceTorque(unsigned int _index) = 0;

      public: virtual void SetMaxForce(unsigned int _index, double _force) = 0;

      public: virtual double GetMaxForce(unsigned int _index) = 0;

      public: math::Angle GetAngle(unsigned int _index) const;

      public: virtual unsigned int GetAngleCount() const = 0;

      public: void SetAngle(unsigned int _index, math::Angle _angle);

      public: virtual math::Vector3 GetLinkForce(unsigned int _index) const = 0;

      public: virtual math::Vector3 GetLinkTorque(
                  unsigned int _index) const = 0;

      public: virtual bool SetParam(const std::string &_key,
                                    unsigned int _index,
                                    const boost::any &_value) = 0;

      public: virtual void SetAttribute(const std::string &_key,
                                        unsigned int _index,
                                        const boost::any &_value)
                                        GAZEBO_DEPRECATED(3.0) = 0;

      public: virtual double GetParam(const std::string &_key,
                                          unsigned int _index) = 0;

      public: virtual double GetAttribute(const std::string &_key,
                unsigned int _index) GAZEBO_DEPRECATED(3.0) = 0;

      public: LinkPtr GetChild() const;

      public: LinkPtr GetParent() const;

      public: void FillMsg(msgs::Joint &_msg);

      public: double GetInertiaRatio(const unsigned int _index) const;

      public: double GetInertiaRatio(const math::Vector3 &_axis) const;

      public: math::Angle GetLowerLimit(unsigned int _index) const;

      public: math::Angle GetUpperLimit(unsigned int _index) const;

      public: void SetLowerLimit(unsigned int _index, math::Angle _limit);

      public: void SetUpperLimit(unsigned int _index, math::Angle _limit);

      public: virtual void SetProvideFeedback(bool _enable);

      public: virtual void CacheForceTorque() { }

      public: double GetDampingCoefficient() const GAZEBO_DEPRECATED(3.0);

      public: void SetStopStiffness(unsigned int _index, double _stiffness);

      public: void SetStopDissipation(unsigned int _index, double _dissipation);

      public: double GetStopStiffness(unsigned int _index) const;

      public: double GetStopDissipation(unsigned int _index) const;

      public: math::Pose GetInitialAnchorPose() const;

      public: math::Pose GetWorldPose() const;

      public: math::Pose GetParentWorldPose() const;

      public: math::Pose GetAnchorErrorPose() const;

      public: math::Quaternion GetAxisFrame(unsigned int _index) const;

      public: double GetWorldEnergyPotentialSpring(unsigned int _index) const;

      protected: virtual math::Angle GetAngleImpl(
                     unsigned int _index) const = 0;

      private: void LoadImpl(const math::Pose &_pose);

      protected: LinkPtr childLink;

      protected: LinkPtr parentLink;

      protected: ModelPtr model;

      protected: math::Vector3 anchorPos;

      protected: math::Pose anchorPose;

      protected: math::Pose parentAnchorPose;

      protected: LinkPtr anchorLink;

      protected: double dampingCoefficient;

      protected: double dissipationCoefficient[MAX_JOINT_AXIS];

      protected: double stiffnessCoefficient[MAX_JOINT_AXIS];

      protected: double springReferencePosition[MAX_JOINT_AXIS];

      protected: gazebo::event::ConnectionPtr applyDamping;

      protected: double effortLimit[MAX_JOINT_AXIS];

      protected: double velocityLimit[MAX_JOINT_AXIS];

      protected: math::Angle lowerLimit[MAX_JOINT_AXIS];

      protected: math::Angle upperLimit[MAX_JOINT_AXIS];

      protected: JointWrench wrench;

      protected: bool useCFMDamping;

      protected: bool axisParentModelFrame[MAX_JOINT_AXIS];

      private: static sdf::ElementPtr sdfJoint;

      protected: bool provideFeedback;

      private: std::vector<std::string> sensors;

      private: event::EventT<void ()> jointUpdate;

      private: math::Angle staticAngle;

      private: double stopStiffness[MAX_JOINT_AXIS];

      private: double stopDissipation[MAX_JOINT_AXIS];
    };
  }
}
#endif