LRT13  1.0
 All Classes Namespaces Functions Variables Enumerations Enumerator
Public Member Functions | List of all members
Component Class Referenceabstract

Generic abstract class for components. More...

#include <Component.h>

Inheritance diagram for Component:
Climber Collector ComponentSystemUnitTest Drivetrain RoutineRecorder Shooter

Public Member Functions

 Component (std::string name, int dio, bool requiresEnabledState)
 Constructs a component with a name.
 
virtual ~Component ()
 Frees the resources allocated by the component.
 
virtual void enabledPeriodic ()=0
 Allows the component to update itself when enabled.
 
virtual void disabledPeriodic ()=0
 Allows the component to execute code when disabled.
 
virtual void onEnable ()=0
 Event handler for when the component is enabled.
 
virtual void onDisable ()=0
 Event handler for when the component is disabled.
 
void Enable ()
 Enables the component.
 
void Disable ()
 Disables the component.
 
bool IsEnabled ()
 Returns whether or not the component is enabled.
 
bool EnableRequired ()
 Returns whether or not the component requires to be in an enabled state.
 
int GetDIO ()
 Gets the digital i/o channel for the component.
 
std::string GetName ()
 Gets the component's name.
 

Detailed Description

Generic abstract class for components.

Author
Tony Peng, Raphael Chang

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