service/native/framework_unified/client/NS_FrameworkCore/src/statemachine/frameworkunified_sm_finalstate.cpp

   1 /*
   2  * @copyright Copyright (c) 2016-2020 TOYOTA MOTOR CORPORATION.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 ///////////////////////////////////////////////////////////////////////////////////////////////////
  18 /// \defgroup <<Group Tag>> <<Group Name>>
  19 /// \ingroup  tag_NSFramework
  20 /// .
  21 ///////////////////////////////////////////////////////////////////////////////////////////////////
  22
  23 ///////////////////////////////////////////////////////////////////////////////////////////////////
  24 /// \ingroup  tag_NSFramework
  25 /// \brief
  26 ///
  27 /// This file has the CFrameworkunifiedFinalState class definitions. CFrameworkunifiedFinalState is derived from C
  28 /// FrameworkunifiedState class.This class implements the additional functionality supported by HSM Final
  29 /// state.
  30 ///
  31 ///////////////////////////////////////////////////////////////////////////////////////////////////
  32
  33 #include <native_service/frameworkunified_sm_hsm.h>
  34 #include <string>
  35 #include "frameworkunified_sm_finalstate.h"
  36 ///////////////////////////////////////////////////////////////////////////////////////////
  37 /// ~CFrameworkunifiedFinalState
  38 /// Class destructor
  39 ///////////////////////////////////////////////////////////////////////////////////////////
  40 CFrameworkunifiedFinalState::~CFrameworkunifiedFinalState() {
  41   FRAMEWORKUNIFIEDLOG(ZONE_NS_INFO, __FUNCTION__, "CFrameworkunifiedFinalState destructor");
  42 }
  43
  44 ///////////////////////////////////////////////////////////////////////////////////////////
  45 /// CFrameworkunifiedFinalState
  46 /// Parameterized constructor
  47 ///////////////////////////////////////////////////////////////////////////////////////////
  48 CFrameworkunifiedFinalState::CFrameworkunifiedFinalState(std::string f_pName): CFrameworkunifiedState(f_pName) {
  49 }
  50
  51 ///////////////////////////////////////////////////////////////////////////////////////////
  52 /// FrameworkunifiedOnEntry
  53 /// state initialization can be performed in this function.
  54 ///////////////////////////////////////////////////////////////////////////////////////////
  55 EFrameworkunifiedStatus CFrameworkunifiedFinalState::FrameworkunifiedOnEntry(CEventDataPtr f_pEventData) {
  56   FRAMEWORKUNIFIEDLOG(ZONE_NS_SM_USR_INFO, __FUNCTION__, " Entering state %s ", m_strStateName.c_str());
  57   return eFrameworkunifiedStatusOK;
  58 }
  59
  60 ///////////////////////////////////////////////////////////////////////////////////////////
  61 /// FrameworkunifiedOnExit
  62 /// state cleanup can be performed in this function.
  63 ///////////////////////////////////////////////////////////////////////////////////////////
  64 EFrameworkunifiedStatus CFrameworkunifiedFinalState::FrameworkunifiedOnExit(CEventDataPtr f_pEventData) {
  65   FRAMEWORKUNIFIEDLOG(ZONE_NS_SM_USR_INFO, __FUNCTION__, " Leaving state %s ", m_strStateName.c_str());
  66   return eFrameworkunifiedStatusOK;
  67 }
  68
  69 CFrameworkunifiedState *CFrameworkunifiedFinalState::FrameworkunifiedGetActiveState() {
  70   return this;
  71 }
  72
  73 ////////////////////////////////////////////////////////////////////////////////////////////////////
  74 /// UpdateHistory
  75 /// This function stores the last active state
  76 ////////////////////////////////////////////////////////////////////////////////////////////////////
  77 EFrameworkunifiedStatus CFrameworkunifiedFinalState::UpdateHistory() {
  78   return eFrameworkunifiedStatusOK;
  79 }