SAE Teensy ECU
IIT SAE Microcontroller programming
Loading...
Searching...
No Matches
State.h
Go to the documentation of this file.
1
22#ifndef __ECU_STATE_H__
23#define __ECU_STATE_H__
24
25#include <stdint.h>
26#include <stdlib.h>
27#include <typeinfo>
28
29#include "Log.h"
30#include "PPHelp.h"
31
38namespace State {
39
44enum NotifyValue : int {
48 E_NOERR,
52 E_CONTINUE,
56 E_ERROR,
60 E_FATAL = 0xFA7A1,
64 E_RESTART = 2357427,
65};
66
70struct State_t {
71protected:
77 int getNotify(void);
78
84 void notify(int notify);
85
86public:
90 int notifyCode = 0;
91
95 LOG_TAG ID = "ID NOT SET";
96
102 virtual State_t *run(void);
103
109 virtual LOG_TAG getID(void);
110
116 State_t *getLastState();
117};
118
124void begin(State_t &entry);
125
126} // namespace State
127
128#endif // __ECU_STATE_H__
Log.h
Special logging functionality.
LOG_TAG
const char * LOG_TAG
Type definition of logging tags This typedef is necessary to allow for easier manipulation of code by...
Definition Log.h:48
PPHelp.h
Compilation of various helpful preprocessor macros.
State
A state machine implementation, refer to State.h for more info.
Definition State.h:38
State::NotifyValue
NotifyValue
Common codes that can be used by states.
Definition State.h:44
State::E_RESTART
@ E_RESTART
Special code that makes the state machine start from the first state again.
Definition State.h:64
State::E_ERROR
@ E_ERROR
An error has occurred, attempt to skip the state.
Definition State.h:56
State::E_CONTINUE
@ E_CONTINUE
An error has occurred but we can continue normally.
Definition State.h:52
State::E_NOERR
@ E_NOERR
No error has occurred.
Definition State.h:48
State::E_FATAL
@ E_FATAL
Special code that makes the state machine completely stop.
Definition State.h:60
State::begin
void begin(State_t &entry)
Begin the state machine with a pointer to a state.
State::State_t
The parent state structure to extend from to create more states.
Definition State.h:70
State::State_t::notifyCode
int notifyCode
Used for receiving values from other states.
Definition State.h:90
State::State_t::notify
void notify(int notify)
Send a code to the next state.
State::State_t::ID
LOG_TAG ID
The unique ID of the state, used for logging.
Definition State.h:95
State::State_t::getID
virtual LOG_TAG getID(void)
Returns the LOG_TAG of the state.
State::State_t::run
virtual State_t * run(void)
Runs the state.
State::State_t::getLastState
State_t * getLastState()
Get a pointer of the last state.
State::State_t::getNotify
int getNotify(void)
Get the code of the previous state.