ConOpSys V2970  P004.07
ANVILEX control operating system
Function_Block_Sinus.h
Go to the documentation of this file.
1 //------------------------------------------------------------------------------
2 //! @file Function_Block_Sinus.h
3 //! @author ANVILEX GmbH
4 //! @version V1.0
5 //! @date 18.04.2016
6 //! @brief Sinus 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 // TFunction_Block_Sinus
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 "Function_Block_Base.h"
61 
62 //------------------------------------------------------------------------------
63 // Include ConOpSys application header files
64 //------------------------------------------------------------------------------
65 
66 //------------------------------------------------------------------------------
67 // Macros
68 //------------------------------------------------------------------------------
69 
70 //------------------------------------------------------------------------------
71 //! @brief Class declaration description
72 //------------------------------------------------------------------------------
73 
75 {
76 
77  //----------------------------------------------------------------------------
78  // Public defines, methods and variables
79  //----------------------------------------------------------------------------
80 
81  public:
82 
83  //!-------------------------------------------------------------------------
84  //! @brief Class constructor method.
85  //! @note None
86  //! \par Override
87  //! Not allowed
88  //! @attention Don't call this method directly.
89  //--------------------------------------------------------------------------
90 
92 
93  //!-------------------------------------------------------------------------
94  //! @brief Class destructor method.
95  //! @note None
96  //! \par Override
97  //! Not allowed
98  //! @attention Don't call this method directly.
99  //--------------------------------------------------------------------------
100 
101  virtual ~TFunction_Block_Sinus();
102 
103  //!-------------------------------------------------------------------------
104  //! @brief Function block initialisation method.
105  //! @note None
106  //! \par Override
107  //! Not allowed
108  //! @attention Don't call this method directly.
109  //--------------------------------------------------------------------------
110 
111  virtual VOID Init();
112 
113  //!-------------------------------------------------------------------------
114  //! @brief Function block execution method.
115  //! @note None
116  //! \par Override
117  //! Not allowed
118  //! @attention None
119  //--------------------------------------------------------------------------
120 
121  virtual VOID Execute();
122 
123  //--------------------------------------------------------------------------
124  // Function block parameter connectors
125  //--------------------------------------------------------------------------
126 
127  //--------------------------------------------------------------------------
128  // Function block input connectors
129  //--------------------------------------------------------------------------
130 
131  TBlock_Input_Connector object_f32_Theta; //!< Block input signal
132 
133  //--------------------------------------------------------------------------
134  // Function block output connectors
135  //--------------------------------------------------------------------------
136 
137  TBlock_Output_Connector object_f32_Sinus; //!< Block output signal
138 
139  //----------------------------------------------------------------------------
140  // Protected defines, methods and variables
141  //----------------------------------------------------------------------------
142 
143  protected:
144 
145  //----------------------------------------------------------------------------
146  // Private defines, methods and variables
147  //----------------------------------------------------------------------------
148 
149  private:
150 
151 };
152 
153 //------------------------------------------------------------------------------
154 // Export references to the objects
155 //------------------------------------------------------------------------------
156 
157 //------------------------------------------------------------------------------
158 // Export references to the functions
159 //------------------------------------------------------------------------------
160 
161 //------------------------------------------------------------------------------
162 // End Of File
163 //------------------------------------------------------------------------------
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_Sinus.h:75
TFunction_Block_Sinus()
Class constructor method.
Definition: Function_Block_Sinus.cpp:68
TBlock_Input_Connector object_f32_Theta
Block input signal.
Definition: Function_Block_Sinus.h:131
virtual ~TFunction_Block_Sinus()
Class destructor method.
Definition: Function_Block_Sinus.cpp:93
virtual VOID Init()
Function block initialisation method.
Definition: Function_Block_Sinus.cpp:103
TBlock_Output_Connector object_f32_Sinus
Block output signal.
Definition: Function_Block_Sinus.h:137
virtual VOID Execute()
Function block execution method.
Definition: Function_Block_Sinus.cpp:114