F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
Public Types | Public Member Functions | Protected Member Functions | List of all members
Fw::Serializable Class Referenceabstract

forward declaration More...

#include <Fw/Types/Serializable.hpp>

Inheritance diagram for Fw::Serializable:
ComCfg::FrameContext Drv::ByteStreamStatus Drv::GpioStatus Drv::I2cStatus Fw::Active Fw::Buffer Fw::CmdResponse Fw::ComPacket Fw::Completed Fw::DeserialStatus Fw::Direction Fw::DpCfg::ProcType Fw::DpState Fw::Enabled Fw::Health Fw::Logic Fw::LogSeverity Fw::On Fw::Open Fw::ParamValid Fw::PolyType Fw::SerialStatus Fw::StringBase Fw::Success Fw::Time Fw::TimeInterval Fw::Wait Os::DirectoryOpenMode Os::DirectoryStatus Os::FileMode Os::FileStatus Os::FileSystemStatus Os::GenericStatus Os::MutexStatus Os::QueueBlockingType Os::QueueStatus Os::RawTimeInterface Os::RawTimeStatus Os::TaskStatus Svc::ActiveLogger_Enabled Svc::ActiveLogger_FilterSeverity Svc::BufferAccumulator_BlockMode Svc::BufferAccumulator_OpState Svc::BufferLogger_LogState Svc::BuffQueueDepth Svc::CmdSequencer_BlockState Svc::CmdSequencer_FileReadStage Svc::CmdSequencer_SeqMode Svc::ComQueueDepth Svc::CustomVersionDb Svc::DpHdrField Svc::DpRecord Svc::FprimeProtocol::FrameHeader Svc::FprimeProtocol::FrameTrailer Svc::Fpy::DirectiveId Svc::Fpy::Footer Svc::Fpy::Header Svc::Fpy::Sequence Svc::Fpy::Statement Svc::Fpy::StatementType Svc::FpySequencer_BlockState Svc::FpySequencer_GoalState Svc::FpySequencer_SequenceExecutionArgs Svc::FpySequencer_WaitAbsDirective Svc::FpySequencer_WaitRelDirective Svc::MeasurementStatus Svc::PolyDbCfg::PolyDbEntry Svc::PrmDb_PrmReadError Svc::PrmDb_PrmWriteError Svc::QueueType Svc::SendFileResponse Svc::SendFileStatus Svc::SeqDispatcher_CmdSequencerState Svc::SystemResourceEnabled Svc::VersionCfg::VersionEnum Svc::VersionEnabled Svc::VersionStatus Svc::VersionType

Public Types

using SizeType = FwSizeType
 

Public Member Functions

virtual SerializeStatus serialize (SerializeBufferBase &buffer) const =0
 serialize contents More...
 
virtual SerializeStatus deserialize (SerializeBufferBase &buffer)=0
 deserialize to contents More...
 

Protected Member Functions

 Serializable ()
 Default constructor. More...
 
virtual ~Serializable ()
 destructor More...
 

Detailed Description

forward declaration

Definition at line 25 of file Serializable.hpp.

Member Typedef Documentation

◆ SizeType

using Fw::Serializable::SizeType = FwSizeType

Definition at line 28 of file Serializable.hpp.

Constructor & Destructor Documentation

◆ Serializable()

Fw::Serializable::Serializable ( )
protected

Default constructor.

Definition at line 16 of file Serializable.cpp.

◆ ~Serializable()

Fw::Serializable::~Serializable ( )
protectedvirtual

destructor

Definition at line 18 of file Serializable.cpp.

Member Function Documentation

◆ deserialize()

virtual SerializeStatus Fw::Serializable::deserialize ( SerializeBufferBase &  buffer)
pure virtual

deserialize to contents

Implemented in Os::FileSystemStatus, Os::TaskStatus, Os::RawTime, Svc::VersionCfg::VersionEnum, Os::DirectoryStatus, Os::FileStatus, Os::QueueStatus, Svc::PolyDbCfg::PolyDbEntry, Fw::LogSeverity, Svc::ActiveLogger_FilterSeverity, Fw::CmdResponse, Os::FileMode, Drv::I2cStatus, Svc::PrmDb_PrmReadError, Os::MutexStatus, Os::RawTimeStatus, Svc::VersionType, Fw::DpCfg::ProcType, Fw::DeserialStatus, Svc::CmdSequencer_FileReadStage, Svc::PrmDb_PrmWriteError, Drv::ByteStreamStatus, Drv::GpioStatus, Fw::DpState, Fw::Direction, Fw::Health, Fw::SerialStatus, Svc::MeasurementStatus, Fw::Completed, Os::DirectoryOpenMode, Fw::ParamValid, Fw::Active, Fw::Enabled, Fw::Logic, Fw::On, Fw::Open, Fw::Success, Fw::Wait, Os::GenericStatus, Os::QueueBlockingType, Svc::ActiveLogger_Enabled, Svc::DpHdrField, Svc::SendFileStatus, Svc::Fpy::DirectiveId, Svc::VersionStatus, Svc::VersionEnabled, Svc::Fpy::StatementType, Svc::CmdSequencer_BlockState, Svc::CmdSequencer_SeqMode, Svc::ComQueueDepth, Svc::QueueType, Svc::FpySequencer_GoalState, Svc::SeqDispatcher_CmdSequencerState, Svc::BufferAccumulator_BlockMode, Svc::BufferAccumulator_OpState, Svc::BufferLogger_LogState, Svc::FpySequencer_BlockState, Svc::SystemResourceEnabled, Fw::Buffer, Svc::BuffQueueDepth, Svc::Fpy::Sequence, Svc::DpRecord, Svc::Fpy::Header, Fw::PolyType, Svc::Fpy::Statement, Svc::CustomVersionDb, Svc::FprimeProtocol::FrameHeader, Svc::SendFileResponse, Svc::FpySequencer_SequenceExecutionArgs, Svc::FprimeProtocol::FrameTrailer, ComCfg::FrameContext, Svc::Fpy::Footer, Svc::FpySequencer_WaitAbsDirective, Svc::FpySequencer_WaitRelDirective, Os::RawTimeInterface, Os::Posix::RawTime::PosixRawTime, Os::Stub::RawTime::StubRawTime, Fw::StringBase, Fw::Time, Fw::TimeInterval, Fw::TlmPacket, Fw::AmpcsEvrLogPacket, Fw::LogPacket, and Fw::CmdPacket.

◆ serialize()

virtual SerializeStatus Fw::Serializable::serialize ( SerializeBufferBase &  buffer) const
pure virtual

serialize contents

Implemented in Os::FileSystemStatus, Os::TaskStatus, Svc::VersionCfg::VersionEnum, Os::DirectoryStatus, Os::FileStatus, Os::QueueStatus, Svc::PolyDbCfg::PolyDbEntry, Os::RawTime, Fw::LogSeverity, Svc::ActiveLogger_FilterSeverity, Fw::CmdResponse, Os::FileMode, Drv::I2cStatus, Svc::PrmDb_PrmReadError, Os::MutexStatus, Os::RawTimeStatus, Svc::VersionType, Fw::DpCfg::ProcType, Fw::DeserialStatus, Svc::CmdSequencer_FileReadStage, Svc::PrmDb_PrmWriteError, Drv::ByteStreamStatus, Drv::GpioStatus, Fw::DpState, Fw::Direction, Fw::Health, Fw::SerialStatus, Svc::MeasurementStatus, Fw::Completed, Os::DirectoryOpenMode, Fw::ParamValid, Fw::Active, Fw::Enabled, Fw::Logic, Fw::On, Fw::Open, Fw::Success, Fw::Wait, Os::GenericStatus, Os::QueueBlockingType, Svc::ActiveLogger_Enabled, Svc::DpHdrField, Svc::SendFileStatus, Svc::Fpy::DirectiveId, Svc::VersionStatus, Svc::VersionEnabled, Svc::Fpy::StatementType, Svc::CmdSequencer_BlockState, Svc::CmdSequencer_SeqMode, Svc::ComQueueDepth, Svc::QueueType, Svc::FpySequencer_GoalState, Svc::SeqDispatcher_CmdSequencerState, Svc::BufferAccumulator_BlockMode, Svc::BufferAccumulator_OpState, Svc::BufferLogger_LogState, Svc::FpySequencer_BlockState, Svc::SystemResourceEnabled, Svc::BuffQueueDepth, Fw::Buffer, Svc::Fpy::Sequence, Fw::PolyType, Svc::DpRecord, Svc::Fpy::Header, Svc::Fpy::Statement, Svc::CustomVersionDb, Svc::FprimeProtocol::FrameHeader, Svc::SendFileResponse, Svc::FpySequencer_SequenceExecutionArgs, Svc::FprimeProtocol::FrameTrailer, ComCfg::FrameContext, Svc::Fpy::Footer, Svc::FpySequencer_WaitAbsDirective, Svc::FpySequencer_WaitRelDirective, Os::RawTimeInterface, Os::Posix::RawTime::PosixRawTime, Fw::StringBase, Os::Stub::RawTime::StubRawTime, Fw::Time, Fw::TimeInterval, Fw::AmpcsEvrLogPacket, Fw::TlmPacket, Fw::LogPacket, and Fw::CmdPacket.

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