GlobalPositionModel Class Reference

Global Position Model Interface. More...

#include <models/global_position/globalpositionmodel.h>

Inheritance diagram for GlobalPositionModel:

Inheritance graph
[legend]

List of all members.


Public Member Functions

virtual ~GlobalPositionModel ()
 Empty virtual destructor.
virtual void set_robot_position (float x, float y, float ori)=0
 Set the global position of the object.
virtual void set_position_in_image (unsigned int x, unsigned int y)=0
 Set the position of the object as recognized in the image.
virtual float get_x () const =0
 Get global x coordinate of object.
virtual float get_y () const =0
 Get global y coordinate of object.
virtual void calc ()=0
 Calculate position.
virtual bool is_pos_valid () const =0
 Check if the position is valid.

Detailed Description

Global Position Model Interface.

This interface defines the API for global position models.

Definition at line 28 of file globalpositionmodel.h.

Constructor & Destructor Documentation

GlobalPositionModel::~GlobalPositionModel (  )  [virtual]

Empty virtual destructor.

Definition at line 63 of file globalpositionmodel.cpp.

Member Function Documentation

void GlobalPositionModel::calc (  )  [pure virtual]

Calculate position.

From the data set via setRobotPosition() or setPositionInImage() calculate the objects global position.

Implemented in GlobalFromRelativePos, and OmniGlobal.

float GlobalPositionModel::get_x ( void   )  const [pure virtual]

Get global x coordinate of object.

Returns:
x coordinate of object

Implemented in GlobalFromRelativePos, and OmniGlobal.

Referenced by VelocityFromGlobal::calc().

float GlobalPositionModel::get_y ( void   )  const [pure virtual]

Get global y coordinate of object.

Returns:
y coordinate of object

Implemented in GlobalFromRelativePos, and OmniGlobal.

Referenced by VelocityFromGlobal::calc().

bool GlobalPositionModel::is_pos_valid (  )  const [pure virtual]

Check if the position is valid.

Returns:
true, if the calculated position is valid, false otherwise
Author:
Tim Niemueller

Implemented in GlobalFromRelativePos, and OmniGlobal.

void GlobalPositionModel::set_position_in_image ( unsigned int  x,
unsigned int  y 
) [pure virtual]

Set the position of the object as recognized in the image.

Parameters:
x x coordinate in pixels
y y coordinate in pixels

Implemented in GlobalFromRelativePos, and OmniGlobal.

void GlobalPositionModel::set_robot_position ( float  x,
float  y,
float  ori 
) [pure virtual]

Set the global position of the object.

Parameters:
x x coordinate of position
y y coordinate of position
ori orientation of robot

Implemented in GlobalFromRelativePos, and OmniGlobal.

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