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

#include <>>

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 38 of file field.h.

Constructor & Destructor Documentation

firevision::Field::~Field ( )

Destructor.

Definition at line 57 of file field.cpp.

Field * firevision::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

Definition at line 116 of file field.cpp.

float firevision::Field::get_field_length ( ) const

Field length getter.

Definition at line 68 of file field.cpp.

float firevision::Field::get_field_width ( ) const

Field width getter.

Definition at line 79 of file field.cpp.

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

Field lines getter.

Definition at line 43 of file field.h.

void firevision::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 90 of file field.cpp.

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