WPILibC++  unspecified
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Pages
Trigger Class Referenceabstract

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

#include <Trigger.h>

Inheritance diagram for Trigger:
Sendable Button InternalButton JoystickButton NetworkButton

Public Member Functions

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 (std::shared_ptr< ITable > table)
 Initializes a table for this sendable object. More...
 
virtual std::shared_ptr< ITableGetTable () const
 
virtual std::string GetSmartDashboardType () const
 

Protected Attributes

std::shared_ptr< ITablem_table
 

Detailed Description

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

It is very easy to link a polled input to a command. For instance, you could link the trigger button of a joystick to a "score" command or an encoder reaching a particular value.

It is encouraged that teams write a subclass of Trigger if they want to have something unusual (for instance, if they want to react to the user holding a button while the robot is reading a certain sensor input). For this, they only have to write the Trigger#Get() method to get the full functionality of the Trigger class.

Author
Brad Miller, Joe Grinstead

Member Function Documentation

std::string Trigger::GetSmartDashboardType ( ) const
virtual
Returns
the string representation of the named data type that will be used by the smart dashboard for this sendable

Implements Sendable.

std::shared_ptr< ITable > Trigger::GetTable ( ) const
virtual
Returns
the table that is currently associated with the sendable

Implements Sendable.

void Trigger::InitTable ( std::shared_ptr< ITable subtable)
virtual

Initializes a table for this sendable object.

Parameters
subtableThe table to put the values in.

Implements Sendable.


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