Event manager class. More...

#include <Event_Manager_Base.h>

Collaboration diagram for TEvent_Manager_Base:

Classes
union	TEvent_Generic_Record
	Consolidated generic event data record. More...

union	TEvent_Header_Record
	Event header data record, 64 bytes. More...

union	TEvent_Payload_Record
	Event payload data record, 64 bytes. More...

Public Member Functions
virtual VOID	Init ()
	Event manager initialisation method. More...

virtual VOID	Done ()
	Event manager finalisation method. More...

virtual VOID	Execute ()
	Event manager background execution method. More...

virtual VOID	Assign_Memory (TS25FL512 *object_Memory_Pointer)
	Memory type assignment method. More...

virtual VOID	Verify_Database ()
	Verify database method. More...

virtual VOID	Create (U32 u32_Event_ID)
	Method for creating event with determine event index. More...

virtual VOID	Create (const TEvent_Descriptor &struct_Event_Descriptor)
	Method for creating event by given event descriptor. More...

virtual U32	Get_Database_Hash ()
	Method get event database descriptor hash. More...

virtual U32	Get_Database_Record_Count ()
	Method get event database descriptor hash. More...

virtual U64	Get_First_Event_Index ()
	Method get index of the first event record. More...

virtual U64	Get_Last_Event_Index ()
	Method get index of the last event record. More...

virtual U64	Get_Selected_Event_Index ()
	Method get index of the currently selected event. More...

virtual BOOL	Set_Selected_Event_Index (U64 u64_Selected_Event_New_Index)
	Method set index of the currently selected even. More...

virtual BOOL	Get_Selected_Event (TEvent_Generic_Record **struct_Event_Record)
	Method get selected event. More...

virtual VOID	Show_Boot_Information (TProtocol_Base *object_Protocol)
	Method show boot information message method. More...

virtual VOID	Send_Information (TProtocol_Base *object_Protocol)
	Method send diagnostic information about event manager. More...

virtual BOOL	Get_Event_Description_By_Event_ID (U32 u32_Event_ID, C8 **c8_Event_Description)
	Method get pointer to event description by given event ID. More...

virtual U32	Get_OS_Status ()
	This method return OS status. More...

virtual BOOL	Start_Operation ()
	This method set module in operation mode. More...

Detailed Description

Event manager class.

Member Function Documentation

◆ Assign_Memory()

VOID TEvent_Manager_Base::Assign_Memory ( TS25FL512 * object_Memory_Pointer )

virtual

Memory type assignment method.

Note: Assign SPI memory

Parameters

[in] *object_Memory_Pointer - Pointer to object of memory class

Returns: None

Override: Not allowed

Attention: None

◆ Create() [1/2]

VOID TEvent_Manager_Base::Create ( const TEvent_Descriptor & struct_Event_Descriptor )

virtual

Method for creating event by given event descriptor.

Note: None

Parameters

[in] &struct_Event_Descriptor - Event descriptor

Returns: None

Override: Not allowed

Attention: None

◆ Create() [2/2]

VOID TEvent_Manager_Base::Create ( U32 u32_Event_ID )

virtual

Method for creating event with determine event index.

Note: None

Parameters

[in] u32_Event_ID - Event index

Returns: None

Override: Not allowed

Attention: None

◆ Done()

VOID TEvent_Manager_Base::Done ( )

virtual

Event manager finalisation method.

Note: None

Returns: None

Override: Not allowed

Attention: None

◆ Execute()

VOID TEvent_Manager_Base::Execute ( )

virtual

Event manager background execution method.

Note: None

Returns: None

Override: Not allowed

Attention: None

◆ Get_Database_Hash()

U32 TEvent_Manager_Base::Get_Database_Hash ( )

virtual

Method get event database descriptor hash.

Note: None

Returns: Event database descriptor hash

Override: Not allowed

Attention: None

◆ Get_Database_Record_Count()

U32 TEvent_Manager_Base::Get_Database_Record_Count ( )

virtual

Method get event database descriptor hash.

Note: None

Returns: Databse record count

Override: Not allowed

Attention: None

◆ Get_Event_Description_By_Event_ID()

BOOL TEvent_Manager_Base::Get_Event_Description_By_Event_ID	(	U32	u32_Event_ID,
		C8 **	c8_Event_Description
	)

virtual

Method get pointer to event description by given event ID.

Note: None

Parameters

[in]	u32_Event_ID	- Event index
[out]	**c8_Event_Description	- Pointer to event description

Returns: BOOL - Operation status

Return values

false	- Operation falled
true	- Operation successfully done

Override: Not allowed

Attention: None

◆ Get_First_Event_Index()

U64 TEvent_Manager_Base::Get_First_Event_Index ( )

virtual

Method get index of the first event record.

Note: None

Returns: U64 - Event index for first record

Override: Not allowed

Attention: None

◆ Get_Last_Event_Index()

U64 TEvent_Manager_Base::Get_Last_Event_Index ( )

virtual

Method get index of the last event record.

Note: None

Returns: U64 - Event index for last record

Override: Not allowed

Attention: None

◆ Get_OS_Status()

U32 TEvent_Manager_Base::Get_OS_Status ( )

virtual

This method return OS status.

Note: None

Returns: U32 - OS status

Override: Required

Attention: None

◆ Get_Selected_Event()

BOOL TEvent_Manager_Base::Get_Selected_Event ( TEvent_Generic_Record ** struct_Event_Record )

virtual

Method get selected event.

Note: None

Parameters

[out] **struct_Event_Record - Pointer to event

Returns: BOOL - Operation status

Return values

false	- Event not getting
true	- Event successfully getting

Override: Not allowed

Attention: None

◆ Get_Selected_Event_Index()

U64 TEvent_Manager_Base::Get_Selected_Event_Index ( )

virtual

Method get index of the currently selected event.

Note: None

Returns: U64 - index of the currently selected event

Override: Not allowed

Attention: None

◆ Init()

VOID TEvent_Manager_Base::Init ( )

virtual

Event manager initialisation method.

Note: None

Returns: None

Override: Not allowed

Attention: None

◆ Send_Information()

VOID TEvent_Manager_Base::Send_Information ( TProtocol_Base * object_Protocol )

virtual

Method send diagnostic information about event manager.

Note: None

Parameters

[in] *object_Protocol - Pointer to communication protocol

Returns: None

Override: Not allowed

Attention: None

References TProtocol_Base::Transmit_String().

Here is the call graph for this function:

◆ Set_Selected_Event_Index()

BOOL TEvent_Manager_Base::Set_Selected_Event_Index ( U64 u64_Selected_Event_New_Index )

virtual

Method set index of the currently selected even.

Note: None

Returns: BOOL - Operation status

Return values

false	- Index dont set
true	- Index set successfully

Override: Not allowed

Attention: None

◆ Show_Boot_Information()

VOID TEvent_Manager_Base::Show_Boot_Information ( TProtocol_Base * object_Protocol )

virtual

Method show boot information message method.

Note: None

Parameters

[in] *object_Protocol - Pointer to communication protocol

Returns: None

Override: Not allowed

Attention: None

References TProtocol_Base::Transmit_String(), and TProtocol_Base::Transmit_String_Of_Char().

Here is the call graph for this function:

◆ Start_Operation()

BOOL TEvent_Manager_Base::Start_Operation ( )

virtual

This method set module in operation mode.

Note: None

Returns: BOOL - Module status

Return values

false	- Module in error mode
true	- Module ready to operations

Override: Required

Attention: None

◆ Verify_Database()

VOID TEvent_Manager_Base::Verify_Database ( )

virtual

Verify database method.

Note: None

Returns: None

Override: Not allowed

Attention: None

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

ConOpSys/Engine/Event_Manager_Base.h
ConOpSys/Engine/Event_Manager_Base.cpp

Classes

Public Member Functions

Detailed Description

Member Function Documentation

◆ Assign_Memory()

◆ Create() [1/2]

◆ Create() [2/2]

◆ Done()

◆ Execute()

◆ Get_Database_Hash()

◆ Get_Database_Record_Count()

◆ Get_Event_Description_By_Event_ID()

◆ Get_First_Event_Index()

◆ Get_Last_Event_Index()

◆ Get_OS_Status()

◆ Get_Selected_Event()

◆ Get_Selected_Event_Index()

◆ Init()

◆ Send_Information()

◆ Set_Selected_Event_Index()

◆ Show_Boot_Information()

◆ Start_Operation()

◆ Verify_Database()