TCommand_Base Class Reference

ConOpSys terminal command base class. More...

#include <Command_Base.h>

Inheritance diagram for TCommand_Base:

Collaboration diagram for TCommand_Base:

Classes
struct	TCommand_Descriptor
	Command descriptor structure. More...

Public Member Functions
	TCommand_Base (TCommand_Descriptor *struct_Descriptor)
	Class constructor method. More...
virtual	~TCommand_Base ()
	Class distructor method. More...
BOOL	Is_Command_Name (C8 *c8_Command_String)
	Test command name. More...
virtual VOID	Execute (TProtocol_Base *object_Protocol)
	Execute command method. More...
VOID	Send_Information (TProtocol_Base *object_Protocol)
	Send information about cpecific command over communication link protocol. More...

Private Attributes
TCommand_Descriptor *	struct_Descriptor
	Command descriptor storage. More...

Detailed Description

ConOpSys terminal command base class.

Constructor & Destructor Documentation

TCommand_Base()

TCommand_Base::TCommand_Base

(

TCommand_Descriptor *

struct_Descriptor

)

Class constructor method.

---

Note

None

Parameters

[in]

*struct_Descriptor

- Pointer to the command description

Override

Not allowed

Attention

Don't call this method directly.

UML diagram

References struct_Descriptor.

~TCommand_Base()

TCommand_Base::~TCommand_Base ( )

virtual

Class distructor method.

---

Note

None

Override

Not allowed

Attention

Don't call this method directly.

UML diagram

Member Function Documentation

Execute()

VOID TCommand_Base::Execute ( TProtocol_Base *  object_Protocol )

virtual

Execute command method.

---

Note

This method executes command specific functionality.

Parameters

[in]

*object_Protocol

- Pointer to the communication link protocol

Returns

BOOL - Command execution status

Return values

false	- Command execution failed
true	- Command execution successfull

Override

Required

Attention

None

UML diagram

Reimplemented in TCommand_TERMINAL, TCommand_STATUS, TCommand_STACK, TCommand_SCOPE_STATUS, TCommand_SCOPE_FORCE, TCommand_SCOPE_ARM, TCommand_SCOPE, TCommand_RTC, TCommand_RESTART, TCommand_RESET, TCommand_PROTOCOL, TCommand_PARAMETERS, TCommand_NVRAM_STATUS, TCommand_NVRAM_FORMAT, TCommand_NVRAM, TCommand_MEMORY, TCommand_INFO, TCommand_HELP, TCommand_HEAP, TCommand_FSM, TCommand_FPGA, TCommand_FLASH_FORMAT, TCommand_FLASH, TCommand_EVENTS, TCommand_ETHERNET, TCommand_ENABLE, TCommand_DISABLE, TCommand_CONTACT, TCommand_COM3, TCommand_COM2, TCommand_COM1, TCommand_COM0, TCommand_CAN, TCommand_APPLICATION, and TCommand_ANYBUS.

Referenced by TCommand_Manager::Execute().

Here is the caller graph for this function:

Is_Command_Name()

BOOL TCommand_Base::Is_Command_Name

(

C8 *

c8_Command_String

)

Test command name.

---

Note

This method test command name against given name and returns status.

Parameters

[in]

*c8_Command_String

- Pointer to the command string

Returns

BOOL - Command name test status

Return values

false	- Command not queal
true	- Command not queal

Override

Not allowed

Attention

None

UML diagram

References TCommand_Base::TCommand_Descriptor::c8_Command_Name, and struct_Descriptor.

Referenced by TCommand_Manager::Execute().

Here is the caller graph for this function:

Send_Information()

VOID TCommand_Base::Send_Information

(

TProtocol_Base *

object_Protocol

)

Send information about cpecific command over communication link protocol.

---

Note

This method sends information about specific command over specified communication link protocol.

Parameters

[in]

*object_Protocol

- Pointer to the communication link protocol

Returns

None

Override

Not allowed

Attention

None

UML diagram

References TCommand_Base::TCommand_Descriptor::c8_Command_Description, TCommand_Base::TCommand_Descriptor::c8_Command_Name, NULL, struct_Descriptor, and TProtocol_Base::Transmit_String().

Referenced by TCommand_HELP::Execute().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

struct_Descriptor

TCommand_Descriptor* TCommand_Base::struct_Descriptor

private

Command descriptor storage.

Referenced by Is_Command_Name(), Send_Information(), and TCommand_Base().

---

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

• ConOpSys/Commands/Command_Base.h
• ConOpSys/Commands/Command_Base.cpp