Fw::LogPacket Class Reference

#include <Fw/Log/LogPacket.hpp>

Inheritance diagram for Fw::LogPacket:

Public Member Functions
	LogPacket ()
virtual	~LogPacket ()
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) override
	Deserialize the contents of this object from a buffer. More...
void	setId (FwEventIdType id)
void	setLogBuffer (const LogBuffer &buffer)
void	setTimeTag (const Fw::Time &timeTag)
FwEventIdType	getId ()
Fw::Time &	getTimeTag ()
LogBuffer &	getLogBuffer ()
Public Member Functions inherited from Fw::ComPacket
	ComPacket ()
virtual	~ComPacket ()
Public Member Functions inherited from Fw::Serializable
Serializable &	operator= (const Serializable &src)=default
	TODO: this operator should be deleted, this must be done after RawTime is modified though. More...
	DEPRECATED (SerializeStatus serialize(SerialBufferBase &buffer) const, "Use serializeTo(SerialBufferBase& buffer) instead")
	DEPRECATED (SerializeStatus deserialize(SerialBufferBase &buffer), "Use deserializeFrom(SerialBufferBase& buffer) instead")

Protected Attributes
FwEventIdType	m_id
Fw::Time	m_timeTag
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 17 of file LogPacket.hpp.

Constructor & Destructor Documentation

LogPacket()

Fw::LogPacket::LogPacket

(

)

Definition at line 13 of file LogPacket.cpp.

~LogPacket()

Fw::LogPacket::~LogPacket ( )

virtual

Definition at line 17 of file LogPacket.cpp.

Member Function Documentation

deserializeFrom()

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

overridevirtual

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

buffer	Reference to the SerialBufferBase from which data will be deserialized
mode	Endianness mode for deserialization (default is Endianness::BIG)

Returns

SerializeStatus indicating the result of the operation

Implements Fw::Serializable.

Definition at line 39 of file LogPacket.cpp.

getId()

FwEventIdType Fw::LogPacket::getId

(

)

Definition at line 78 of file LogPacket.cpp.

getLogBuffer()

LogBuffer & Fw::LogPacket::getLogBuffer

(

)

Definition at line 86 of file LogPacket.cpp.

getTimeTag()

Fw::Time & Fw::LogPacket::getTimeTag

(

)

Definition at line 82 of file LogPacket.cpp.

serializeTo()

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

overridevirtual

serialize contents

Implements Fw::Serializable.

Definition at line 19 of file LogPacket.cpp.

setId()

void Fw::LogPacket::setId

(

FwEventIdType

id

)

Definition at line 66 of file LogPacket.cpp.

setLogBuffer()

void Fw::LogPacket::setLogBuffer

(

const LogBuffer &

buffer

)

Definition at line 70 of file LogPacket.cpp.

setTimeTag()

void Fw::LogPacket::setTimeTag

(

const Fw::Time &

timeTag

)

Definition at line 74 of file LogPacket.cpp.

Member Data Documentation

m_id

FwEventIdType Fw::LogPacket::m_id

protected

Definition at line 35 of file LogPacket.hpp.

m_logBuffer

LogBuffer Fw::LogPacket::m_logBuffer

protected

Definition at line 37 of file LogPacket.hpp.

m_timeTag

Fw::Time Fw::LogPacket::m_timeTag

protected

Definition at line 36 of file LogPacket.hpp.

---

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

• Fw/Log/LogPacket.hpp
• Fw/Log/LogPacket.cpp