WPILibC++ 2023.4.3-108-ge5452e3
frc2::ProxyCommand Class Reference

Schedules the given command when this command is initialized, and ends when it ends. More...

#include <frc2/command/ProxyCommand.h>

Inheritance diagram for frc2::ProxyCommand:
frc2::CommandHelper< CommandBase, ProxyCommand >

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 (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
 
void Execute () override
 
bool IsFinished () override
 
void InitSendable (wpi::SendableBuilder &builder) override
 
- Public Member Functions inherited from frc2::CommandHelper< CommandBase, ProxyCommand >
 CommandHelper ()=default
 
CommandPtr ToPtr () &&override
 

Additional Inherited Members

- Protected Member Functions inherited from frc2::CommandHelper< CommandBase, ProxyCommand >
std::unique_ptr< CommandTransferOwnership () &&override
 

Detailed Description

Schedules the given command when this command is initialized, and ends when it ends.

Useful for forking off from CommandGroups. If this command is interrupted, it will cancel the command.

This class is provided by the NewCommands VendorDep

Constructor & Destructor Documentation

◆ ProxyCommand() [1/4]

frc2::ProxyCommand::ProxyCommand ( wpi::unique_function< Command *()>  supplier)
explicit

Creates a new ProxyCommand that schedules the supplied command when initialized, and ends when it is no longer scheduled.

Useful for lazily creating commands at runtime.

Parameters
supplierthe command supplier

◆ ProxyCommand() [2/4]

frc2::ProxyCommand::ProxyCommand ( Command command)
explicit

Creates a new ProxyCommand that schedules the given command when initialized, and ends when it is no longer scheduled.

Parameters
commandthe command to run by proxy

◆ ProxyCommand() [3/4]

frc2::ProxyCommand::ProxyCommand ( std::unique_ptr< Command command)
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.

Parameters
commandthe command to schedule

◆ ProxyCommand() [4/4]

frc2::ProxyCommand::ProxyCommand ( ProxyCommand &&  other)
default

Member Function Documentation

◆ End()

void frc2::ProxyCommand::End ( bool  interrupted)
override

◆ Execute()

void frc2::ProxyCommand::Execute ( )
override

◆ Initialize()

void frc2::ProxyCommand::Initialize ( )
override

◆ InitSendable()

void frc2::ProxyCommand::InitSendable ( wpi::SendableBuilder builder)
override

◆ IsFinished()

bool frc2::ProxyCommand::IsFinished ( )
override

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