blob: 232c91e78ba771e53e46e3d34f5d1a1442b38172 (
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
|
/*
* @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 CFrameworkunifiedTransition class definitions.This class provides the
/// interface for reacting local transition and external transition
///
///////////////////////////////////////////////////////////////////////////////
//@{
/**
* @file frameworkunified_sm_transition.h
* @brief \~english This file has the CFrameworkunifiedTransition class definitions.
*
*/
/** @addtogroup BaseSystem
* @{
*/
/** @addtogroup native_service
* @ingroup BaseSystem
* @{
*/
/** @addtogroup framework_unified
* @ingroup native_service
* @{
*/
/** @addtogroup framework
* @ingroup framework_unified
* @{
*/
/** @addtogroup statemachine
* @ingroup framework
* @{
*/
#ifndef __FRAMEWORKUNIFIED_NATIVESERVICES_NATIVESERVICES_INC_FRAMEWORK_STATEMACHINE_FRAMEWORKUNIFIED_SM_TRANSITION_H__ // NOLINT (build/header_guard)
#define __FRAMEWORKUNIFIED_NATIVESERVICES_NATIVESERVICES_INC_FRAMEWORK_STATEMACHINE_FRAMEWORKUNIFIED_SM_TRANSITION_H__
///////////////////////////////////////////////////////////////////////////////////////////////////
// Include Files
///////////////////////////////////////////////////////////////////////////////////////////////////
#include <native_service/frameworkunified_sm_reaction.h>
class CFrameworkunifiedState;
class CFrameworkunifiedEventData;
///////////////////////////////////////////////////////////////////////////////////////////////////
/// This class provides the interface for reacting local transition and external transition
///////////////////////////////////////////////////////////////////////////////////////////////////
class CFrameworkunifiedTransition : public CFrameworkunifiedReaction {
public :
/////////////////////////////////////////////////////////////////////////////////////
/// \ingroup CFrameworkunifiedTransition
/// \~english @par Summary
/// CFrameworkunifiedTransition constructor
/// \~english @param [in] f_pTargetState
/// CFrameworkunifiedState *f_pTargetState - set m_pTargetState value
/// \~english @retval None
/// \~english @par Preconditions
/// - None.
/// \~english @par Change of the internal state
/// - m_pTargetState = f_pTargetState
/// \~english @par Causes of failures
/// None
/// \~english @par Classification
/// Public
/// \~english @par Type
/// sync only
/// \~english @par Detail
/// CFrameworkunifiedTransition constructor, for create CFrameworkunifiedTransition object
/// \~english @see
////////////////////////////////////////////////////////////////////////////////////
CFrameworkunifiedTransition(CFrameworkunifiedState *f_pTargetState); // NOLINT (readability/nolint)
/////////////////////////////////////////////////////////////////////////////////////
/// \ingroup CFrameworkunifiedTransition
/// \~english @par Summary
/// CFrameworkunifiedTransition 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
/// CFrameworkunifiedTransition destructor, for destroy CFrameworkunifiedTransition object
/// \~english @see
////////////////////////////////////////////////////////////////////////////////////
virtual ~CFrameworkunifiedTransition();
/////////////////////////////////////////////////////////////////////////////////////
/// \ingroup CFrameworkunifiedTransition
/// \~english @par Summary
/// virtual fuction
/// \~english @param [in] f_pSourceState
/// CFrameworkunifiedState *f_pSourceState - source state
/// \~english @param [in] f_pData
/// CEventDataPtr f_pData - event data
/// \~english @retval CFrameworkunifiedState* depend on implement class
/// \~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
/// virtual function , implement by child class
/// \~english @see
////////////////////////////////////////////////////////////////////////////////////
virtual CFrameworkunifiedState *FrameworkunifiedReaction(CFrameworkunifiedState *f_pSourceState, CEventDataPtr f_pData) = 0;
protected :
/// Pointer to the target state of transition
CFrameworkunifiedState *m_pTargetState;
};
#endif // __FRAMEWORKUNIFIED_NATIVESERVICES_NATIVESERVICES_INC_FRAMEWORK_STATEMACHINE_FRAMEWORKUNIFIED_SM_TRANSITION_H__ // NOLINT (build/header_guard)
/** @}*/
/** @}*/
/** @}*/
/** @}*/
/** @}*/
//@}
|
