ConOpSys V2970  P004.07
ANVILEX control operating system
Function_Block_RS_Flip_Flop_BOOL.h
Go to the documentation of this file.
1 //------------------------------------------------------------------------------
2 //! @file Function_Block_Flip_Flop_BOOL.h
3 //! @author ANVILEX GmbH
4 //! @version V1.0
5 //! @date 18.05.2016
6 //! @brief Flip-Flop class header file.
7 //! @attention
8 //!
9 //! COPYRIGHT(C) 2016 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, mathods 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  virtual VOID Init();
108 
109  //!-------------------------------------------------------------------------
110  //! @brief Function block execution method.
111  //! @note None
112  //! \par Override
113  //! Not allowed
114  //! @attention None
115  //--------------------------------------------------------------------------
116 
117  virtual VOID Execute();
118 
119  //--------------------------------------------------------------------------
120  // Function block parameter connectors
121  //--------------------------------------------------------------------------
122 
123  //! @brief Block flip-flop initial state signal
125 
126  //--------------------------------------------------------------------------
127  // Function block input connectors
128  //--------------------------------------------------------------------------
129 
130  //! @brief Block flip-flop set input signal
132 
133  //! @brief Block flip-flop reset input signal
135 
136  //--------------------------------------------------------------------------
137  // Function block output connectors
138  //--------------------------------------------------------------------------
139 
140  //! @brief Block output signal
142 
143  //----------------------------------------------------------------------------
144  // Protected defines, mathods and variables
145  //----------------------------------------------------------------------------
146 
147  protected:
148 
149  //----------------------------------------------------------------------------
150  // Private defines, mathods and variables
151  //----------------------------------------------------------------------------
152 
153  private:
154 
155  //! @brief Internal flip flop state
156  BOOL bool_State = (BOOL)false;
157 
158 };
159 
160 //------------------------------------------------------------------------------
161 // End of file
162 //------------------------------------------------------------------------------
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
Class declaration description.
Definition: Function_Block_RS_Flip_Flop_BOOL.h:71
TBlock_Output_Connector object_bool_Output
Block output signal.
Definition: Function_Block_RS_Flip_Flop_BOOL.h:141
TFunction_Block_RS_Flip_Flop_BOOL()
Class constructor method.
Definition: Function_Block_RS_Flip_Flop_BOOL.cpp:66
TBlock_Input_Connector object_bool_Set_Input
Block flip-flop set input signal.
Definition: Function_Block_RS_Flip_Flop_BOOL.h:131
BOOL bool_State
Internal flip flop state.
Definition: Function_Block_RS_Flip_Flop_BOOL.h:156
virtual ~TFunction_Block_RS_Flip_Flop_BOOL()
Class destructor method.
Definition: Function_Block_RS_Flip_Flop_BOOL.cpp:94
virtual VOID Execute()
Function block execution method.
Definition: Function_Block_RS_Flip_Flop_BOOL.cpp:114
TBlock_Input_Connector object_bool_Initial_State
Block flip-flop initial state signal.
Definition: Function_Block_RS_Flip_Flop_BOOL.h:124
virtual VOID Init()
Function block initialisation method.
Definition: Function_Block_RS_Flip_Flop_BOOL.cpp:102
TBlock_Input_Connector object_bool_Reset_Input
Block flip-flop reset input signal.
Definition: Function_Block_RS_Flip_Flop_BOOL.h:134