ConOpSys V2970  P004.07
ANVILEX control operating system
Function_Block_PI_Regulator_F32_T1.h
Go to the documentation of this file.
1 //------------------------------------------------------------------------------
2 //! @file Function_Block_PI_Regulator_F32_T1.h
3 //! @author ANVILEX GmbH
4 //! @version V1.0
5 //! @date 08.03.2022
6 //! @brief PI regulator class header file.
7 //! @attention
8 //!
9 //! COPYRIGHT(C) 2015-2022 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 "Function_Block_Base.h"
57 
58 //------------------------------------------------------------------------------
59 // Include ConOpSys application header files
60 //------------------------------------------------------------------------------
61 
62 //------------------------------------------------------------------------------
63 // Macros
64 //------------------------------------------------------------------------------
65 
66 //------------------------------------------------------------------------------
67 //! @brief Class declaration description
68 //------------------------------------------------------------------------------
69 
71 {
72 
73  //----------------------------------------------------------------------------
74  // Public defines, methods and variables
75  //----------------------------------------------------------------------------
76 
77  public:
78 
79  //!-------------------------------------------------------------------------
80  //! @brief Class constructor method.
81  //! @note None
82  //! \par Override
83  //! Not allowed
84  //! @attention Don't call this method directly.
85  //--------------------------------------------------------------------------
86 
88 
89  //!-------------------------------------------------------------------------
90  //! @brief Class destructor method.
91  //! @note None
92  //! \par Override
93  //! Not allowed
94  //! @attention Don't call this method directly.
95  //--------------------------------------------------------------------------
96 
98 
99  //!-------------------------------------------------------------------------
100  //! @brief Function block initialisation method.
101  //! @note None
102  //! \par Override
103  //! Not allowed
104  //! @attention Don't call this method directly.
105  //--------------------------------------------------------------------------
106 
107  VOID Init();
108 
109  //!-------------------------------------------------------------------------
110  //! @brief Function block cyclic execution method.
111  //! @note None
112  //! \par Override
113  //! Not allowed
114  //! @attention Don't call this method directly.
115  //--------------------------------------------------------------------------
116 
117  virtual VOID Execute();
118 
119  //!-------------------------------------------------------------------------
120  //! @brief Send information about Function block over communication link protocol
121  //! @note This method sends information about Function block over specified communication link protocol.
122  //! @param [in] *object_Protocol - Pointer to the communication link protocol
123  //! @return None
124  //! \par Override
125  //! Not allowed
126  //! @attention None
127  //--------------------------------------------------------------------------
128 
129  virtual VOID Send_Information( TProtocol_Base *object_Protocol );
130 
131  //--------------------------------------------------------------------------
132  // Function block parameter connectors
133  //--------------------------------------------------------------------------
134 
135  //! @brief Propotrional gain parameter
137 
138  //! @brief Integral gain parameter
140 
141  //! @brief Integrator positive limit parameter
143 
144  //! @brief Integrator negative limit parameter
146 
147  //! @brief Output positive limit parameter
149 
150  //! @brief Output negative limit parameter
152 
153  //! @brief Sample time parameter
155 
156  //--------------------------------------------------------------------------
157  // Block input signal signals
158  //--------------------------------------------------------------------------
159 
160  //! @brief Setpoint signal input
162 
163  //! @brief Feedback signal input
165 
166  //! @brief Enable signal input
168 
169  //! @brief Reset signal input
171 
172  //--------------------------------------------------------------------------
173  // Function block output connectors
174  //--------------------------------------------------------------------------
175 
176  //! @brief Error signal output
178 
179  //! @brief PI regulator block output
181 
182  //----------------------------------------------------------------------------
183  // Protected defines, methods and variables
184  //----------------------------------------------------------------------------
185 
186  protected:
187 
188  //----------------------------------------------------------------------------
189  // Private defines, methods and variables
190  //----------------------------------------------------------------------------
191 
192  private:
193 
194  //--------------------------------------------------------------------------
195  // Private variables
196  //--------------------------------------------------------------------------
197 
198  //! @brief Proportional part
200 
201  //! @brief Integral part
203 
204 };
205 
206 //------------------------------------------------------------------------------
207 // End of file
208 //------------------------------------------------------------------------------
void VOID
Datatypesess datatype definition.
Definition: Defines.h:105
float F32
IEEE-754 32-Bit single presession floating point numbers datatype defenition.
Definition: Defines.h:324
Function block base class header file.
Function block input connector class.
Definition: Block_Input_Connector.h:83
Function block output connector class.
Definition: Block_Output_Connector.h:59
Function block base class for device.
Definition: Function_Block_Base.h:96
Class declaration description.
Definition: Function_Block_PI_Regulator_F32_T1.h:71
TBlock_Output_Connector object_f32_Output
PI regulator block output.
Definition: Function_Block_PI_Regulator_F32_T1.h:180
TBlock_Input_Connector object_f32_Integrator_Negative_Limit
Integrator negative limit parameter.
Definition: Function_Block_PI_Regulator_F32_T1.h:145
TBlock_Input_Connector object_f32_Feedback
Feedback signal input.
Definition: Function_Block_PI_Regulator_F32_T1.h:164
virtual VOID Send_Information(TProtocol_Base *object_Protocol)
Send information about Function block over communication link protocol.
Definition: Function_Block_PI_Regulator_F32_T1.cpp:281
TBlock_Output_Connector object_f32_Error
Error signal output.
Definition: Function_Block_PI_Regulator_F32_T1.h:177
TBlock_Input_Connector object_f32_Output_Positive_Limit
Output positive limit parameter.
Definition: Function_Block_PI_Regulator_F32_T1.h:148
TBlock_Input_Connector object_f32_Integrator_Positive_Limit
Integrator positive limit parameter.
Definition: Function_Block_PI_Regulator_F32_T1.h:142
virtual ~TFunction_Block_PI_Regulator_F32_T1()
Class destructor method.
Definition: Function_Block_PI_Regulator_F32_T1.cpp:103
TBlock_Input_Connector object_bool_Reset
Reset signal input.
Definition: Function_Block_PI_Regulator_F32_T1.h:170
TFunction_Block_PI_Regulator_F32_T1()
Class constructor method.
Definition: Function_Block_PI_Regulator_F32_T1.cpp:66
TBlock_Input_Connector object_f32_Ki
Integral gain parameter.
Definition: Function_Block_PI_Regulator_F32_T1.h:139
virtual VOID Execute()
Function block cyclic execution method.
Definition: Function_Block_PI_Regulator_F32_T1.cpp:143
F32 f32_Proportional
Proportional part.
Definition: Function_Block_PI_Regulator_F32_T1.h:199
VOID Init()
Function block initialisation method.
Definition: Function_Block_PI_Regulator_F32_T1.cpp:111
TBlock_Input_Connector object_bool_Enable
Enable signal input.
Definition: Function_Block_PI_Regulator_F32_T1.h:167
TBlock_Input_Connector object_f32_Kp
Propotrional gain parameter.
Definition: Function_Block_PI_Regulator_F32_T1.h:136
TBlock_Input_Connector object_f32_Output_Negative_Limit
Output negative limit parameter.
Definition: Function_Block_PI_Regulator_F32_T1.h:151
TBlock_Input_Connector object_f32_Sample_Time
Sample time parameter.
Definition: Function_Block_PI_Regulator_F32_T1.h:154
F32 f32_Integral
Integral part.
Definition: Function_Block_PI_Regulator_F32_T1.h:202
TBlock_Input_Connector object_f32_Setpoint
Setpoint signal input.
Definition: Function_Block_PI_Regulator_F32_T1.h:161
Definition: Protocol_Base.h:57