ConOpSys V2970  P004.07
ANVILEX control operating system
LED_P014_51_CB.h
Go to the documentation of this file.
1 //------------------------------------------------------------------------------
2 //! @file LED_P014_51_CB.h
3 //! @brief Control board P015.27 LED hardware driver header file.
4 //! @attention No special attention requered.
5 //! @copyright (C) 2015-2020 ANVILEX LLC
6 //! $HeadURL: https://192.168.3.4:8443/svn/P004_07/ConOpSys/Hardware/P014_51_CB/LED_P014_51_CB.h $
7 //! $Revision: 2059 $
8 //! $Date: 2020-09-06 03:43:45 +0500 (So, 06 Sep 2020) $
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 ConOpSys header files
48 //------------------------------------------------------------------------------
49 
50 #include "System_Led_Base.h"
51 
52 //------------------------------------------------------------------------------
53 // Class definition
54 //------------------------------------------------------------------------------
55 
56 //! @brief P015.27 V1.0 control board system LED class
58 {
59 
60  //----------------------------------------------------------------------------
61  // Public defines, methods and variables
62  //----------------------------------------------------------------------------
63 
64  public:
65 
66  //--------------------------------------------------------------------------
67  // Public methods
68  //--------------------------------------------------------------------------
69 
70  //!-------------------------------------------------------------------------
71  //! @brief System LED initialisation method.
72  //! @note None
73  //! @return None
74  //! \par Override
75  //! Not allowed
76  //! @attention None
77  //--------------------------------------------------------------------------
78 
79  VOID Init();
80 
81  //!-------------------------------------------------------------------------
82  //! @brief System LED finalisation method.
83  //! @note None
84  //! @return None
85  //! \par Override
86  //! Not allowed
87  //! @attention None
88  //--------------------------------------------------------------------------
89 
90  VOID Done();
91 
92  //!-------------------------------------------------------------------------
93  //! @brief Method turns on the alarm LED.
94  //! @note None
95  //! @return None
96  //! \par Override
97  //! Not allowed
98  //! @attention None
99  //--------------------------------------------------------------------------
100 
101  virtual VOID Alarm_On();
102 
103  //!-------------------------------------------------------------------------
104  //! @brief Method turns off the alarm LED.
105  //! @note None
106  //! @return None
107  //! \par Override
108  //! Not allowed
109  //! @attention None
110  //--------------------------------------------------------------------------
111 
112  virtual VOID Alarm_Off();
113 
114  //!-------------------------------------------------------------------------
115  //! @brief Method toggle the alarm LED.
116  //! @note None
117  //! @return None
118  //! \par Override
119  //! Not allowed
120  //! @attention None
121  //--------------------------------------------------------------------------
122 
123  virtual VOID Alarm_Toggle();
124 
125  //!-------------------------------------------------------------------------
126  //! @brief Method turns on the run LED.
127  //! @note None
128  //! @return None
129  //! \par Override
130  //! Not allowed
131  //! @attention None
132  //--------------------------------------------------------------------------
133 
134  virtual VOID Run_On();
135 
136  //!-------------------------------------------------------------------------
137  //! @brief Method turns off the run LED.
138  //! @note None
139  //! @return None
140  //! \par Override
141  //! Not allowed
142  //! @attention None
143  //--------------------------------------------------------------------------
144 
145  virtual VOID Run_Off();
146 
147  //!-------------------------------------------------------------------------
148  //! @brief Method toggle the run LED.
149  //! @note None
150  //! @return None
151  //! \par Override
152  //! Not allowed
153  //! @attention None
154  //--------------------------------------------------------------------------
155 
156  virtual VOID Run_Toggle();
157 
158  //!-------------------------------------------------------------------------
159  //! @brief Method turns on the ready LED.
160  //! @note None
161  //! @return None
162  //! \par Override
163  //! Not allowed
164  //! @attention None
165  //--------------------------------------------------------------------------
166 
167  virtual VOID Ready_On();
168 
169  //!-------------------------------------------------------------------------
170  //! @brief Method turns off the ready LED.
171  //! @note None
172  //! @return None
173  //! \par Override
174  //! Not allowed
175  //! @attention None
176  //--------------------------------------------------------------------------
177 
178  virtual VOID Ready_Off();
179 
180  //!-------------------------------------------------------------------------
181  //! @brief Method toggle the ready LED.
182  //! @note None
183  //! @return None
184  //! \par Override
185  //! Not allowed
186  //! @attention None
187  //--------------------------------------------------------------------------
188 
189  virtual VOID Ready_Toggle();
190 
191  //!-------------------------------------------------------------------------
192  //! @brief Method turns on the error LED.
193  //! @note None
194  //! @return None
195  //! \par Override
196  //! Not allowed
197  //! @attention None
198  //--------------------------------------------------------------------------
199 
200  virtual VOID Error_On();
201 
202  //!-------------------------------------------------------------------------
203  //! @brief Method turns off the error LED.
204  //! @note None
205  //! @return None
206  //! \par Override
207  //! Not allowed
208  //! @attention None
209  //--------------------------------------------------------------------------
210 
211  virtual VOID Error_Off();
212 
213  //!-------------------------------------------------------------------------
214  //! @brief Method toggle the error LED.
215  //! @note None
216  //! @return None
217  //! \par Override
218  //! Not allowed
219  //! @attention None
220  //--------------------------------------------------------------------------
221 
222  virtual VOID Error_Toggle();
223 
224  //!-------------------------------------------------------------------------
225  //! @brief Method return state of alarm LED.
226  //! @note None
227  //! @return BOOL - Alarm LED state
228  //! @retval false - Alarm LED is off
229  //! @retval true - Alarm LED is on
230  //! \par Override
231  //! Not allowed
232  //! @attention None
233  //--------------------------------------------------------------------------
234 
235  virtual BOOL Get_Alarm_LED_State();
236 
237  //!-------------------------------------------------------------------------
238  //! @brief Method return state of run LED.
239  //! @note None
240  //! @return BOOL - Run LED state
241  //! @retval false - Run LED is off
242  //! @retval true - Run LED is on
243  //! \par Override
244  //! Not allowed
245  //! @attention None
246  //--------------------------------------------------------------------------
247 
248  virtual BOOL Get_Run_LED_State();
249 
250  //!-------------------------------------------------------------------------
251  //! @brief Method return state of ready LED.
252  //! @note None
253  //! @return BOOL - Ready LED state
254  //! @retval false - Ready LED is off
255  //! @retval true - Ready LED is on
256  //! \par Override
257  //! Not allowed
258  //! @attention None
259  //--------------------------------------------------------------------------
260 
261  virtual BOOL Get_Ready_LED_State();
262 
263  //!-------------------------------------------------------------------------
264  //! @brief Method return state of error LED.
265  //! @note None
266  //! @return BOOL - Error LED state
267  //! @retval false - Error LED is off
268  //! @retval true - Error LED is on
269  //! \par Override
270  //! Not allowed
271  //! @attention None
272  //--------------------------------------------------------------------------
273 
274  virtual BOOL Get_Error_LED_State();
275 
276  //----------------------------------------------------------------------------
277  // Protected defines, methods and variables
278  //----------------------------------------------------------------------------
279 
280  protected:
281 
282  //----------------------------------------------------------------------------
283  // Private defines, methods and variables
284  //----------------------------------------------------------------------------
285 
286  private:
287 
288 };
289 
290 //------------------------------------------------------------------------------
291 // End of file
292 //------------------------------------------------------------------------------
int BOOL
Boolean datatype definition.
Definition: Defines.h:124
void VOID
Datatypesess datatype definition.
Definition: Defines.h:105
System LED base class header file.
P015.27 V1.0 control board system LED class.
Definition: LED_P014_51_CB.h:58
virtual BOOL Get_Error_LED_State()
Method return state of error LED.
Definition: LED_P014_51_CB.cpp:439
virtual VOID Alarm_Toggle()
Method toggle the alarm LED.
Definition: LED_P014_51_CB.cpp:283
virtual VOID Alarm_Off()
Method turns off the alarm LED.
Definition: LED_P014_51_CB.cpp:271
virtual VOID Error_Toggle()
Method toggle the error LED.
Definition: LED_P014_51_CB.cpp:391
virtual VOID Error_Off()
Method turns off the error LED.
Definition: LED_P014_51_CB.cpp:379
virtual VOID Ready_On()
Method turns on the ready LED.
Definition: LED_P014_51_CB.cpp:331
virtual VOID Error_On()
Method turns on the error LED.
Definition: LED_P014_51_CB.cpp:367
virtual VOID Ready_Off()
Method turns off the ready LED.
Definition: LED_P014_51_CB.cpp:343
virtual BOOL Get_Ready_LED_State()
Method return state of ready LED.
Definition: LED_P014_51_CB.cpp:427
virtual BOOL Get_Alarm_LED_State()
Method return state of alarm LED.
Definition: LED_P014_51_CB.cpp:403
virtual VOID Alarm_On()
Method turns on the alarm LED.
Definition: LED_P014_51_CB.cpp:259
virtual VOID Run_On()
Method turns on the run LED.
Definition: LED_P014_51_CB.cpp:295
virtual BOOL Get_Run_LED_State()
Method return state of run LED.
Definition: LED_P014_51_CB.cpp:415
virtual VOID Ready_Toggle()
Method toggle the ready LED.
Definition: LED_P014_51_CB.cpp:355
VOID Done()
System LED finalisation method.
Definition: LED_P014_51_CB.cpp:166
virtual VOID Run_Off()
Method turns off the run LED.
Definition: LED_P014_51_CB.cpp:307
VOID Init()
System LED initialisation method.
Definition: LED_P014_51_CB.cpp:68
virtual VOID Run_Toggle()
Method toggle the run LED.
Definition: LED_P014_51_CB.cpp:319
Base LED manager class.
Definition: System_LED_Base.h:62