WPILibC++ 2024.3.2-63-g0f8aa8a
|
Schedules a given command when this command is initialized and ends when it ends, but does not directly run it. More...
#include <frc2/command/ProxyCommand.h>
Public Member Functions | |
ProxyCommand (wpi::unique_function< Command *()> supplier) | |
Creates a new ProxyCommand that schedules the supplied command when initialized, and ends when it is no longer scheduled. More... | |
ProxyCommand (wpi::unique_function< CommandPtr()> supplier) | |
Creates a new ProxyCommand that schedules the supplied command when initialized, and ends when it is no longer scheduled. More... | |
ProxyCommand (Command *command) | |
Creates a new ProxyCommand that schedules the given command when initialized, and ends when it is no longer scheduled. More... | |
ProxyCommand (std::unique_ptr< Command > command) | |
Creates a new ProxyCommand that schedules the given command when initialized, and ends when it is no longer scheduled. More... | |
ProxyCommand (ProxyCommand &&other)=default | |
void | Initialize () override |
void | End (bool interrupted) override |
bool | IsFinished () override |
void | InitSendable (wpi::SendableBuilder &builder) override |
Public Member Functions inherited from frc2::CommandHelper< Command, ProxyCommand > | |
CommandHelper ()=default | |
CommandPtr | ToPtr () &&override |
Additional Inherited Members | |
Protected Member Functions inherited from frc2::CommandHelper< Command, ProxyCommand > | |
std::unique_ptr< Command > | TransferOwnership () &&override |
Schedules a given command when this command is initialized and ends when it ends, but does not directly run it.
Use this for including a command in a composition without adding its requirements, but only if you know what you are doing. If you are unsure, see the WPILib docs for a complete explanation of proxy semantics. Do not proxy a command from a subsystem already required by the composition, or else the composition will cancel itself when the proxy is reached. If this command is interrupted, it will cancel the command.
This class is provided by the NewCommands VendorDep
|
explicit |
Creates a new ProxyCommand that schedules the supplied command when initialized, and ends when it is no longer scheduled.
Use this for lazily creating proxied commands at runtime. Proxying should only be done to escape from composition requirement semantics, so if only initialization time command construction is needed, use DeferredCommand
instead.
supplier | the command supplier |
|
explicit |
Creates a new ProxyCommand that schedules the supplied command when initialized, and ends when it is no longer scheduled.
Use this for lazily creating proxied commands at runtime. Proxying should only be done to escape from composition requirement semantics, so if only initialization time command construction is needed, use DeferredCommand
instead.
supplier | the command supplier |
|
explicit |
Creates a new ProxyCommand that schedules the given command when initialized, and ends when it is no longer scheduled.
command | the command to run by proxy |
|
explicit |
Creates a new ProxyCommand that schedules the given command when initialized, and ends when it is no longer scheduled.
Note that this constructor passes ownership of the given command to the returned ProxyCommand.
command | the command to schedule |
|
default |
|
override |
|
override |
|
override |
|
override |