service/native/framework_unified/client/include/native_service/ns__CWORD77__data_pool_if.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  * @file ns__CWORD77__data_pool_if.h
  19  * @brief \~english This file provides api to operating _CWORD77_DataPool
  20  *
  21  */
  22 /** @addtogroup BaseSystem
  23  *  @{
  24  */
  25 /** @addtogroup native_service
  26  *  @ingroup BaseSystem
  27  *  @{
  28  */
  29 /** @addtogroup framework_unified
  30  *  @ingroup native_service
  31  *  @{
  32  */
  33 /** @addtogroup _CWORD77_
  34  *  @ingroup framework_unified
  35  *  @{
  36  */
  37 ////////////////////////////////////////////////////////////////////////////////
  38 /// \ingroup  tag_HMI_CWORD77_Controller
  39 /// \brief
  40 ///
  41 ////////////////////////////////////////////////////////////////////////////////
  42 //@{
  43 #ifndef _C_CWORD77_DATAPOOLIF_H_  // NOLINT  (build/header_guard)
  44 #define _C_CWORD77_DATAPOOLIF_H_
  45
  46 #include <native_service/ns__CWORD77__types.h>
  47
  48   ////////////////////////////////////////////////////////////////////////////////////////////
  49   /// \ingroup tag_HMI_CWORD77_Controller
  50   /// \~english @par Brief
  51   ///        API to set data associated with request into _CWORD77_ Data Pool
  52   /// \~english @param  [in] f_DataPoolKey
  53   ///        _CWORD77_DataPoolKey  - Data pool key
  54   /// \~english @param  [in] f_uiSize
  55   ///        UI_32  - size of the data
  56   /// \~english @param  [in] f_pData
  57   ///        PVOID  - void pointer to data
  58   /// \~english @retval none
  59   /// \~english @par Preconditions
  60   ///       - None.
  61   /// \~english @par Change of the internal state
  62   ///       - Change of internal state according to the API does not occur.
  63   /// \~english @par Conditions of processing failure
  64   ///       - None.
  65   /// \~english @par Detail
  66   ///        API to set data associated with request into _CWORD77_ Data Pool
  67   /// \~english @par
  68   ///       It is maintained by executing C_CWORD77_Data::SetRespoData().
  69   /// \~english @par Classification
  70   ///       Public
  71   /// \~english @par Type
  72   ///          Set Get
  73   /// \~english @see GetRespDataFrom_CWORD77_DataPool, C_CWORD77_Data::SetRespoData
  74   ////////////////////////////////////////////////////////////////////////////////////////////
  75 VOID SetReqDataIn_CWORD77_DataPool(const _CWORD77_DataPoolKey &f_DataPoolKey, UI_32 f_uiSize, PVOID f_pData);
  76
  77   ////////////////////////////////////////////////////////////////////////////////////////////
  78   /// \ingroup tag_HMI_CWORD77_Controller
  79   /// \~english @par Brief
  80   ///        API to get data associated with response from _CWORD77_ Data Pool
  81   /// \~english @param  [in] f_DataPoolKey
  82   ///        _CWORD77_DataPoolKey  - Data pool key
  83   /// \~english @param  [out] f_uiSize
  84   ///        UI_32  - size of the data
  85   /// \~english @param  [out] f_pData
  86   ///        PVOID  - void pointer to data
  87   /// \~english @retval eFrameworkunifiedStatusOK    Success
  88   /// \~english @retval eFrameworkunifiedStatusFail  Error
  89   /// \~english @par Preconditions
  90   ///       - None.
  91   /// \~english @par Change of the internal state
  92   ///       - Change of internal state according to the API does not occur.
  93   /// \~english @par Conditions of processing failure
  94   ///       - C_CWORD77_Data Class instance fail or create fail [eFrameworkunifiedStatusFail]
  95   ///       - f_DataPoolKey is not registered [eFrameworkunifiedStatusFail]
  96   ///       - f_pData is NULL [eFrameworkunifiedStatusFail]
  97   /// \~english @par Detail
  98   ///        API to get data associated with response from _CWORD77_ Data Pool
  99   /// \~english @par
 100   ///       Use SetRespNotfnDataFrom_CWORD77_DataPool() to keep the data.
 101   /// \~english @par Classification
 102   ///       Public
 103   /// \~english @par Type
 104   ///          Set Get
 105   /// \~english @see SetRespNotfnDataFrom_CWORD77_DataPool, C_CWORD77_Data::GetRespoData
 106   ////////////////////////////////////////////////////////////////////////////////////////////
 107 EFrameworkunifiedStatus GetRespDataFrom_CWORD77_DataPool(const _CWORD77_DataPoolKey &f_DataPoolKey,  // NOLINT  (readability/nolint)
 108                                       UI_32 &f_uiSize,  // NOLINT  (readability/nolint)
 109                                       PVOID &f_pData);  // NOLINT  (readability/nolint)
 110
 111   ////////////////////////////////////////////////////////////////////////////////////////////
 112   /// \ingroup tag_HMI_CWORD77_Controller
 113   /// \~english @par Brief
 114   ///        API to set data associated with notification response into _CWORD77_ Data Pool
 115   /// \~english @param[in] f_cNotificationName
 116   ///        const std::string& - Name of the notification
 117   /// \~english @param[in] f_uiSize
 118   ///        UI_32 - size of the data
 119   /// \~english @param[in] f_pData
 120   ///        const PVOID - void pointer to data
 121   /// \~english @retval none
 122   /// \~english @par Preconditions
 123   ///       - None.
 124   /// \~english @par Change of the internal state
 125   ///       - Change of internal state according to the API does not occur.
 126   /// \~english @par Conditions of processing failure
 127   ///       - None.
 128   /// \~english @par Detail
 129   ///        API to set data associated with notification response into _CWORD77_ Data Pool
 130   /// \~english @par
 131   ///       Use GetRespNotfnDataFrom_CWORD77_DataPool() to get the held data.
 132   /// \~english @par
 133   ///       It is maintained by executing C_CWORD77_Data::SetRespoData().
 134   /// \~english @par Classification
 135   ///        Public
 136   /// \~english @par Type
 137   ///          Set Get
 138   /// \~english @see GetRespNotfnDataFrom_CWORD77_DataPool, C_CWORD77_Data::SetRespoData
 139   ////////////////////////////////////////////////////////////////////////////////////////////
 140 VOID SetRespNotfnDataIn_CWORD77_DataPool(const std::string &f_cNotificationName, UI_32 f_uiSize, const PVOID f_pData);
 141
 142   ////////////////////////////////////////////////////////////////////////////////////////////
 143   /// \ingroup tag_HMI_CWORD77_Controller
 144   /// \~english @par Brief
 145   ///        API to set data associated with notification response into _CWORD77_ Data Pool
 146   /// \~english @param[in] f_cNotificationName
 147   ///        const std::string& - Name of the notification
 148   /// \~english @param[out] f_uiSize
 149   ///        UI_32& - size of the data
 150   /// \~english @param[out] f_pData
 151   ///        PVOID& - void pointer to data
 152   /// \~english @retval eFrameworkunifiedStatusOK    Success
 153   /// \~english @retval eFrameworkunifiedStatusFail  Fail
 154   /// \~english @par Preconditions
 155   ///       - None.
 156   /// \~english @par Change of the internal state
 157   ///       - Change of internal state according to the API does not occur.
 158   /// \~english @par Conditions of processing failure
 159   ///       - C_CWORD77_Data Class instance fail or create fail [eFrameworkunifiedStatusFail]
 160   ///       - f_cNotificationName is not registered [eFrameworkunifiedStatusFail]
 161   ///       - f_pData is NULL [eFrameworkunifiedStatusFail]
 162   /// \~english @par Detail
 163   ///        API to set data associated with notification response into _CWORD77_ Data Pool
 164   /// \~english @par
 165   ///       Use SetRespNotfnDataFrom_CWORD77_DataPool() to keep the data.
 166   /// \~english @par
 167   ///       Get by executing C_CWORD77_Data::GetRespoData().
 168   /// \~english @par Classification
 169   ///        Public
 170   /// \~english @par Type
 171   ///          Set Get
 172   /// \~english @see SetRespNotfnDataFrom_CWORD77_DataPool, C_CWORD77_Data::GetRespoData
 173   ////////////////////////////////////////////////////////////////////////////////////////////
 174 EFrameworkunifiedStatus GetRespNotfnDataFrom_CWORD77_DataPool(const std::string &f_cNotificationName,  // NOLINT  (readability/nolint)
 175                                            UI_32 &f_uiSize,  // NOLINT  (readability/nolint)
 176                                            PVOID &f_pData);  // NOLINT  (readability/nolint)
 177
 178 #endif  // _C_CWORD77_DATAPOOLIF_H_ NOLINT  (build/header_guard)
 179 //@}
 180 /** @}*/
 181 /** @}*/
 182 /** @}*/
 183 /** @}*/