blob: 99975eb10870b20dd6e3209842dcfb966d315762 (
plain)
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
|
/*
* @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 CFrameworkunifiedLocalTransition class definitions. CFrameworkunifiedLocalTransition is derived
/// from CFrameworkunifiedTransition class.This class provides the interface for local transition over event
///////////////////////////////////////////// //////////////////////////////////
//@{
/**
* @file frameworkunified_sm_localtransition.h
* @brief \~english This file has the CFrameworkunifiedLocalTransition class definitions. CFrameworkunifiedLocalTransition is derived
* from CFrameworkunifiedTransition class.
*
*/
/** @addtogroup BaseSystem
* @{
*/
/** @addtogroup native_service
* @ingroup BaseSystem
* @{
*/
/** @addtogroup framework_unified
* @ingroup native_service
* @{
*/
/** @addtogroup framework
* @ingroup framework_unified
* @{
*/
/** @addtogroup statemachine
* @ingroup framework
* @{
*/
#ifndef _FRAMEWORKUNIFIEDLOCALTRANSITIONS_H // NOLINT (build/header_guard)
#define _FRAMEWORKUNIFIEDLOCALTRANSITIONS_H
///////////////////////////////////////////////////////////////////////////////////////////////////
// Include Files
///////////////////////////////////////////////////////////////////////////////////////////////////
#include <native_service/frameworkunified_sm_transition.h>
class CFrameworkunifiedEventData;
///////////////////////////////////////////////////////////////////////////////////////////////////
/// This class provides the interface for local transition over event
///////////////////////////////////////////////////////////////////////////////////////////////////
class CFrameworkunifiedLocalTransition : public CFrameworkunifiedTransition {
public :
/////////////////////////////////////////////////////////////////////////////////////
/// \ingroup CFrameworkunifiedLocalTransition
/// \~english @par Brief
/// CFrameworkunifiedLocalTransition constructor
/// \~english @param [in] f_pTargetState
/// CFrameworkunifiedState *f_pTargetState - target state
/// \~english @retval None
/// \~english @par Prerequisite
/// None
/// \~english @par Change of internal state
/// None
/// \~english @par Conditions of processing failure
/// None
/// \~english @par Detail
/// Constructor of CFrameworkunifiedLocalTransition, to create CFrameworkunifiedLocalTransition object
/// \~english @par Classification
/// Public
/// \~english @par Type
/// sync only
/// \~english @see
///
/////////////////////////////////////////////////////////////////////////////////////
CFrameworkunifiedLocalTransition(CFrameworkunifiedState *f_pTargetState); // NOLINT (readability/nolint)
/////////////////////////////////////////////////////////////////////////////////////
/// \ingroup CFrameworkunifiedLocalTransition
/// \~english @par Brief
/// CFrameworkunifiedLocalTransition destructor
/// \~english @param None
/// \~english @retval None
/// \~english @par Prerequisite
/// None
/// \~english @par Change of internal state
/// None
/// \~english @par Conditions of processing failure
/// None
/// \~english @par Detail
/// CFrameworkunifiedLocalTransition destructor, for destory CFrameworkunifiedLocalTransition object
/// \~english @par Classification
/// Public
/// \~english @par Type
/// sync only
/// \~english @see
///
/////////////////////////////////////////////////////////////////////////////////////
virtual ~CFrameworkunifiedLocalTransition();
/////////////////////////////////////////////////////////////////////////////////////
/// \ingroup CFrameworkunifiedLocalTransition
/// \~english @par Brief
/// reaction for location transition
/// \~english @param None
/// \~english @retval None
/// \~english @par Prerequisite
/// None
/// \~english @par Change of internal state
/// None
/// \~english @par Conditions of processing failure
/// None
/// \~english @par Detail
/// For local transition from inner
/// state to outer state exit of the inner state is invoked, but entry of outer state is not
/// invoked and from outer state to inner state entry of the inner state is invoked but exit of
/// outer state is not invoked
/// \~english @par Classification
/// Public
/// \~english @par Type
/// sync only
/// \~english @see
///
/////////////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////////////////
/// FrameworkunifiedReaction
/// The reaction for an event is implemented in this function. For local transition from inner
/// state to outer state exit of the inner state is invoked, but entry of outer state is not
/// invoked and from outer state to inner state entry of the inner state is invoked but exit of
/// outer state is not invoked
///
/// \param [in] f_pSourceState
/// CFrameworkunifiedState* - Source state in which reaction is being executed
///
/// \param [in] f_pData
/// CEventDataPtr - event data
///
/// \return ActiveState
/// CFrameworkunifiedState* - Returns Active state
///
///////////////////////////////////////////////////////////////////////////////////////////
virtual CFrameworkunifiedState *FrameworkunifiedReaction(CFrameworkunifiedState *f_pSourceState, CEventDataPtr f_pData);
};
#endif // _FRAMEWORKUNIFIEDLOCALTRANSITIONS_H // NOLINT (build/header_guard)
/** @}*/
/** @}*/
/** @}*/
/** @}*/
/** @}*/
//@}
|
