video_in_hal/systemservice/logger_service/server/include/ss_logger_fs_directory.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_SS_LoggerService
  19 /// \brief    This file contains declaration of class CFSDirectory.
  20 ///
  21 ///////////////////////////////////////////////////////////////////////////////
  22 #ifndef LOGGER_SERVICE_SERVER_INCLUDE_SS_LOGGER_FS_DIRECTORY_H_
  23 #define LOGGER_SERVICE_SERVER_INCLUDE_SS_LOGGER_FS_DIRECTORY_H_
  24 #include <native_service/frameworkunified_types.h>
  25 #include<string>
  26
  27 // Class to provide file system directory operations like create,delete etc.
  28 class CFSDirectory {
  29  public:
  30   ////////////////////////////////////////////////////////////////////////////////////////////////
  31   /// CFSDirectory
  32   /// Constructor of CFSDirectory class
  33   ///
  34   /// \param
  35   ///
  36   /// \return
  37   ///
  38   ////////////////////////////////////////////////////////////////////////////////////////////////
  39   CFSDirectory();
  40
  41   ////////////////////////////////////////////////////////////////////////////////////////////////
  42   /// ~CFSDirectory
  43   /// Destructor of CFSDirectory class
  44   ///
  45   /// \param
  46   ///
  47   /// \return
  48   ///
  49   ////////////////////////////////////////////////////////////////////////////////////////////////
  50   ~CFSDirectory();
  51
  52   ////////////////////////////////////////////////////////////////////////////////////////////
  53   /// This method is used to check if the directory exists.
  54   ///
  55   /// \param [in] f_cDirPath
  56   ///         std::string - Path of the directory to delete.
  57   ///
  58   /// \return status
  59   ///         EFrameworkunifiedStatus - success or error
  60   ////////////////////////////////////////////////////////////////////////////////////////////
  61   static BOOL DoesDirectoryExist(std::string &f_cDirPath);  // NOLINT (runtime/references)
  62
  63   ////////////////////////////////////////////////////////////////////////////////////////////
  64   /// This method is used to create a directory.
  65   ///
  66   /// \param [in] f_cDirPath
  67   ///         std::string - Path of the directory to delete.
  68   ///
  69   /// \return status
  70   ///         EFrameworkunifiedStatus - success or error
  71   ////////////////////////////////////////////////////////////////////////////////////////////
  72   static EFrameworkunifiedStatus CreateDirectory(std::string &f_cDirPath);  // NOLINT (runtime/references)
  73
  74   ////////////////////////////////////////////////////////////////////////////////////////////
  75   /// This method is used to verify directory.
  76   ///
  77   /// \param [in] f_cPath
  78   ///         std::string - Path of the directory to delete.
  79   ///
  80   /// \return status
  81   ///         EFrameworkunifiedStatus - success or error
  82   ////////////////////////////////////////////////////////////////////////////////////////////
  83   static BOOL IsDirectory(std::string &f_cPath);  // NOLINT (runtime/references)
  84
  85   ////////////////////////////////////////////////////////////////////////////////////////////
  86   /// This method is used to delete directory.
  87   ///
  88   /// \param [in] f_cPath
  89   ///         std::string - Path of the directory to delete.
  90   ///
  91   /// \return status
  92   ///         EFrameworkunifiedStatus - success or error
  93   ////////////////////////////////////////////////////////////////////////////////////////////
  94   static BOOL RemoveDirectory(std::string &f_cPath);  // NOLINT (runtime/references)
  95
  96   ////////////////////////////////////////////////////////////////////////////////////////////
  97   /// This method is used to delete file in direcotry.
  98   ///
  99   /// \param [in] f_cPath
 100   ///         std::string - Path of the directory to delete.
 101   ///
 102   /// \return status
 103   ///         EFrameworkunifiedStatus - success or error
 104   ////////////////////////////////////////////////////////////////////////////////////////////
 105   static BOOL RemoveSubDirectory(std::string &f_cPath);  // NOLINT (runtime/references)
 106 };
 107
 108 #endif  // LOGGER_SERVICE_SERVER_INCLUDE_SS_LOGGER_FS_DIRECTORY_H_