WPILibC++  trunk
Public Member Functions | List of all members
Button Class Reference

#include <Button.h>

Inheritance diagram for Button:
Inheritance graph
[legend]
Collaboration diagram for Button:
Collaboration graph
[legend]

Public Member Functions

virtual void WhenPressed (Command *command)
 
virtual void WhileHeld (Command *command)
 
virtual void WhenReleased (Command *command)
 
virtual void CancelWhenPressed (Command *command)
 
virtual void ToggleWhenPressed (Command *command)
 
- Public Member Functions inherited from Trigger
bool Grab ()
 
virtual bool Get ()=0
 
void WhenActive (Command *command)
 
void WhileActive (Command *command)
 
void WhenInactive (Command *command)
 
void CancelWhenActive (Command *command)
 
void ToggleWhenActive (Command *command)
 
virtual void InitTable (ITable *table)
 
virtual ITableGetTable ()
 
virtual std::string GetSmartDashboardType ()
 

Additional Inherited Members

- Protected Attributes inherited from Trigger
ITablem_table
 

Detailed Description

This class provides an easy way to link commands to OI inputs.

It is very easy to link a button to a command. For instance, you could link the trigger button of a joystick to a "score" command.

This class represents a subclass of Trigger that is specifically aimed at buttons on an operator interface as a common use case of the more generalized Trigger objects. This is a simple wrapper around Trigger with the method names renamed to fit the Button object use.

Author
brad

Definition at line 26 of file Button.h.

Member Function Documentation

void Button::CancelWhenPressed ( Command command)
virtual

Cancels the specificed command when the button is pressed

Parameters
Thecommand to be canceled

Definition at line 40 of file Button.cpp.

void Button::ToggleWhenPressed ( Command command)
virtual

Toggle the specified command when the button is pressed

Parameters
Thecommand to be toggled

Definition at line 48 of file Button.cpp.

void Button::WhenPressed ( Command command)
virtual

Specifies the command to run when a button is first pressed

Parameters
commandThe pointer to the command to run

Definition at line 13 of file Button.cpp.

void Button::WhenReleased ( Command command)
virtual

Specifies the command to run when the button is released The command will be scheduled a single time.

Parameters
Thepointer to the command to run

Definition at line 32 of file Button.cpp.

void Button::WhileHeld ( Command command)
virtual

Specifies the command to be scheduled while the button is pressed The command will be scheduled repeatedly while the button is pressed and will be canceled when the button is released.

Parameters
commandThe pointer to the command to run

Definition at line 23 of file Button.cpp.


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