ConOpSys terminal command manager base class. More...

#include <Command_Manager_Base.h>

Inheritance diagram for TCommand_Manager_Base:

Collaboration diagram for TCommand_Manager_Base:

Public Member Functions
	TCommand_Manager_Base ()
	Class constructor method. More...

virtual	~TCommand_Manager_Base ()
	Class destructor method. More...

virtual VOID	Init ()
	Command manager initialisation method. More...

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

virtual BOOL	Get_Index (U32 u32_Storage_Index, TCommand_Base object_Command)
	Get command object index referenced by command object pointer. More...

virtual BOOL	Get_Command_By_Storage_Index (U32 u32_Storage_Index, TCommand_Base **object_Command)
	Get pointer to the command object referenced by command manager storage index. More...

virtual BOOL	Is_Registered (TCommand_Base *object_Command)
	Test for command registered in command manager. More...

virtual BOOL	Register (TCommand_Base *object_Command)
	Performs registration of the command in command manager. More...

virtual BOOL	Unregister (TCommand_Base *object_Command)
	Performs unregistration of the command in command manager. More...

virtual BOOL	Execute (C8 c8_Command_String, TProtocol_Base object_Protocol)
	Execute command method. More...

virtual U32	Get_Command_Count ()
	Get command count registered in command manager. More...

virtual VOID	Get_Usage (U32 u32_Command_Capacity, U32 u32_Command_Count)
	Get command manager storage utilisation. More...

virtual VOID	Show_Boot_Information (TProtocol_Base *object_Protocol)
	Send boot information message over given protocol. More...

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

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

Protected Attributes
TOS_Status_Structure	struct_OS_Status
	Container for OS status. More...

Detailed Description

ConOpSys terminal command manager base class.

Constructor & Destructor Documentation

◆ TCommand_Manager_Base()

TCommand_Manager_Base::TCommand_Manager_Base ( )

Class constructor method.

Note: None

Override: Not allowed

Attention: Don't call this method directly.

References struct_OS_Status, and TOS_Status_Structure::u32_Raw_Data.

◆ ~TCommand_Manager_Base()

TCommand_Manager_Base::~TCommand_Manager_Base ( )

virtual

Class destructor method.

Note: None

Override: Not allowed

Attention: Don't call this method directly.

Member Function Documentation

◆ Done()

VOID TCommand_Manager_Base::Done ( )

virtual

Command manager finalisation method.

Note: None

Override: Not allowed

Attention: Don't call this method directly.

Reimplemented in TCommand_Manager.

◆ Execute()

BOOL TCommand_Manager_Base::Execute	(	C8 *	c8_Command_String,
		TProtocol_Base *	object_Protocol
	)

virtual

Execute command method.

Note: None

Parameters

[in]	*c8_Command_String	- Pointer to the command name string
[in]	*object_Protocol	- Pointer to the communication protocol object

Returns: BOOL - Execution status

Return values

false	- Command name is not equal and command not executed
true	- Command name is equal and command executed

Override: Not allowed

Attention: None

Reimplemented in TCommand_Manager.

◆ Get_Command_By_Storage_Index()

BOOL TCommand_Manager_Base::Get_Command_By_Storage_Index	(	U32	u32_Storage_Index,
		TCommand_Base **	object_Command
	)

virtual

Get pointer to the command object referenced by command manager storage index.

Note: None

Parameters

[in]	u32_Storage_Index	- Command manager storage index
[out]	**object_Command	- Pointer to the command object

Returns: BOOL - Execution status

Return values

false	- Command object not found in command manager storage
true	- Command object found in command manager storage

Override: Not allowed

Attention: None

Reimplemented in TCommand_Manager.

◆ Get_Command_Count()

U32 TCommand_Manager_Base::Get_Command_Count ( )

virtual

Get command count registered in command manager.

Note: None

Returns: U32 - Command count

Override: Not allowed

Attention: None

Reimplemented in TCommand_Manager.

◆ Get_Index()

BOOL TCommand_Manager_Base::Get_Index	(	U32 *	u32_Storage_Index,
		TCommand_Base *	object_Command
	)

virtual

Get command object index referenced by command object pointer.

Note: This method allows resovle command manager storage index of the command

Parameters

[out]	*u32_Storage_Index	- Command manager storage index
[in]	*object_Command	- Pointer to the command object

Returns: BOOL - Execution status

Return values

false	- Command object not found in command manager storage
true	- Command object found in command manager storage

Override: Not allowed

Attention: None

Reimplemented in TCommand_Manager.

◆ Get_OS_Status()

U32 TCommand_Manager_Base::Get_OS_Status ( )

virtual

This method return OS status.

Note: None

Returns: U32 - OS status

Override: Required

Attention: None

Reimplemented in TCommand_Manager.

References struct_OS_Status, and TOS_Status_Structure::u32_Raw_Data.

◆ Get_Usage()

VOID TCommand_Manager_Base::Get_Usage	(	U32 *	u32_Command_Capacity,
		U32 *	u32_Command_Count
	)

virtual

Get command manager storage utilisation.

Note: None

Parameters

[out]	*u32_Command_Capacity	- Pointer to the command manager capacity variable
[out]	*u32_Command_Count	- Pointer to the command count variable

Returns: None

Override: Not allowed

Attention: None

Reimplemented in TCommand_Manager.

◆ Init()

VOID TCommand_Manager_Base::Init ( )

virtual

Command manager initialisation method.

Note: None

Override: Not allowed

Attention: Don't call this method directly.

Reimplemented in TCommand_Manager.

◆ Is_Registered()

BOOL TCommand_Manager_Base::Is_Registered ( TCommand_Base * object_Command )

virtual

Test for command registered in command manager.

Note: None

Parameters

[in] *object_Command - Pointer to the command object

Returns: BOOL - Execution status

Return values

false	- Command object not registered in command manager storage
true	- Command object registered in command manager storage

Override: Not allowed

Attention: None

Reimplemented in TCommand_Manager.

◆ Register()

BOOL TCommand_Manager_Base::Register ( TCommand_Base * object_Command )

virtual

Performs registration of the command in command manager.

Note: None

Parameters

[in] *object_Command - Pointer to the command object

Returns: BOOL - Execution status

Return values

false	- Command object registration successed
true	- Command object registration failed

Override: Not allowed

Attention: None

Reimplemented in TCommand_Manager.

◆ Show_Boot_Information()

VOID TCommand_Manager_Base::Show_Boot_Information ( TProtocol_Base * object_Protocol )

virtual

Send boot information message over given protocol.

Note: None

Parameters

[in] *object_Protocol - Pointer to the protocol object

Returns: None

Override: Not allowed

Attention: None

Reimplemented in TCommand_Manager.

◆ Start_Operation()

BOOL TCommand_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

Reimplemented in TCommand_Manager.

◆ Unregister()

BOOL TCommand_Manager_Base::Unregister ( TCommand_Base * object_Command )

virtual

Performs unregistration of the command in command manager.

Note: None

Parameters

[in] *object_Command - Pointer to the command object

Returns: BOOL - Execution status

Return values

false	- Command object unregistration successed
true	- Command object unregistration failed

Override: Not allowed

Attention: None

Reimplemented in TCommand_Manager.

Member Data Documentation

◆ struct_OS_Status

TOS_Status_Structure TCommand_Manager_Base::struct_OS_Status

protected

Container for OS status.

Referenced by TCommand_Manager::Get_OS_Status(), Get_OS_Status(), TCommand_Manager::Init(), TCommand_Manager::Start_Operation(), TCommand_Manager::TCommand_Manager(), and TCommand_Manager_Base().

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

ConOpSys/Engine/Command_Manager_Base.h
ConOpSys/Engine/Command_Manager_Base.cpp

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TCommand_Manager_Base()

◆ ~TCommand_Manager_Base()

Member Function Documentation

◆ Done()

◆ Execute()

◆ Get_Command_By_Storage_Index()

◆ Get_Command_Count()

◆ Get_Index()

◆ Get_OS_Status()

◆ Get_Usage()

◆ Init()

◆ Is_Registered()

◆ Register()

◆ Show_Boot_Information()

◆ Start_Operation()

◆ Unregister()

Member Data Documentation

◆ struct_OS_Status