caterpillar.h

Go to the documentation of this file.

/**************************************************************************/
/*schlangeservo.h                                                         */
/*Snake with PID Servo motors (just motor per joint)                      */
/*@author Georg Martius                                                   */
/*                                                                        */
/**************************************************************************/
/***************************************************************************
 *   Copyright (C) 2005-2011 LpzRobots development team                    *
 *    Georg Martius  <georg dot martius at web dot de>                     *
 *    Frank Guettler <guettler at informatik dot uni-leipzig dot de        *
 *    Frank Hesse    <frank at nld dot ds dot mpg dot de>                  *
 *    Ralf Der       <ralfder at mis dot mpg dot de>                       *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 *                                                                         *
 ***************************************************************************/
#ifndef __CATERPILLAR_H
#define __CATERPILLAR_H

#include "defaultCaterpillar.h"
#include "twoaxisservo.h"
#include "oneaxisservo.h"

namespace lpzrobots {

  /**
   * This is a class, which models a snake like robot. 
   * It consists of a number of equal elements, each linked 
   * by a joint powered by 2 servos
   **/
  class CaterPillar : public DefaultCaterPillar
    {
  private:
    std::vector <UniversalServo*> universalServos;
    std::vector <SliderServo*> sliderServos;

  public:
      CaterPillar ( const OdeHandle& odeHandle, const OsgHandle& osgHandle,
                      const CaterPillarConf& conf, const std::string& name);
    
      virtual ~CaterPillar();
        
    /**
     *Reads the actual motor commands from an array, 
     *an sets all motors of the snake to this values.
     *It is an linear allocation.
     *@param motors pointer to the array, motor values are scaled to [-1,1] 
     *@param motornumber length of the motor array
     **/
    virtual void setMotors ( const motor* motors, int motornumber );

    /**
     *Writes the sensor values to an array in the memory.
     *@param sensors pointer to the array
     *@param sensornumber length of the sensor array
     *@return number of actually written sensors
     **/
    virtual int getSensors ( sensor* sensors, int sensornumber );
        
    /** returns number of sensors
     */
    virtual int getSensorNumber() { assert(created); return 2*universalServos.size()+sliderServos.size(); }

    /** returns number of motors
     */
    virtual int getMotorNumber(){ assert(created); return 2*universalServos.size()+sliderServos.size(); }

    /******** CONFIGURABLE ***********/
    virtual void notifyOnChange(const paramkey& key);

  private:
    virtual void create(const osg::Matrix& pose);
    virtual void destroy();
  };

}

#endif