Robot Simulator of the Robotics Group for Self-Organization of Control  0.8.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Spring Class Reference

#include <spring.h>

Inheritance diagram for Spring:
Collaboration diagram for Spring:

Public Member Functions

 Spring (OneAxisJoint *joint, double _min, double _max, double power, double damp=0.2, double integration=0.0, double maxVel=10.0, double jointLimit=1.0)
 
virtual ~Spring ()
 
virtual void set (double pos)
 sets the set point of the servo. More...
 
virtual double get ()
 returns the position of the slider in ranges [-1, 1] (scaled by min, max) More...
 
virtual void setMinMax (double _min, double _max)
 
- Public Member Functions inherited from OneAxisServo
 OneAxisServo (OneAxisJoint *joint, double _min, double _max, double power, double damp=0.2, double integration=2, double maxVel=10.0, double jointLimit=1.3, bool minmaxCheck=true)
 min and max values are understood as travel bounds. More...
 
virtual ~OneAxisServo ()
 
virtual double get () const
 returns the position of the joint in the range [-1, 1] (scaled by min, max) More...
 
virtual void init (Primitive *own, Joint *joint=0) override
 initialises motor with body of robot More...
 
virtual bool sense (const GlobalData &globaldata) override
 performs sense action More...
 
virtual int getSensorNumber () const override
 returns the number of sensors values produced by this sensor More...
 
virtual std::list< sensorgetList () const
 returns a list of sensor values (usually in the range [-1,1] ) This function should be overloaded. More...
 
virtual int get (sensor *sensors, int length) const
 writes the sensor values (usually in the range [-1,1] ) into the given sensor array and returns the number of sensors written. More...
 
virtual int getMotorNumber () const override
 return the dimensionality of this motor More...
 
virtual bool act (GlobalData &globaldata) override
 performs the actions, This is usually called in doInternalStuff() from the robot More...
 
virtual int set (const motor *values, int length) override
 sends the action commands to the motor. More...
 
virtual void setPower (double power)
 adjusts the power of the servo More...
 
virtual double getPower ()
 returns the power of the servo More...
 
virtual double getDamping ()
 returns the damping of the servo More...
 
virtual void setDamping (double damp)
 sets the damping of the servo More...
 
virtual double & offsetCanceling ()
 returns the integration term of the PID controller of the servo More...
 
virtual void setMaxVel (double maxVel)
 adjusts maximal speed of servo More...
 
virtual double getMaxVel ()
 adjusts maximal speed of servo More...
 
- Public Member Functions inherited from Sensor
 Sensor ()
 
virtual ~Sensor ()
 
virtual std::list
< SensorMotorInfo
getSensorInfos () const
 returns a list of sensor infos ( More...
 
virtual void update ()
 to update any visual appearance More...
 
std::list< sensorgetListOfArray () const
 helper function for performance implementation of list<> get() based on array-get More...
 
- Public Member Functions inherited from SensorMotorInfoAble
 SensorMotorInfoAble ()
 
void setBaseName (const std::string &basename)
 
void setBaseInfo (const SensorMotorInfo &baseinfo)
 
SensorMotorInfo getBaseInfo ()
 
void setNamingFunc (const NamingFunction &func)
 
NamingFunction getNamingFunc () const
 
void setNames (const std::vector< std::string > &names)
 set names explicitly (basename is anyway suffixed) More...
 
std::string getName (int index) const
 returns the name of a single item. Typically called from within Sensor and Motor class. More...
 
std::list< SensorMotorInfogetInfos (int number) const
 get all infos. More...
 
- Public Member Functions inherited from Motor
 Motor ()
 
virtual ~Motor ()
 
virtual std::list
< SensorMotorInfo
getMotorInfos () const
 returns a list of motor names ( More...
 

Additional Inherited Members

- Public Types inherited from Sensor
enum  Dimensions {
  X = 1, Y = 2, Z = 4, XY = X | Y,
  XZ = X | Z, YZ = Y | Z, XYZ = X | Y | Z
}
 defines which dimensions should be sensed. The meaning is sensor specific. More...
 
- Public Types inherited from SensorMotorInfoAble
typedef std::function
< std::string(int)> 
NamingFunction
 function that returns the name given the index More...
 
- Static Public Member Functions inherited from Sensor
static std::list< sensorselectrows (const matrix::Matrix &m, short dimensions)
 selects the rows specified by dimensions (X->0, Y->1, Z->2) More...
 
static int selectrows (sensor *sensors, int length, const matrix::Matrix &m, short dimensions)
 selects the rows specified by dimensions (X->0, Y->1, Z->2) More...
 
static Dimensions parseSensorDimension (char *str)
 
static std::string dimensions2String (short dimensions)
 
- Static Public Member Functions inherited from SensorMotorInfoAble
static std::string defaultNameing (int index)
 the default implementation is for index==0: basename, otherwise basename + (index+1) More...
 
- Protected Attributes inherited from OneAxisServo
OneAxisJointjoint
 
double min
 
double max
 
PID pid
 
double maxVel
 
double jointLimit
 joint limit with respect to servo limit More...
 
- Protected Attributes inherited from SensorMotorInfoAble
NamingFunction func
 
SensorMotorInfo baseinfo
 

Constructor & Destructor Documentation

Spring ( OneAxisJoint joint,
double  _min,
double  _max,
double  power,
double  damp = 0.2,
double  integration = 0.0,
double  maxVel = 10.0,
double  jointLimit = 1.0 
)
inline
virtual ~Spring ( )
inlinevirtual

Member Function Documentation

virtual double get ( )
inlinevirtual

returns the position of the slider in ranges [-1, 1] (scaled by min, max)

virtual void set ( double  pos)
inlinevirtual

sets the set point of the servo.

Position is relative to initial position of the two parts connected by the spring

Reimplemented from OneAxisServo.

virtual void setMinMax ( double  _min,
double  _max 
)
inlinevirtual

Reimplemented from OneAxisServo.


The documentation for this class was generated from the following file: