frc2::POVButton Class Reference

A class used to bind command scheduling to joystick POV presses. More...

#include <frc2/command/button/POVButton.h>

Inheritance diagram for frc2::POVButton:

Public Member Functions
	POVButton (frc::GenericHID *joystick, frc::DriverStation::POVDirection angle, int povNumber=0)
	Creates a POVButton that commands can be bound to.
Public Member Functions inherited from frc2::Trigger
	Trigger (std::function< bool()> condition)
	Creates a new trigger based on the given condition.
	Trigger (frc::EventLoop *loop, std::function< bool()> condition)
	Creates a new trigger based on the given condition.
	Trigger ()
	Create a new trigger that is always false.
	Trigger (const Trigger &other)
Trigger	OnChange (Command *command)
	Starts the command when the condition changes.
Trigger	OnChange (CommandPtr &&command)
	Starts the command when the condition changes.
Trigger	OnTrue (Command *command)
	Starts the given command whenever the condition changes from false to true.
Trigger	OnTrue (CommandPtr &&command)
	Starts the given command whenever the condition changes from false to true.
Trigger	OnFalse (Command *command)
	Starts the given command whenever the condition changes from true to false.
Trigger	OnFalse (CommandPtr &&command)
	Starts the given command whenever the condition changes from true to false.
Trigger	WhileTrue (Command *command)
	Starts the given command when the condition changes to true and cancels it when the condition changes to false.
Trigger	WhileTrue (CommandPtr &&command)
	Starts the given command when the condition changes to true and cancels it when the condition changes to false.
Trigger	WhileFalse (Command *command)
	Starts the given command when the condition changes to false and cancels it when the condition changes to true.
Trigger	WhileFalse (CommandPtr &&command)
	Starts the given command when the condition changes to false and cancels it when the condition changes to true.
Trigger	ToggleOnTrue (Command *command)
	Toggles a command when the condition changes from false to true.
Trigger	ToggleOnTrue (CommandPtr &&command)
	Toggles a command when the condition changes from false to true.
Trigger	ToggleOnFalse (Command *command)
	Toggles a command when the condition changes from true to the low state.
Trigger	ToggleOnFalse (CommandPtr &&command)
	Toggles a command when the condition changes from true to false.
Trigger	operator&& (std::function< bool()> rhs)
	Composes two triggers with logical AND.
Trigger	operator&& (Trigger rhs)
	Composes two triggers with logical AND.
Trigger	operator|| (std::function< bool()> rhs)
	Composes two triggers with logical OR.
Trigger	operator|| (Trigger rhs)
	Composes two triggers with logical OR.
Trigger	operator! ()
	Composes a trigger with logical NOT.
Trigger	Debounce (units::second_t debounceTime, frc::Debouncer::DebounceType type=frc::Debouncer::DebounceType::kRising)
	Creates a new debounced trigger from this trigger - it will become active when this trigger has been active for longer than the specified period.
bool	Get () const
	Returns the current state of this trigger.

Detailed Description

A class used to bind command scheduling to joystick POV presses.

Can be composed with other buttons with the operators in Trigger.

This class is provided by the NewCommands VendorDep

See also

Trigger

Constructor & Destructor Documentation

POVButton()

frc2::POVButton::POVButton ( frc::GenericHID * joystick, frc::DriverStation::POVDirection angle, int povNumber = 0 )

inline

Creates a POVButton that commands can be bound to.

Parameters

joystick	The joystick on which the button is located.
angle	The angle of the POV corresponding to a button press.
povNumber	The number of the POV on the joystick.

---

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

• frc2/command/button/POVButton.h