WPILibC++  2019.3.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
frc::Potentiometer Class Referenceabstract

Interface for potentiometers. More...

#include <Potentiometer.h>

Inheritance diagram for frc::Potentiometer:
frc::PIDSource frc::AnalogPotentiometer

Public Member Functions

 Potentiometer (Potentiometer &&)=default
 
Potentiometeroperator= (Potentiometer &&)=default
 
virtual double Get () const =0
 Common interface for getting the current value of a potentiometer. More...
 
void SetPIDSourceType (PIDSourceType pidSource) override
 Set which parameter you are using as a process control variable. More...
 
- Public Member Functions inherited from frc::PIDSource
virtual PIDSourceType GetPIDSourceType () const
 
virtual double PIDGet ()=0
 

Additional Inherited Members

- Protected Attributes inherited from frc::PIDSource
PIDSourceType m_pidSource = PIDSourceType::kDisplacement
 

Detailed Description

Interface for potentiometers.

Member Function Documentation

virtual double frc::Potentiometer::Get ( ) const
pure virtual

Common interface for getting the current value of a potentiometer.

Returns
The current set speed. Value is between -1.0 and 1.0.

Implemented in frc::AnalogPotentiometer.

void frc::Potentiometer::SetPIDSourceType ( PIDSourceType  pidSource)
overridevirtual

Set which parameter you are using as a process control variable.

Parameters
pidSourceAn enum to select the parameter.

Reimplemented from frc::PIDSource.


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