F´ Flight Software - C/C++ Documentation  NASA-v1.5.0
A framework for building embedded system applications to NASA flight quality standards.
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Public Attributes | List of all members
Fw::SerializableFile Class Reference

The type of a packet header. More...

#include <Fw/SerializableFile/SerializableFile.hpp>

Public Types

enum  Status {
  OP_OK, FILE_OPEN_ERROR, FILE_WRITE_ERROR, FILE_READ_ERROR,
  DESERIALIZATION_ERROR
}
 

Public Member Functions

 SerializableFile (MemAllocator *allocator, NATIVE_UINT_TYPE maxSerializedSize)
 
 ~SerializableFile ()
 
Status load (const char *fileName, Serializable &serializable)
 
Status save (const char *fileName, Serializable &serializable)
 

Public Attributes

PRIVATE __pad0__: void reset()
 
MemAllocator * allocator
 
bool recoverable
 
NATIVE_UINT_TYPE actualSize
 
SerialBuffer buffer
 

Detailed Description

The type of a packet header.

Definition at line 23 of file SerializableFile.hpp.

Member Enumeration Documentation

◆ Status

enum Fw::SerializableFile::Status
Enumerator
OP_OK 
FILE_OPEN_ERROR 
FILE_WRITE_ERROR 
FILE_READ_ERROR 
DESERIALIZATION_ERROR 

Definition at line 26 of file SerializableFile.hpp.

Constructor & Destructor Documentation

◆ SerializableFile()

Fw::SerializableFile::SerializableFile ( MemAllocator *  allocator,
NATIVE_UINT_TYPE  maxSerializedSize 
)

Definition at line 19 of file SerializableFile.cpp.

◆ ~SerializableFile()

Fw::SerializableFile::~SerializableFile ( )

Definition at line 30 of file SerializableFile.cpp.

Member Function Documentation

◆ load()

SerializableFile::Status Fw::SerializableFile::load ( const char *  fileName,
Serializable &  serializable 
)

Definition at line 34 of file SerializableFile.cpp.

◆ save()

SerializableFile::Status Fw::SerializableFile::save ( const char *  fileName,
Serializable &  serializable 
)

Definition at line 63 of file SerializableFile.cpp.

Member Data Documentation

◆ __pad0__

PRIVATE Fw::SerializableFile::__pad0__

Definition at line 41 of file SerializableFile.hpp.

◆ actualSize

NATIVE_UINT_TYPE Fw::SerializableFile::actualSize

Definition at line 45 of file SerializableFile.hpp.

◆ allocator

MemAllocator* Fw::SerializableFile::allocator

Definition at line 43 of file SerializableFile.hpp.

◆ buffer

SerialBuffer Fw::SerializableFile::buffer

Definition at line 46 of file SerializableFile.hpp.

◆ recoverable

bool Fw::SerializableFile::recoverable

Definition at line 44 of file SerializableFile.hpp.

The documentation for this class was generated from the following files: