mirror of
https://github.com/nasa/fprime.git
synced 2025-12-10 00:44:37 -06:00
48e4720419
* Created new SerialBufferBase as a parent of SerializeBufferBase. Renaming interface functions to be less confusing. * Deprecating copyRawOffset. No direct use-cases in F' core. * Make SerialBufferBase a true pure virtual interface. * Changing Serializable to work with SerialBufferBase parent interface. * Changing copyRaw and copyRawOffset to work with SerialBufferBase * Updating documentation for SerialBufferBase usage * Adding some documentation. Adding missing ASSERT in copyRaw. Fixing some bugs that new ASSERT uncovered. * Renaming SerializeBufferBase to LinearBufferBase. Add a using declaration to maintain backwards compatability. Properly mark LinearBufferBase functions as override. * Filling in the rest of the docstrings for the classes in Serializable * Removing redundant virtual keyword on override function * Applying clang formatting * Incorporating PR comments * Fix compile issues * Bump version to alpha * Format * v --------- Co-authored-by: M Starch <LeStarch@googlemail.com>
91 lines
3.0 KiB
C++
91 lines
3.0 KiB
C++
// ======================================================================
|
|
// \title SerializableFile.cpp
|
|
// \author dinkel
|
|
// \brief cpp file for SerializableFile
|
|
//
|
|
// \copyright
|
|
// Copyright 2009-2016, by the California Institute of Technology.
|
|
// ALL RIGHTS RESERVED. United States Government Sponsorship
|
|
// acknowledged.
|
|
//
|
|
// ======================================================================
|
|
|
|
#include "Fw/SerializableFile/SerializableFile.hpp"
|
|
#include "Fw/Types/Assert.hpp"
|
|
#include "Os/File.hpp"
|
|
|
|
namespace Fw {
|
|
|
|
SerializableFile::SerializableFile(MemAllocator* allocator, FwSizeType maxSerializedSize)
|
|
: m_allocator(allocator),
|
|
m_recoverable(false), // for compiler; not used
|
|
m_actualSize(maxSerializedSize),
|
|
m_buffer(static_cast<U8*>(this->m_allocator->allocate(0, m_actualSize, m_recoverable)), m_actualSize) {
|
|
// assert if allocator returns smaller size
|
|
FW_ASSERT(maxSerializedSize == m_actualSize, static_cast<FwAssertArgType>(maxSerializedSize),
|
|
static_cast<FwAssertArgType>(m_actualSize));
|
|
FW_ASSERT(nullptr != m_buffer.getBuffAddr());
|
|
}
|
|
|
|
SerializableFile::~SerializableFile() {
|
|
this->m_allocator->deallocate(0, this->m_buffer.getBuffAddr());
|
|
}
|
|
|
|
SerializableFile::Status SerializableFile::load(const char* fileName, Serializable& serializable) {
|
|
Os::File file;
|
|
Os::File::Status status;
|
|
status = file.open(fileName, Os::File::OPEN_READ);
|
|
if (Os::File::OP_OK != status) {
|
|
return FILE_OPEN_ERROR;
|
|
}
|
|
|
|
FwSizeType length = this->m_buffer.getCapacity();
|
|
status = file.read(this->m_buffer.getBuffAddr(), length, Os::File::WaitType::NO_WAIT);
|
|
if (Os::File::OP_OK != status) {
|
|
file.close();
|
|
return FILE_READ_ERROR;
|
|
}
|
|
file.close();
|
|
|
|
this->reset();
|
|
SerializeStatus serStatus;
|
|
serStatus = this->m_buffer.setBuffLen(length);
|
|
FW_ASSERT(FW_SERIALIZE_OK == serStatus, serStatus);
|
|
serStatus = serializable.deserializeFrom(this->m_buffer);
|
|
if (FW_SERIALIZE_OK != serStatus) {
|
|
return DESERIALIZATION_ERROR;
|
|
}
|
|
|
|
return SerializableFile::OP_OK;
|
|
}
|
|
|
|
SerializableFile::Status SerializableFile::save(const char* fileName, Serializable& serializable) {
|
|
this->reset();
|
|
SerializeStatus serStatus = serializable.serializeTo(this->m_buffer);
|
|
FW_ASSERT(FW_SERIALIZE_OK == serStatus, serStatus);
|
|
|
|
Os::File file;
|
|
Os::File::Status status;
|
|
status = file.open(fileName, Os::File::OPEN_WRITE);
|
|
if (Os::File::OP_OK != status) {
|
|
return FILE_OPEN_ERROR;
|
|
}
|
|
|
|
FwSizeType length = this->m_buffer.getSize();
|
|
status = file.write(this->m_buffer.getBuffAddr(), length);
|
|
if ((Os::File::OP_OK != status) || (length != this->m_buffer.getSize())) {
|
|
file.close();
|
|
return FILE_WRITE_ERROR;
|
|
}
|
|
|
|
file.close();
|
|
|
|
return SerializableFile::OP_OK;
|
|
}
|
|
|
|
void SerializableFile::reset() {
|
|
this->m_buffer.resetSer(); //!< reset to beginning of buffer to reuse for serialization
|
|
this->m_buffer.resetDeser(); //!< reset deserialization to beginning
|
|
}
|
|
} // namespace Fw
|