RDK Documentation (Open Sourced RDK Components)
indicator Class Reference
Collaboration diagram for indicator:
Collaboration graph

Data Structures

struct  indicatorProperties_t
 

Public Member Functions

 indicator (const std::string &name)
 
const std::string & getName () const
 API to return the indicator name. More...
 
int setState (indicatorState_t state)
 This API cancel the current blinking indicator if any, to change the state . More...
 
int setBlink (const blinkPattern_t *pattern, int repetitions=-1)
 This API enables the indicator to blink with the specified blinking pattern. More...
 
void setColor (const unsigned int color)
 This API sets the indicator color. More...
 
int timerCallback (void)
 This API requests to process the pattern iteration steps.
 
void saveState ()
 This API saves all the current indicator related properties. More...
 
void restoreState ()
 API to restore the indicator properties from saved indicator properties. More...
 
void executeFlare (const unsigned int percentage_increase, const unsigned int length_ms)
 Register Flare callback function to set indicator brightness as flare. More...
 
void flareCallback (void)
 API to perform indicator brightness with flare value.
 

Private Member Functions

int step ()
 This API is to register timer callback function depends on iteration pattern(indefinite iteration and finite iteration). More...
 
int registerCallback (unsigned int milliseconds)
 This API register timer callback function in order to complete the blinking pattern iteration count. More...
 
void setBrightness (unsigned int intensity)
 This API sets the brightness of the specified LED. More...
 
int enableIndicator (bool enable)
 This API sets the indicator state. More...
 

Private Attributes

std::string m_name
 
pthread_mutex_t m_mutex
 
guint m_source_id
 
device::FrontPanelIndicatorm_indicator
 
indicatorState_t m_state
 
const blinkPattern_tm_pattern_ptr
 
int m_pattern_repetitions
 
unsigned char m_sequence_read_offset
 
unsigned int m_preflare_brightness
 
indicatorProperties_t m_saved_properties
 

yes

Definition at line 26 of file indicator.hpp.


Data Structure Documentation

◆ indicator::indicatorProperties_t

struct indicator::indicatorProperties_t

Definition at line 29 of file indicator.hpp.

Collaboration diagram for indicator::indicatorProperties_t:
Collaboration graph
Data Fields
bool isValid
indicatorState_t state
const blinkPattern_t * pattern_ptr
int pattern_repetitions
unsigned char sequence_read_offset
unsigned int intensity
unsigned int color

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