GeoFatFsSurveyStorage.hpp

#ifndef GM_TIVA_FATFS_STORAGE_HPP_
#define GM_TIVA_FATFS_STORAGE_HPP_
 
#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include <stdbool.h>
#include <GmFatFs/ff.h>
#include "GeoFatFsStorage.hpp"
#include <functional>
 
 
namespace Geometrics
{
 
#define FIRST_AVAILABLE_ACQUISITION_FILE -1
 
   class GeoFatFsSurveyStorage : public GeoFatFsStorage
   {
      public:
      GeoFatFsSurveyStorage  ();
 
      /* The destructure is virtual, because some storages are deleted in
       * base class context.
       */
      virtual       ~GeoFatFsSurveyStorage ();
      int           QuitAcquisition          (int             iAcquisitionIndex);
      virtual int   Close               (int             iFileIndex);
 
      int           WriteData           (const char*     pcData,
                                         unsigned int    iDataSize,
                                         UInt32          ui32Topic);
      int           SetSessionFolder    (const char*    *szSurveyName,
                                         const int       iSessionId);
      int           SetSessionFileName  (const char*    *szFileName,
                                         const int       iSessionId);
      int           RunTestSuite        ();
      int           ForEachFileInfo     (const char    *strSurveyId,
                                         const char    *strAcquisitionId,
                                         std::function<void (FILINFO *fInfo)> handler);
      int           ListDataFilesEx     (const char    *strSurveyId,
                                         const char    *strAcqusitionId,
                                         char           pSessions[20][12],
                                         //GmSessionNames   *psnSessions,
                                         int              iMaxFiles,
                                         int             *piFilesCounted,
                                         int             *piFilesReturned);
 
      int           ListAcquisitions         (const char *strSurveyId,
                                              GmSessionNames *psnSessions);
      int           GetSessionDataSize  (int             iAcquisitionIndex,
                                         char*           szSessionName,
                                         UInt32*         uiSize);
      int           SessionTimeString   (int             iAcquisitionIndex,
                                         char           *szSessionName,
                                         char           *szDestination);
 
      /****************************************************************************/
      /* Functions for survey/acquisition/file structure.                         */
      /****************************************************************************/
      int  CreateNextSurveyEx      (const char     *strName,
                                    char           *pcNewIdBuffer,
                                    int             iBufferLength);
 
      int  GetActiveSurveyEx       (char           *szAnswerBuffer,
                                    int             iAnswerBufferSize);
      #if EMBEDDED_DATA_STORAGE == GEO_TRUE
      int  CreateNewSurveyEx       (const char     *strId,
                                    const char     *strName);
      int  GetAcquisitionInfoEx    (const char     *szSurveyId,
                                    const char     *szAcquisitionId,
                                    char           *szAcquisitionNameBuffer,
                                    int             iAcquisitionNameBufferSize,
                                    bool           *pFilesInDirectories,
                                    int            *pDirectorySize);
      int  GetAcquisitionCachedLastFile (const char    *szSurveyId,
                                         const char           *szAcquisitionId,
                                         int                  *pLastFileCounted);
      int  LoadAcquisitionInfoEx   (const char     *szSurveyId,
                                    const char     *szAcquisitionId);
      int  CreateAcquisitionEx     (char           *szSurveyId,
                                    const char     *strAcquisitionId,
                                    const char     *szNewAcquisitionName)    ;
      int  CreateNextAcquisitionEx (char           *szSurveyId,
                                    const char     *szNewAcquisitionName,
                                    char           *pcNewAcquisitionIdBuffer,
                                    int             iAcquisitionIdBufferLength);
      int  AddAcquisitionInfoEx    (const char     *strSurveyId,
                                    const char     *strAcquisitionId,
                                    const char     *iAcquisitionName,
                                    Bool            filesInDirectories,
                                    int             directorySize);
      int  SaveSurveyInfoEx        (const char     *szSurveyId,
                                    const char     *szName,
                                    Bool            filesInDirectories);
      int  ListAcquisitionsEx      (char          **ppcResponse,
                                    const char     *szSurveyId);
      int  ListAcquisitionsEx2      (char          **ppcResponse,
                                    const char     *szSurveyId,
                                    const Bool     includeSizes);
      int  ListSurveysJsonEx       (char          **ppcResponse);
      int ListDataFilesJsonEx      (char            **ppcResponse,
                                      const char       *strSurveyId,
                                      const char       *strAcquisitionId);
      int ListDataFilesJsonEx2      (char            **ppcResponse,
                                      const char       *strSurveyId,
                                      const char       *strAcquisitionId);
      #endif
      int  GetActiveAcquisitionEx  (char           *szSurveyBuffer,
                                    int             iSurveyBufferSize,
                                    char           *szAcquisitionBuffer,
                                    int             iAcquisitionBufferSize);
      int  GetAcquisitionCachedSize (const char    *szSurveyId,
                                                    const char           *szAcquisitionId,
                                                    int                  *pLastFileCounted,
                                                    uint32_t             *pRecordedSize);
      int  AcquisitionIsSet         ();
      int  AddSurveyInfoEx         (int             iSurveyIndex,
                                    char           *szSurveyName);
      int  SelectSurveyEx          (const char     *strSurveyId);
      int  CloseCurrentSurveyEx    ();
      int  CloseCurrentAcquisitionEx    ();
      int  SelectAcqJsonEx         (const char   *strSurveyId,
                                    const char   *strAcquisitionId);
      int  AcquisitionExistsEx     (const char   *strSurveyId,
                                    const char   *strAcquisitionId);
      int  SelectAcqEx (const char   *strSurveyId,
                                               const char   *strAcquisitionId);
      int  SurveyExistsEx          (const char   *strSurveyId);
      int         OpenNextFileEx       (int           iLastFile,
                                      const char   *szOpenMode);
      int  FindSurveyByNameEx        (const char         *strSurveyName,
                                      char             *strIdBuffer,
                                      const int      iBufferSize);
      int    DeleteAcquisitionEx         (const char       *strSurveyId,
                                      const char           *szAcquisitionId);
      int    CleanOldFiles         ();
      int AcquisitionTotalSize           (const char    *strSurveyId,
                                      const char    *strAcquisitionId,
                                      UInt32        *pTotalSize,
                                      int32_t       *pLastFileIndex);
      int AcquisitionLastFile        (const char    *strSurveyId,
                                      const char    *strAcquisitionId,
                                      int32_t       *pLastFileIndex);
 
 
      /************************************************************************/
      /* Delete acquisition including contained files.                        */
      /************************************************************************/
      int    DeleteFullAcquisitionEx    (const char           *strSurveyId,
                                         const char           *szAcquisitionId);
      int           FileDataSizeEx  (const char *strSurveyId,
                                        const char *strAcquisitionId,
                                        const char *strFileName,
                                        UInt32*     uiSize,
                                        const bool  filesInDirectories,
                                        const int   directorySize);
      int           FileDataSizeEx  (const char *strSurveyId,
                                        const char *strAcquisitionId,
                                        const int   fileIndex,
                                        UInt32*     uiSize,
                                        const bool  filesInDirectories,
                                        const int   directorySize);
 
      int           SurveyFileDataSize (const char *strSurveyId,
                                        const char *strAcquisitionId,
                                        bool        filesInDirectories,
                                        int         directorySize,
                                        int         fileIndex,
                                        uint32_t   *fileSize);
 
      static int    FileTimeToString   (FILINFO    *fno,
                                        char       *szDestination);
      int           FileTimeStringEx   (const char *strSurveyId,
                                        const char *strAcquisitionId,
                                        const char *strFileName,
                                        char       *szDestination);
      int           OpenDataFileToRead (const char  *strSurveyId,
                                        const char  *strAcquisitionId,
                                        const char  *strFileName);
      int           OpenDataFileToRead (const char  *strSurveyId,
                                        const char  *strAcquisitionId,
                                        const int    fileIndex,
                                        const bool   filesInDirectories,
                                        const int    directorySize);
      static int    DecodeDownloadName (const char    *szDownloadName,
                                        char          *strSurveyId,
                                        char          *strAcquisitionName,
                                        char          *strFileName);
      static int    BuildDownloadName  (const char *strSurveyId,
                                        const char *strAcquisitionId,
                                        const char *strFileName,
                                        char       *szDest);
      int           DeleteDataFileEx   (const char *strSurveyId,
                                        const char *strAcquisitionId,
                                        const char *strFileName);
 
      /****************************************************************************/
      /* Overrides                                                                */
      /****************************************************************************/
      Int   GetLastError     ();
 
      #if (GEO_DATA_STORAGE == GEO_TRUE)
      int   RollAndSynchFile ();
      #endif
 
 
      public:
      void        InitPaths ();
 
 
      protected:
      int                m_iNextFileIndex;
      char               m_szCurrentActiveSurveyId[MAX_SURVEY_ID_LENGTH+1],
                         m_szCurrentActiveAcquisitionId[MAX_ACQUISITION_ID_LENGTH+1];
      Bool               m_filesInDirectories,
                         m_directoriesNested,
                         m_directoryInfoLoaded;
      int                m_directorySize;
 
 
      int         SearchNextFileIndex (char     *strSurveyPath,
                                       int      *iNextNumber,
                                       Bool      filesInDirectories,
                                       int       directorySize);
      int         FindNextFileName   (char     *dest,
                                      const char     *strSurveyPath,
                                      int      *iNextNumber,
                                      Bool      bIsText,
                                      Bool      filesInDirectories,
                                      int       directorySize);
      int         BuildOutputFileName (char    *szDest, int iPathIndex, int iFileIndex, bool inDirectories,
                                       int directorySize, bool bIsText);
      int         BuildDataSetName (char    *szDest, int iPathIndex, char *strDataSet);
      int         BuildOutputFileName (char    *szDest, char* strSurveyPath, int iIndex, bool inDirectories,
                                       int directorySize,
                                       bool bIsText);
      int         GetAcquisitionPath (char *szDest, int iIndex);
      static int  GetAcquisitionDirectory (char *szDest, const char *strSurveyId, const char *strAcquisitionId);
      int         WriteNameBase       (char *szDest, int iIndex );
 
      /****************************************************************************/
      /* Internal functions for survey/acquisition/file structure.                */
      /****************************************************************************/
      int         FindNextSurveyIndexEx      (int     *iDest);
      int         FindNextAcquisitionIdEx    (const char  *strSurveyId,
                                              char        *pNewAcquisitionIdBuffer,
                                              int          iBufferLength);
      int         CreateSurveyDirectoryEx    (const char *szNewSurveyId);
      int         GetSurveyPath  (char *szDest, int iIndex);
      static int         GetSurveyPathEx  (char *szDest, const char *szSurveyId);
      static int         GetAcquisitionPathEx (const char *szSurveyId,
                                        const char *strAcqId,
                                        char       *strBuffer,
                                        int         iBufferLength);
      int         CountAcquisitionFilesEx   (const char *strSurveyId,
                                           const char *strAcquisitionId,
                                           int        *iCounter);
 
      /************************************************************************/
      /* Delete all the files in an acquisition      .                        */
      /************************************************************************/
      int         DeleteAcquisitionFilesEx  (const char *strSurveyId,
                                             const char *strAcquisitionId);
      int         DeleteAcquisitionConfigFileEx (const char *strSurveyId,
                                                const char *strAcquisitionId);
      int         CreateAcquisitionDirectoryEx (const char *szSurveyId,
                                                const char *strAcqId);
      int         MakeSurveyId         (char *pcDest, const int iBufferSize,
                                          const int iNewSurveyIndex);
      int         MakeAcquisitionIdEx (char *pcDest, const int iBufferSize,
                                       const int iNewAcquisitionIndex);
      int         OpenNextFileEx          ( const char   *strAcquisitionDirectory,
                                            int           iLastFile,
                                            const char   *szOpenMode);
      int         GetAcquisitionConfigFilePath    (const char *strSurveyId,
                                                   const char *strAcquisitionId,
                                                   char       *buffer,
                                                   const int   iBufferSize);
      int         BuildDataFileNameEx    (const char *strSurveyId,
                                        const char *strAcquisitionId,
                                        const char *strFileName,
                                        char       *strBuffer,
                                        int         iMaxBufferSize,
                                        const bool  filesInDirectories,
                                        const int   directorySize);
      int         BuildDataFileNameEx    (const char *strSurveyId,
                                        const char *strAcquisitionId,
                                        const int   fileIndex,
                                        char       *strBuffer,
                                        int         iMaxBufferSize,
                                        const bool  filesInDirectories,
                                        const int   directorySize);
      public:
 
      /* Sometimes we want a simple, non-survey, file of the same storage
       * type as this.
       */
      virtual GeoFatFsSurveyStorage *GetSimilarStorage () = 0;
 
      public:
 
      class ISurveyStorageFactory
      {
      public:
         virtual GeoFatFsSurveyStorage *MakeNewSurveyStorage () { return NULL; };
         int i;
      };
 
     // static int     s_recordsPerFile;
      static ISurveyStorageFactory  *s_pSurveyStorageFactoryPrimary,
                                    *s_pSurveyStorageFactoryZero,
                                    *s_pSurveyStorageFactoryOne;
      static ISurveyStorageFactory *GetFactory (const char whichFactory);
      static void SetFactory (const char whichStorage, ISurveyStorageFactory *pFactory);
 
 
      private:
      /*************************************************************************/
      /*   m_iDataset is the identifier for data obtained between any one      */
      /*     START and its corresponding STOP action.                          */
      /*************************************************************************/
      //int   m_iCurrentDataSetId;
      int   WriteHeader ();
 
      /************************************************************************/
      /* See explanation of transactions in GMStorage.hpp                     */
      /************************************************************************/
      Bool    m_bInTransaction;
      int     mWritesCounted;
      /* How many records to write before rolling to next file.   */
      int           CheckToFlush ();
      virtual int   EnterTransaction () { m_bInTransaction = TRUE; return GM_STORAGE_OK; };
      virtual int   LeaveTransaction ();
   };
}
 
 
 
#endif /* GMTIVASDSTORAGE_HPP_ */