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

#include <Fw/Log/AmpcsEvrLogPacket.hpp>

Inheritance diagram for Fw::AmpcsEvrLogPacket:
Fw::ComPacket Fw::Serializable

Public Member Functions

 AmpcsEvrLogPacket ()
 
virtual ~AmpcsEvrLogPacket ()
 
SerializeStatus serializeTo (SerialBufferBase &buffer, Fw::Endianness mode=Fw::Endianness::BIG) const override
 serialize contents More...
 
SerializeStatus deserializeFrom (SerialBufferBase &buffer, Fw::Endianness mode=Fw::Endianness::BIG)
 Deserialize the contents of this object from a buffer. More...
 
void setTaskName (U8 *taskName, U8 len)
 
void setId (U32 eventID)
 
void setOverSeqNum (U32 overSeqNum)
 
void setCatSeqNum (U32 catSeqNum)
 
void setLogBuffer (LogBuffer &buffer)
 
const U8 * getTaskName () const
 
U32 getId () const
 
U32 getOverSeqNum () const
 
U32 getCatSeqNum () const
 
LogBuffer & getLogBuffer ()
 
- Public Member Functions inherited from Fw::ComPacket
 ComPacket ()
 
virtual ~ComPacket ()
 
- Public Member Functions inherited from Fw::Serializable
 DEPRECATED (SerializeStatus serialize(SerialBufferBase &buffer) const, "Use serializeTo(SerialBufferBase& buffer) instead")
 
 DEPRECATED (SerializeStatus deserialize(SerialBufferBase &buffer), "Use deserializeFrom(SerialBufferBase& buffer) instead")
 

Protected Attributes

U8 m_taskName [AMPCS_EVR_TASK_NAME_LEN]
 
U32 m_eventID
 
U32 m_overSeqNum
 
U32 m_catSeqNum
 
LogBuffer m_logBuffer
 
- Protected Attributes inherited from Fw::ComPacket
ComPacketType m_type
 

Additional Inherited Members

- Public Types inherited from Fw::Serializable
using SizeType = FwSizeType
 
- Protected Member Functions inherited from Fw::ComPacket
SerializeStatus serializeBase (SerialBufferBase &buffer) const
 
SerializeStatus deserializeBase (SerialBufferBase &buffer)
 
- Protected Member Functions inherited from Fw::Serializable
 Serializable ()
 Default constructor. More...
 
virtual ~Serializable ()
 Virtual destructor. More...
 

Detailed Description

Definition at line 21 of file AmpcsEvrLogPacket.hpp.

Constructor & Destructor Documentation

◆ AmpcsEvrLogPacket()

Fw::AmpcsEvrLogPacket::AmpcsEvrLogPacket ( )

Definition at line 14 of file AmpcsEvrLogPacket.cpp.

◆ ~AmpcsEvrLogPacket()

Fw::AmpcsEvrLogPacket::~AmpcsEvrLogPacket ( )
virtual

Definition at line 17 of file AmpcsEvrLogPacket.cpp.

Member Function Documentation

◆ deserializeFrom()

SerializeStatus Fw::AmpcsEvrLogPacket::deserializeFrom ( SerialBufferBase &  buffer,
Fw::Endianness  mode = Fw::Endianness::BIG 
)
virtual

Deserialize the contents of this object from a buffer.

This method reads serialized data from the provided buffer and reconstructs the object's data from it. The buffer should contain data in the format produced by serializeTo().

Parameters
bufferReference to the SerialBufferBase from which data will be deserialized
modeEndianness mode for deserialization (default is Endianness::BIG)
Returns
SerializeStatus indicating the result of the operation

Implements Fw::Serializable.

Definition at line 45 of file AmpcsEvrLogPacket.cpp.

◆ getCatSeqNum()

U32 Fw::AmpcsEvrLogPacket::getCatSeqNum ( ) const

Definition at line 116 of file AmpcsEvrLogPacket.cpp.

◆ getId()

U32 Fw::AmpcsEvrLogPacket::getId ( ) const

Definition at line 108 of file AmpcsEvrLogPacket.cpp.

◆ getLogBuffer()

LogBuffer & Fw::AmpcsEvrLogPacket::getLogBuffer ( )

Definition at line 120 of file AmpcsEvrLogPacket.cpp.

◆ getOverSeqNum()

U32 Fw::AmpcsEvrLogPacket::getOverSeqNum ( ) const

Definition at line 112 of file AmpcsEvrLogPacket.cpp.

◆ getTaskName()

const U8 * Fw::AmpcsEvrLogPacket::getTaskName ( ) const

Definition at line 104 of file AmpcsEvrLogPacket.cpp.

◆ serializeTo()

SerializeStatus Fw::AmpcsEvrLogPacket::serializeTo ( SerialBufferBase &  buffer,
Fw::Endianness  mode = Fw::Endianness::BIG 
) const
overridevirtual

serialize contents

Implements Fw::Serializable.

Definition at line 19 of file AmpcsEvrLogPacket.cpp.

◆ setCatSeqNum()

void Fw::AmpcsEvrLogPacket::setCatSeqNum ( U32  catSeqNum)

Definition at line 96 of file AmpcsEvrLogPacket.cpp.

◆ setId()

void Fw::AmpcsEvrLogPacket::setId ( U32  eventID)

Definition at line 88 of file AmpcsEvrLogPacket.cpp.

◆ setLogBuffer()

void Fw::AmpcsEvrLogPacket::setLogBuffer ( LogBuffer &  buffer)

Definition at line 100 of file AmpcsEvrLogPacket.cpp.

◆ setOverSeqNum()

void Fw::AmpcsEvrLogPacket::setOverSeqNum ( U32  overSeqNum)

Definition at line 92 of file AmpcsEvrLogPacket.cpp.

◆ setTaskName()

void Fw::AmpcsEvrLogPacket::setTaskName ( U8 *  taskName,
U8  len 
)

Definition at line 81 of file AmpcsEvrLogPacket.cpp.

Member Data Documentation

◆ m_catSeqNum

U32 Fw::AmpcsEvrLogPacket::m_catSeqNum
protected

Definition at line 46 of file AmpcsEvrLogPacket.hpp.

◆ m_eventID

U32 Fw::AmpcsEvrLogPacket::m_eventID
protected

Definition at line 44 of file AmpcsEvrLogPacket.hpp.

◆ m_logBuffer

LogBuffer Fw::AmpcsEvrLogPacket::m_logBuffer
protected

Definition at line 47 of file AmpcsEvrLogPacket.hpp.

◆ m_overSeqNum

U32 Fw::AmpcsEvrLogPacket::m_overSeqNum
protected

Definition at line 45 of file AmpcsEvrLogPacket.hpp.

◆ m_taskName

U8 Fw::AmpcsEvrLogPacket::m_taskName[AMPCS_EVR_TASK_NAME_LEN]
protected

Definition at line 43 of file AmpcsEvrLogPacket.hpp.

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