Files
allwpilib/wpilibc/shared/include/Commands/InstantCommand.h
Tyler Veness b25a7cb370 Command::IsFinished() must be overriden by subclasses again (#353)
Documentation was added for InstantCommand and TimedCommand.
2016-11-19 00:26:22 -08:00

33 lines
995 B
C++

/*----------------------------------------------------------------------------*/
/* Copyright (c) FIRST 2016. All Rights Reserved. */
/* Open Source Software - may be modified and shared by FRC teams. The code */
/* must be accompanied by the FIRST BSD license file in the root directory of */
/* the project. */
/*----------------------------------------------------------------------------*/
#pragma once
#include <string>
#include "Commands/Command.h"
namespace frc {
/**
* This command will execute once, then finish immediately afterward.
*
* <p>Subclassing {@link InstantCommand} is shorthand for returning true from
* {@link Command isFinished}.
*/
class InstantCommand : public Command {
public:
explicit InstantCommand(const std::string& name);
InstantCommand() = default;
virtual ~InstantCommand() = default;
protected:
bool IsFinished() override;
};
} // namespace frc