Fawkes API  Fawkes Development Version
Public Member Functions | Static Public Member Functions | List of all members
firevision::Field Class Reference

This class is used to describe a soccer field. More...

#include <>>

Public Member Functions

 ~Field ()
 Destructor. More...
 
const FieldLines & get_lines () const
 Field lines getter. More...
 
float get_field_length () const
 Field length getter. More...
 
float get_field_width () const
 Field width getter. More...
 
void print (bool in_mm) const
 Prints the information to the console. More...
 

Static Public Member Functions

static Field * field_for_name (std::string field_name, float field_length, float field_width)
 Returns the corresponding Field object. More...
 

Detailed Description

This class is used to describe a soccer field.

Definition at line 38 of file field.h.

Constructor & Destructor Documentation

firevision::Field::~Field ( )

Destructor.

Definition at line 57 of file field.cpp.

Member Function Documentation

Field * firevision::Field::field_for_name ( std::string  field_name,
float  field_length,
float  field_width 
)
static

Returns the corresponding Field object.

Parameters
field_namethe name of the field
field_lengththe area of interest around the field
field_widththe area of interest around the field
Returns
the Field object pointer

Definition at line 116 of file field.cpp.

Referenced by get_lines().

float firevision::Field::get_field_length ( ) const

Field length getter.

Returns
the length of the soccer field

Definition at line 68 of file field.cpp.

Referenced by get_lines().

float firevision::Field::get_field_width ( ) const

Field width getter.

Returns
the width of the soccer field

Definition at line 79 of file field.cpp.

Referenced by get_lines().

const FieldLines & firevision::Field::get_lines ( ) const
inline

Field lines getter.

Returns
the field lines object
Author
Christof Rath

Definition at line 43 of file field.h.

References field_for_name(), get_field_length(), get_field_width(), and print().

void firevision::Field::print ( bool  in_mm) const

Prints the information to the console.

Parameters
in_mmif true all units that have been [m] are now [mm]

Definition at line 90 of file field.cpp.

Referenced by get_lines().

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