blob: 83beea0a55000c399b084c82ef2b6a6aa9d8bfec (
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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
|
/*
* @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 CFrameworkunifiedReaction class definitions.This class provides the interface
/// for defining a reaction for an event
///
///////////////////////////////////////////////////////////////////////////////
//@{
/**
* @file frameworkunified_sm_reaction.h
* @brief \~english This file has the CFrameworkunifiedReaction class definitions.This class provides the interface
* for defining a reaction for an event
*
*/
/** @addtogroup BaseSystem
* @{
*/
/** @addtogroup native_service
* @ingroup BaseSystem
* @{
*/
/** @addtogroup framework_unified
* @ingroup native_service
* @{
*/
/** @addtogroup framework
* @ingroup framework_unified
* @{
*/
/** @addtogroup statemachine
* @ingroup framework
* @{
*/
#ifndef _FRAMEWORKUNIFIEDREACTION_H // NOLINT (build/header_guard)
#define _FRAMEWORKUNIFIEDREACTION_H
///////////////////////////////////////////////////////////////////////////////////////////////////
// Include Files
///////////////////////////////////////////////////////////////////////////////////////////////////
#include <boost/smart_ptr.hpp>
#include <native_service/frameworkunified_types.h>
#include <native_service/ns_logger_if.h>
#include <exception>
class CFrameworkunifiedState;
class CEventData;
typedef boost::shared_ptr<CEventData> CEventDataPtr;
///////////////////////////////////////////////////////////////////////////////////////////////////
/// This class provides the interface for defining a reaction for an event
///////////////////////////////////////////////////////////////////////////////////////////////////
class CFrameworkunifiedReaction {
public :
/////////////////////////////////////////////////////////////////////////////////////
/// \ingroup CFrameworkunifiedReaction
/// \~english @par Summary
/// pure virtual fuction
/// \~english @param [in] f_pSourceState
/// CFrameworkunifiedState* f_pSourceState - source state
/// \~english @param [in] f_pData
/// CEventDataPtr f_pData - event data
/// \~english @retval None
/// \~english @par Preconditions
/// - None.
/// \~english @par Change of the internal state
/// - None
/// \~english @par Causes of failures
/// None
/// \~english @par Classification
/// Public
/// \~english @par Type
/// sync only
/// \~english @par Detail
/// pure virtual function , implement by child class
/// \~english @see
////////////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////////////////
/// FrameworkunifiedReaction
/// The reaction for the event has to be implemented in this function
///
/// \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) = 0;
/////////////////////////////////////////////////////////////////////////////////////
/// \ingroup CFrameworkunifiedReaction
/// \~english @par Summary
/// CFrameworkunifiedReaction constructor
/// \~english @param None
/// \~english @retval None
/// \~english @par Preconditions
/// - None.
/// \~english @par Change of the internal state
/// - m_ucRefCount = 0
/// \~english @par Causes of failures
/// None
/// \~english @par Classification
/// Public
/// \~english @par Type
/// sync only
/// \~english @par Detail
/// CFrameworkunifiedReaction Constructor, for create CFrameworkunifiedReaction object
/// \~english @see
////////////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////////////////
/// CFrameworkunifiedReaction
/// Constructor
///
/// \param
///
/// \return
///
///////////////////////////////////////////////////////////////////////////////////////////
CFrameworkunifiedReaction() {
m_ucRefCount = 0;
}
/////////////////////////////////////////////////////////////////////////////////////
/// \ingroup CFrameworkunifiedReaction
/// \~english @par Summary
/// CFrameworkunifiedReaction destructor
/// \~english @param None
/// \~english @retval None
/// \~english @par Preconditions
/// - None.
/// \~english @par Change of the internal state
/// - None
/// \~english @par Causes of failures
/// None
/// \~english @par Classification
/// Public
/// \~english @par Type
/// sync only
/// \~english @par Detail
/// CFrameworkunifiedReaction destructor, for destory CFrameworkunifiedReaction object
/// \~english @see
////////////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////////////////
/// ~CFrameworkunifiedReaction
/// Destructor
///
/// \param
///
/// \return
///
///////////////////////////////////////////////////////////////////////////////////////////
virtual ~CFrameworkunifiedReaction() {}
// count to check the number of reference of this reaction in all the states of statemachine
UI_8 m_ucRefCount;
};
#endif // _FRAMEWORKUNIFIEDREACTION_H // NOLINT (build/header_guard)
/** @}*/
/** @}*/
/** @}*/
/** @}*/
/** @}*/
//@}
|
