F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
Fw::Serializable Class Reference

forward declaration More...

#include <Fw/Types/Serializable.hpp>

Inheritance diagram for Fw::Serializable:
ComCfg::APID ComCfg::FrameContext Drv::ByteStreamStatus Drv::GpioStatus Drv::I2cStatus Fpp::ToCpp::Phases 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::TimeIntervalValue Fw::TimeValue Fw::TlmValid 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::BufferAccumulator_BlockMode Svc::BufferAccumulator_OpState Svc::BufferLogger_LogState Svc::BuffQueueDepth Svc::Ccsds::SpacePacketHeader Svc::Ccsds::TCHeader Svc::Ccsds::TCTrailer Svc::Ccsds::TMHeader Svc::Ccsds::TMTrailer Svc::CmdSequencer_BlockState Svc::CmdSequencer_FileReadStage Svc::CmdSequencer_SeqMode Svc::ComQueueDepth Svc::CustomVersionDb Svc::DpHdrField Svc::DpRecord Svc::EventManager_Enabled Svc::EventManager_FilterSeverity Svc::FprimeProtocol::FrameHeader Svc::FprimeProtocol::FrameTrailer Svc::Fpy::DirectiveId Svc::Fpy::Footer Svc::Fpy::Header Svc::Fpy::Sequence Svc::Fpy::Statement Svc::FpySequencer_BinaryRegOpDirective Svc::FpySequencer_BlockState Svc::FpySequencer_CmdDirective Svc::FpySequencer_DebugBreakpointArgs Svc::FpySequencer_DebugTelemetry Svc::FpySequencer_DeserSerRegDirective Svc::FpySequencer_DirectiveErrorCode Svc::FpySequencer_ExitDirective Svc::FpySequencer_FileReadStage Svc::FpySequencer_GetPrmDirective Svc::FpySequencer_GetTlmDirective Svc::FpySequencer_GoalState Svc::FpySequencer_GotoDirective Svc::FpySequencer_IfDirective Svc::FpySequencer_NoOpDirective Svc::FpySequencer_SequenceExecutionArgs Svc::FpySequencer_SetRegDirective Svc::FpySequencer_SetSerRegDirective Svc::FpySequencer_UnaryRegOpDirective 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 TimeBase

Public Types

using SizeType = FwSizeType
 

Public Member Functions

virtual SerializeStatus serializeTo (SerializeBufferBase &buffer) const
 serialize contents to buffer More...
 
virtual SerializeStatus deserializeFrom (SerializeBufferBase &buffer)
 deserialize contents from buffer More...
 
virtual SerializeStatus serialize (SerializeBufferBase &buffer) const
 
virtual SerializeStatus deserialize (SerializeBufferBase &buffer)
 

Protected Member Functions

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

Detailed Description

forward declaration

Definition at line 27 of file Serializable.hpp.

Member Typedef Documentation

◆ SizeType

Definition at line 30 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()

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

Reimplemented in Svc::Fpy::DirectiveId, Os::FileSystemStatus, Os::RawTime, Os::FileStatus, Os::QueueStatus, Os::TaskStatus, Svc::VersionCfg::VersionEnum, ComCfg::APID, Os::DirectoryStatus, Svc::PolyDbCfg::PolyDbEntry, Fw::LogSeverity, Fpp::ToCpp::Phases, Svc::EventManager_FilterSeverity, Fw::CmdResponse, Os::FileMode, Svc::FpySequencer_DirectiveErrorCode, Drv::I2cStatus, Svc::PrmDb_PrmReadError, Os::MutexStatus, Os::RawTimeStatus, Svc::VersionType, Fw::DpCfg::ProcType, Fw::DeserialStatus, Svc::CmdSequencer_FileReadStage, Svc::PrmDb_PrmWriteError, Fw::Buffer, Drv::ByteStreamStatus, Drv::GpioStatus, Fw::DpState, TimeBase, 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::DpHdrField, Svc::EventManager_Enabled, Svc::SendFileStatus, Svc::VersionStatus, Svc::VersionEnabled, Svc::CmdSequencer_BlockState, Svc::CmdSequencer_SeqMode, Svc::ComQueueDepth, Svc::QueueType, Svc::FpySequencer_FileReadStage, Svc::FpySequencer_GoalState, Svc::SeqDispatcher_CmdSequencerState, Fw::TlmValid, Svc::BufferAccumulator_BlockMode, Svc::BufferAccumulator_OpState, Svc::BufferLogger_LogState, Svc::FpySequencer_BlockState, Svc::SystemResourceEnabled, Svc::BuffQueueDepth, Svc::Fpy::Sequence, Svc::FpySequencer_CmdDirective, Svc::FpySequencer_SetSerRegDirective, Fw::PolyType, Svc::DpRecord, Svc::Fpy::Header, ComCfg::FrameContext, Fw::TimeValue, Svc::Ccsds::TMHeader, Svc::FpySequencer_BinaryRegOpDirective, Svc::FpySequencer_DeserSerRegDirective, Svc::Ccsds::SpacePacketHeader, Svc::Ccsds::TCHeader, Svc::FpySequencer_DebugTelemetry, Svc::Fpy::Statement, Svc::CustomVersionDb, Svc::FprimeProtocol::FrameHeader, Svc::FpySequencer_UnaryRegOpDirective, Svc::FpySequencer_GetTlmDirective, Svc::SendFileResponse, Svc::FpySequencer_DebugBreakpointArgs, Fw::TimeIntervalValue, Svc::FpySequencer_GetPrmDirective, Svc::FpySequencer_SequenceExecutionArgs, Svc::FpySequencer_SetRegDirective, Svc::FpySequencer_IfDirective, Svc::FpySequencer_WaitRelDirective, Svc::Ccsds::TCTrailer, Svc::Ccsds::TMTrailer, Svc::FprimeProtocol::FrameTrailer, Svc::Fpy::Footer, Svc::FpySequencer_WaitAbsDirective, Svc::FpySequencer_ExitDirective, Svc::FpySequencer_GotoDirective, Svc::FpySequencer_NoOpDirective, Os::Posix::RawTime::PosixRawTime, Os::Stub::RawTime::StubRawTime, Fw::StringBase, Fw::Time, Fw::TimeInterval, Fw::ComPacket, Fw::TlmPacket, Fw::AmpcsEvrLogPacket, Fw::CmdPacket, and Fw::LogPacket.

Definition at line 814 of file Serializable.cpp.

◆ deserializeFrom()

◆ serialize()

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

Reimplemented in Svc::Fpy::DirectiveId, Os::FileSystemStatus, Os::RawTime, Os::FileStatus, Os::QueueStatus, Os::TaskStatus, Svc::VersionCfg::VersionEnum, ComCfg::APID, Os::DirectoryStatus, Svc::PolyDbCfg::PolyDbEntry, Fw::LogSeverity, Fpp::ToCpp::Phases, Svc::EventManager_FilterSeverity, Fw::CmdResponse, Os::FileMode, Svc::FpySequencer_DirectiveErrorCode, Fw::Buffer, 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, TimeBase, 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::DpHdrField, Svc::EventManager_Enabled, Svc::SendFileStatus, Svc::VersionStatus, Svc::VersionEnabled, Svc::CmdSequencer_BlockState, Svc::CmdSequencer_SeqMode, Svc::ComQueueDepth, Svc::QueueType, Svc::FpySequencer_FileReadStage, Svc::FpySequencer_GoalState, Svc::SeqDispatcher_CmdSequencerState, Fw::TlmValid, Svc::BufferAccumulator_BlockMode, Svc::BufferAccumulator_OpState, Svc::BufferLogger_LogState, Svc::FpySequencer_BlockState, Svc::SystemResourceEnabled, Svc::BuffQueueDepth, Svc::Fpy::Sequence, Svc::FpySequencer_CmdDirective, Svc::FpySequencer_SetSerRegDirective, Fw::PolyType, Svc::DpRecord, Svc::Fpy::Header, ComCfg::FrameContext, Fw::TimeValue, Svc::Ccsds::TMHeader, Svc::FpySequencer_BinaryRegOpDirective, Svc::FpySequencer_DeserSerRegDirective, Svc::Ccsds::SpacePacketHeader, Svc::Ccsds::TCHeader, Svc::FpySequencer_DebugTelemetry, Svc::Fpy::Statement, Svc::CustomVersionDb, Svc::FprimeProtocol::FrameHeader, Svc::FpySequencer_UnaryRegOpDirective, Svc::FpySequencer_GetTlmDirective, Svc::SendFileResponse, Svc::FpySequencer_DebugBreakpointArgs, Fw::TimeIntervalValue, Svc::FpySequencer_GetPrmDirective, Svc::FpySequencer_SequenceExecutionArgs, Svc::FpySequencer_SetRegDirective, Svc::FpySequencer_IfDirective, Svc::FpySequencer_WaitRelDirective, Svc::Ccsds::TCTrailer, Svc::Ccsds::TMTrailer, Svc::FprimeProtocol::FrameTrailer, Svc::Fpy::Footer, Svc::FpySequencer_WaitAbsDirective, Svc::FpySequencer_ExitDirective, Svc::FpySequencer_GotoDirective, Svc::FpySequencer_NoOpDirective, Os::Posix::RawTime::PosixRawTime, Os::Stub::RawTime::StubRawTime, Fw::StringBase, Fw::Time, Fw::TimeInterval, Fw::ComPacket, Fw::AmpcsEvrLogPacket, Fw::TlmPacket, Fw::CmdPacket, and Fw::LogPacket.

Definition at line 810 of file Serializable.cpp.

◆ serializeTo()


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