|
WPILibC++
2020.3.2
|
GyroBase is the common base class for Gyro implementations such as AnalogGyro. More...
#include <GyroBase.h>
Public Member Functions | |
| GyroBase (GyroBase &&)=default | |
| GyroBase & | operator= (GyroBase &&)=default |
| double | PIDGet () override |
| Get the PIDOutput for the PIDSource base object. More... | |
| void | InitSendable (SendableBuilder &builder) override |
| Initializes this Sendable object. More... | |
Public Member Functions inherited from frc::Gyro | |
| Gyro (Gyro &&)=default | |
| Gyro & | operator= (Gyro &&)=default |
| virtual void | Calibrate ()=0 |
| Calibrate the gyro by running for a number of samples and computing the center value. More... | |
| virtual void | Reset ()=0 |
| Reset the gyro. More... | |
| virtual double | GetAngle () const =0 |
| Return the actual angle in degrees that the robot is currently facing. More... | |
| virtual double | GetRate () const =0 |
| Return the rate of rotation of the gyro. More... | |
Public Member Functions inherited from frc::ErrorBase | |
| ErrorBase (const ErrorBase &)=default | |
| ErrorBase & | operator= (const ErrorBase &)=default |
| ErrorBase (ErrorBase &&)=default | |
| ErrorBase & | operator= (ErrorBase &&)=default |
| virtual Error & | GetError () |
| Retrieve the current error. More... | |
| virtual const Error & | GetError () 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... | |
| void | ClearGlobalErrors () |
| Clear global errors. | |
Public Member Functions inherited from frc::PIDSource | |
| virtual void | SetPIDSourceType (PIDSourceType pidSource) |
| Set which parameter you are using as a process control variable. More... | |
| virtual PIDSourceType | GetPIDSourceType () const |
Public Member Functions inherited from frc::SendableHelper< GyroBase > | |
| SendableHelper (const SendableHelper &rhs)=default | |
| SendableHelper (SendableHelper &&rhs) | |
| SendableHelper & | operator= (const SendableHelper &rhs)=default |
| SendableHelper & | operator= (SendableHelper &&rhs) |
| std::string | GetName () const |
| Gets the name of this Sendable object. More... | |
| void | SetName (const wpi::Twine &name) |
| Sets the name of this Sendable object. More... | |
| void | SetName (const wpi::Twine &subsystem, const wpi::Twine &name) |
| Sets both the subsystem name and device name of this Sendable object. More... | |
| std::string | GetSubsystem () const |
| Gets the subsystem name of this Sendable object. More... | |
| void | SetSubsystem (const wpi::Twine &subsystem) |
| Sets the subsystem name of this Sendable object. More... | |
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 Error | GetGlobalError () |
| Retrieve the last global error. | |
| static std::vector< Error > | GetGlobalErrors () |
| Retrieve all global errors. | |
Protected Member Functions inherited from frc::SendableHelper< GyroBase > | |
| 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... | |
| void | AddChild (std::shared_ptr< Sendable > child) |
| Add a child component. More... | |
| void | AddChild (void *child) |
| Add a child component. More... | |
Protected Attributes inherited from frc::ErrorBase | |
| Error | m_error |
Protected Attributes inherited from frc::PIDSource | |
| PIDSourceType | m_pidSource = PIDSourceType::kDisplacement |
GyroBase is the common base class for Gyro implementations such as AnalogGyro.
|
overridevirtual |
|
overridevirtual |
Get the PIDOutput for the PIDSource base object.
Can be set to return angle or rate using SetPIDSourceType(). Defaults to angle.
Implements frc::PIDSource.