ConOpSys V2970  P004.07
ANVILEX control operating system
Parameter_CAN_OPEN_COB_ID_EMCY.h
Go to the documentation of this file.
1 //------------------------------------------------------------------------------
2 //! @file Parameter_CAN_OPEN_COB_ID_EMCY.h
3 //! @brief object header file.
4 //! @note Automatic generated file.
5 //! @copyright ANVILEX LLC
6 //! @attention No special attention requered.
7 //! $HeadURL: $
8 //! $Revision: $
9 //! $Date: $
10 //! $Author: $
11 //
12 // Copyright(C) 2020 ANVILEX LLC
13 //
14 // Redistribution and use in source and binary forms, with or without
15 // modification, are permitted provided that the following conditions are met:
16 //
17 // 1. Redistributions of source code must retain the above copyright notice,
18 // this list of conditions and the following disclaimer.
19 //
20 // 2. Redistributions in binary form must reproduce the above copyright notice,
21 // this list of conditions and the following disclaimer in the documentation
22 // and/or other materials provided with the distribution.
23 //
24 // 3. Neither the name of ANVILEX nor the names of its contributors may be
25 // used to endorse or promote products derived from this software without
26 // specific prior written permission.
27 //
28 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
29 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
30 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
31 // ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
32 // LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
33 // CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
34 // SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
35 // INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
36 // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
37 // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
38 // POSSIBILITY OF SUCH DAMAGE.
39 //
40 //------------------------------------------------------------------------------
41 
42 //------------------------------------------------------------------------------
43 // Protecting header files from mutual, recursive inclusion.
44 //------------------------------------------------------------------------------
45 
46 #pragma once
47 
48 //------------------------------------------------------------------------------
49 // Include standard libraries header files
50 //------------------------------------------------------------------------------
51 
52 //------------------------------------------------------------------------------
53 // Include thrid party header files
54 //------------------------------------------------------------------------------
55 
56 //------------------------------------------------------------------------------
57 // Include ConOpSys header files
58 //------------------------------------------------------------------------------
59 
60 #include "System_Resource.h"
61 #include "Parameter_Base.h"
62 
63 //------------------------------------------------------------------------------
64 // Macros
65 //------------------------------------------------------------------------------
66 
67 //------------------------------------------------------------------------------
68 // Class definitions
69 //------------------------------------------------------------------------------
70 
71 //! @brief class
73 {
74 
75  //----------------------------------------------------------------------------
76  // Public defines, methods and variables
77  //----------------------------------------------------------------------------
78 
79  public:
80 
81  //!-------------------------------------------------------------------------
82  //! @brief Parameter initialisation method.
83  //! @note None
84  //! @return BOOL - Initialisation status
85  //! @retval true - Initialisation successed
86  //! @retval false - Initialisation failed
87  //! \par Override
88  //! Not allowed
89  //! @attention Don't call this method directly.
90  //--------------------------------------------------------------------------
91 
92  virtual BOOL Init();
93 
94  //!-------------------------------------------------------------------------
95  //! @brief Parameter post write data processing method.
96  //! @note None
97  //! @return BOOL - Post write data processing status
98  //! @retval true - Post write data processing successed
99  //! @retval false - Post write data processing failed
100  //! \par Override
101  //! Not allowed
102  //! @attention Don't call this method directly.
103  //--------------------------------------------------------------------------
104 
106 
107  //!-------------------------------------------------------------------------
108  //! @brief Parameter pre read data processing method.
109  //! @note None
110  //! @return BOOL - Pre read data processing status
111  //! @retval true - Pre read data processing successed
112  //! @retval false - Pre read data processing failed
113  //! \par Override
114  //! Not allowed
115  //! @attention Don't call this method directly.
116  //--------------------------------------------------------------------------
117 
118  virtual BOOL Pre_Read_Data_Processing();
119 
120  //----------------------------------------------------------------------------
121  // Protected defines, methods and variables
122  //----------------------------------------------------------------------------
123 
124  protected:
125 
126  //----------------------------------------------------------------------------
127  // Private defines, methods and variables
128  //----------------------------------------------------------------------------
129 
130  private:
131 
132 };
133 
134 //------------------------------------------------------------------------------
135 // Export references to the parameter objects
136 //------------------------------------------------------------------------------
137 
139 
140 //------------------------------------------------------------------------------
141 // End Of File
142 //------------------------------------------------------------------------------
143 
int BOOL
Boolean datatype definition.
Definition: Defines.h:124
ConOpSys parameter base class header file.
TParameter_CAN_OPEN_COB_ID_EMCY object_Parameter_CAN_OPEN_COB_ID_EMCY
Definition: Parameter_CAN_OPEN_COB_ID_EMCY.cpp:68
System resource header file.
Parameter base class.
Definition: Parameter_Base.h:60
class
Definition: Parameter_CAN_OPEN_COB_ID_EMCY.h:73
virtual BOOL Pre_Read_Data_Processing()
Parameter pre read data processing method.
Definition: Parameter_CAN_OPEN_COB_ID_EMCY.cpp:161
virtual BOOL Post_Write_Data_Processing()
Parameter post write data processing method.
Definition: Parameter_CAN_OPEN_COB_ID_EMCY.cpp:128
virtual BOOL Init()
Parameter initialisation method.
Definition: Parameter_CAN_OPEN_COB_ID_EMCY.cpp:102