ConOpSys V2970  P004.07
ANVILEX control operating system
System_Command_COM0.h
Go to the documentation of this file.
1 //------------------------------------------------------------------------------
2 //! @file System_Command_COM0.h
3 //! @brief ConOpSys terminal system command COM0 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_COM0.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 // Protecting header files from mutual, recursive inclusion.
42 //------------------------------------------------------------------------------
43 
44 #pragma once
45 
46 //------------------------------------------------------------------------------
47 // Include standard libraries header files
48 //------------------------------------------------------------------------------
49 
50 //------------------------------------------------------------------------------
51 // Include thrid party header files
52 //------------------------------------------------------------------------------
53 
54 //------------------------------------------------------------------------------
55 // Include ConOpSys header files
56 //------------------------------------------------------------------------------
57 
58 #include "Command_Base.h"
59 
60 //------------------------------------------------------------------------------
61 // Include ConOpSys application header files
62 //------------------------------------------------------------------------------
63 
64 //! @brief ConOpSys terminal command COM0 class
66 {
67 
68  //----------------------------------------------------------------------------
69  // Public defines, methods and variables
70  //----------------------------------------------------------------------------
71 
72  public:
73 
74  //!-------------------------------------------------------------------------
75  //! @brief Class constructor method.
76  //! @note None
77  //! @param [in] *struct_Descriptor - Pointer to the command description
78  //! \par Override
79  //! Not allowed
80  //! @attention Don't call this method directly.
81  //! \par UML diagram
82  //! @dotfile TCommand_COM0__TCommand_COM0.dt
83  //--------------------------------------------------------------------------
84 
86 
87  //!-------------------------------------------------------------------------
88  //! @brief Execute command method
89  //! @note This method executes command specific functionality.
90  //! @param [in] *object_Protocol - Pointer to the communication link protocol
91  //! \par Override
92  //! Required
93  //! @attention None
94  //! \par UML diagram
95  //! @dotfile TCommand_COM0__Execute.dt
96  //--------------------------------------------------------------------------
97 
98  virtual VOID Execute( TProtocol_Base *object_Protocol );
99 
100  //----------------------------------------------------------------------------
101  // Protected defines, methods and variables
102  //----------------------------------------------------------------------------
103 
104  protected:
105 
106  //----------------------------------------------------------------------------
107  // Private defines, methods and variables
108  //----------------------------------------------------------------------------
109 
110  private:
111 
112 };
113 
114 //------------------------------------------------------------------------------
115 // Export references to the objects
116 //------------------------------------------------------------------------------
117 
118 // Test for communication port COM0 installed
119 #if ( COM0_MODULE_INSTALLED == (true) )
120 
122 
123 #endif
124 
125 //------------------------------------------------------------------------------
126 // End of file
127 //------------------------------------------------------------------------------
ConOpSys command base class header file.
void VOID
Datatypesess datatype definition.
Definition: Defines.h:105
TCommand_COM0 object_Command_COM0
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 COM0 class.
Definition: System_Command_COM0.h:66
TCommand_COM0(TCommand_Descriptor *struct_Descriptor)
Class constructor method.
Definition: System_Command_COM0.cpp:92
virtual VOID Execute(TProtocol_Base *object_Protocol)
Execute command method.
Definition: System_Command_COM0.cpp:100
Definition: Protocol_Base.h:57
Command descriptor structure.
Definition: Command_Base.h:100