|
WPILibC++
2020.3.2
|
A base for subsystems that handles registration in the constructor, and provides a more intuitive method for setting the default command. More...
#include <SubsystemBase.h>
Public Member Functions | |
| void | InitSendable (frc::SendableBuilder &builder) override |
| Initializes this Sendable object. More... | |
| std::string | GetName () const |
| Gets the name of this Subsystem. More... | |
| void | SetName (const wpi::Twine &name) |
| Sets the name of this Subsystem. More... | |
| std::string | GetSubsystem () const |
| Gets the subsystem name of this Subsystem. More... | |
| void | SetSubsystem (const wpi::Twine &name) |
| Sets the subsystem name of this Subsystem. More... | |
| void | AddChild (std::string name, frc::Sendable *child) |
| Associate a Sendable with this Subsystem. More... | |
Public Member Functions inherited from frc2::Subsystem | |
| virtual void | Periodic () |
| This method is called periodically by the CommandScheduler. More... | |
| template<class T , typename = std::enable_if_t<std::is_base_of_v< Command, std::remove_reference_t<T>>>> | |
| void | SetDefaultCommand (T &&defaultCommand) |
| Sets the default Command of the subsystem. More... | |
| Command * | GetDefaultCommand () const |
| Gets the default command for this subsystem. More... | |
| Command * | GetCurrentCommand () const |
| Returns the command currently running on this subsystem. More... | |
| void | Register () |
| Registers this subsystem with the CommandScheduler, allowing its Periodic() method to be called when the scheduler runs. | |
Public Member Functions inherited from frc::SendableHelper< SubsystemBase > | |
| 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 | |
Protected Member Functions inherited from frc::SendableHelper< SubsystemBase > | |
| 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... | |
A base for subsystems that handles registration in the constructor, and provides a more intuitive method for setting the default command.
| void frc2::SubsystemBase::AddChild | ( | std::string | name, |
| frc::Sendable * | child | ||
| ) |
Associate a Sendable with this Subsystem.
Also update the child's name.
| name | name to give child |
| child | sendable |
| std::string frc2::SubsystemBase::GetName | ( | ) | const |
Gets the name of this Subsystem.
| std::string frc2::SubsystemBase::GetSubsystem | ( | ) | const |
|
overridevirtual |
| void frc2::SubsystemBase::SetName | ( | const wpi::Twine & | name | ) |
Sets the name of this Subsystem.
| name | name |
| void frc2::SubsystemBase::SetSubsystem | ( | const wpi::Twine & | name | ) |
Sets the subsystem name of this Subsystem.
| subsystem | subsystem name |