subzero::IPidMotorController Class Reference

#include <IPidMotorController.h>

Inheritance diagram for subzero::IPidMotorController:

Collaboration diagram for subzero::IPidMotorController:

Public Member Functions
	IPidMotorController (std::string name)
virtual void	Set (double percentage)=0
virtual void	Set (units::volt_t volts)=0
virtual void	SetPidTolerance (double tolerance)=0
virtual void	Update (void)=0
virtual void	RunWithVelocity (units::revolutions_per_minute_t rpm)=0
virtual void	RunWithVelocity (double percentage)=0
virtual void	RunToPosition (double position)=0
virtual void	ResetEncoder (void)=0
virtual double	GetEncoderPosition (void)=0
virtual std::optional< double >	GetAbsoluteEncoderPosition (void)=0
virtual void	SetEncoderConversionFactor (double factor)=0
virtual void	SetAbsoluteEncoderConversionFactor (double factor)=0
virtual void	Stop (void)=0
virtual const PidSettings &	GetPidSettings (void)=0
virtual void	UpdatePidSettings (PidSettings settings)=0

Public Attributes
const std::string	m_name

Detailed Description

Definition at line 14 of file IPidMotorController.h.

Constructor & Destructor Documentation

IPidMotorController()

subzero::IPidMotorController::IPidMotorController ( std::string name )

inlineexplicit

Definition at line 16 of file IPidMotorController.h.

Member Function Documentation

GetAbsoluteEncoderPosition()

virtual std::optional< double > subzero::IPidMotorController::GetAbsoluteEncoderPosition ( void )

pure virtual

Implemented in subzero::PidMotorController< TMotor, TController, TRelativeEncoder, TAbsoluteEncoder >, subzero::PidMotorController< rev::CANSparkMax, rev::SparkPIDController, rev::SparkRelativeEncoder, rev::SparkAbsoluteEncoder >, and subzero::SimPidMotorController.

GetEncoderPosition()

virtual double subzero::IPidMotorController::GetEncoderPosition ( void )

pure virtual

Implemented in subzero::PidMotorController< TMotor, TController, TRelativeEncoder, TAbsoluteEncoder >, subzero::PidMotorController< rev::CANSparkMax, rev::SparkPIDController, rev::SparkRelativeEncoder, rev::SparkAbsoluteEncoder >, and subzero::SimPidMotorController.

GetPidSettings()

virtual const PidSettings & subzero::IPidMotorController::GetPidSettings ( void )

pure virtual

Implemented in subzero::PidMotorController< TMotor, TController, TRelativeEncoder, TAbsoluteEncoder >, subzero::PidMotorController< rev::CANSparkMax, rev::SparkPIDController, rev::SparkRelativeEncoder, rev::SparkAbsoluteEncoder >, and subzero::SimPidMotorController.

ResetEncoder()

virtual void subzero::IPidMotorController::ResetEncoder ( void )

pure virtual

Implemented in subzero::PidMotorController< TMotor, TController, TRelativeEncoder, TAbsoluteEncoder >, subzero::PidMotorController< rev::CANSparkMax, rev::SparkPIDController, rev::SparkRelativeEncoder, rev::SparkAbsoluteEncoder >, and subzero::SimPidMotorController.

RunToPosition()

virtual void subzero::IPidMotorController::RunToPosition ( double position )

pure virtual

Implemented in subzero::PidMotorController< TMotor, TController, TRelativeEncoder, TAbsoluteEncoder >, subzero::PidMotorController< rev::CANSparkMax, rev::SparkPIDController, rev::SparkRelativeEncoder, rev::SparkAbsoluteEncoder >, and subzero::SimPidMotorController.

RunWithVelocity() [1/2]

virtual void subzero::IPidMotorController::RunWithVelocity ( double percentage )

pure virtual

Implemented in subzero::PidMotorController< TMotor, TController, TRelativeEncoder, TAbsoluteEncoder >, subzero::PidMotorController< rev::CANSparkMax, rev::SparkPIDController, rev::SparkRelativeEncoder, rev::SparkAbsoluteEncoder >, and subzero::SimPidMotorController.

RunWithVelocity() [2/2]

virtual void subzero::IPidMotorController::RunWithVelocity ( units::revolutions_per_minute_t rpm )

pure virtual

Implemented in subzero::PidMotorController< TMotor, TController, TRelativeEncoder, TAbsoluteEncoder >, subzero::PidMotorController< rev::CANSparkMax, rev::SparkPIDController, rev::SparkRelativeEncoder, rev::SparkAbsoluteEncoder >, and subzero::SimPidMotorController.

Set() [1/2]

virtual void subzero::IPidMotorController::Set ( double percentage )

pure virtual

Implemented in subzero::PidMotorController< TMotor, TController, TRelativeEncoder, TAbsoluteEncoder >, subzero::PidMotorController< rev::CANSparkMax, rev::SparkPIDController, rev::SparkRelativeEncoder, rev::SparkAbsoluteEncoder >, and subzero::SimPidMotorController.

Set() [2/2]

virtual void subzero::IPidMotorController::Set ( units::volt_t volts )

pure virtual

Implemented in subzero::PidMotorController< TMotor, TController, TRelativeEncoder, TAbsoluteEncoder >, subzero::PidMotorController< rev::CANSparkMax, rev::SparkPIDController, rev::SparkRelativeEncoder, rev::SparkAbsoluteEncoder >, and subzero::SimPidMotorController.

SetAbsoluteEncoderConversionFactor()

virtual void subzero::IPidMotorController::SetAbsoluteEncoderConversionFactor ( double factor )

pure virtual

Implemented in subzero::PidMotorController< TMotor, TController, TRelativeEncoder, TAbsoluteEncoder >, subzero::PidMotorController< rev::CANSparkMax, rev::SparkPIDController, rev::SparkRelativeEncoder, rev::SparkAbsoluteEncoder >, and subzero::SimPidMotorController.

SetEncoderConversionFactor()

virtual void subzero::IPidMotorController::SetEncoderConversionFactor ( double factor )

pure virtual

Implemented in subzero::PidMotorController< TMotor, TController, TRelativeEncoder, TAbsoluteEncoder >, subzero::PidMotorController< rev::CANSparkMax, rev::SparkPIDController, rev::SparkRelativeEncoder, rev::SparkAbsoluteEncoder >, and subzero::SimPidMotorController.

SetPidTolerance()

virtual void subzero::IPidMotorController::SetPidTolerance ( double tolerance )

pure virtual

Implemented in subzero::PidMotorController< TMotor, TController, TRelativeEncoder, TAbsoluteEncoder >, subzero::PidMotorController< rev::CANSparkMax, rev::SparkPIDController, rev::SparkRelativeEncoder, rev::SparkAbsoluteEncoder >, and subzero::SimPidMotorController.

Stop()

virtual void subzero::IPidMotorController::Stop ( void )

pure virtual

Implemented in subzero::PidMotorController< TMotor, TController, TRelativeEncoder, TAbsoluteEncoder >, subzero::PidMotorController< rev::CANSparkMax, rev::SparkPIDController, rev::SparkRelativeEncoder, rev::SparkAbsoluteEncoder >, and subzero::SimPidMotorController.

Update()

virtual void subzero::IPidMotorController::Update ( void )

pure virtual

Implemented in subzero::PidMotorController< TMotor, TController, TRelativeEncoder, TAbsoluteEncoder >, subzero::PidMotorController< rev::CANSparkMax, rev::SparkPIDController, rev::SparkRelativeEncoder, rev::SparkAbsoluteEncoder >, and subzero::SimPidMotorController.

UpdatePidSettings()

virtual void subzero::IPidMotorController::UpdatePidSettings ( PidSettings settings )

pure virtual

Implemented in subzero::PidMotorController< TMotor, TController, TRelativeEncoder, TAbsoluteEncoder >, subzero::PidMotorController< rev::CANSparkMax, rev::SparkPIDController, rev::SparkRelativeEncoder, rev::SparkAbsoluteEncoder >, and subzero::SimPidMotorController.

Member Data Documentation

m_name

const std::string subzero::IPidMotorController::m_name

Definition at line 34 of file IPidMotorController.h.

---

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

• include/subzero/motor/IPidMotorController.h