blob: 1792f72f7dee79a47c15ee5ac12868f288238673 (
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
|
/*
* @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 CFrameworkunifiedGuard class definitions. This is an interface that defines the Evaluate
/// interface for guard condition validation.
///
///////////////////////////////////////////////////////////////////////////////
//@{
/**
* @file frameworkunified_sm_guard.h
* @brief \~english This file has the CFrameworkunifiedGuard 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 _FRAMEWORKUNIFIEDGUARD_H // NOLINT (build/header_guard)
#define _FRAMEWORKUNIFIEDGUARD_H
#include <native_service/frameworkunified_types.h>
#include <string>
/**
* @class CNSSharedMem
* \~english @brief this file has the CFrameworkunifiedGuard class definitions
* \~english @par Brief Introduction
* This file has the CFrameworkunifiedGuard class definitions. This is an interface \n
* that defines the Evaluate interface for guard condition validation.
*
*/
class CFrameworkunifiedGuard {
public :
/////////////////////////////////////////////////////////////////////////////////////
/// \ingroup CFrameworkunifiedGuard
/// \~english @par Brief
/// CFrameworkunifiedGuard's constructor
/// \~english @param [in] f_strName
/// string - Name of the guard
/// \~english @retval none
/// \~english @par Preconditons
/// - None
/// \~english @par Change of internal status
/// - None
/// \~english @par Conditions of processing failure
/// - None
/// \~english @par Detail
/// - CFrameworkunifiedGuard's constructor
/// \~english @par Classification
/// - Public
/// \~english @par Type
/// - Sync only
/// \~english @see ~CFrameworkunifiedGuard
////////////////////////////////////////////////////////////////////////////////////
CFrameworkunifiedGuard(std::string f_strName); // NOLINT (readability/nolint)
/////////////////////////////////////////////////////////////////////////////////////
/// \ingroup ~CFrameworkunifiedGuard
/// \~english @par Brief
/// - Destructor of CFrameworkunifiedGuard class
/// \~english @param None
/// \~english @retval none
/// \~english @par Preconditons
/// - Calls constructor to successfully create object.
/// \~english @par Change of internal status
/// - None
/// \~english @par Conditions of processing failure
/// - None
/// \~english @par Detail
/// - Destruct the object of this class.
/// \~english @par Classification
/// - Public
/// \~english @par Type
/// - Sync only
/// \~english @see CFrameworkunifiedGuard
////////////////////////////////////////////////////////////////////////////////////
virtual ~CFrameworkunifiedGuard();
/////////////////////////////////////////////////////////////////////////////////////
/// \ingroup CFrameworkunifiedGuard
/// \~english @par Brief
/// This is a pure virtual function that defines the logic for evaluating the guard condition
/// \~english @param None
/// \~english @retval TRUE - if test passes
/// \~english @retval FALSE - otherwise returns false
/// \~english @par Preconditons
/// - None
/// \~english @par Change of internal status
/// - None
/// \~english @par Conditions of processing failure
/// - None
/// \~english @par Detail
/// - This is a pure virtual function that defines the logic for evaluating the guard condition
/// \~english @par Classification
/// - Public
/// \~english @par Type
/// - Sync only
/// \~english @see None
////////////////////////////////////////////////////////////////////////////////////
virtual BOOL FrameworkunifiedEvaluate() = 0;
private:
std::string m_strName;
};
#endif // _FRAMEWORKUNIFIEDGUARD_H // NOLINT (build/header_guard)
/** @}*/
/** @}*/
/** @}*/
/** @}*/
/** @}*/
//@}
|
