Field Class Reference

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

#include </nao_fawkes/src/firevision/apps/nao_loc/field.cpp/field.h>

List of all members.


Public Member Functions

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

Static Public Member Functions

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

Detailed Description

This class is used to describe a soccer field.

Definition at line 32 of file field.h.

Constructor & Destructor Documentation

Field::~Field (  ) 

Destructor.

Definition at line 52 of file field.cpp.

Member Function Documentation

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

Returns the corresponding Field object.

Parameters:
field_name the name of the field
field_length the area of interest around the field
field_width the area of interest around the field
Returns:
the Field object pointer

Definition at line 111 of file field.cpp.

float Field::get_field_length (  )  const

Field length getter.

Returns:
the length of the soccer field

Definition at line 63 of file field.cpp.

References FieldLines::get_field_length().

float Field::get_field_width (  )  const

Field width getter.

Returns:
the width of the soccer field

Definition at line 74 of file field.cpp.

References FieldLines::get_field_width().

const FieldLines & Field::get_lines (  )  const [inline]

Field lines getter.

Returns:
the field lines object
Author:
Christof Rath

Definition at line 37 of file field.h.

void Field::print ( bool  in_mm  )  const

Prints the information to the console.

Parameters:
in_mm if true all units that have been [m] are now [mm]

Definition at line 85 of file field.cpp.

References FieldLines::get_circles().

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