API Documentation v0.0.1
Loading...
Searching...
No Matches
FuelPanel Class Reference
+ Inheritance diagram for FuelPanel:

Static Public Member Functions

static FuelPanelgetInstance (int startIndex=0, CRGB *ledStrip=nullptr)
 Gets the singleton instance of the FuelPanel class.
 

Additional Inherited Members

- Public Member Functions inherited from Panel
virtual int getStartIndex () const
 Gets the start index of this panel on the LED strip.
 
virtual int getLedCount () const
 Gets the number of LEDs in this panel.
 
virtual const LedgetLedTable () const
 Gets the LED table for this panel.
 
virtual CRGB * getLedStrip () const
 Gets the LED strip for this panel.
 
- Protected Member Functions inherited from Panel
 Panel ()
 Protected constructor to prevent direct instantiation.
 
void setInstrLights (uint16_t newValue, const CRGB &color=NVIS_GREEN_A)
 Set the color of all instrument backlight LEDs.
 
void setConsoleLights (uint16_t newValue, const CRGB &color=NVIS_GREEN_A)
 Sets the color of all console backlight LEDs.
 
void setIndicatorColor (LedRole role, const CRGB &color)
 Sets the color of LEDs with a specific role.
 
void setFloodlights (uint16_t newValue)
 Sets the brightness of floodlight LEDs.
 
void setAllLightsOff ()
 Turns off all lights in this panel, irrespective of their role, and resets brightness state.
 
- Protected Attributes inherited from Panel
int panelStartIndex
 
int ledCount
 
const LedledTable
 
CRGB * ledStrip
 
uint16_t current_backl_brightness
 
uint16_t current_console_brightness
 
uint16_t current_flood_brightness
 
PanelnextPanel
 

Detailed Description

Definition at line 52 of file 4A5A1_FUEL_PANEL.h.

Member Function Documentation

◆ getInstance()

static FuelPanel * FuelPanel::getInstance ( int startIndex = 0,
CRGB * ledStrip = nullptr )
inlinestatic

Gets the singleton instance of the FuelPanel class.

Parameters
startIndexThe starting index for this panel's LEDs on the strip
ledStripPointer to the LED strip array
Returns
Pointer to the singleton instance
See also
This method is called by the main .ino file's addPanel() method to create the panel instance

Definition at line 61 of file 4A5A1_FUEL_PANEL.h.

61 {
62 if (!instance) {
63 instance = new FuelPanel(startIndex, ledStrip);
64 }
65 return instance;
66 }

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