WPILibC++  2019.3.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
frc::SpeedControllerGroup Class Reference
Inheritance diagram for frc::SpeedControllerGroup:
frc::SendableBase frc::SpeedController frc::Sendable frc::PIDOutput

Public Member Functions

template<class... SpeedControllers>
 SpeedControllerGroup (SpeedController &speedController, SpeedControllers &...speedControllers)
 
 SpeedControllerGroup (SpeedControllerGroup &&)=default
 
SpeedControllerGroupoperator= (SpeedControllerGroup &&)=default
 
void Set (double speed) override
 Common interface for setting the speed of a speed controller. More...
 
double Get () const override
 Common interface for getting the current set speed of a speed controller. More...
 
void SetInverted (bool isInverted) override
 Common interface for inverting direction of a speed controller. More...
 
bool GetInverted () const override
 Common interface for returning the inversion state of a speed controller. More...
 
void Disable () override
 Common interface for disabling a motor.
 
void StopMotor () override
 Common interface to stop the motor until Set is called again.
 
void PIDWrite (double output) override
 
void InitSendable (SendableBuilder &builder) override
 Initializes this Sendable object. 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...
 

Additional Inherited Members

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

Member Function Documentation

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

Common interface for getting the current set speed of a speed controller.

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

Implements frc::SpeedController.

bool frc::SpeedControllerGroup::GetInverted ( ) const
overridevirtual

Common interface for returning the inversion state of a speed controller.

Returns
isInverted The state of inversion, true is inverted.

Implements frc::SpeedController.

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

Initializes this Sendable object.

Parameters
buildersendable builder

Implements frc::Sendable.

void frc::SpeedControllerGroup::Set ( double  speed)
overridevirtual

Common interface for setting the speed of a speed controller.

Parameters
speedThe speed to set. Value should be between -1.0 and 1.0.

Implements frc::SpeedController.

void frc::SpeedControllerGroup::SetInverted ( bool  isInverted)
overridevirtual

Common interface for inverting direction of a speed controller.

Parameters
isInvertedThe state of inversion, true is inverted.

Implements frc::SpeedController.


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