1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
|
/*
* @copyright Copyright (c) 2016-2020 TOYOTA MOTOR CORPORATION.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
///////////////////////////////////////////////////////////////////////////////
/// \ingroup tag_StateMachine
/// \brief
///
/// This file has the CFrameworkunifiedLeafState class definitions. CFrameworkunifiedLeafState is derived from C
/// FrameworkunifiedState class.This class implements the additional functionality supported by HSM Leafstate.
///////////////////////////////////////////////////////////////////////////////
//@{
/**
* @file frameworkunified_sm_leafstate.h
* @brief \~english This file has the CFrameworkunifiedLeafState class definitions. CFrameworkunifiedLeafState is derived from C
* FrameworkunifiedState class.This class implements the additional functionality supported by HSM Leafstate.
*
*/
/** @addtogroup BaseSystem
* @{
*/
/** @addtogroup native_service
* @ingroup BaseSystem
* @{
*/
/** @addtogroup framework_unified
* @ingroup native_service
* @{
*/
/** @addtogroup framework
* @ingroup framework_unified
* @{
*/
/** @addtogroup statemachine
* @ingroup framework
* @{
*/
#ifndef _FRAMEWORKUNIFIEDLEAFSTATE_H // NOLINT (build/header_guard)
#define _FRAMEWORKUNIFIEDLEAFSTATE_H
///////////////////////////////////////////////////////////////////////////////////////////////////
// Include Files
///////////////////////////////////////////////////////////////////////////////////////////////////
#include <native_service/frameworkunified_sm_state.h>
#include <string>
///////////////////////////////////////////////////////////////////////////////////////////////////
/// This class implements the additional functionality supported by HSM Leafstate.
///////////////////////////////////////////////////////////////////////////////////////////////////
class CFrameworkunifiedLeafState : public CFrameworkunifiedState {
public :
///////////////////////////////////////////////////////////////////////////////////////////
/// \ingroup CFrameworkunifiedLeafState
/// \~english @par Brief
/// It is a constructor for CFrameworkunifiedLeafState classes.
/// \~english @param [in] f_pName
/// std::string - state name
/// \~english @retval None
/// \~english @par Prerequisite
/// - None
/// \~english @par Change of internal state
/// - The internal state is not changed.
/// \~english @par Conditions of processing failure
/// - None
/// \~english @par Detail
/// Inherits CFrameworkunifiedState, which is a superclass of state machines.\n
/// This class is implemented by HSM Leafstate as an additional class of functional support.\n
/// It inherits from the CFrameworkunifiedState classes and instantiates the CFrameworkunifiedLeafState.
/// \~english @par Immediate
/// Brief
/// \~english @par Classification
/// Public
/// \~english @par Type
/// Not applicable
/// \~english @see ~CFrameworkunifiedLeafState
///////////////////////////////////////////////////////////////////////////////////////////
/// CFrameworkunifiedState
/// Parameterized constructor
/// \param [in] f_pName
/// string - Name of the state
///
/// \return none
CFrameworkunifiedLeafState(std::string f_pName); // NOLINT (readability/nolint)
///////////////////////////////////////////////////////////////////////////////////////////
/// \ingroup CFrameworkunifiedLeafState
/// \~english @par Brief
/// Destructors for CFrameworkunifiedLeafState classes.
/// \~english @retval None
/// \~english @par Prerequisite
/// - Its own instance (CFrameworkunifiedLeafState) has been created.
/// \~english @par Change of internal state
/// - The internal state is not changed.
/// \~english @par Conditions of processing failure
/// - None
/// \~english @par Detail
/// Frees instances of CFrameworkunifiedLeafState classes.
/// \~english @par Classification
/// Public
/// \~english @par Type
/// Not applicable
/// \~english @see CFrameworkunifiedLeafState::CFrameworkunifiedLeafState
///////////////////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////////////////
/// ~CFrameworkunifiedState
/// Class destructor
///
/// \return none
virtual ~CFrameworkunifiedLeafState();
///////////////////////////////////////////////////////////////////////////////////////////
/// \ingroup CFrameworkunifiedLeafState
/// \~english @par Brief
/// Get the active state.
/// \~english @retval CFrameworkunifiedState* Pointers to active-state (CFrameworkunifiedState classes) objects
/// \~english @par Prerequisite
/// - Its own instance (CFrameworkunifiedLeafState) has been created.
/// \~english @par Change of internal state
/// - The internal state is not changed.
/// \~english @par Conditions of processing failure
/// - None
/// \~english @par Detail
/// This method overrides and uses CFrameworkunifiedState::FrameworkunifiedGetActiveState, which is pure virtual functions.\n
/// Returns the current state (this) as the active state.
/// \~english @par Classification
/// Public
/// \~english @par Type
/// Not applicable
/// \~english @see CFrameworkunifiedState::FrameworkunifiedGetActiveState
///////////////////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////////////////
/// FrameworkunifiedGetActiveState
/// This interface returns the Active state of the current composite state. In case of
/// non-composite state current state is active state
///
/// \return Active state
/// CFrameworkunifiedState* - Active state
virtual CFrameworkunifiedState *FrameworkunifiedGetActiveState();
///////////////////////////////////////////////////////////////////////////////////////////
/// \ingroup CFrameworkunifiedLeafState
/// \~english @par Brief
/// Save the last active state.
/// \~english @retval eFrameworkunifiedStatusOK success
/// \~english @par Prerequisite
/// - Its own instance (CFrameworkunifiedLeafState) has been created.
/// \~english @par Change of internal state
/// - The internal state is not changed.
/// \~english @par Conditions of processing failure
/// - None
/// \~english @par Detail
/// This method overrides CFrameworkunifiedState::UpdateHistory, which is pure virtual functions.Used and saves the last active state.
/// \~english @par Classification
/// Public
/// \~english @par Type
/// Not applicable
/// \~english @see CFrameworkunifiedState::UpdateHistory
///////////////////////////////////////////////////////////////////////////////////////////
/// UpdateHistory
/// This function stores the last active state
///
/// \return EFrameworkunifiedStatus
/// EFrameworkunifiedStatus - Returns status of operation
EFrameworkunifiedStatus UpdateHistory();
protected :
///////////////////////////////////////////////////////////////////////////////////////////
/// \ingroup CFrameworkunifiedLeafState
/// \~english @par Brief
/// Initialize state
/// \~english @param f_pEventData
/// CEventDataPtr - Pointer to the event data class
/// \~english @retval eFrameworkunifiedStatusOK success
/// \~english @par Prerequisite
/// - Its own instance (CFrameworkunifiedLeafState) has been created.
/// \~english @par Change of internal state
/// - The internal state is not changed.
/// \~english @par Conditions of processing failure
/// - None
/// \~english @par Detail
/// This method overrides and uses CFrameworkunifiedState::FrameworkunifiedOnEntry, which is pure virtual functions, to initialize state.
/// \~english @par Classification
/// Public
/// \~english @par Type
/// Not applicable
/// \~english @see CFrameworkunifiedState::FrameworkunifiedOnEntry, FrameworkunifiedOnExit
///////////////////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////////////////
/// FrameworkunifiedOnEntry
/// state initialization can be performed in this function.
///
/// \param [in] f_pEventData
/// CEventDataPtr - Event data
///
/// \return EFrameworkunifiedStatus
/// EFrameworkunifiedStatus - Returns status of operation
virtual EFrameworkunifiedStatus FrameworkunifiedOnEntry(CEventDataPtr f_pEventData);
///////////////////////////////////////////////////////////////////////////////////////////
/// \ingroup CFrameworkunifiedLeafState
/// \~english @par Brief
/// Clean up state.
/// \~english @param f_pEventData
/// CEventDataPtr - Pointer to the event data class
/// \~english @retval eFrameworkunifiedStatusOK success
/// \~english @par Prerequisite
/// - Its own instance (CFrameworkunifiedLeafState) has been created.
/// \~english @par Change of internal state
/// - The internal state is not changed.
/// \~english @par Conditions of processing failure
/// - None
/// \~english @par Detail
/// This method overrides and uses CFrameworkunifiedState::FrameworkunifiedOnExit, which is pure virtual functions, to clean up state.
/// \~english @par Classification
/// Public
/// \~english @par Type
/// Not applicable
/// \~english @see CFrameworkunifiedState::FrameworkunifiedOnExit, FrameworkunifiedOnEntry
///////////////////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////////////////
/// FrameworkunifiedOnExit
/// state cleanup can be performed in this function.
///
/// \param [in] f_pEventData
/// CEventDataPtr - Event data
///
/// \return EFrameworkunifiedStatus
/// EFrameworkunifiedStatus - Returns status of operation
virtual EFrameworkunifiedStatus FrameworkunifiedOnExit(CEventDataPtr f_pEventData);
};
#endif // _FRAMEWORKUNIFIEDLEAFSTATE_H // NOLINT (build/header_guard)
/** @}*/
/** @}*/
/** @}*/
/** @}*/
/** @}*/
//@}
|
