File.hpp

Go to the documentation of this file.

#ifndef _File_hpp_
#define _File_hpp_
 
#include <FpConfig.hpp>
#include <Fw/Types/BasicTypes.hpp>
 
namespace Os {
 
    // This class encapsulates a very simple file interface that has the most often-used features
 
    class File {
        public:
 
            typedef enum {
                OPEN_NO_MODE,   
                OPEN_READ, 
                OPEN_WRITE, 
                OPEN_SYNC_WRITE, 
                OPEN_SYNC_DIRECT_WRITE, 
                OPEN_CREATE, 
                OPEN_APPEND, 
            } Mode;
 
            typedef enum {
                OP_OK, 
                DOESNT_EXIST, 
                NO_SPACE, 
                NO_PERMISSION, 
                BAD_SIZE, 
                NOT_OPENED, 
                FILE_EXISTS, 
                OTHER_ERROR, 
            } Status;
 
            File(); 
            virtual ~File(); 
            Status prealloc(NATIVE_INT_TYPE offset, NATIVE_INT_TYPE len);
            Status open(const char* fileName, Mode mode); 
            Status open(const char* fileName, Mode mode, bool include_excl); 
            bool isOpen(void); 
            Status seek(NATIVE_INT_TYPE offset, bool absolute = true); 
            Status flush(); 
            Status read(void * buffer, NATIVE_INT_TYPE &size, bool waitForFull = true); 
                                                                            // size is modified to actual read size
            Status write(const void * buffer, NATIVE_INT_TYPE &size, bool waitForDone = true); 
            Status bulkWrite(const void * buffer, NATIVE_UINT_TYPE &totalSize, NATIVE_INT_TYPE chunkSize); 
 
            void close(void); 
 
            NATIVE_INT_TYPE getLastError(void); 
            const char* getLastErrorString(void); 
            Status calculateCRC32(U32 &crc); 
 
            static Status niceCRC32(U32 &crc, const char* fileName); 
 
        private:
 
            NATIVE_INT_TYPE m_fd; 
            Mode m_mode; 
            NATIVE_INT_TYPE m_lastError; 
 
    };
 
}
 
#endif