Fawkes API  Fawkes Development Version
fawkes::field_line_struct Struct Reference

Describes a field line. More...

#include <types.h>

Public Member Functions

 field_line_struct (fawkes::cart_coord_2d_t start, fawkes::cart_coord_2d_t end)
 Constructor. More...
 
 field_line_struct (float start_x, float start_y, float end_x, float end_y)
 Constructor. More...
 

Public Attributes

cart_coord_2d_t start
 start of the line [m] More...
 
cart_coord_2d_t end
 end of the line [m] More...
 

Detailed Description

Describes a field line.

Definition at line 117 of file types.h.

Constructor & Destructor Documentation

◆ field_line_struct() [1/2]

fawkes::field_line_struct::field_line_struct ( fawkes::cart_coord_2d_t  start,
fawkes::cart_coord_2d_t  end 
)
inline

Constructor.

Parameters
startof the line
endof the line

Definition at line 126 of file types.h.

◆ field_line_struct() [2/2]

fawkes::field_line_struct::field_line_struct ( float  start_x,
float  start_y,
float  end_x,
float  end_y 
)
inline

Constructor.

Parameters
start_xof the line
start_yof the line
end_xof the line
end_yof the line

Definition at line 139 of file types.h.

References fawkes::cart_coord_2d_struct::x, and fawkes::cart_coord_2d_struct::y.

Member Data Documentation

◆ end

cart_coord_2d_t fawkes::field_line_struct::end

end of the line [m]

Definition at line 119 of file types.h.

◆ start

cart_coord_2d_t fawkes::field_line_struct::start

start of the line [m]

Definition at line 118 of file types.h.


The documentation for this struct was generated from the following file: