robot.h

Go to the documentation of this file.

/*********************************************************************
 * Software License Agreement (BSD License)
 *
 *  Copyright (c) 2008, Willow Garage, Inc.
 *  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 Willow Garage 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.
 *********************************************************************/

/*
 * The robot model tracks the state of the robot.
 *
 * State path:
 *               +---------------+
 * Actuators --> | Transmissions | --> Joints
 *               +---------------+
 *
 * Author: Stuart Glaser
 */

#ifndef ROBOT_H
#define ROBOT_H

#include <vector>
#include <map>
#include <string>
#include <urdf/model.h>
#include <pr2_hardware_interface/hardware_interface.h>
#include <hardware_interface/hardware_interface.h>
#include "pr2_mechanism_model/joint.h"
#include "pr2_mechanism_model/transmission.h"

class TiXmlElement;

// Forward declared to avoid extra includes
namespace pluginlib {
template <class T> class ClassLoader;
}

namespace pr2_mechanism_model
{


class Robot
{
public:
  Robot(pr2_hardware_interface::HardwareInterface *hw);

  ~Robot() { }

  bool initXml(TiXmlElement *root);

  urdf::Model robot_model_;

  std::vector<boost::shared_ptr<Transmission> > transmissions_;

  int getTransmissionIndex(const std::string &name) const;

  pr2_hardware_interface::Actuator* getActuator(const std::string &name) const;

  boost::shared_ptr<pr2_mechanism_model::Transmission> getTransmission(const std::string &name) const;

  ros::Time getTime();

  pr2_hardware_interface::HardwareInterface* hw_;

private:
  boost::shared_ptr<pluginlib::ClassLoader<pr2_mechanism_model::Transmission> > transmission_loader_;
};



class RobotState : public hardware_interface::HardwareInterface
{
public:
  RobotState(Robot *model);

  Robot *model_;

  std::vector<JointState> joint_states_;

  JointState *getJointState(const std::string &name);

  const JointState *getJointState(const std::string &name) const;

  ros::Time getTime() {return model_->getTime();};

  std::vector<std::vector<pr2_hardware_interface::Actuator*> > transmissions_in_;

  std::vector<std::vector<pr2_mechanism_model::JointState*> > transmissions_out_;

  void propagateActuatorPositionToJointPosition();
  void propagateJointPositionToActuatorPosition();

  void propagateJointEffortToActuatorEffort();
  void propagateActuatorEffortToJointEffort();

  void enforceSafety();

  bool isHalted();

  void zeroCommands();


  std::map<std::string, JointState*> joint_states_map_;

};

}

#endif