Program Listing for File velocity_profile_atrap.h

Return to documentation for file (include/pilz_industrial_motion_planner/velocity_profile_atrap.h)

/*********************************************************************
 * Software License Agreement (BSD License)
 *
 *  Copyright (c) 2018 Pilz GmbH & Co. KG
 *  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 Pilz GmbH & Co. KG 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 OWNER 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.
 *********************************************************************/

#pragma once

#include <kdl/velocityprofile.hpp>
#include <iostream>

namespace pilz_industrial_motion_planner
{
class VelocityProfileATrap : public KDL::VelocityProfile
{
public:
  VelocityProfileATrap(double max_vel = 0, double max_acc = 0, double max_dec = 0);

  void SetProfile(double pos1, double pos2) override;

  void SetProfileDuration(double pos1, double pos2, double duration) override;

  bool setProfileAllDurations(double pos1, double pos2, double duration1, double duration2, double duration3);

  bool setProfileStartVelocity(double pos1, double pos2, double vel1);

  double firstPhaseDuration() const
  {
    return t_a_;
  }
  double secondPhaseDuration() const
  {
    return t_b_;
  }
  double thirdPhaseDuration() const
  {
    return t_c_;
  }

  bool operator==(const VelocityProfileATrap& other) const;

  double Duration() const override;
  double Pos(double time) const override;
  double Vel(double time) const override;
  double Acc(double time) const override;
  void Write(std::ostream& os) const override;
  KDL::VelocityProfile* Clone() const override;

  friend std::ostream& operator<<(std::ostream& os, const VelocityProfileATrap& p);  // LCOV_EXCL_LINE

  ~VelocityProfileATrap() override;

private:
  void setEmptyProfile();

private:
  const double max_vel_;
  const double max_acc_;
  const double max_dec_;
  double start_pos_;
  double end_pos_;

  double start_vel_;

  double a1_, a2_, a3_;
  double b1_, b2_, b3_;
  double c1_, c2_, c3_;

  double t_a_;
  double t_b_;
  double t_c_;
};

std::ostream& operator<<(std::ostream& os,
                         const VelocityProfileATrap& p);  // LCOV_EXCL_LINE

}  // namespace pilz_industrial_motion_planner