blob: 110c1517e502ef12737a495f958c57174544eb2c (
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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
|
/*
* @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_NSFramework
/// \brief
/// This file has class declaration of the CFrameworkunifiedConditionConnector. This class is responsible for
/// implementing interfaces required to use condition connector in statemachine.
///
///////////////////////////////////////////////////////////////////////////////
//@{
/**
* @file frameworkunified_sm_conditionconnector.h
* @brief \~english This file has class declaration of the CFrameworkunifiedConditionConnector. This class is responsible for
* implementing interfaces required to use condition connector in statemachine.
*
*/
/** @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_NSFRAMEWORKCORE_STATEMACHINE_INC_FRAMEWORKUNIFIEDSMCONDITIONCONNECTOR_H__ // NOLINT (build/header_guard)
#define __FRAMEWORKUNIFIED_NATIVESERVICES_NSFRAMEWORKCORE_STATEMACHINE_INC_FRAMEWORKUNIFIEDSMCONDITIONCONNECTOR_H__
#include <native_service/frameworkunified_sm_externaltransition.h>
#include <string>
#include <vector>
// This class is responsible for implementing interfaces required to use condition connector in statemachine.
class CFrameworkunifiedConditionConnector : public CFrameworkunifiedExternalTransition {
public:
///////////////////////////////////////////////////////////////////////////////////////////
/// \ingroup CFrameworkunifiedConditionConnector
/// \~english @par Brief
/// Constructor for class CFrameworkunifiedConditionConnector.
/// \~english @param [in] f_strName
/// std::string - Name of the condition connector
/// \~english @retval
/// \~english @par Prerequisite
/// none
/// \~english @par Change of internal state
/// none
/// \~english @par Conditions of processing failure
/// none
/// \~english @par Detail
/// Inherite from base class CFrameworkunifiedExternalTransition.
/// \~english @par Classification
/// public
/// \~english @par Type
/// none
/// \~english @see CFrameworkunifiedExternalTransition, ~CFrameworkunifiedConditionConnector
///////////////////////////////////////////////////////////////////////////////////////////
CFrameworkunifiedConditionConnector(std::string f_strName); // NOLINT (readability/nolint)
///////////////////////////////////////////////////////////////////////////////////////////
/// \ingroup CFrameworkunifiedConditionConnector
/// \~english @par Brief
/// Destructor for CFrameworkunifiedCompositeState
/// \~english @retval none
/// \~english @par Preconditons
/// - Self instance of CFrameworkunifiedConditionConnector created.
/// \~english @par Change of internal status
/// none
/// \~english @par Conditions of processing failure
/// none
/// \~english @par Detail
/// Class CFrameworkunifiedExternalTransition instance and CFrameworkunifiedConditionConnector instance release.
/// \~english @par Classification
/// public
/// \~english @par Type
/// none
/// \~english @see CFrameworkunifiedConditionConnector::CFrameworkunifiedConditionConnector
///////////////////////////////////////////////////////////////////////////////////////////
virtual ~CFrameworkunifiedConditionConnector();
////////////////////////////////////////////////////////////////////////////////////////////
/// \ingroup CFrameworkunifiedConditionConnector
/// \~english @par Brief
/// This API evaluates the guards added in the condition list. If the guard is evaluated as
/// true then statemachine transitions to target state associated with guard.
/// \~english @param [in] f_pSourceState
/// CFrameworkunifiedState* - Source state in which reaction is being executed
/// \~english @param [in] f_pData
/// CEventDataPtr - event data
/// \~english @retval CFrameworkunifiedState*
/// CFrameworkunifiedState* - Returns Active state
/// \~english @par Preconditons
/// - Self instance of CFrameworkunifiedConditionConnector created.
/// \~english @par Change of internal status
/// - none
/// \~english @par Conditions of processing failure
/// - If parameter f_pSourceState is NULL. [NULL]
/// - If m_pConditionList is NULL. [NULL]
/// \~english @par Detail
/// This API evaluates the guards added in the condition list. If the guard is evaluated as
/// true then statemachine transitions to target state associated with guard.
/// \~english @par Classification
/// public
/// \~english @par Type
/// none
/// \~english @see none
////////////////////////////////////////////////////////////////////////////////////////////
virtual CFrameworkunifiedState *FrameworkunifiedReaction(CFrameworkunifiedState *f_pSourceState, CEventDataPtr f_pData);
////////////////////////////////////////////////////////////////////////////////////////////
/// \ingroup CFrameworkunifiedConditionConnector
/// \~english @par Brief
/// Adds connect condition into condition list of current connection
/// \~english @param [in] f_pGuard
/// CFrameworkunifiedState* - Pointer to the guard object to be added in the currrent connection
/// \~english @param [in] f_pTargetState
/// CFrameworkunifiedState* - Target state for given guard condition
/// \~english @retval EFrameworkunifiedStatus eFrameworkunifiedStatusOK
/// eFrameworkunifiedStatusNullPointer
/// \~english @par Preconditons
/// - Self instance of CFrameworkunifiedConditionConnector created.
/// \~english @par Change of internal status
/// - none
/// \~english @par Conditions of processing failure
/// - If m_pConditionList is NULL. [eFrameworkunifiedStatusNullPointer]
/// - If parameter f_pGuard is NULL. [eFrameworkunifiedStatusNullPointer]
/// - If parameter f_pTargetState is NULL. [eFrameworkunifiedStatusNullPointer]
/// \~english @par Detail
/// Adds connect condition into condition list of current connection.\n
/// \~english @par Classification
/// public
/// \~english @par Type
/// none
/// \~english @see none
////////////////////////////////////////////////////////////////////////////////////////////
virtual EFrameworkunifiedStatus FrameworkunifiedAddCondition(CFrameworkunifiedGuard *f_pGuard, CFrameworkunifiedState *f_pTargetState);
private:
// This class defines the conditions required in condition connector
class CCondition {
public:
///////////////////////////////////////////////////////////////////////////////////////////
/// CCondition
/// Parameterized constructor
/// \param [in] f_pGuard
/// CFrameworkunifiedGuard* - guard object
/// \param [in] f_pTargetState
/// CFrameworkunifiedState* - target state for a condition
///
/// \return none
///////////////////////////////////////////////////////////////////////////////////////////
CCondition(CFrameworkunifiedGuard *f_pGuard, CFrameworkunifiedState *f_pTargetState);
// pointer to guard that will be evaluated for a condition
CFrameworkunifiedGuard *m_pGuard;
// pointer to target state for a condition
CFrameworkunifiedState *m_pTargetState;
};
// Condition list
typedef std::vector<CCondition *> TConditionList;
// Condition list iterator
typedef TConditionList::iterator TConditionIterator;
// condition connector name
std::string m_strName;
// List of conditions
TConditionList *m_pConditionList;
};
#endif /* __FRAMEWORKUNIFIED_NATIVESERVICES_NSFRAMEWORKCORE_STATEMACHINE_INC_FRAMEWORKUNIFIEDSMCONDITIONCONNECTOR_H__ */ // NOLINT (build/header_guard)
/** @}*/
/** @}*/
/** @}*/
/** @}*/
/** @}*/
//@}
|
