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

Class for reading analog potentiometers. More...

#include <AnalogPotentiometer.h>

Inheritance diagram for frc::AnalogPotentiometer:
frc::ErrorBase frc::SendableBase frc::Potentiometer frc::Sendable frc::PIDSource

Public Member Functions

 AnalogPotentiometer (int channel, double fullRange=1.0, double offset=0.0)
 Construct an Analog Potentiometer object from a channel number. More...
 
 AnalogPotentiometer (AnalogInput *input, double fullRange=1.0, double offset=0.0)
 Construct an Analog Potentiometer object from an existing Analog Input pointer. More...
 
 AnalogPotentiometer (std::shared_ptr< AnalogInput > input, double fullRange=1.0, double offset=0.0)
 Construct an Analog Potentiometer object from an existing Analog Input pointer. More...
 
 AnalogPotentiometer (AnalogPotentiometer &&)=default
 
AnalogPotentiometeroperator= (AnalogPotentiometer &&)=default
 
double Get () const override
 Get the current reading of the potentiomer. More...
 
double PIDGet () override
 Implement the PIDSource interface. More...
 
void InitSendable (SendableBuilder &builder) override
 Initializes this Sendable object. More...
 
- Public Member Functions inherited from frc::ErrorBase
 ErrorBase (ErrorBase &&)=default
 
ErrorBaseoperator= (ErrorBase &&)=default
 
virtual ErrorGetError ()
 Retrieve the current error. More...
 
virtual const ErrorGetError () const
 Retrieve the current error. More...
 
virtual void ClearError () const
 Clear the current error information associated with this sensor.
 
virtual void SetErrnoError (const wpi::Twine &contextMessage, wpi::StringRef filename, wpi::StringRef function, int lineNumber) const
 Set error information associated with a C library call that set an error to the "errno" global variable. More...
 
virtual void SetImaqError (int success, const wpi::Twine &contextMessage, wpi::StringRef filename, wpi::StringRef function, int lineNumber) const
 Set the current error information associated from the nivision Imaq API. More...
 
virtual void SetError (Error::Code code, const wpi::Twine &contextMessage, wpi::StringRef filename, wpi::StringRef function, int lineNumber) const
 Set the current error information associated with this sensor. More...
 
virtual void SetErrorRange (Error::Code code, int32_t minRange, int32_t maxRange, int32_t requestedValue, const wpi::Twine &contextMessage, wpi::StringRef filename, wpi::StringRef function, int lineNumber) const
 Set the current error information associated with this sensor. More...
 
virtual void SetWPIError (const wpi::Twine &errorMessage, Error::Code code, const wpi::Twine &contextMessage, wpi::StringRef filename, wpi::StringRef function, int lineNumber) const
 Set the current error information associated with this sensor. More...
 
virtual void CloneError (const ErrorBase &rhs) const
 
virtual bool StatusIsFatal () const
 Check if the current error code represents a fatal error. More...
 
- Public Member Functions inherited from frc::SendableBase
 SendableBase (bool addLiveWindow=true)
 Creates an instance of the sensor base. More...
 
 SendableBase (SendableBase &&rhs)
 
SendableBaseoperator= (SendableBase &&rhs)
 
std::string GetName () const final
 Gets the name of this Sendable object. More...
 
void SetName (const wpi::Twine &name) final
 Sets the name of this Sendable object. More...
 
std::string GetSubsystem () const final
 Gets the subsystem name of this Sendable object. More...
 
void SetSubsystem (const wpi::Twine &subsystem) final
 Sets the subsystem name of this Sendable object. More...
 
- Public Member Functions inherited from frc::Sendable
 Sendable (Sendable &&)=default
 
Sendableoperator= (Sendable &&)=default
 
void SetName (const wpi::Twine &subsystem, const wpi::Twine &name)
 Sets both the subsystem name and device name of this Sendable object. More...
 
- Public Member Functions inherited from frc::Potentiometer
 Potentiometer (Potentiometer &&)=default
 
Potentiometeroperator= (Potentiometer &&)=default
 
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
 

Additional Inherited Members

- Static Public Member Functions inherited from frc::ErrorBase
static void SetGlobalError (Error::Code code, const wpi::Twine &contextMessage, wpi::StringRef filename, wpi::StringRef function, int lineNumber)
 
static void SetGlobalWPIError (const wpi::Twine &errorMessage, const wpi::Twine &contextMessage, wpi::StringRef filename, wpi::StringRef function, int lineNumber)
 
static const ErrorGetGlobalError ()
 Retrieve the current global error.
 
- Protected Member Functions inherited from frc::SendableBase
void AddChild (std::shared_ptr< Sendable > child)
 Add a child component. More...
 
void AddChild (void *child)
 Add a child component. More...
 
void SetName (const wpi::Twine &moduleType, int channel)
 Sets the name of the sensor with a channel number. More...
 
void SetName (const wpi::Twine &moduleType, int moduleNumber, int channel)
 Sets the name of the sensor with a module and channel number. More...
 
- Protected Attributes inherited from frc::ErrorBase
Error m_error
 
- Protected Attributes inherited from frc::PIDSource
PIDSourceType m_pidSource = PIDSourceType::kDisplacement
 

Detailed Description

Class for reading analog potentiometers.

Analog potentiometers read in an analog voltage that corresponds to a position. The position is in whichever units you choose, by way of the scaling and offset constants passed to the constructor.

Constructor & Destructor Documentation

frc::AnalogPotentiometer::AnalogPotentiometer ( int  channel,
double  fullRange = 1.0,
double  offset = 0.0 
)
explicit

Construct an Analog Potentiometer object from a channel number.

Use the fullRange and offset values so that the output produces meaningful values. I.E: you have a 270 degree potentiometer and you want the output to be degrees with the halfway point as 0 degrees. The fullRange value is 270.0 degrees and the offset is -135.0 since the halfway point after scaling is 135 degrees.

This will calculate the result from the fullRange times the fraction of the supply voltage, plus the offset.

Parameters
channelThe channel number on the roboRIO to represent. 0-3 are on-board 4-7 are on the MXP port.
fullRangeThe angular value (in desired units) representing the full 0-5V range of the input.
offsetThe angular value (in desired units) representing the angular output at 0V.
frc::AnalogPotentiometer::AnalogPotentiometer ( AnalogInput input,
double  fullRange = 1.0,
double  offset = 0.0 
)
explicit

Construct an Analog Potentiometer object from an existing Analog Input pointer.

Use the fullRange and offset values so that the output produces meaningful values. I.E: you have a 270 degree potentiometer and you want the output to be degrees with the halfway point as 0 degrees. The fullRange value is 270.0 degrees and the offset is -135.0 since the halfway point after scaling is 135 degrees.

This will calculate the result from the fullRange times the fraction of the supply voltage, plus the offset.

Parameters
channelThe existing Analog Input pointer
fullRangeThe angular value (in desired units) representing the full 0-5V range of the input.
offsetThe angular value (in desired units) representing the angular output at 0V.
frc::AnalogPotentiometer::AnalogPotentiometer ( std::shared_ptr< AnalogInput input,
double  fullRange = 1.0,
double  offset = 0.0 
)
explicit

Construct an Analog Potentiometer object from an existing Analog Input pointer.

Use the fullRange and offset values so that the output produces meaningful values. I.E: you have a 270 degree potentiometer and you want the output to be degrees with the halfway point as 0 degrees. The fullRange value is 270.0 degrees and the offset is -135.0 since the halfway point after scaling is 135 degrees.

This will calculate the result from the fullRange times the fraction of the supply voltage, plus the offset.

Parameters
channelThe existing Analog Input pointer
fullRangeThe angular value (in desired units) representing the full 0-5V range of the input.
offsetThe angular value (in desired units) representing the angular output at 0V.

Member Function Documentation

double frc::AnalogPotentiometer::Get ( ) const
overridevirtual

Get the current reading of the potentiomer.

Returns
The current position of the potentiometer (in the units used for fullRange and offset).

Implements frc::Potentiometer.

void frc::AnalogPotentiometer::InitSendable ( SendableBuilder builder)
overridevirtual

Initializes this Sendable object.

Parameters
buildersendable builder

Implements frc::Sendable.

double frc::AnalogPotentiometer::PIDGet ( )
overridevirtual

Implement the PIDSource interface.

Returns
The current reading.

Implements frc::PIDSource.


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