rmb Namespace Reference

the master namespace of librmb More...

Namespaces
namespace	trajectory
	namespace for trajectory calculations

Classes
class	AHRSGyro
class	AngularFeedforwardontroller
class	AngularPositionController
class	AngularVelocityController
class	ArmFeedforward
class	BaseDrive
class	DifferentialDrive
class	ElevatorFeedforward
class	Feedforward
class	Gyro
class	LinearFeedforwardController
class	LinearPositionController
class	LinearVelocityController
class	LogitechGamepad
class	LogitechJoystick
class	ServoPositionController
class	SimpleFeedforward
class	SparkMaxPositionController
class	SparkMaxVelocityController
class	SwerveDrive
class	SwerveModule
struct	SwerveModulePower
class	TalonFXPositionController
class	TalonFXVelocityController

Functions
std::unique_ptr< LinearPositionController >	asLinear (std::unique_ptr< AngularPositionController > angularController, AngularPositionController::ConversionUnit_t conversion)
std::unique_ptr< LinearVelocityController >	asLinear (std::unique_ptr< AngularVelocityController > angularController, AngularVelocityController::ConversionUnit_t conversion)
std::unique_ptr< AngularPositionController >	asAngular (std::unique_ptr< LinearPositionController > linearController, LinearPositionController::ConversionUnit_t conversion)
std::unique_ptr< AngularVelocityController >	asAngular (std::unique_ptr< LinearVelocityController > linearController, LinearVelocityController::ConversionUnit_t conversion)

Detailed Description

the master namespace of librmb

This is where all of the librmb specific functions and classes are placed for your use

Function Documentation

asAngular() [1/2]

std::unique_ptr< AngularPositionController > rmb::asAngular	(	std::unique_ptr< LinearPositionController >	linearController,
		LinearPositionController::ConversionUnit_t	conversion )

Generates a AngularVelocityController from a LinearVelocityController via a proportional conversion factor. The new controller takes ownership over the old one.

Parameters

linearController	Controller in linear units form which to create an angular controller
conversion	Conversion factor from linear to angular units such as a wheel diameter.

asAngular() [2/2]

std::unique_ptr< AngularVelocityController > rmb::asAngular	(	std::unique_ptr< LinearVelocityController >	linearController,
		LinearVelocityController::ConversionUnit_t	conversion )

Generates a AngularVelocityController from a LinearVelocityController via a proportional conversion factor. The new controller takes ownership over the old one.

Parameters

linearController	Controller in linear units form which to create an angular controller
conversion	conversion factor from linear to angular units such as a wheel diameter.

asLinear() [1/2]

std::unique_ptr< LinearPositionController > rmb::asLinear	(	std::unique_ptr< AngularPositionController >	angularController,
		AngularPositionController::ConversionUnit_t	conversion )

Generates a linearVelocityController from a AngularVelocityController via a proportional conversion factor. The new controller takes ownership over the old one.

Parameters

angularController	Controller in angular units form which to create a linear controller
conversion	conversion factor from linear to angular units such as a wheel diameter.

asLinear() [2/2]

std::unique_ptr< LinearVelocityController > rmb::asLinear	(	std::unique_ptr< AngularVelocityController >	angularController,
		AngularVelocityController::ConversionUnit_t	conversion )

Generates a linearVelocityController from a AngularVelocityController via a proportional conversion factor. The new controller takes ownership over the old one.

Parameters

angularController	Controller in angular units form which to create a linear controller
conversion	conversion factor from linear to angular units such as a wheel diameter.