JointState.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2012-2015 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 joint state
 * Author: Nate Koenig
 */

#ifndef _JOINTSTATE_HH_
#define _JOINTSTATE_HH_

#include <vector>
#include <string>

#include "gazebo/physics/State.hh"
#include "gazebo/math/Pose.hh"
#include "gazebo/util/system.hh"

namespace gazebo
{
  namespace physics
  {

    class GAZEBO_VISIBLE JointState : public State
    {
      public: JointState();

      public: JointState(JointPtr _joint, const common::Time &_realTime,
                  const common::Time &_simTime);

      public: explicit JointState(JointPtr _joint);

      public: explicit JointState(const sdf::ElementPtr _sdf);

      public: virtual ~JointState();

      public: void Load(JointPtr _joint, const common::Time &_realTime,
                  const common::Time &_simTime);

      public: virtual void Load(const sdf::ElementPtr _elem);

      public: unsigned int GetAngleCount() const;

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

      public: const std::vector<math::Angle> &GetAngles() const;

      public: bool IsZero() const;

      public: void FillSDF(sdf::ElementPtr _sdf);

      public: JointState &operator=(const JointState &_state);

      public: JointState operator-(const JointState &_state) const;

      public: JointState operator+(const JointState &_state) const;

      public: inline friend std::ostream &operator<<(std::ostream &_out,
                  const gazebo::physics::JointState &_state)
      {
        _out << "<joint name='" << _state.GetName() << "'>";

        int i = 0;
        for (std::vector<math::Angle>::const_iterator iter =
            _state.angles.begin(); iter != _state.angles.end(); ++iter)
        {
          _out << "<angle axis='" << i << "'>" << (*iter) << "</angle>";
        }

        _out << "</joint>";

        return _out;
      }

      private: std::vector<math::Angle> angles;
    };
  }
}
#endif