GM6000 Digital Heater Controller Branch: main
SDX-1330
Fsm_.h
Go to the documentation of this file.
1/*-----------------------------------------------------------------------------
2* This file is part of the Colony.Core Project. The Colony.Core Project is an
3* open source project with a BSD type of licensing agreement. See the license
4* agreement (license.txt) in the top/ directory or on the Internet at
5* http://integerfox.com/colony.core/license.txt
6*
7* Copyright (c) 2014-2020 John T. Taylor
8*
9* Redistributions of the source code must retain the above copyright notice.
10*----------------------------------------------------------------------------*/
11/** @file */
12
13/* Command line options: -p CADIFRA -doxygen -o Fsm -l cppx -Trace Fsm.cdd */
14/* This file is generated from Fsm.cdd - do not edit manually */
15/* Generated on: Version 6.0.2.3601 */
16
17
18#ifndef FSM_AJAX_HEATING_SUPERVISOR_H
19#define FSM_AJAX_HEATING_SUPERVISOR_H
20
21/** \class Ajax::Heating::Supervisor::Fsm
22
23Here is the graph that shows the state machine this class implements
24
25\dot
26digraph G {
27rankdir=TB;
28bgcolor=transparent;
29node[fontsize=14 shape=box];
30edge[fontsize=14; arrowsize=0.7];
31compound=true;
32remincross=true;
33nodesep=0.5;
34ranksep=0.5;
35structOff->structFailedSafeOff[minlen=1 label=<evHiTemp&#47; <br ALIGN="LEFT"/>fanOn();> color=black, fontname=Arial; fontsize=14, fontcolor=black]; // (B)Off FailedSafeOff
36structFailedSafeOff->structOff[minlen=1 label=<evSafeTemp&#47; <br ALIGN="LEFT"/>allOff();> color=black, fontname=Arial; fontsize=14, fontcolor=black]; // (B)FailedSafeOff Off
37structOff -> structHeating[minlen=1 labeldistance=2.0 , label=<evEnabled> color=black, fontname=Arial; fontsize=14, fontcolor=black lhead=clusterOn];// (D4)Off On
38structDefaultOn->structOff[minlen=1 labeldistance=2.0 , headlabel=<evDisabled&#47; <br ALIGN="LEFT"/>allOff();> color=black, fontname=Arial; fontsize=14, fontcolor=black ltail=clusterOn];// (I1)On structOff
39structHeating->structWaitingForSensor[minlen=1 label=<evNoTempSensor&#47; <br ALIGN="LEFT"/>allOff();> color=black, fontname=Arial; fontsize=14, fontcolor=black]; // (B)Heating WaitingForSensor
40structWaitingForSensor->structHeating[minlen=1 label=<evSensorAvailable> color=black, fontname=Arial; fontsize=14, fontcolor=black]; // (B)WaitingForSensor Heating
41struct__C0->structWaitingForSensor[minlen=1 label=<&#91;!isSensorAvailable()&#93;&#47; <br ALIGN="LEFT"/>allOff(...> color=black, fontname=Arial; fontsize=14, fontcolor=black]; // (B)__C0 WaitingForSensor
42struct__C0->structHeating[minlen=1 label=<&#91;else&#93;> color=black, fontname=Arial; fontsize=14, fontcolor=black]; // (B)__C0 Heating
43structFailedSafeOff->structFailedSafeOn[minlen=1 label=<evEnabled> color=black, fontname=Arial; fontsize=14, fontcolor=black]; // (B)FailedSafeOff FailedSafeOn
44structDefaultOn->structFailedSafeOn[minlen=1 labeldistance=2.0 , headlabel=<evHiTemp&#47; <br ALIGN="LEFT"/>heatOff();> color=black, fontname=Arial; fontsize=14, fontcolor=black ltail=clusterOn];// (I1)On structFailedSafeOn
45structDefaultOn->struct__C0[minlen=1 label=< > fontname=Arial; fontsize=14, style=dotted]; // (A)
46structFailedSafeOn->structFailedSafeOff[minlen=1 label=<evDisabled> color=black, fontname=Arial; fontsize=14, fontcolor=black]; // (B)FailedSafeOn FailedSafeOff
47structFailedSafeOn -> structHeating[minlen=1 labeldistance=2.0 , label=<evSafeTemp> color=black, fontname=Arial; fontsize=14, fontcolor=black lhead=clusterOn];// (D4)FailedSafeOn On
48structDefaultroot->structOff[minlen=1 label=< > fontname=Arial; fontsize=14, style=dotted]; // (A)
49
50structOff[margin="0.4,0.08" penwidth="1" style="rounded" BORDER="1" color="black" fontname=Arial; fontsize=14 label=< <TABLE STYLE="rounded" BORDER="0" CELLBORDER="0">
51<TR><TD PORT="NW"></TD><TD PORT="N"></TD><TD PORT="NE"></TD></TR>
52<TR><TD PORT="W"></TD> <TD BORDER="1" SIDES="B">Off</TD><TD PORT="E"></TD></TR>
53<TR><TD PORT="SW"></TD><TD PORT="S"></TD><TD PORT="SE"></TD></TR>
54</TABLE> >];
55
56
57structFailedSafeOff[margin="0.4,0.08" penwidth="1" style="rounded" BORDER="1" color="black" fontname=Arial; fontsize=14 label=< <TABLE STYLE="rounded" BORDER="0" CELLBORDER="0">
58<TR><TD PORT="NW"></TD><TD PORT="N"></TD><TD PORT="NE"></TD></TR>
59<TR><TD PORT="W"></TD> <TD BORDER="1" SIDES="B">FailedSafeOff</TD><TD PORT="E"></TD></TR>
60<TR><TD PORT="SW"></TD><TD PORT="S"></TD><TD PORT="SE"></TD></TR>
61</TABLE> >];
62
63
64
65
66subgraph "cluster0"{ style=invis;label=""
67subgraph "cluster1"{ style=invis;label=""
68subgraph "cluster2"{ style=invis;label=""
69subgraph "cluster3"{ style=invis;label=""
70subgraph "cluster4"{ style=invis;label=""
71subgraph "cluster5"{ style=invis;label=""
72subgraph "cluster6"{ style=invis;label=""
73subgraph "cluster7"{ style=invis;label=""
74subgraph "clusterOn"{ margin=10 fontname=Arial; fontsize=14; fontsize=14
75color=black; style=rounded;
76 label=< <TABLE BORDER="0" ><TR><TD PORT="W"></TD><TD PORT="N"> On </TD><TD PORT="E"></TD></TR><HR/><TR><TD> </TD></TR>
77</TABLE> >;
78
79structHeating[margin="0.4,0.08" penwidth="1" style="rounded" BORDER="1" color="black" fontname=Arial; fontsize=14 label=< <TABLE STYLE="rounded" BORDER="0" CELLBORDER="0">
80<TR><TD PORT="NW"></TD><TD PORT="N"></TD><TD PORT="NE"></TD></TR>
81<TR><TD PORT="W"></TD> <TD BORDER="1" SIDES="B">Heating</TD><TD PORT="E"></TD></TR>
82<TR><TD COLSPAN="3" ALIGN="LEFT">Do:<br ALIGN="LEFT"/>runHeatingAlgo();<br ALIGN="LEFT"/></TD></TR>
83<TR><TD PORT="SW"></TD><TD PORT="S"></TD><TD PORT="SE"></TD></TR>
84</TABLE> >];
85
86
87structWaitingForSensor[margin="0.4,0.08" penwidth="1" style="rounded" BORDER="1" color="black" fontname=Arial; fontsize=14 label=< <TABLE STYLE="rounded" BORDER="0" CELLBORDER="0">
88<TR><TD PORT="NW"></TD><TD PORT="N"></TD><TD PORT="NE"></TD></TR>
89<TR><TD PORT="W"></TD> <TD BORDER="1" SIDES="B">WaitingForSensor</TD><TD PORT="E"></TD></TR>
90<TR><TD COLSPAN="3" ALIGN="LEFT">Do:<br ALIGN="LEFT"/>checkForSensor();<br ALIGN="LEFT"/></TD></TR>
91<TR><TD PORT="SW"></TD><TD PORT="S"></TD><TD PORT="SE"></TD></TR>
92</TABLE> >];
93
94structDefaultOn[shape=circle, fontsize=14, height=0.3, width=0.3, fixedsize=true, fontname=Arial; fontsize=14, fontcolor=white,fillcolor=black, style=filled label=< <TABLE BORDER="0"><TR><TD PORT="NW"></TD> <TD PORT="N"></TD> <TD PORT="NE"></TD></TR><TR><TD PORT="W"> </TD> <TD BORDER="0" ALIGN="CENTER"> <FONT COLOR="white"> </FONT> </TD> <TD PORT="E"></TD></TR><TR><TD PORT="SW"></TD><TD PORT="S"></TD><TD PORT="SE"></TD></TR></TABLE> >];struct__C0 [label = "" xlabel="__C0" fontcolor=black shape=diamond, fixedsize=true, height=0.2, width=0.2, fontname=Arial; fontsize=14 color=black];
95};
96};
97};
98};
99};
100};
101};
102};
103};
104
105
106structFailedSafeOn[margin="0.4,0.08" penwidth="1" style="rounded" BORDER="1" color="black" fontname=Arial; fontsize=14 label=< <TABLE STYLE="rounded" BORDER="0" CELLBORDER="0">
107<TR><TD PORT="NW"></TD><TD PORT="N"></TD><TD PORT="NE"></TD></TR>
108<TR><TD PORT="W"></TD> <TD BORDER="1" SIDES="B">FailedSafeOn</TD><TD PORT="E"></TD></TR>
109<TR><TD PORT="SW"></TD><TD PORT="S"></TD><TD PORT="SE"></TD></TR>
110</TABLE> >];
111
112structDefaultroot[shape=circle, fontsize=14, height=0.3, width=0.3, fixedsize=true, fontname=Arial; fontsize=14, fontcolor=white,fillcolor=black, style=filled label=< <TABLE BORDER="0"><TR><TD PORT="NW"></TD> <TD PORT="N"></TD> <TD PORT="NE"></TD></TR><TR><TD PORT="W"> </TD> <TD BORDER="0" ALIGN="CENTER"> <FONT COLOR="white"> </FONT> </TD> <TD PORT="E"></TD></TR><TR><TD PORT="SW"></TD><TD PORT="S"></TD><TD PORT="SE"></TD></TR></TABLE> >];}
113\enddot
114*/
115
116// User defined includes
117#include <stdint.h>
118#include <stdbool.h>
119
120#include "Ajax/Heating/Supervisor/Fsm_ext_.h"
121#include "Ajax/Heating/Supervisor/FsmContext_.h"
122
123#ifndef DOXYGEN_WILL_SKIP_THIS
124
125namespace Ajax { namespace Heating { namespace Supervisor {
126
127 class Fsm: public FsmContext_
128 {
129 public:
130 explicit Fsm(void);
131
132
133 int processEvent(const FSM_EVENT_T msg);
134
135 void initialize(void);
136
137 // Helper(s) to reset history
138 void resetHistoryOn(void);
139
140 // Helper(s) to find out if the machine is in a certain state
141 bool isInOff(void) const;
142 bool isInOn(void) const;
143 bool isInHeating(void) const;
144 bool isInFailedSafeOn(void) const;
145 bool isInFailedSafeOff(void) const;
146 bool isInWaitingForSensor(void) const;
147
148
149 // Helper returning the innermost active state id.
150 enum States{
151 Off,
152 On,
153 Heating,
154 FailedSafeOn,
155 FailedSafeOff,
156 WaitingForSensor,
157 NUM_STATES // number of states in the machine
158 };
159
160 States getInnermostActiveState(void) const;
161
162
163 // Returns the state name as string
164 static const char* getNameByState(const unsigned short state);
165
166 // Returns the event as string
167 static const char* getNameByEvent(const FSM_EVENT_T evt);
168
169 protected:
170
171
172 int m_initialized;
173
174
175
176 protected:
177 // State variables
178 struct stateVarsT{
179 States stateVar;
180 States stateVarOn;
181 };
182
183 stateVarsT stateVars;
184 stateVarsT stateVarsCopy;
185
186
187
188
189
190
191 };
192
193}}} //namespace Ajax { namespace Heating { namespace Supervisor
194
195
196#endif // !DOXYGEN_WILL_SKIP_THIS
197
198#endif // __FSM_AJAX_HEATING_SUPERVISOR_H__
199
Fsm_ext_.h
FsmContext_.h
Fsm
Here is the graph that shows the state machine this class implements.
Ajax
The 'Ajax' namespace is the root name space all GM6000 application specific source code.
Generated on Sat Jan 18 2025 22:23:55 for GM6000 Digital Heater Controller by doxygen 1.9.8