WPILibC++  unspecified
frc::AnalogPotentiometer Class Reference

Class for reading analog potentiometers. More...

#include <AnalogPotentiometer.h>

Inheritance diagram for frc::AnalogPotentiometer:
Collaboration diagram for frc::AnalogPotentiometer:

Public Member Functions

 AnalogPotentiometer (int channel, double fullRange=1.0, double offset=0.0)
 AnalogPotentiometer constructor. 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...
 
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
 Live Window code, only does anything if live window is activated.
 
- Public Member Functions inherited from frc::SensorBase
 SensorBase (const SensorBase &)=delete
 
SensorBaseoperator= (const SensorBase &)=delete
 
- Public Member Functions inherited from frc::ErrorBase
 ErrorBase (const ErrorBase &)=delete
 
ErrorBaseoperator= (const ErrorBase &)=delete
 
virtual ErrorGetError ()
 Retrieve the current error. More...
 
virtual const ErrorGetError () const
 
virtual void SetErrnoError (const llvm::Twine &contextMessage, llvm::StringRef filename, llvm::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 llvm::Twine &contextMessage, llvm::StringRef filename, llvm::StringRef function, int lineNumber) const
 Set the current error information associated from the nivision Imaq API. More...
 
virtual void SetError (Error::Code code, const llvm::Twine &contextMessage, llvm::StringRef filename, llvm::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 llvm::Twine &contextMessage, llvm::StringRef filename, llvm::StringRef function, int lineNumber) const
 Set the current error information associated with this sensor. More...
 
virtual void SetWPIError (const llvm::Twine &errorMessage, Error::Code code, const llvm::Twine &contextMessage, llvm::StringRef filename, llvm::StringRef function, int lineNumber) const
 Set the current error information associated with this sensor. More...
 
virtual void CloneError (const ErrorBase &rhs) const
 
virtual void ClearError () const
 Clear the current error information associated with this sensor.
 
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 () override
 Free the resources used by this object.
 
std::string GetName () const final
 Gets the name of this Sendable object. More...
 
void SetName (const llvm::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 llvm::Twine &subsystem) final
 Sets the subsystem name of this Sendable object. More...
 
- Public Member Functions inherited from frc::Sendable
void SetName (const llvm::Twine &subsystem, const llvm::Twine &name)
 Sets both the subsystem name and device name of this Sendable object. More...
 
- Public Member Functions inherited from frc::Potentiometer
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::SensorBase
static int GetDefaultSolenoidModule ()
 
static bool CheckSolenoidModule (int moduleNumber)
 Check that the solenoid module number is valid. More...
 
static bool CheckDigitalChannel (int channel)
 Check that the digital channel number is valid. More...
 
static bool CheckRelayChannel (int channel)
 Check that the relay channel number is valid. More...
 
static bool CheckPWMChannel (int channel)
 Check that the digital channel number is valid. More...
 
static bool CheckAnalogInputChannel (int channel)
 Check that the analog input number is value. More...
 
static bool CheckAnalogOutputChannel (int channel)
 Check that the analog output number is valid. More...
 
static bool CheckSolenoidChannel (int channel)
 Verify that the solenoid channel number is within limits. More...
 
static bool CheckPDPChannel (int channel)
 Verify that the power distribution channel number is within limits. More...
 
- Static Public Member Functions inherited from frc::ErrorBase
static void SetGlobalError (Error::Code code, const llvm::Twine &contextMessage, llvm::StringRef filename, llvm::StringRef function, int lineNumber)
 
static void SetGlobalWPIError (const llvm::Twine &errorMessage, const llvm::Twine &contextMessage, llvm::StringRef filename, llvm::StringRef function, int lineNumber)
 
static ErrorGetGlobalError ()
 Retrieve the current global error.
 
- Static Public Attributes inherited from frc::SensorBase
static const int kDigitalChannels = HAL_GetNumDigitalChannels()
 
static const int kAnalogInputs = HAL_GetNumAnalogInputs()
 
static const int kAnalogOutputs
 
static const int kSolenoidChannels = HAL_GetNumSolenoidChannels()
 
static const int kSolenoidModules = HAL_GetNumPCMModules()
 
static const int kPwmChannels = HAL_GetNumPWMChannels()
 
static const int kRelayChannels = HAL_GetNumRelayHeaders()
 
static const int kPDPChannels = HAL_GetNumPDPChannels()
 
- 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 llvm::Twine &moduleType, int channel)
 Sets the name of the sensor with a channel number. More...
 
void SetName (const llvm::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
 
- Static Protected Attributes inherited from frc::ErrorBase
static wpi::mutex _globalErrorMutex
 
static Error _globalError
 

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

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

AnalogPotentiometer constructor.

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 analog channel this potentiometer is plugged into.
fullRangeThe scaling to multiply the voltage by to get a meaningful unit.
offsetThe offset to add to the scaled value for controlling the zero value.
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.
AnalogPotentiometer::AnalogPotentiometer ( AnalogInput input,
double  fullRange = 1.0,
double  offset = 0.0 
)
explicit

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

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.
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.

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 AnalogPotentiometer::Get ( ) const
overridevirtual

Get the current reading of the potentiomer.

Get the current reading of the potentiometer.

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

Implements frc::Potentiometer.

double AnalogPotentiometer::PIDGet ( )
overridevirtual

Implement the PIDSource interface.

Returns
The current reading.

Implements frc::PIDSource.


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