f2c Namespace Reference

Main namespace of the fields2cover library. More...

Namespaces
	decomp
	Decomposition algorithms' namespace.
	hg
	Headland generator algorithms' namespace.
	obj
	Objective algorithms' namespace.
	pp
	Path planning algorithms' namespace.
	rp
	Route planning algorithms' namespace.
	sg
	Swath generator algorithms' namespace.
	types
	Types used by fields2cover library.

Classes
class	CubicSpline
struct	Options
class	Parser
	Class to parse files of the OGC Standards to our custom format. More...
class	Random
class	Transform
class	Visualizer
	Class to plot Fields2Cover data structures. More...

Enumerations
enum	DecompAlg { DecompAlg::NONE = 0 }
enum	HGAlg { HGAlg::NONE = 0, HGAlg::CONST = 1 }
enum	PPAlg { PPAlg::DUBINS = 0, PPAlg::DUBINS_CC = 1, PPAlg::REEDS_SHEPP = 2, PPAlg::REEDS_SHEPP_HC = 3 }
enum	RPAlg { RPAlg::SHORTEST_ROUTE = 0 }
enum	SGAlg { SGAlg::BRUTE_FORCE = 0, SGAlg::GIVEN_ANGLE = 1 }
enum	SGObjFunc {   SGObjFunc::N_SWATH_MOD = 0, SGObjFunc::N_SWATH = 1, SGObjFunc::SWATH_LENGTH = 2, SGObjFunc::FIELD_COV = 3,   SGObjFunc::OVERLAPS = 4 }

Functions
F2CCell	getCellFromJson (const json &imported_cell)
F2CPoint	getPointFromJson (const json &ps)
std::unique_ptr< f2c::pp::TurningBase >	getPPTurningBasePtr (const Options &opt)
std::unique_ptr< obj::SGObjective >	getSGObjPtr (const Options &opt)
F2CPath	planCovPath (const F2CRobot &robot, const F2CCell &cell, const Options &opt=Options())
F2CPath	planCovPath (const F2CRobot &robot, const F2CCells &cells, const Options &opt=Options())
F2CPath	planCovPath (const F2CRobot &robot, const F2CField &field, bool local_crs)
F2CPath	planCovPath (const F2CRobot &robot, const F2CField &field, const Options &opt=Options(), bool local_crs=true)
F2CRoute	planCovRoute (const F2CRobot &robot, const F2CCell &cell, const Options &opt=Options())
F2CRoute	planCovRoute (const F2CRobot &robot, const F2CCells &cells, const Options &opt=Options())
F2CRoute	planCovRoute (const F2CRobot &robot, const F2CField &field, bool local_crs)
F2CRoute	planCovRoute (const F2CRobot &robot, const F2CField &field, const Options &opt=Options(), bool local_crs=true)
	TEST (fields2cover_types_point, clone)
	TEST (fields2cover_types_point, closestPointInSegment)
	TEST (fields2cover_types_point, intersectionOfLines)
	TEST (fields2cover_types_point, minus)
	TEST (fields2cover_types_point, minus_v)
	TEST (fields2cover_types_point, mult_equal)
	TEST (fields2cover_types_point, multiply)
	TEST (fields2cover_types_point, plus)
	TEST (fields2cover_types_point, plus_v)
	TEST (fields2cover_types_point, print)
	TEST (fields2cover_types_point, rotateFromPoint)
	TEST (fields2cover_types_point, set)
	TEST (fields2cover_types_point, signedDistance2Segment)

Detailed Description

Main namespace of the fields2cover library.

Enumeration Type Documentation

DecompAlg

enum f2c::DecompAlg

strong

Enumerator
NONE

Definition at line 130 of file fields2cover.h.

HGAlg

enum f2c::HGAlg

strong

Enumerator
NONE
CONST

Definition at line 121 of file fields2cover.h.

PPAlg

enum f2c::PPAlg

strong

Enumerator
DUBINS
DUBINS_CC
REEDS_SHEPP
REEDS_SHEPP_HC

Definition at line 110 of file fields2cover.h.

RPAlg

enum f2c::RPAlg

strong

Enumerator
SHORTEST_ROUTE

Definition at line 99 of file fields2cover.h.

SGAlg

enum f2c::SGAlg

strong

Enumerator
BRUTE_FORCE
GIVEN_ANGLE

Definition at line 83 of file fields2cover.h.

SGObjFunc

enum f2c::SGObjFunc

strong

Enumerator
N_SWATH_MOD
N_SWATH
SWATH_LENGTH
FIELD_COV
OVERLAPS

Definition at line 88 of file fields2cover.h.

Function Documentation

getCellFromJson()

F2CCell f2c::getCellFromJson

(

const json &

imported_cell

)

Definition at line 90 of file parser.cpp.

getPointFromJson()

F2CPoint f2c::getPointFromJson

(

const json &

ps

)

Definition at line 81 of file parser.cpp.

getPPTurningBasePtr()

std::unique_ptr<f2c::pp::TurningBase> f2c::getPPTurningBasePtr

(

const Options &

opt

)

Definition at line 58 of file fields2cover.cpp.

getSGObjPtr()

std::unique_ptr<obj::SGObjective> f2c::getSGObjPtr

(

const Options &

opt

)

Definition at line 36 of file fields2cover.cpp.

planCovPath() [1/4]

F2CPath f2c::planCovPath	(	const F2CRobot &	robot,
		const F2CCell &	cell,
		const Options &	opt = Options()
	)

Definition at line 136 of file fields2cover.cpp.

planCovPath() [2/4]

F2CPath f2c::planCovPath	(	const F2CRobot &	robot,
		const F2CCells &	cells,
		const Options &	opt = Options()
	)

Definition at line 142 of file fields2cover.cpp.

planCovPath() [3/4]

F2CPath f2c::planCovPath	(	const F2CRobot &	robot,
		const F2CField &	field,
		bool	local_crs
	)

Definition at line 148 of file fields2cover.cpp.

planCovPath() [4/4]

F2CPath f2c::planCovPath	(	const F2CRobot &	robot,
		const F2CField &	field,
		const Options &	opt = Options(),
		bool	local_crs = true
	)

Definition at line 154 of file fields2cover.cpp.

planCovRoute() [1/4]

F2CRoute f2c::planCovRoute	(	const F2CRobot &	robot,
		const F2CCell &	cell,
		const Options &	opt = Options()
	)

Definition at line 81 of file fields2cover.cpp.

planCovRoute() [2/4]

F2CRoute f2c::planCovRoute	(	const F2CRobot &	robot,
		const F2CCells &	cells,
		const Options &	opt = Options()
	)

Definition at line 86 of file fields2cover.cpp.

planCovRoute() [3/4]

F2CRoute f2c::planCovRoute	(	const F2CRobot &	robot,
		const F2CField &	field,
		bool	local_crs
	)

Definition at line 121 of file fields2cover.cpp.

planCovRoute() [4/4]

F2CRoute f2c::planCovRoute	(	const F2CRobot &	robot,
		const F2CField &	field,
		const Options &	opt = Options(),
		bool	local_crs = true
	)

Definition at line 126 of file fields2cover.cpp.

TEST() [1/13]

f2c::TEST	(	fields2cover_types_point	,
		clone
	)

Definition at line 127 of file Point_test.cpp.

TEST() [2/13]

f2c::TEST	(	fields2cover_types_point	,
		closestPointInSegment
	)

Definition at line 296 of file Point_test.cpp.

TEST() [3/13]

f2c::TEST	(	fields2cover_types_point	,
		intersectionOfLines
	)

Definition at line 281 of file Point_test.cpp.

TEST() [4/13]

f2c::TEST	(	fields2cover_types_point	,
		minus
	)

Definition at line 13 of file Point_test.cpp.

TEST() [5/13]

f2c::TEST	(	fields2cover_types_point	,
		minus_v
	)

Definition at line 99 of file Point_test.cpp.

TEST() [6/13]

f2c::TEST	(	fields2cover_types_point	,
		mult_equal
	)

Definition at line 64 of file Point_test.cpp.

TEST() [7/13]

f2c::TEST	(	fields2cover_types_point	,
		multiply
	)

Definition at line 72 of file Point_test.cpp.

TEST() [8/13]

f2c::TEST	(	fields2cover_types_point	,
		plus
	)

Definition at line 44 of file Point_test.cpp.

TEST() [9/13]

f2c::TEST	(	fields2cover_types_point	,
		plus_v
	)

Definition at line 83 of file Point_test.cpp.

TEST() [10/13]

f2c::TEST	(	fields2cover_types_point	,
		print
	)

Definition at line 145 of file Point_test.cpp.

TEST() [11/13]

f2c::TEST	(	fields2cover_types_point	,
		rotateFromPoint
	)

Definition at line 156 of file Point_test.cpp.

TEST() [12/13]

f2c::TEST	(	fields2cover_types_point	,
		set
	)

Definition at line 134 of file Point_test.cpp.

TEST() [13/13]

f2c::TEST	(	fields2cover_types_point	,
		signedDistance2Segment
	)

Definition at line 263 of file Point_test.cpp.