ConOpSys V2970  P004.07
ANVILEX control operating system
Parameter_PARAMETER_DATABASE_USER.h
Go to the documentation of this file.
1 //------------------------------------------------------------------------------
2 //! @file Parameter_PARAMETER_DATABASE_USER.h
3 //! @author ANVILEX GmbH
4 //! @version V1.0
5 //! @date 04.05.2015
6 //! @brief Parameter database user parameter object header file.
7 //! @attention
8 //!
9 //! COPYRIGHT(C) 2015-2017 ANVILEX GmbH
10 //!
11 //! Redistribution and use in source and binary forms, with or without
12 //! modification, are permitted provided that the following conditions are met:
13 //!
14 //! 1. Redistributions of source code must retain the above copyright notice,
15 //! this list of conditions and the following disclaimer.
16 //!
17 //! 2. Redistributions in binary form must reproduce the above copyright notice,
18 //! this list of conditions and the following disclaimer in the documentation
19 //! and/or other materials provided with the distribution.
20 //!
21 //! 3. Neither the name of ANVILEX nor the names of its contributors may be
22 //! used to endorse or promote products derived from this software without
23 //! specific prior written permission.
24 //!
25 //! THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
26 //! AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 //! IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28 //! ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
29 //! LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30 //! CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31 //! SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32 //! INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33 //! CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34 //! ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35 //! POSSIBILITY OF SUCH DAMAGE.
36 //------------------------------------------------------------------------------
37 
38 //------------------------------------------------------------------------------
39 // Protecting header files from mutual, recursive inclusion.
40 //------------------------------------------------------------------------------
41 
42 #pragma once
43 
44 //------------------------------------------------------------------------------
45 // Include standard libraries header files
46 //------------------------------------------------------------------------------
47 
48 //------------------------------------------------------------------------------
49 // Include thrid party header files
50 //------------------------------------------------------------------------------
51 
52 //------------------------------------------------------------------------------
53 // Include ConOpSys header files
54 //------------------------------------------------------------------------------
55 
56 #include "Parameter_Base.h"
57 
58 //------------------------------------------------------------------------------
59 // Include ConOpSys application header files
60 //------------------------------------------------------------------------------
61 
62 //------------------------------------------------------------------------------
63 // Macros
64 //------------------------------------------------------------------------------
65 
66 //------------------------------------------------------------------------------
67 //! @brief PARAMETER_DATABASE_USER parameter class
68 //------------------------------------------------------------------------------
69 
71 {
72 
73  //----------------------------------------------------------------------------
74  // Public defines, methods and variables
75  //----------------------------------------------------------------------------
76 
77  public:
78 
79  //!-------------------------------------------------------------------------
80  //! @brief Parameter initialisation method.
81  //! @note None
82  //! @return None
83  //! \par Override
84  //! Not allowed
85  //! @attention Don't call this method directly.
86  //--------------------------------------------------------------------------
87 
88  virtual BOOL Init();
89 
90  //----------------------------------------------------------------------------
91  // Protected defines, methods and variables
92  //----------------------------------------------------------------------------
93 
94  protected:
95 
96  //----------------------------------------------------------------------------
97  // Private defines, methods and variables
98  //----------------------------------------------------------------------------
99 
100  private:
101 
102 };
103 
104 //------------------------------------------------------------------------------
105 // Export references to the objects
106 //------------------------------------------------------------------------------
107 
109 
110 //------------------------------------------------------------------------------
111 // Export references to the functions
112 //------------------------------------------------------------------------------
113 
114 //------------------------------------------------------------------------------
115 // End Of File
116 //------------------------------------------------------------------------------
int BOOL
Boolean datatype definition.
Definition: Defines.h:124
ConOpSys parameter base class header file.
TParameter_PARAMETER_DATABASE_USER object_Parameter_PARAMETER_DATABASE_USER
Definition: Parameter_PARAMETER_DATABASE_USER.cpp:62
Parameter base class.
Definition: Parameter_Base.h:60
PARAMETER_DATABASE_USER parameter class.
Definition: Parameter_PARAMETER_DATABASE_USER.h:71
virtual BOOL Init()
Parameter initialisation method.
Definition: Parameter_PARAMETER_DATABASE_USER.cpp:98