wpi::cmd::SequentialCommandGroup Class Reference

A command composition that runs a list of commands in sequence. More...

#include <wpi/commands2/SequentialCommandGroup.hpp>

Inheritance diagram for wpi::cmd::SequentialCommandGroup:

Public Member Functions
	SequentialCommandGroup (std::vector< std::unique_ptr< Command > > &&commands)
	Creates a new SequentialCommandGroup.
template<wpi::util::DecayedDerivedFrom< Command >... Commands>
	SequentialCommandGroup (Commands &&... commands)
	Creates a new SequentialCommandGroup.
	SequentialCommandGroup (SequentialCommandGroup &&other)=default
	SequentialCommandGroup (const SequentialCommandGroup &)=delete
	SequentialCommandGroup (SequentialCommandGroup &)=delete
template<wpi::util::DecayedDerivedFrom< Command >... Commands>
void	AddCommands (Commands &&... commands)
	Adds the given commands to the group.
void	Initialize () final
void	Execute () final
void	End (bool interrupted) final
bool	IsFinished () final
bool	RunsWhenDisabled () const override
Command::InterruptionBehavior	GetInterruptionBehavior () const override
void	InitSendable (wpi::util::SendableBuilder &builder) override
Public Member Functions inherited from wpi::cmd::CommandHelper< Command, SequentialCommandGroup >
	CommandHelper ()=default
CommandPtr	ToPtr () &&override

Detailed Description

A command composition that runs a list of commands in sequence.

The rules for command compositions apply: command instances that are passed to it are owned by the composition and cannot be added to any other composition or scheduled individually, and the composition requires all subsystems its components require.

This class is provided by the NewCommands VendorDep

Constructor & Destructor Documentation

SequentialCommandGroup() [1/5]

wpi::cmd::SequentialCommandGroup::SequentialCommandGroup ( std::vector< std::unique_ptr< Command > > && commands )

explicit

Creates a new SequentialCommandGroup.

The given commands will be run sequentially, with the composition finishing when the last command finishes.

Parameters

commands

the commands to include in this composition.

SequentialCommandGroup() [2/5]

template<wpi::util::DecayedDerivedFrom< Command >... Commands>

wpi::cmd::SequentialCommandGroup::SequentialCommandGroup ( Commands &&... commands )

inlineexplicit

Creates a new SequentialCommandGroup.

The given commands will be run sequentially, with the composition finishing when the last command finishes.

Parameters

commands

the commands to include in this composition.

SequentialCommandGroup() [3/5]

wpi::cmd::SequentialCommandGroup::SequentialCommandGroup ( SequentialCommandGroup && other )

default

SequentialCommandGroup() [4/5]

wpi::cmd::SequentialCommandGroup::SequentialCommandGroup ( const SequentialCommandGroup & )

delete

SequentialCommandGroup() [5/5]

wpi::cmd::SequentialCommandGroup::SequentialCommandGroup ( SequentialCommandGroup & )

delete

Member Function Documentation

AddCommands()

template<wpi::util::DecayedDerivedFrom< Command >... Commands>

void wpi::cmd::SequentialCommandGroup::AddCommands ( Commands &&... commands )

inline

Adds the given commands to the group.

Parameters

commands

Commands to add, in order of execution.

End()

void wpi::cmd::SequentialCommandGroup::End ( bool interrupted )

final

Execute()

void wpi::cmd::SequentialCommandGroup::Execute ( )

final

GetInterruptionBehavior()

Command::InterruptionBehavior wpi::cmd::SequentialCommandGroup::GetInterruptionBehavior ( ) const

override

Initialize()

void wpi::cmd::SequentialCommandGroup::Initialize ( )

final

InitSendable()

void wpi::cmd::SequentialCommandGroup::InitSendable ( wpi::util::SendableBuilder & builder )

override

IsFinished()

bool wpi::cmd::SequentialCommandGroup::IsFinished ( )

final

RunsWhenDisabled()

bool wpi::cmd::SequentialCommandGroup::RunsWhenDisabled ( ) const

override

---

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

• wpi/commands2/SequentialCommandGroup.hpp