nsframework/framework_unified/client/include/native_service/frameworkunified_sm_eventdata.h

   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 /// \ingroup  tag_NSFramework
  19 /// \brief
  20 ///       This file has class declaration of the CFrameworkunifiedAction. This is an interface class that defines
  21 ///     interfaces for implementing action
  22 ///
  23 ///////////////////////////////////////////////////////////////////////////////
  24 //@{
  25 /**
  26  * @file frameworkunified_sm_eventdata.h
  27  * @brief \~english This file has class declaration of the CFrameworkunifiedAction. This is an interface class that defines
  28  *          interfaces for implementing action
  29  *
  30  */
  31 /** @addtogroup BaseSystem
  32  *  @{
  33  */
  34 /** @addtogroup native_service
  35  *  @ingroup BaseSystem
  36  *  @{
  37  */
  38 /** @addtogroup framework_unified
  39  *  @ingroup native_service
  40  *  @{
  41  */
  42 /** @addtogroup framework
  43  *  @ingroup framework_unified
  44  *  @{
  45  */
  46 /** @addtogroup statemachine
  47  *  @ingroup framework
  48  *  @{
  49  */
  50 #ifndef __FRAMEWORKUNIFIED_NATIVESERVICES_NSFRAMEWORKCORE_STATEMACHINE_INC_FRAMEWORKUNIFIEDSMEVENTDATA_H__  // NOLINT  (build/header_guard)
  51 #define __FRAMEWORKUNIFIED_NATIVESERVICES_NSFRAMEWORKCORE_STATEMACHINE_INC_FRAMEWORKUNIFIEDSMEVENTDATA_H__
  52
  53 #include <native_service/frameworkunified_types.h>
  54 #include <native_service/ns_logger_if.h>
  55 #include <boost/smart_ptr.hpp>
  56
  57
  58 class CEventData {
  59  public:
  60   CEventData(UI_32 f_uiEventId): m_uiEventId(f_uiEventId) {  // NOLINT  (readability/nolint)
  61     FRAMEWORKUNIFIEDLOG(ZONE_NS_SM_USR_INFO, __FUNCTION__, "CEventData parameterized constructor");  // LCOV_EXCL_BR_LINE 15:marco defined in "native_service/ns_logger_if.h"
  62   }
  63
  64   virtual ~CEventData() {
  65     FRAMEWORKUNIFIEDLOG(ZONE_NS_SM_USR_INFO, __FUNCTION__, "CEventData destructor");  // LCOV_EXCL_BR_LINE 15:marco defined in "native_service/ns_logger_if.h"
  66   }
  67
  68   // event id
  69   UI_32 m_uiEventId;
  70
  71  private:
  72   CEventData() {
  73     FRAMEWORKUNIFIEDLOG(ZONE_NS_SM_USR_INFO, __FUNCTION__, "CEventData constructor");
  74   }
  75 };
  76
  77 #endif /* __FRAMEWORKUNIFIED_NATIVESERVICES_NSFRAMEWORKCORE_STATEMACHINE_INC_FRAMEWORKUNIFIEDSMEVENTDATA_H__ */  // NOLINT  (build/header_guard)
  78 /** @}*/
  79 /** @}*/
  80 /** @}*/
  81 /** @}*/
  82 /** @}*/
  83 //@}