joints.h

Go to the documentation of this file.

/******************************************************************************
Copyright (c) 2017, Alexander W. Winkler. All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this
  list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.

* Neither the name of the copyright holder nor the names of its
  contributors may be used to endorse or promote products derived from
  this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
******************************************************************************/

#ifndef _XPP_STATES_JOINTS_H_
#define _XPP_STATES_JOINTS_H_

#include <vector>
#include <Eigen/Dense>

#include <xpp_states/endeffectors.h>

namespace xpp {

class Joints : public Endeffectors<VectorXd> {
public:
  using Base = Endeffectors<VectorXd>;
  using Base::GetEECount;
  using Base::at;
  using EEOrder = std::vector<EndeffectorID>;
  using JointID = uint;

  explicit Joints (int n_ee, int n_joints_per_ee, double value = 0.0);

  explicit Joints (const std::vector<VectorXd>& joints);
  virtual ~Joints () = default;

  VectorXd ToVec() const;

  VectorXd ToVec(const EEOrder& ee_order) const;

  void SetFromVec(const VectorXd& q);

  void SetFromVec(const VectorXd& q, const EEOrder& ee_order);

  double& GetJoint(JointID joint);

  double GetJoint(JointID joint) const;

  int GetNumJoints() const;
  int GetNumJointsPerEE() const;

private:
  int n_joints_per_leg_;
  int n_joints_;
};

} /* namespace xpp */

#endif /* _XPP_STATES_JOINTS_H_ */