GmStorage.hpp

/*
 * GmStorage.hpp
 *
 *  Created on: May 10, 2016
 *      Author: rcram
 */
 
#ifndef GM_STORAGE_H_
#define GM_STORAGE_H_
 
typedef unsigned long DWORD;
 
#include <geotypes.hpp>
 
 
#ifdef acs
#include <xdc/runtime/Types.h>
#endif
 
/* Error and return codes. */
#define GM_STORAGE_OK       0
#define GM_STORAGE_FAIL    -1
#define GM_STORAGE_ERROR    1
#define GM_STORAGE_EOF      2
#define GM_STORAGE_DATA_TOO_LARGE 3
#define GM_STORAGE_NO_SD_STORAGE_CREATED 4
#define GM_STORAGE_NO_USB_STORAGE_CREATED 5
#define GM_STORAGE_NO_TOPIC   6
#define GM_STORAGE_BAD_TOPIC  7
#define GM_STORAGE_UNKNOWN_OPEN_MODE 8
#define GM_STORAGE_CANT_BUILD_DATA_SET_NAME 9
#define GM_STORAGE_STRING_TOO_LONG 10
#define GM_STORAGE_ERROR_390 11
#define GM_STORAGE_CANT_DELETE_SURVEY 12
#define GM_STORAGE_CANT_VERIFY 13
#define GM_STORAGE_FAIL_SDSPI_OPEN 14
#define GM_STORAGE_BUFFER_NOT_EMPTY 15
#define GM_STORAGE_WRITE_ZERO_LENGTH 16
#define GM_STORAGE_FILE_NOT_FOUND    17
#define GM_STORAGE_SURVEY_ALREADY_ACTIVE 18
#define GM_STORAGE_CURRENTLY_LOGGING     19
#define GM_STORAGE_DIRECTORY_NOT_FOUND   20
#define GM_STORAGE_ACQUISITION_ALREADY_OPEN 21
#define GM_STORAGE_BUFFER_TOO_SMALL      22
#define GM_STORAGE_NO_ACTIVE_SURVEY 23
#define GM_STORAGE_NO_ACTIVE_ACQUISITION 24
#define GM_STORAGE_SURVEY_NOT_FOUND 25
#define GM_STORAGE_ACQUISITION_HAS_FILES 26
#define GM_STORAGE_ACQUISITION_HAS_NO_FILES 27
#define GM_STORAGE_FILE_EXISTS  28
#define GM_STORAGE_FLUSH_FAILED 29
#define GM_STORAGE_FILE_SYSTEM_NOT_READY 30
#define GM_STORAGE_NO_FILE_FOUND         31
#define GM_STORAGE_CANT_CREATE_DIRECTORY 32
#define GM_STORAGE_CANT_DELETE_FILE      33
#define GM_STORAGE_CANT_DELETE_DIRECTORY 34
#define GM_STORAGE_NO_CACHED_SIZE_FOUND  35
#define GM_STORAGE_ALREADY_CLOSED        36
#define GM_STORAGE_FILE_NOT_OPEN         37
#define GM_STORAGE_INTERNAL_ERROR_BASE 100
 
/* Flags for opening and closing files */
#define GM_STORAGE_NO_FLAGS             (0x0000)
#define GM_STORAGE_CLOSE_ROLLOVER       (GM_STORAGE_NO_FLAGS)
#define GM_STORAGE_STOPPING_ACQUISITION (0x0001)
#define GM_STORAGE_DO_NOT_REPORT        (0x0002)
#define GM_STORAGE_DO_NOT_LOCK          (0x0004)
 
namespace Geometrics
{
    typedef char** GmSessionNames;
    #define MAX_SURVEY_ID_LENGTH 10
    #define MAX_ACQUISITION_ID_LENGTH 10
    #define MAX_ACQUISITION_NAME_LENGTH 20
    #define MAX_SURVEY_NAME_LENGTH 20
    #define GM_DEFAULT_SURVEY_NAME "DEFAULT"
    #define MAX_DATA_FILE_SHORT_NAME_LENGTH 20
 
 
    class GmStorage
    {
        public:
        //  virtual int   Open                 (const char*     zName,
        //                                            const char*   szReadWrite) { return 0; };
         GmStorage ();
               virtual int   Close                 (int           iFileIndex) { return 0;};
 
         //  Without this variable defined in a cpp file, the CCS linker won't find a place
         //     for the vtable for this class.  Hacky.  Maybe find some real functionality
         //     in here.
         virtual int   WriteData   (const char*     pcData,
                                    unsigned int    iDataSize,
                                    UInt32          ui32Topic) = 0;
 
         /***********************************************************************************/
         /* Some storages need to treat some groups of writes as single transactions.  For  */
         /*    example, file storages may decide to roll over to a new physical file after  */
         /*    some number of writes.  In the case of array writes, when the header gets    */
         /*    written and then a set of records gets written, the file storage must        */
         /*    put the array header and all of the individual records all in the same file, */
         /*    and roll over only after the end.  The default behavior for storages         */
         /*    is a NOP.  EnterTransaction and LeaveTransaction handle this feature.        */
         /***********************************************************************************/
         virtual int   EnterTransaction () { return GM_STORAGE_OK; };
         virtual int   LeaveTransaction () { return GM_STORAGE_OK; };
         virtual int   RollAndSynchFile () { return GM_STORAGE_OK; };
         virtual int   SelectSurveyEx   (const char     *strSurveyId) { return GM_STORAGE_FAIL; };
         //virtual int   IsFileStorage    () { return FALSE; };
         virtual int   IsDataStorage    () { return FALSE; };
 
 
 
         virtual int   GetLastError () { return -1; };
 
         virtual ~GmStorage ();
 
         /*******************************************************************************************/
         /* IsOpen is declared here, and also defined, in order to provide a model of the function  */
         /*    throughout the class tree derived from GmStorage.  BUT, we don't want to rely on this */
         /*    implementation, so it will break.  If you develop code that requires IsOpen(), then  */
         /*    you must develop for the correction semantics for that class.                        */
         /*******************************************************************************************/
         virtual bool  IsOpen () { return m_bIsOpen; /* m_bIsOpen;*/ };
 
         /* TODO RHC really should be SetAttribute, or something generic, because this is pushing
          * survey information down into the base class.
          */
         /* Push a known datasetID into the storage. */
         void  SetDatasetId     (const int iDataset);
 
         /* Get the current dataset ID.  Optionally, increment */
         /* The result will be a positive integer              */
         int   GetDatasetId     (bool      increment);
 
 
         virtual int  Shutdown () { return 0; };
 
         static int     s_recordsPerFile;
 
         static int DecodeDownloadName(const char *szDownloadName,
                                       char *strSurveyId,
                                       char *strAcquisitionId,
                                       char *strFileName);
 
 
        protected:
         bool   m_bIsOpen;
         int    m_iCurrentDataSetId;
         bool   mIncrementDatasetId;
    };
}
 
#endif