endeffectors.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_ENDEFFECTORS_H_
#define _XPP_STATES_ENDEFFECTORS_H_

#include <deque>
#include <iostream>
#include <vector>

#include <xpp_states/state.h>

namespace xpp {

using EndeffectorID = uint;

template<typename T>
class Endeffectors {
public:
  using Container     = std::deque<T>;   // only to avoid faulty std::vector<bool>
  using EndeffectorsT = Endeffectors<T>;

  Endeffectors (int n_ee = 0);
  virtual ~Endeffectors () = default;

  void SetCount(int n_ee);

  void SetAll(const T& value);

  int GetEECount() const;

  std::vector<EndeffectorID> GetEEsOrdered() const;

  T& at(EndeffectorID ee);

  const T& at(EndeffectorID ee) const;

  const EndeffectorsT operator-(const EndeffectorsT& rhs) const;
  const EndeffectorsT operator/(double scalar) const;

  bool operator!=(const Endeffectors& other) const;

  Container ToImpl() const;

private:
  Container ee_;
};

// convenience typedefs, can also be extended to derived classes if desired.
using EndeffectorsPos  = Endeffectors<Eigen::Vector3d>;
using EndeffectorsVel  = Endeffectors<Eigen::Vector3d>;
using EndeffectorsAcc  = Endeffectors<Eigen::Vector3d>;

class EndeffectorsMotion : public Endeffectors<StateLin3d> {
public:
  Endeffectors<Vector3d> Get (MotionDerivative deriv) const
  {
    Endeffectors<Vector3d> val(GetEECount());
    for (auto ee : GetEEsOrdered())
      val.at(ee) = at(ee).GetByIndex(deriv);

    return val;
  }
};


class EndeffectorsContact : public Endeffectors<bool> {
public:
  EndeffectorsContact (int n_ee=0, bool in_contact=false)
      :Endeffectors(n_ee) { SetAll(in_contact);};

  int GetContactCount() const
  {
    int count = 0;
    for (auto ee : GetEEsOrdered())
      if (at(ee))
        count++;

    return count;
  }
};


// implementations
template<typename T>
Endeffectors<T>::Endeffectors (int n_ee)
{
  SetCount(n_ee);
}

template<typename T>
void
Endeffectors<T>::SetCount (int n_ee)
{
  ee_.resize(n_ee);
}

template<typename T>
void
Endeffectors<T>::SetAll (const T& value)
{
  std::fill(ee_.begin(), ee_.end(), value);
}

template<typename T>
T&
Endeffectors<T>::at (EndeffectorID idx)
{
  return ee_.at(idx);
}

template<typename T>
const T&
Endeffectors<T>::at (EndeffectorID idx) const
{
  return ee_.at(idx);
}

template<typename T>
int
Endeffectors<T>::GetEECount () const
{
  return ee_.size();
}

template<typename T>
typename Endeffectors<T>::Container
Endeffectors<T>::ToImpl () const
{
  return ee_;
}

template<typename T>
std::vector<EndeffectorID>
Endeffectors<T>::GetEEsOrdered () const
{
  std::vector<EndeffectorID> vec;
  for (int i=0; i<ee_.size(); ++i)
    vec.push_back(i);

  return vec;
}

template<typename T>
const typename Endeffectors<T>::EndeffectorsT
Endeffectors<T>::operator - (const EndeffectorsT& rhs) const
{
  EndeffectorsT result(ee_.size());
  for (auto i : GetEEsOrdered())
    result.at(i) = ee_.at(i) - rhs.at(i);

  return result;
}

template<typename T>
const typename Endeffectors<T>::EndeffectorsT
Endeffectors<T>::operator / (double scalar) const
{
  EndeffectorsT result(ee_.size());
  for (auto i : GetEEsOrdered())
    result.at(i) = ee_.at(i)/scalar;

  return result;
}

template <typename T>
std::ostream& operator<<(std::ostream& stream, Endeffectors<T> endeffectors)
{
  for (EndeffectorID ee : endeffectors.GetEEsOrdered())
    stream << endeffectors.at(ee) << ", ";

  return stream;
}

template<typename T>
bool
Endeffectors<T>::operator!=(const Endeffectors& other) const
{
  for (auto ee : GetEEsOrdered()) {
    if (ee_.at(ee) != other.at(ee))
      return true;
  }
  return false;
}

} /* namespace xpp */

#endif /* _XPP_STATES_ENDEFFECTORS_H_ */