ConOpSys V2970  P004.07
ANVILEX control operating system
System_Command_PROTOCOL.h
Go to the documentation of this file.
1 //------------------------------------------------------------------------------
2 //! @file System_Command_PROTOCOL.h
3 //! @brief ConOpSys terminal system command PROTOCOL class header file.
4 //! @attention No special attention requered.
5 //! @copyright (C) 2017-2020 ANVILEX LLC
6 //! $HeadURL: https://192.168.3.4:8443/svn/P004_07/ConOpSys/Commands/System_Command_PROTOCOL.h $
7 //! $Revision: 2797 $
8 //! $Date: 2021-07-12 16:13:33 +0500 (Mo, 12 Jul 2021) $
9 //! $Author: minch $
10 //------------------------------------------------------------------------------
11 //
12 // Redistribution and use in source and binary forms, with or without
13 // modification, are permitted provided that the following conditions are met:
14 //
15 // 1. Redistributions of source code must retain the above copyright notice,
16 // this list of conditions and the following disclaimer.
17 //
18 // 2. Redistributions in binary form must reproduce the above copyright notice,
19 // this list of conditions and the following disclaimer in the documentation
20 // and/or other materials provided with the distribution.
21 //
22 // 3. Neither the name of ANVILEX nor the names of its contributors may be
23 // used to endorse or promote products derived from this software without
24 // specific prior written permission.
25 //
26 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
27 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29 // ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
30 // LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31 // CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32 // SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33 // INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34 // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35 // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36 // POSSIBILITY OF SUCH DAMAGE.
37 //
38 //------------------------------------------------------------------------------
39 
40 
41 //------------------------------------------------------------------------------
42 // Protecting header files from mutual, recursive inclusion.
43 //------------------------------------------------------------------------------
44 
45 #pragma once
46 
47 //------------------------------------------------------------------------------
48 // Include standard libraries header files
49 //------------------------------------------------------------------------------
50 
51 //------------------------------------------------------------------------------
52 // Include thrid party header files
53 //------------------------------------------------------------------------------
54 
55 //------------------------------------------------------------------------------
56 // Include ConOpSys header files
57 //------------------------------------------------------------------------------
58 
59 #include "Command_Base.h"
60 
61 //------------------------------------------------------------------------------
62 // Include ConOpSys application header files
63 //------------------------------------------------------------------------------
64 
65 //!-----------------------------------------------------------------------------
66 //! @brief ConOpSys terminal command PROTOCOL class
67 //------------------------------------------------------------------------------
68 
70 {
71 
72  //----------------------------------------------------------------------------
73  // Public defines, methods and variables
74  //----------------------------------------------------------------------------
75 
76  public:
77 
78  //!-------------------------------------------------------------------------
79  //! @brief Class constructor method.
80  //! @note None
81  //! @param [in] *struct_Descriptor - Pointer to the command description
82  //! \par Override
83  //! Not allowed
84  //! @attention Don't call this method directly.
85  //! \par UML diagram
86  //! @dotfile TCommand_PROTOCOL__TCommand_PROTOCOL.dt
87  //--------------------------------------------------------------------------
88 
90 
91  //!-------------------------------------------------------------------------
92  //! @brief Execute command method
93  //! @note This method executes command specific functionality.
94  //! @param [in] *object_Protocol - Pointer to the communication link protocol
95  //! \par Override
96  //! Required
97  //! @attention None
98  //! \par UML diagram
99  //! @dotfile TCommand_PROTOCOL__Execute.dt
100  //--------------------------------------------------------------------------
101 
102  virtual VOID Execute( TProtocol_Base *object_Protocol );
103 
104  //----------------------------------------------------------------------------
105  // protected defines, methods and variables
106  //----------------------------------------------------------------------------
107 
108  protected:
109 
110  //----------------------------------------------------------------------------
111  // Private defines, methods and variables
112  //----------------------------------------------------------------------------
113 
114  private:
115 
116 };
117 
118 //------------------------------------------------------------------------------
119 // Export references to the objects
120 //------------------------------------------------------------------------------
121 
123 
124 //------------------------------------------------------------------------------
125 // End Of File
126 //------------------------------------------------------------------------------
ConOpSys command base class header file.
void VOID
Datatypesess datatype definition.
Definition: Defines.h:105
TCommand_PROTOCOL object_Command_PROTOCOL
ConOpSys terminal command base class.
Definition: Command_Base.h:86
TCommand_Descriptor * struct_Descriptor
Command descriptor storage.
Definition: Command_Base.h:208
ConOpSys terminal command PROTOCOL class.
Definition: System_Command_PROTOCOL.h:70
TCommand_PROTOCOL(TCommand_Descriptor *struct_Descriptor)
Class constructor method.
Definition: System_Command_PROTOCOL.cpp:84
virtual VOID Execute(TProtocol_Base *object_Protocol)
Execute command method.
Definition: System_Command_PROTOCOL.cpp:92
Definition: Protocol_Base.h:57
Command descriptor structure.
Definition: Command_Base.h:100