Svc::CompressionMetadata Class Reference

#include <Svc/DpCompressProc/Types/CompressionMetadataSerializableAc.hpp>

Inheritance diagram for Svc::CompressionMetadata:

Public Types
enum	{ SERIALIZED_SIZE }
Public Types inherited from Fw::Serializable
using	SizeType = FwSizeType

Public Member Functions
	CompressionMetadata ()
	Constructor (default value) More...
	CompressionMetadata (Svc::CompressionAlgorithm::T algorithm)
	Member constructor. More...
	CompressionMetadata (const CompressionMetadata &obj)
	Copy constructor. More...
CompressionMetadata &	operator= (const CompressionMetadata &obj)
	Copy assignment operator. More...
bool	operator== (const CompressionMetadata &obj) const
	Equality operator. More...
bool	operator!= (const CompressionMetadata &obj) const
	Inequality operator. More...
Fw::SerializeStatus	serializeTo (Fw::SerialBufferBase &buffer, Fw::Endianness mode=Fw::Endianness::BIG) const
	Serialization. More...
Fw::SerializeStatus	deserializeFrom (Fw::SerialBufferBase &buffer, Fw::Endianness mode=Fw::Endianness::BIG)
	Deserialization. More...
FwSizeType	serializedSize () const
	Get the dynamic serialized size of the struct. More...
Svc::CompressionAlgorithm::T	get_algorithm () const
	Get member algorithm. More...
void	set (Svc::CompressionAlgorithm::T algorithm)
	Set all members. More...
void	set_algorithm (Svc::CompressionAlgorithm::T algorithm)
	Set member algorithm. More...
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
Svc::CompressionAlgorithm	m_algorithm

Additional Inherited Members
Protected Member Functions inherited from Fw::Serializable
	Serializable ()
	Default constructor. More...
virtual	~Serializable ()
	Virtual destructor. More...

Detailed Description

Definition at line 18 of file CompressionMetadataSerializableAc.hpp.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
SERIALIZED_SIZE	The size of the serial representation.

Definition at line 28 of file CompressionMetadataSerializableAc.hpp.

Constructor & Destructor Documentation

CompressionMetadata() [1/3]

Svc::CompressionMetadata::CompressionMetadata

(

)

Constructor (default value)

Definition at line 17 of file CompressionMetadataSerializableAc.cpp.

CompressionMetadata() [2/3]

Svc::CompressionMetadata::CompressionMetadata

(

Svc::CompressionAlgorithm::T

algorithm

)

Member constructor.

Definition at line 25 of file CompressionMetadataSerializableAc.cpp.

CompressionMetadata() [3/3]

Svc::CompressionMetadata::CompressionMetadata

(

const CompressionMetadata &

obj

)

Copy constructor.

Parameters

obj	The source object

Definition at line 33 of file CompressionMetadataSerializableAc.cpp.

Member Function Documentation

deserializeFrom()

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

virtual

Deserialization.

Parameters

buffer	The serial buffer
mode	Endianness of serialized buffer

Implements Fw::Serializable.

Definition at line 99 of file CompressionMetadataSerializableAc.cpp.

get_algorithm()

Svc::CompressionAlgorithm::T Svc::CompressionMetadata::get_algorithm ( ) const

inline

Get member algorithm.

Definition at line 117 of file CompressionMetadataSerializableAc.hpp.

operator!=()

bool Svc::CompressionMetadata::operator!=

(

const CompressionMetadata &

obj

)

const

Inequality operator.

Parameters

obj	The other object

Definition at line 62 of file CompressionMetadataSerializableAc.cpp.

operator=()

CompressionMetadata & Svc::CompressionMetadata::operator=

(

const CompressionMetadata &

obj

)

Copy assignment operator.

Parameters

obj	The source object

Definition at line 45 of file CompressionMetadataSerializableAc.cpp.

operator==()

bool Svc::CompressionMetadata::operator==

(

const CompressionMetadata &

obj

)

const

Equality operator.

Parameters

obj	The other object

Definition at line 56 of file CompressionMetadataSerializableAc.cpp.

serializedSize()

FwSizeType Svc::CompressionMetadata::serializedSize

(

)

const

Get the dynamic serialized size of the struct.

Definition at line 115 of file CompressionMetadataSerializableAc.cpp.

serializeTo()

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

virtual

Serialization.

Parameters

buffer	The serial buffer
mode	Endianness of serialized buffer

Implements Fw::Serializable.

Definition at line 83 of file CompressionMetadataSerializableAc.cpp.

set()

void Svc::CompressionMetadata::set

(

Svc::CompressionAlgorithm::T

algorithm

)

Set all members.

Definition at line 144 of file CompressionMetadataSerializableAc.cpp.

set_algorithm()

void Svc::CompressionMetadata::set_algorithm

(

Svc::CompressionAlgorithm::T

algorithm

)

Set member algorithm.

Definition at line 150 of file CompressionMetadataSerializableAc.cpp.

Member Data Documentation

m_algorithm

Svc::CompressionAlgorithm Svc::CompressionMetadata::m_algorithm

protected

Definition at line 138 of file CompressionMetadataSerializableAc.hpp.

---

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

• Svc/DpCompressProc/Types/CompressionMetadataSerializableAc.hpp
• Svc/DpCompressProc/Types/CompressionMetadataSerializableAc.cpp