ConOpSys V2970  P004.07
ANVILEX control operating system
Public Types | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
TSystem_LED_Base Class Referenceabstract

Base LED manager class. More...

#include <System_LED_Base.h>

Inheritance diagram for TSystem_LED_Base:
Inheritance graph
Collaboration diagram for TSystem_LED_Base:
Collaboration graph

Public Types

enum  TLED_Mode {
  enum_Off , enum_On , enum_Flash_1_Hz , enum_Flash_4_Hz ,
  enum_Flash_8_Hz
}
 LED operating modes. More...
 

Public Member Functions

VOID Init ()
 System LED base initialisation method. More...
 
VOID Done ()
 System LED base finalisation method. More...
 
VOID Execute_1ms ()
 1 ms cyclic execution method More...
 
VOID Set_Alarm_LED_Mode (TLED_Mode enum_New_Mode)
 Set mode for alarm LED. More...
 
VOID Set_Run_LED_Mode (TLED_Mode enum_New_Mode)
 Set mode for run LED. More...
 
VOID Set_Ready_LED_Mode (TLED_Mode enum_New_Mode)
 Set mode for ready LED. More...
 
VOID Set_Error_LED_Mode (TLED_Mode enum_New_Mode)
 Set mode for error LED. More...
 

Public Attributes

BOOL bool_Start_Procesing = (BOOL)false
 

Protected Member Functions

virtual VOID Alarm_On ()=0
 Method turns on the alarm LED. More...
 
virtual VOID Alarm_Off ()=0
 Method turns off the alarm LED. More...
 
virtual VOID Alarm_Toggle ()=0
 Method toggle the alarm LED. More...
 
virtual VOID Run_On ()=0
 Method turns on the run LED. More...
 
virtual VOID Run_Off ()=0
 Method turns off the run LED. More...
 
virtual VOID Run_Toggle ()=0
 Method toggle the run LED. More...
 
virtual VOID Ready_On ()=0
 Method turns on the ready LED. More...
 
virtual VOID Ready_Off ()=0
 Method turns off the ready LED. More...
 
virtual VOID Ready_Toggle ()=0
 Method toggle the ready LED. More...
 
virtual VOID Error_On ()=0
 Method turns on the error LED. More...
 
virtual VOID Error_Off ()=0
 Method turns off the error LED. More...
 
virtual VOID Error_Toggle ()=0
 Method toggle the error LED. More...
 
virtual BOOL Get_Alarm_LED_State ()=0
 Method return alarm LED state. More...
 
virtual BOOL Get_Run_LED_State ()=0
 Method return run LED state. More...
 
virtual BOOL Get_Ready_LED_State ()=0
 Method return ready LED state. More...
 
virtual BOOL Get_Error_LED_State ()=0
 Method return error LED state. More...
 

Protected Attributes

TLED_Mode enum_Alarm_LED_Mode = enum_Off
 Contains alarm LED operation mode. More...
 
TLED_Mode enum_Run_LED_Mode = enum_Off
 Contains run LED operation mode. More...
 
TLED_Mode enum_Ready_LED_Mode = enum_Off
 Contains ready LED operation mode. More...
 
TLED_Mode enum_Error_LED_Mode = enum_Off
 Contains error LED operation mode. More...
 
U32 u32_Alarm_LED_Delay_Counter = (U32)0
 Contains delay counter for alarm LED. More...
 
U32 u32_Run_LED_Delay_Counter = (U32)0
 Contains delay counter for run LED. More...
 
U32 u32_Ready_LED_Delay_Counter = (U32)0
 Contains delay counter for ready LED. More...
 
U32 u32_Error_LED_Delay_Counter = (U32)0
 Contains delay counter for error LED. More...
 

Private Member Functions

VOID Decode ()
 Decode LED states methood. More...
 
VOID Process ()
 Process LED operation method. More...
 

Private Attributes

U32 u32_Decode_Counter = (U32)0
 Decode LED counter. More...
 

Detailed Description

Base LED manager class.

Member Enumeration Documentation

◆ TLED_Mode

enum TSystem_LED_Base::TLED_Mode

LED operating modes.

Enumerator
enum_Off 

LED off.

enum_On 

LED on.

enum_Flash_1_Hz 

Blinking LED (1 Hz)

enum_Flash_4_Hz 

Blinking LED (1 Hz)

enum_Flash_8_Hz 

Blinking LED (8 Hz)

Member Function Documentation

◆ Alarm_Off()

virtual VOID TSystem_LED_Base::Alarm_Off ( )
protectedpure virtual

Method turns off the alarm LED.

Note
None
Returns
None
Override
Not allowed
Attention
None

Implemented in TLED_P017_39_KG3_CB, TLED_P016_05_PUC2, TLED_P015_27_V1_0_CB, TLED_P015_09_CB, and TLED_P014_51_CB.

Referenced by Done(), Init(), and Process().

Here is the caller graph for this function:

◆ Alarm_On()

virtual VOID TSystem_LED_Base::Alarm_On ( )
protectedpure virtual

Method turns on the alarm LED.

Note
None
Returns
None
Override
Not allowed
Attention
None

Implemented in TLED_P017_39_KG3_CB, TLED_P016_05_PUC2, TLED_P015_27_V1_0_CB, TLED_P015_09_CB, and TLED_P014_51_CB.

Referenced by Process().

Here is the caller graph for this function:

◆ Alarm_Toggle()

virtual VOID TSystem_LED_Base::Alarm_Toggle ( )
protectedpure virtual

Method toggle the alarm LED.

Note
None
Returns
None
Override
Not allowed
Attention
None

Implemented in TLED_P017_39_KG3_CB, TLED_P016_05_PUC2, TLED_P015_27_V1_0_CB, TLED_P015_09_CB, and TLED_P014_51_CB.

Referenced by Process().

Here is the caller graph for this function:

◆ Decode()

VOID TSystem_LED_Base::Decode ( )
private

Decode LED states methood.

Note
None
Returns
None
Override
Not allowed
Attention
None

References TOS_Status_Structure::Bits, bool_Start_Procesing, enum_Flash_1_Hz, enum_Flash_4_Hz, enum_Off, enum_On, TCommand_Manager::Get_OS_Status(), TParameter_Manager::Get_OS_Status(), object_Command_Manager, object_Parameter_APPLICATION_BACKGROUND_TASK_ALARM_STATUS, object_Parameter_APPLICATION_BACKGROUND_TASK_CRITICAL_STATUS, object_Parameter_APPLICATION_BACKGROUND_TASK_STATUS, object_Parameter_APPLICATION_BACKGROUND_TASK_TRIP_STATUS, object_Parameter_APPLICATION_BACKGROUND_TASK_WARNING_STATUS, object_Parameter_APPLICATION_CONTROL_TASK_ALARM_STATUS, object_Parameter_APPLICATION_CONTROL_TASK_CRITICAL_STATUS, object_Parameter_APPLICATION_CONTROL_TASK_STATUS, object_Parameter_APPLICATION_CONTROL_TASK_TRIP_STATUS, object_Parameter_APPLICATION_CONTROL_TASK_WARNING_STATUS, object_Parameter_APPLICATION_SYSTEM_TASK_ALARM_STATUS, object_Parameter_APPLICATION_SYSTEM_TASK_CRITICAL_STATUS, object_Parameter_APPLICATION_SYSTEM_TASK_STATUS, object_Parameter_APPLICATION_SYSTEM_TASK_TRIP_STATUS, object_Parameter_APPLICATION_SYSTEM_TASK_WARNING_STATUS, object_Parameter_Manager, TParameter_Base::Read_Value_As_BOOL(), TParameter_Base::Read_Value_As_U32(), Set_Alarm_LED_Mode(), Set_Error_LED_Mode(), Set_Ready_LED_Mode(), Set_Run_LED_Mode(), state_Operation, state_Reseting, state_Transition, TOS_Status_Structure::u32_Alarm, TOS_Status_Structure::u32_Error, TOS_Status_Structure::u32_Init, TOS_Status_Structure::u32_Raw_Data, and TOS_Status_Structure::u32_Ready.

Referenced by Execute_1ms().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Done()

VOID TSystem_LED_Base::Done ( )

System LED base finalisation method.

Note
None
Returns
None
Override
Not allowed
Attention
None

References Alarm_Off(), Error_Off(), Ready_Off(), and Run_Off().

Referenced by TLED_P014_51_CB::Done(), TLED_P015_09_CB::Done(), TLED_P015_27_V1_0_CB::Done(), TLED_P016_05_PUC2::Done(), and TLED_P017_39_KG3_CB::Done().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Error_Off()

virtual VOID TSystem_LED_Base::Error_Off ( )
protectedpure virtual

Method turns off the error LED.

Note
None
Returns
None
Override
Not allowed
Attention
None

Implemented in TLED_P017_39_KG3_CB, TLED_P016_05_PUC2, TLED_P015_27_V1_0_CB, TLED_P015_09_CB, and TLED_P014_51_CB.

Referenced by Done(), Init(), and Process().

Here is the caller graph for this function:

◆ Error_On()

virtual VOID TSystem_LED_Base::Error_On ( )
protectedpure virtual

Method turns on the error LED.

Note
None
Returns
None
Override
Not allowed
Attention
None

Implemented in TLED_P017_39_KG3_CB, TLED_P016_05_PUC2, TLED_P015_27_V1_0_CB, TLED_P015_09_CB, and TLED_P014_51_CB.

Referenced by Process().

Here is the caller graph for this function:

◆ Error_Toggle()

virtual VOID TSystem_LED_Base::Error_Toggle ( )
protectedpure virtual

Method toggle the error LED.

Note
None
Returns
None
Override
Not allowed
Attention
None

Implemented in TLED_P017_39_KG3_CB, TLED_P016_05_PUC2, TLED_P015_27_V1_0_CB, TLED_P015_09_CB, and TLED_P014_51_CB.

Referenced by Process().

Here is the caller graph for this function:

◆ Execute_1ms()

VOID TSystem_LED_Base::Execute_1ms ( )

1 ms cyclic execution method

Note
None
Returns
None
Override
Not allowed
Attention
None

References Decode(), DECODE_INTERLEAVE_FACTOR, Process(), and u32_Decode_Counter.

Referenced by TApplication_Base::System_Task_Handler().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Get_Alarm_LED_State()

virtual BOOL TSystem_LED_Base::Get_Alarm_LED_State ( )
protectedpure virtual

Method return alarm LED state.

Note
None
Returns
BOOL - Alarm LED state
Return values
false- Alarm LED is off
true- Alarm LED is on
Override
Not allowed
Attention
None

Implemented in TLED_P017_39_KG3_CB, TLED_P016_05_PUC2, TLED_P015_27_V1_0_CB, TLED_P015_09_CB, and TLED_P014_51_CB.

◆ Get_Error_LED_State()

virtual BOOL TSystem_LED_Base::Get_Error_LED_State ( )
protectedpure virtual

Method return error LED state.

Note
None
Returns
BOOL - Error LED state
Return values
false- Error LED is off
true- Error LED is on
Override
Not allowed
Attention
None

Implemented in TLED_P017_39_KG3_CB, TLED_P016_05_PUC2, TLED_P015_27_V1_0_CB, TLED_P015_09_CB, and TLED_P014_51_CB.

◆ Get_Ready_LED_State()

virtual BOOL TSystem_LED_Base::Get_Ready_LED_State ( )
protectedpure virtual

Method return ready LED state.

Note
None
Returns
BOOL - Ready LED state
Return values
false- Ready LED is off
true- Ready LED is on
Override
Not allowed
Attention
None

Implemented in TLED_P017_39_KG3_CB, TLED_P016_05_PUC2, TLED_P015_27_V1_0_CB, TLED_P015_09_CB, and TLED_P014_51_CB.

◆ Get_Run_LED_State()

virtual BOOL TSystem_LED_Base::Get_Run_LED_State ( )
protectedpure virtual

Method return run LED state.

Note
None
Returns
BOOL - Run LED state
Return values
false- Run LED is off
true- Run LED is on
Override
Not allowed
Attention
None

Implemented in TLED_P017_39_KG3_CB, TLED_P016_05_PUC2, TLED_P015_27_V1_0_CB, TLED_P015_09_CB, and TLED_P014_51_CB.

◆ Init()

VOID TSystem_LED_Base::Init ( )

System LED base initialisation method.

Note
None
Returns
None
Override
Not allowed
Attention
None

References Alarm_Off(), Error_Off(), Ready_Off(), and Run_Off().

Referenced by TLED_P014_51_CB::Init(), TLED_P015_09_CB::Init(), TLED_P015_27_V1_0_CB::Init(), TLED_P016_05_PUC2::Init(), and TLED_P017_39_KG3_CB::Init().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Process()

VOID TSystem_LED_Base::Process ( )
private

Process LED operation method.

Note
None
Returns
None
Override
Not allowed
Attention
None

References Alarm_Off(), Alarm_On(), Alarm_Toggle(), enum_Alarm_LED_Mode, enum_Error_LED_Mode, enum_Flash_1_Hz, enum_Flash_4_Hz, enum_Flash_8_Hz, enum_Off, enum_On, enum_Ready_LED_Mode, enum_Run_LED_Mode, Error_Off(), Error_On(), Error_Toggle(), Ready_Off(), Ready_On(), Ready_Toggle(), Run_Off(), Run_On(), Run_Toggle(), u32_Alarm_LED_Delay_Counter, u32_Error_LED_Delay_Counter, u32_Ready_LED_Delay_Counter, and u32_Run_LED_Delay_Counter.

Referenced by Execute_1ms().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Ready_Off()

virtual VOID TSystem_LED_Base::Ready_Off ( )
protectedpure virtual

Method turns off the ready LED.

Note
None
Returns
None
Override
Not allowed
Attention
None

Implemented in TLED_P017_39_KG3_CB, TLED_P016_05_PUC2, TLED_P015_27_V1_0_CB, TLED_P015_09_CB, and TLED_P014_51_CB.

Referenced by Done(), Init(), and Process().

Here is the caller graph for this function:

◆ Ready_On()

virtual VOID TSystem_LED_Base::Ready_On ( )
protectedpure virtual

Method turns on the ready LED.

Note
None
Returns
None
Override
Not allowed
Attention
None

Implemented in TLED_P017_39_KG3_CB, TLED_P016_05_PUC2, TLED_P015_27_V1_0_CB, TLED_P015_09_CB, and TLED_P014_51_CB.

Referenced by Process().

Here is the caller graph for this function:

◆ Ready_Toggle()

virtual VOID TSystem_LED_Base::Ready_Toggle ( )
protectedpure virtual

Method toggle the ready LED.

Note
None
Returns
None
Override
Not allowed
Attention
None

Implemented in TLED_P017_39_KG3_CB, TLED_P016_05_PUC2, TLED_P015_27_V1_0_CB, TLED_P015_09_CB, and TLED_P014_51_CB.

Referenced by Process().

Here is the caller graph for this function:

◆ Run_Off()

virtual VOID TSystem_LED_Base::Run_Off ( )
protectedpure virtual

Method turns off the run LED.

Note
None
Returns
None
Override
Not allowed
Attention
None

Implemented in TLED_P017_39_KG3_CB, TLED_P016_05_PUC2, TLED_P015_27_V1_0_CB, TLED_P015_09_CB, and TLED_P014_51_CB.

Referenced by Done(), Init(), and Process().

Here is the caller graph for this function:

◆ Run_On()

virtual VOID TSystem_LED_Base::Run_On ( )
protectedpure virtual

Method turns on the run LED.

Note
None
Returns
None
Override
Not allowed
Attention
None

Implemented in TLED_P017_39_KG3_CB, TLED_P016_05_PUC2, TLED_P015_27_V1_0_CB, TLED_P015_09_CB, and TLED_P014_51_CB.

Referenced by Process().

Here is the caller graph for this function:

◆ Run_Toggle()

virtual VOID TSystem_LED_Base::Run_Toggle ( )
protectedpure virtual

Method toggle the run LED.

Note
None
Returns
None
Override
Not allowed
Attention
None

Implemented in TLED_P017_39_KG3_CB, TLED_P016_05_PUC2, TLED_P015_27_V1_0_CB, TLED_P015_09_CB, and TLED_P014_51_CB.

Referenced by Process().

Here is the caller graph for this function:

◆ Set_Alarm_LED_Mode()

VOID TSystem_LED_Base::Set_Alarm_LED_Mode ( TLED_Mode  enum_New_Mode)

Set mode for alarm LED.

Note
None
Parameters
[in]enum_New_Mode- Required mode for LED
Returns
None
Override
Not allowed
Attention
None

References enum_Alarm_LED_Mode, and u32_Alarm_LED_Delay_Counter.

Referenced by Decode().

Here is the caller graph for this function:

◆ Set_Error_LED_Mode()

VOID TSystem_LED_Base::Set_Error_LED_Mode ( TLED_Mode  enum_New_Mode)

Set mode for error LED.

Note
None
Parameters
[in]enum_New_Mode- Required mode for LED
Returns
None
Override
Not allowed
Attention
None

References enum_Error_LED_Mode, and u32_Error_LED_Delay_Counter.

Referenced by Decode().

Here is the caller graph for this function:

◆ Set_Ready_LED_Mode()

VOID TSystem_LED_Base::Set_Ready_LED_Mode ( TLED_Mode  enum_New_Mode)

Set mode for ready LED.

Note
None
Parameters
[in]enum_New_Mode- Required mode for LED
Returns
None
Override
Not allowed
Attention
None

References enum_Ready_LED_Mode, and u32_Ready_LED_Delay_Counter.

Referenced by Decode().

Here is the caller graph for this function:

◆ Set_Run_LED_Mode()

VOID TSystem_LED_Base::Set_Run_LED_Mode ( TLED_Mode  enum_New_Mode)

Set mode for run LED.

Note
None
Parameters
[in]enum_New_Mode- Required mode for LED
Returns
None
Override
Not allowed
Attention
None

References enum_Run_LED_Mode, and u32_Run_LED_Delay_Counter.

Referenced by Decode().

Here is the caller graph for this function:

Member Data Documentation

◆ bool_Start_Procesing

BOOL TSystem_LED_Base::bool_Start_Procesing = (BOOL)false

Referenced by Decode(), TApplication_Base::Run(), and TBootloader_Base::Run().

◆ enum_Alarm_LED_Mode

TLED_Mode TSystem_LED_Base::enum_Alarm_LED_Mode = enum_Off
protected

Contains alarm LED operation mode.

Referenced by Process(), and Set_Alarm_LED_Mode().

◆ enum_Error_LED_Mode

TLED_Mode TSystem_LED_Base::enum_Error_LED_Mode = enum_Off
protected

Contains error LED operation mode.

Referenced by Process(), and Set_Error_LED_Mode().

◆ enum_Ready_LED_Mode

TLED_Mode TSystem_LED_Base::enum_Ready_LED_Mode = enum_Off
protected

Contains ready LED operation mode.

Referenced by Process(), and Set_Ready_LED_Mode().

◆ enum_Run_LED_Mode

TLED_Mode TSystem_LED_Base::enum_Run_LED_Mode = enum_Off
protected

Contains run LED operation mode.

Referenced by Process(), and Set_Run_LED_Mode().

◆ u32_Alarm_LED_Delay_Counter

U32 TSystem_LED_Base::u32_Alarm_LED_Delay_Counter = (U32)0
protected

Contains delay counter for alarm LED.

Referenced by Process(), and Set_Alarm_LED_Mode().

◆ u32_Decode_Counter

U32 TSystem_LED_Base::u32_Decode_Counter = (U32)0
private

Decode LED counter.

Referenced by Execute_1ms().

◆ u32_Error_LED_Delay_Counter

U32 TSystem_LED_Base::u32_Error_LED_Delay_Counter = (U32)0
protected

Contains delay counter for error LED.

Referenced by Process(), and Set_Error_LED_Mode().

◆ u32_Ready_LED_Delay_Counter

U32 TSystem_LED_Base::u32_Ready_LED_Delay_Counter = (U32)0
protected

Contains delay counter for ready LED.

Referenced by Process(), and Set_Ready_LED_Mode().

◆ u32_Run_LED_Delay_Counter

U32 TSystem_LED_Base::u32_Run_LED_Delay_Counter = (U32)0
protected

Contains delay counter for run LED.

Referenced by Process(), and Set_Run_LED_Mode().

The documentation for this class was generated from the following files:
Generated on Thu Mar 10 2022 03:57:41 for ConOpSys V2970 by doxygen 1.9.1