video_in_hal/nsframework/framework_unified/client/include/native_service/frameworkunified_sm_eventfactory.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_StateMachine
  19 /// \brief
  20 ///
  21 /// This file defines the events used by the statemachine framework
  22 ///////////////////////////////////////////////////////////////////////////////
  23 //@{
  24 /**
  25  * @file frameworkunified_sm_eventfactory.h
  26  * @brief \~english This file defines the events used by the statemachine framework.
  27  *
  28  */
  29 /** @addtogroup BaseSystem
  30  *  @{
  31  */
  32 /** @addtogroup native_service
  33  *  @ingroup BaseSystem
  34  *  @{
  35  */
  36 /** @addtogroup framework_unified
  37  *  @ingroup native_service
  38  *  @{
  39  */
  40 /** @addtogroup framework
  41  *  @ingroup framework_unified
  42  *  @{
  43  */
  44 /** @addtogroup statemachine
  45  *  @ingroup framework
  46  *  @{
  47  */
  48 #ifndef CFRAMEWORKUNIFIEDEVENTFACTORY_H_  // NOLINT  (build/header_guard)
  49 #define CFRAMEWORKUNIFIEDEVENTFACTORY_H_
  50
  51 #include <native_service/frameworkunified_types.h>
  52
  53 ///////////////////////////////////////////////////////////////////////////////////////////////////
  54 /// This class defines the events used by the statemachine framework
  55 ///////////////////////////////////////////////////////////////////////////////////////////////////
  56 class CFrameworkunifiedEventFactory {
  57  public:
  58   ///////////////////////////////////////////////////////////////////////////////////////////
  59   /// \ingroup CFrameworkunifiedEventFactory
  60   /// \~english @par Brief
  61   ///          Constructor for class CFrameworkunifiedEventFactory.
  62   /// \~english @param none
  63   /// \~english @retval
  64   /// \~english @par Prerequisite
  65   ///            none
  66   /// \~english @par Change of internal state
  67   ///            none
  68   /// \~english @par Conditions of processing failure
  69   ///            none
  70   /// \~english @par Detail
  71   ///           none
  72   /// \~english @par Classification
  73   ///           public
  74   /// \~english @par Type
  75   ///           none
  76   /// \~english @see ~CFrameworkunifiedEventFactory
  77   ///////////////////////////////////////////////////////////////////////////////////////////
  78   CFrameworkunifiedEventFactory();
  79
  80   ///////////////////////////////////////////////////////////////////////////////////////////
  81   /// \ingroup CFrameworkunifiedEventFactory
  82   /// \~english @par Brief
  83   ///        Destructor for CFrameworkunifiedEventFactory
  84   /// \~english @retval none
  85   /// \~english @par Preconditons
  86   ///          - Self instance of CFrameworkunifiedEventFactory created.
  87   /// \~english @par Change of internal status
  88   ///                none
  89   /// \~english @par Conditions of processing failure
  90   ///                none
  91   /// \~english @par Detail
  92   ///          Class CFrameworkunifiedHistoryState instance release.
  93   /// \~english @par Classification
  94   ///           public
  95   /// \~english @par Type
  96   ///            none
  97   /// \~english @see CFrameworkunifiedEventFactory::CFrameworkunifiedEventFactory
  98   ///////////////////////////////////////////////////////////////////////////////////////////
  99   virtual ~CFrameworkunifiedEventFactory();
 100
 101   /// Defines the events for starting an application
 102   static const UI_32 evFrameworkunifiedStart = 0;
 103
 104   /// Defines the Higher limit for event id reserved only for framework
 105   static const UI_32 evFrameworkunifiedEventLimit = 10;
 106 };
 107
 108 #endif /* CFRAMEWORKUNIFIEDEVENTFACTORY_H_ */  // NOLINT  (build/header_guard)
 109 /** @}*/
 110 /** @}*/
 111 /** @}*/
 112 /** @}*/
 113 /** @}*/
 114 //@}