rmb::TalonFXVelocityController Class Reference

Inheritance diagram for rmb::TalonFXVelocityController:

Classes
struct	CreateInfo

Public Member Functions
	TalonFXVelocityController (const CreateInfo &createInfo)
void	setVelocity (units::radians_per_second_t velocity) override
units::radians_per_second_t	getTargetVelocity () const override
virtual void	setPower (double power) override
virtual double	getPower () const override
virtual void	disable () override
virtual void	stop () override
units::radians_per_second_t	getVelocity () const override
units::radian_t	getPosition () const override
void	setEncoderPosition (units::radian_t position=0_rad) override
virtual units::radians_per_second_t	getTolerance () const override
void	follow (const TalonFXVelocityController &parentController, bool inverted)
Public Member Functions inherited from rmb::AngularVelocityController
virtual units::radians_per_second_t	getError () const
virtual bool	atTarget () const

Additional Inherited Members
Public Types inherited from rmb::AngularVelocityController
using	ConversionUnit
using	ConversionUnit_t = units::unit_t<ConversionUnit>

Member Function Documentation

disable()

virtual void rmb::TalonFXVelocityController::disable ( )

overridevirtual

Common interface for disabling a mechanism.

Implements rmb::AngularVelocityController.

follow()

void rmb::TalonFXVelocityController::follow	(	const TalonFXVelocityController &	parentController,
		bool	inverted )

Match duty cycle of the given controller

Parameters

inverted

Use the inverted form of the parent's duty cycle

getPosition()

units::radian_t rmb::TalonFXVelocityController::getPosition ( ) const

overridevirtual

Gets the angular position of an motor.

Returns

The position of the motor in radians.

Implements rmb::AngularVelocityController.

getPower()

virtual double rmb::TalonFXVelocityController::getPower ( ) const

overridevirtual

Retrieve the percentage [-1.0, 1.0] output of the motor

Implements rmb::AngularVelocityController.

getTargetVelocity()

units::radians_per_second_t rmb::TalonFXVelocityController::getTargetVelocity ( ) const

overridevirtual

Gets the target angular velocity.

Returns

The target angular velocity in radians per second.

Implements rmb::AngularVelocityController.

getTolerance()

virtual units::radians_per_second_t rmb::TalonFXVelocityController::getTolerance ( ) const

inlineoverridevirtual

Gets the motor's tolerance.

Returns

the motor's tolerance in radians per second.

Implements rmb::AngularVelocityController.

getVelocity()

units::radians_per_second_t rmb::TalonFXVelocityController::getVelocity ( ) const

overridevirtual

Gets the angular velocity of the motor.

Returns

The velocity of the motor in radians per second.

Implements rmb::AngularVelocityController.

setEncoderPosition()

void rmb::TalonFXVelocityController::setEncoderPosition ( units::radian_t position = 0_rad )

overridevirtual

Sets the encoder's reported position

Parameters

position

The position to reset the reference to. Defaults to 0

Implements rmb::AngularVelocityController.

setPower()

virtual void rmb::TalonFXVelocityController::setPower ( double power )

overridevirtual

Common interface for setting a mechanism's raw power output.

Implements rmb::AngularVelocityController.

setVelocity()

void rmb::TalonFXVelocityController::setVelocity ( units::radians_per_second_t velocity )

overridevirtual

Sets the target angular velocity.

Parameters

velocity

The target angular velocity in radians per second.

Implements rmb::AngularVelocityController.

stop()

virtual void rmb::TalonFXVelocityController::stop ( )

overridevirtual

Common interface to stop the mechanism until setPosition is called again.

Implements rmb::AngularVelocityController.

---

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

• src/rmb/motorcontrol/Talon/TalonFXVelocityController.h