ConOpSys V2970  P004.07
ANVILEX control operating system
Function_Block_Toggle_Button_Controller.h
Go to the documentation of this file.
1 //------------------------------------------------------------------------------
2 //! @file Function_Block_Toggle_Button_Controller.h
3 //! @author ANVILEX GmbH
4 //! @version V1.0
5 //! @date 18.05.2016
6 //! @brief Toggle button controller class header file.
7 //! @attention
8 //!
9 //! COPYRIGHT(C) 2020 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 // Class declarations
68 //------------------------------------------------------------------------------
69 
70 //! @brief Function block TFunction_Block_Toggle_Button_Controller class declaration
72 {
73 
74  //----------------------------------------------------------------------------
75  // Public defines, methods and variables
76  //----------------------------------------------------------------------------
77 
78  public:
79 
80  //!-------------------------------------------------------------------------
81  //! @brief Class constructor method.
82  //! @note None
83  //! \par Override
84  //! Not allowed
85  //! @attention Don't call this method directly.
86  //--------------------------------------------------------------------------
87 
89 
90  //!-------------------------------------------------------------------------
91  //! @brief Class destructor method.
92  //! @note None
93  //! \par Override
94  //! Not allowed
95  //! @attention Don't call this method directly.
96  //--------------------------------------------------------------------------
97 
99 
100  //!-------------------------------------------------------------------------
101  //! @brief Function block initialisation method.
102  //! @note None
103  //! \par Override
104  //! Not allowed
105  //! @attention Don't call this method directly.
106  //--------------------------------------------------------------------------
107 
108  virtual VOID Init();
109 
110  //!-------------------------------------------------------------------------
111  //! @brief Function block execution method.
112  //! @note None
113  //! \par Override
114  //! Not allowed
115  //! @attention None
116  //--------------------------------------------------------------------------
117 
118  virtual VOID Execute();
119 
120  //!-------------------------------------------------------------------------
121  //! @brief Send information about Function block over communication link protocol
122  //! @note This method sends information about Function block over specified communication link protocol.
123  //! @param [in] *object_Protocol - Pointer to the communication link protocol
124  //! @return None
125  //! \par Override
126  //! Not allowed
127  //! @attention None
128  //--------------------------------------------------------------------------
129 
130  virtual VOID Send_Information( TProtocol_Base *object_Protocol );
131 
132  //--------------------------------------------------------------------------
133  // Function block parameter connectors
134  //--------------------------------------------------------------------------
135 
136  //--------------------------------------------------------------------------
137  // Function block input connectors
138  //--------------------------------------------------------------------------
139 
140  TBlock_Input_Connector object_bool_Enable_Input; //!< Block enable input signal (active high)
141  TBlock_Input_Connector object_bool_Toggle_Input; //!< Block toggle input signal (active high)
142  TBlock_Input_Connector object_bool_Emergency_Stop_Input; //!< Block emergency stop input signal (active low)
144 
145  //--------------------------------------------------------------------------
146  // Function block output connectors
147  //--------------------------------------------------------------------------
148 
149  TBlock_Output_Connector object_bool_Output; //!< Block output signal
150 
151  //----------------------------------------------------------------------------
152  // Protected defines, methods and variables
153  //----------------------------------------------------------------------------
154 
155  protected:
156 
157  //----------------------------------------------------------------------------
158  // Private defines, methods and variables
159  //----------------------------------------------------------------------------
160 
161  private:
162 
163  BOOL bool_State; //!< Internal state
164  BOOL bool_Previous_Output_State; //!< Previous output state
165  BOOL bool_New_Input_State; //!< New input state
166  BOOL bool_Previous_Input_State; //!< Previous input state
167 
168 };
169 
170 //------------------------------------------------------------------------------
171 // End of file
172 //------------------------------------------------------------------------------
int BOOL
Boolean datatype definition.
Definition: Defines.h:124
void VOID
Datatypesess datatype definition.
Definition: Defines.h:105
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
Function block TFunction_Block_Toggle_Button_Controller class declaration.
Definition: Function_Block_Toggle_Button_Controller.h:72
virtual VOID Send_Information(TProtocol_Base *object_Protocol)
Send information about Function block over communication link protocol.
Definition: Function_Block_Toggle_Button_Controller.cpp:204
BOOL bool_Previous_Output_State
Previous output state.
Definition: Function_Block_Toggle_Button_Controller.h:164
BOOL bool_Previous_Input_State
Previous input state.
Definition: Function_Block_Toggle_Button_Controller.h:166
TBlock_Output_Connector object_bool_Output
Block output signal.
Definition: Function_Block_Toggle_Button_Controller.h:149
BOOL bool_New_Input_State
New input state.
Definition: Function_Block_Toggle_Button_Controller.h:165
TFunction_Block_Toggle_Button_Controller()
Class constructor method.
Definition: Function_Block_Toggle_Button_Controller.cpp:66
virtual VOID Init()
Function block initialisation method.
Definition: Function_Block_Toggle_Button_Controller.cpp:108
TBlock_Input_Connector object_bool_Enable_Input
Block enable input signal (active high)
Definition: Function_Block_Toggle_Button_Controller.h:140
TBlock_Input_Connector object_bool_Toggle_Input
Block toggle input signal (active high)
Definition: Function_Block_Toggle_Button_Controller.h:141
BOOL bool_State
Internal state.
Definition: Function_Block_Toggle_Button_Controller.h:163
virtual VOID Execute()
Function block execution method.
Definition: Function_Block_Toggle_Button_Controller.cpp:121
TBlock_Input_Connector object_bool_Internal_Stop_Input
Internal stop signal.
Definition: Function_Block_Toggle_Button_Controller.h:143
TBlock_Input_Connector object_bool_Emergency_Stop_Input
Block emergency stop input signal (active low)
Definition: Function_Block_Toggle_Button_Controller.h:142
virtual ~TFunction_Block_Toggle_Button_Controller()
Class destructor method.
Definition: Function_Block_Toggle_Button_Controller.cpp:100
Definition: Protocol_Base.h:57