Fawkes API  Fawkes Development Version
firevision::GlobalPositionModel Class Referenceabstract

Global Position Model Interface. More...

#include <>>

Inheritance diagram for firevision::GlobalPositionModel:

Public Member Functions

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

Detailed Description

Global Position Model Interface.

This interface defines the API for global position models.

Definition at line 33 of file globalpositionmodel.h.

Constructor & Destructor Documentation

◆ ~GlobalPositionModel()

firevision::GlobalPositionModel::~GlobalPositionModel ( )
virtual

Empty virtual destructor.

Definition at line 68 of file globalpositionmodel.cpp.

Member Function Documentation

◆ calc()

void firevision::GlobalPositionModel::calc ( )
pure virtual

Calculate position.

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

Implemented in firevision::OmniGlobal, and firevision::GlobalFromRelativePos.

◆ get_x()

float firevision::GlobalPositionModel::get_x ( void  ) const
pure virtual

Get global x coordinate of object.

Returns
x coordinate of object

Implemented in firevision::OmniGlobal, and firevision::GlobalFromRelativePos.

Referenced by firevision::VelocityFromGlobal::calc().

◆ get_y()

float firevision::GlobalPositionModel::get_y ( void  ) const
pure virtual

Get global y coordinate of object.

Returns
y coordinate of object

Implemented in firevision::OmniGlobal, and firevision::GlobalFromRelativePos.

Referenced by firevision::VelocityFromGlobal::calc().

◆ is_pos_valid()

bool firevision::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 firevision::OmniGlobal, and firevision::GlobalFromRelativePos.

◆ set_position_in_image()

void firevision::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
xx coordinate in pixels
yy coordinate in pixels

Implemented in firevision::GlobalFromRelativePos, and firevision::OmniGlobal.

◆ set_robot_position()

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

Set the global position of the object.

Parameters
xx coordinate of position
yy coordinate of position
oriorientation of robot

Implemented in firevision::GlobalFromRelativePos, and firevision::OmniGlobal.


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