firevision::VelocityFromGlobal Class Reference

Velocity from global positions. More...

#include <models/velocity/globvelo.h>

Inheritance diagram for firevision::VelocityFromGlobal:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 VelocityFromGlobal (GlobalPositionModel *model, unsigned int history_length, unsigned int calc_interval)
 Constructor.
virtual ~VelocityFromGlobal ()
 Destructor.
virtual const char * getName () const
 Get name of velocity model.
virtual void setRobotPosition (float x, float y, float ori, timeval t)
 Set robot position.
virtual void setRobotVelocity (float vel_x, float vel_y, timeval t)
 Set robot velocity.
virtual void setPanTilt (float pan, float tilt)
 Set pan and tilt.
virtual void setTime (timeval t)
 Set current time.
virtual void setTimeNow ()
 Get current time from system.
virtual void getTime (long int *sec, long int *usec)
 Get time from velocity.
virtual void getVelocity (float *vel_x, float *vel_y)
 Method to retrieve velocity information.
virtual float getVelocityX ()
 Get velocity of tracked object in X direction.
virtual float getVelocityY ()
 Get velocity of tracked object in X direction.
virtual void calc ()
 Calculate velocity values from given data This method must be called after all relevent data (set*) has been set.
virtual void reset ()
 Reset velocity model Must be called if ball is not visible at any time.
virtual coordsys_type_t getCoordinateSystem ()
 Returns the used coordinate system, must be either COORDSYS_ROBOT_CART or COORDSYS_ROBOT_WORLD.

Detailed Description

Velocity from global positions.

Definition at line 40 of file globvelo.h.


Constructor & Destructor Documentation

firevision::VelocityFromGlobal::VelocityFromGlobal ( GlobalPositionModel model,
unsigned int  history_length,
unsigned int  calc_interval 
)

Constructor.

Parameters:
model global position model
history_length maximum history length
calc_interval calculation interval

Definition at line 44 of file globvelo.cpp.

firevision::VelocityFromGlobal::~VelocityFromGlobal (  )  [virtual]

Destructor.

Definition at line 80 of file globvelo.cpp.


Member Function Documentation

void firevision::VelocityFromGlobal::calc (  )  [virtual]

Calculate velocity values from given data This method must be called after all relevent data (set*) has been set.

After calc() the velocity values can be retrieved

Implements firevision::VelocityModel.

Definition at line 160 of file globvelo.cpp.

References firevision::GlobalPositionModel::get_x(), and firevision::GlobalPositionModel::get_y().

coordsys_type_t firevision::VelocityFromGlobal::getCoordinateSystem (  )  [virtual]

Returns the used coordinate system, must be either COORDSYS_ROBOT_CART or COORDSYS_ROBOT_WORLD.

ROBOT denotes velocities relative to the robot (which can be tramsformed to global velocities by: glob_vel_x = rel_vel_x * cos( robot_ori ) - rel_vel_y * sin( robot_ori ) WORLD denotes velocities in the robot coordinate system glob_vel_y = rel_vel_x * sin( robot_ori ) + rel_vel_y * cos( robot_ori )

Returns:
coordinate system type

ROBOT denotes velocities relative to the robot (which can be tramsformed to global velocities by: glob_vel_x = rel_vel_x * cos( robot_ori ) - rel_vel_y * sin( robot_ori ) WORLD denotes velocities in the robot coordinate system glob_vel_y = rel_vel_x * sin( robot_ori ) + rel_vel_y * cos( robot_ori )

Implements firevision::VelocityModel.

Definition at line 227 of file globvelo.cpp.

const char * firevision::VelocityFromGlobal::getName ( void   )  const [virtual]

Get name of velocity model.

Returns:
name of velocity model

Implements firevision::VelocityModel.

Definition at line 220 of file globvelo.cpp.

void firevision::VelocityFromGlobal::getTime ( long int *  sec,
long int *  usec 
) [virtual]

Get time from velocity.

Parameters:
sec contains seconds since the epoch upon return (Unix timestamp)
usec contains microseconds upon return

Implements firevision::VelocityModel.

Definition at line 125 of file globvelo.cpp.

void firevision::VelocityFromGlobal::getVelocity ( float *  vel_x,
float *  vel_y 
) [virtual]

Method to retrieve velocity information.

Parameters:
vel_x If not NULL contains velocity in X direction after call
vel_y If not NULL contains velocity in Y direction after call

Implements firevision::VelocityModel.

Definition at line 133 of file globvelo.cpp.

float firevision::VelocityFromGlobal::getVelocityX (  )  [virtual]

Get velocity of tracked object in X direction.

Returns:
velocity in m/s.

Implements firevision::VelocityModel.

Definition at line 145 of file globvelo.cpp.

float firevision::VelocityFromGlobal::getVelocityY (  )  [virtual]

Get velocity of tracked object in X direction.

Returns:
velocity in m/s.

Implements firevision::VelocityModel.

Definition at line 152 of file globvelo.cpp.

void firevision::VelocityFromGlobal::reset ( void   )  [virtual]

Reset velocity model Must be called if ball is not visible at any time.

Implements firevision::VelocityModel.

Definition at line 213 of file globvelo.cpp.

void firevision::VelocityFromGlobal::setPanTilt ( float  pan,
float  tilt 
) [virtual]

Set pan and tilt.

Parameters:
pan pan
tilt tilt

Implements firevision::VelocityModel.

Definition at line 86 of file globvelo.cpp.

void firevision::VelocityFromGlobal::setRobotPosition ( float  x,
float  y,
float  ori,
timeval  t 
) [virtual]

Set robot position.

Parameters:
x x
y y
ori ori
t timestamp of the pose information

Implements firevision::VelocityModel.

Definition at line 92 of file globvelo.cpp.

References fawkes::time_diff_sec().

void firevision::VelocityFromGlobal::setRobotVelocity ( float  vel_x,
float  vel_y,
timeval  t 
) [virtual]

Set robot velocity.

Parameters:
vel_x robot velocity in x direction
vel_y robot velocity in y direction
t timestamp of the velocity information

Implements firevision::VelocityModel.

Definition at line 104 of file globvelo.cpp.

void firevision::VelocityFromGlobal::setTime ( timeval  t  )  [virtual]

Set current time.

Parameters:
t time

Implements firevision::VelocityModel.

Definition at line 110 of file globvelo.cpp.

void firevision::VelocityFromGlobal::setTimeNow (  )  [virtual]

Get current time from system.

Implements firevision::VelocityModel.

Definition at line 118 of file globvelo.cpp.


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

Generated on 1 Mar 2011 for Fawkes API by  doxygen 1.6.1