blob: 20ed3f628f5f2fadc61c231b65a470d4115d7036 (
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
|
/*
* @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 CFrameworkunifiedFinalState class definitions. CFrameworkunifiedFinalState is derived from
/// CFrameworkunifiedState class.This class implements the additional functionality supported by HSM Final
/// state.
///
///////////////////////////////////////////////////////////////////////////////
//@{
#ifndef FRAMEWORK_UNIFIED_CLIENT_NS_FRAMEWORKCORE_INCLUDE_STATEMACHINE_FRAMEWORKUNIFIED_SM_FINALSTATE_H_
#define FRAMEWORK_UNIFIED_CLIENT_NS_FRAMEWORKCORE_INCLUDE_STATEMACHINE_FRAMEWORKUNIFIED_SM_FINALSTATE_H_
#include <native_service/frameworkunified_sm_state.h>
///////////////////////////////////////////////////////////////////////////////////////////////////
/// This class implements the additional functionality supported by HSM Final state.
///////////////////////////////////////////////////////////////////////////////////////////////////
class CFrameworkunifiedFinalState : public CFrameworkunifiedState {
public :
///////////////////////////////////////////////////////////////////////////////////////////
/// CFrameworkunifiedFinalState
/// Parameterized constructor
/// \param [in] f_pName
/// string - Name of the state
///
/// \return none
///////////////////////////////////////////////////////////////////////////////////////////
CFrameworkunifiedFinalState(std::string f_pName); // NOLINT (readability/nolint)
///////////////////////////////////////////////////////////////////////////////////////////
/// ~CFrameworkunifiedFinalState
/// Class destructor
///
/// \return none
///////////////////////////////////////////////////////////////////////////////////////////
virtual ~CFrameworkunifiedFinalState();
virtual CFrameworkunifiedState *FrameworkunifiedGetActiveState();
///////////////////////////////////////////////////////////////////////////////////////////
/// UpdateHistory
/// This function stores the last active state
///
/// \return EFrameworkunifiedStatus
/// EFrameworkunifiedStatus - Returns status of operation
///////////////////////////////////////////////////////////////////////////////////////////
EFrameworkunifiedStatus UpdateHistory();
protected :
///////////////////////////////////////////////////////////////////////////////////////////
/// FrameworkunifiedOnEntry
/// state initialization can be performed in this function.
///
/// \param [in] f_pEventData
/// CEventDataPtr - Event data
///
/// \return EFrameworkunifiedStatus
/// EFrameworkunifiedStatus - Returns status of operation
///////////////////////////////////////////////////////////////////////////////////////////
virtual EFrameworkunifiedStatus FrameworkunifiedOnEntry(CEventDataPtr f_pEventData);
///////////////////////////////////////////////////////////////////////////////////////////
/// FrameworkunifiedOnExit
/// state cleanup can be performed in this function.
///
/// \param [in] f_pEventData
/// CEventDataPtr - Event data
///
/// \return EFrameworkunifiedStatus
/// EFrameworkunifiedStatus - Returns status of operation
///////////////////////////////////////////////////////////////////////////////////////////
virtual EFrameworkunifiedStatus FrameworkunifiedOnExit(CEventDataPtr f_pEventData);
};
#endif // FRAMEWORK_UNIFIED_CLIENT_NS_FRAMEWORKCORE_INCLUDE_STATEMACHINE_FRAMEWORKUNIFIED_SM_FINALSTATE_H_
// @}
|
