SerializableFile.hpp

Go to the documentation of this file.

// ======================================================================
// \title  SerializableFile.hpp
// \author dinkel
// \brief  hpp file for SerializableFile
//
// \copyright
// Copyright 2009-2016, by the California Institute of Technology.
// ALL RIGHTS RESERVED.  United States Government Sponsorship
// acknowledged.
//
// ======================================================================

#ifndef Fw_SerializableFile_HPP
#define Fw_SerializableFile_HPP

#include <Fw/Types/MemAllocator.hpp>
#include <Fw/Types/SerialBuffer.hpp>
#include <Fw/Types/Serializable.hpp>

namespace Fw {

class SerializableFile {
  public:
    enum Status { OP_OK, FILE_OPEN_ERROR, FILE_WRITE_ERROR, FILE_READ_ERROR, DESERIALIZATION_ERROR };

    // NOTE!: This should not be used with an allocator that can return a smaller buffer than requested
    SerializableFile(MemAllocator* allocator, FwSizeType maxSerializedSize);
    ~SerializableFile();

    Status load(const char* fileName, Serializable& serializable);
    Status save(const char* fileName, Serializable& serializable);

  private:
    void reset();
    MemAllocator* m_allocator;
    bool m_recoverable;       // don't care; for allocator
    FwSizeType m_actualSize;  // for checking
    SerialBuffer m_buffer;
};
}  // namespace Fw

#endif