art Namespace Reference

Classes
class	Angle
	A Utility Unit class for Angles. More...
class	Length
	A Utility Unit class for Length. More...
class	PID
	A general use PID class. More...
class	SimpleMotor
	A Simple Motor Wrapper Class. More...
class	SimpleMotorGroup
	A Simple Motor_Group Wrapper Class. More...
class	SmartDrive
	A Smarter Drive Class. More...
class	TankDrive
	A Simple TankDrive class. More...
struct	Vec2
	A Utility 2D Vector class. More...

Typedefs
typedef std::chrono::time_point< std::chrono::high_resolution_clock >	TimePoint
	A Point in time.

Functions
Length	Pixels (double pixels)
	Constructs a Length from Pixels.
Length	Inches (double inches)
	Constructs a Length from Inches.
Length	Feet (double feet)
	Constructs a Length from Feet.
Length	Meters (double meters)
	Constructs a Length from Meters.
Length	Centimeters (double centimeters)
	Constructs a Length from Centimeters.
Length	Millimeters (double millimeters)
	Constructs a Length from Millimeters.
Length	Tiles (double tiles)
	Constructs a Length from Tiles.
Angle	Degrees (double degrees)
	Constructs an Angle from Degrees.
Angle	Radians (double radians)
	Constructs an Angle from Radians.
Angle	Revolutions (double revolutions)
	Constructs an Angle from Revolutions.
Angle	shortestTurnPath (const Angle target)
	Returns the shortest turn path to reach the target angle.

Typedef Documentation

TimePoint

typedef std::chrono::time_point<std::chrono::high_resolution_clock> art::TimePoint

A Point in time.

A TimePoint is just an alias for std::chrono::time_point<std::chrono::high_resolution_clock>. TimePoint is just way easier to type and makes the code more readable

Definition at line 28 of file PID.h.

Function Documentation

Centimeters()

Length art::Centimeters

(

double

centimeters

)

Constructs a Length from Centimeters.

Parameters

centimeters

the length in Centimeters

Returns

Length - the constructed Length

Definition at line 99 of file Units.cpp.

Degrees()

Angle art::Degrees

(

double

degrees

)

Constructs an Angle from Degrees.

Parameters

degrees

the angle in Degrees

Returns

Angle - the constructed Angle

Definition at line 120 of file Units.cpp.

Feet()

Length art::Feet

(

double

feet

)

Constructs a Length from Feet.

Parameters

feet	the length in Feet

Returns

Length - the constructed Length

Definition at line 85 of file Units.cpp.

Inches()

Length art::Inches

(

double

inches

)

Constructs a Length from Inches.

Parameters

inches

the length in Inches

Returns

Length - the constructed Length

Definition at line 78 of file Units.cpp.

Meters()

Length art::Meters

(

double

meters

)

Constructs a Length from Meters.

Parameters

meters

the length in Meters

Returns

Length - the constructed Length

Definition at line 92 of file Units.cpp.

Millimeters()

Length art::Millimeters

(

double

millimeters

)

Constructs a Length from Millimeters.

Parameters

millimeters

the length in Millimeters

Returns

Length - the constructed Length

Definition at line 106 of file Units.cpp.

Pixels()

Length art::Pixels

(

double

pixels

)

Constructs a Length from Pixels.

Parameters

pixels

the length in Pixels

Returns

Length - the constructed Length

Definition at line 71 of file Units.cpp.

Radians()

Angle art::Radians

(

double

radians

)

Constructs an Angle from Radians.

Parameters

radians

the angle in Radians

Returns

Angle - the constructed Angle

Definition at line 127 of file Units.cpp.

Revolutions()

Angle art::Revolutions

(

double

revolutions

)

Constructs an Angle from Revolutions.

Parameters

revolutions

the angle in Revolutions

Returns

Angle - the constructed Angle

Definition at line 134 of file Units.cpp.

shortestTurnPath()

Angle art::shortestTurnPath

(

const Angle

target

)

Returns the shortest turn path to reach the target angle.

Parameters

target

- an Angle to reach

Returns

Angle - the shortest angle(with direction) to the target angle

Definition at line 188 of file Units.cpp.

Tiles()

Length art::Tiles

(

double

tiles

)

Constructs a Length from Tiles.

Parameters

tiles

the length in Tiles

Returns

Length - the constructed Length

Definition at line 113 of file Units.cpp.