Data structure representing a data product. More...

#include <Svc/DpCatalog/DpRecordSerializableAc.hpp>

Inheritance diagram for Svc::DpRecord:

Public Types
enum	{ SERIALIZED_SIZE }

Public Types inherited from Fw::Serializable
using	SizeType = FwSizeType

Public Member Functions
	DpRecord ()
	Constructor (default value) More...

	DpRecord (FwDpIdType id, U32 tSec, U32 tSub, U32 priority, U64 size, U32 blocks, Fw::DpState::T state)
	Member constructor. More...

	DpRecord (const DpRecord &obj)
	Copy constructor. More...

DpRecord &	operator= (const DpRecord &obj)
	Copy assignment operator. More...

bool	operator== (const DpRecord &obj) const
	Equality operator. More...

bool	operator!= (const DpRecord &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...

FwDpIdType	get_id () const
	Get member id. More...

U32	get_tSec () const
	Get member tSec. More...

U32	get_tSub () const
	Get member tSub. More...

U32	get_priority () const
	Get member priority. More...

U64	get_size () const
	Get member size. More...

U32	get_blocks () const
	Get member blocks. More...

Fw::DpState::T	get_state () const
	Get member state. More...

void	set (FwDpIdType id, U32 tSec, U32 tSub, U32 priority, U64 size, U32 blocks, Fw::DpState::T state)
	Set all members. More...

void	set_id (FwDpIdType id)
	Set member id. More...

void	set_tSec (U32 tSec)
	Set member tSec. More...

void	set_tSub (U32 tSub)
	Set member tSub. More...

void	set_priority (U32 priority)
	Set member priority. More...

void	set_size (U64 size)
	Set member size. More...

void	set_blocks (U32 blocks)
	Set member blocks. More...

void	set_state (Fw::DpState::T state)
	Set member state. 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
FwDpIdType	m_id

U32	m_tSec

U32	m_tSub

U32	m_priority

U64	m_size

U32	m_blocks

Fw::DpState	m_state

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

virtual	~Serializable ()
	Virtual destructor. More...

Detailed Description

Data structure representing a data product.

Definition at line 20 of file DpRecordSerializableAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
SERIALIZED_SIZE	The size of the serial representation.

Definition at line 30 of file DpRecordSerializableAc.hpp.

Constructor & Destructor Documentation

◆ DpRecord() [1/3]

Svc::DpRecord::DpRecord ( )

Constructor (default value)

Definition at line 17 of file DpRecordSerializableAc.cpp.

◆ DpRecord() [2/3]

Svc::DpRecord::DpRecord	(	FwDpIdType	id,
		U32	tSec,
		U32	tSub,
		U32	priority,
		U64	size,
		U32	blocks,
		Fw::DpState::T	state
	)

Member constructor.

Definition at line 31 of file DpRecordSerializableAc.cpp.

◆ DpRecord() [3/3]

Svc::DpRecord::DpRecord ( const DpRecord & obj )

Copy constructor.

Parameters

obj	The source object

Definition at line 53 of file DpRecordSerializableAc.cpp.

Member Function Documentation

◆ deserializeFrom()

Fw::SerializeStatus Svc::DpRecord::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 158 of file DpRecordSerializableAc.cpp.

◆ get_blocks()

U32 Svc::DpRecord::get_blocks ( ) const

inline

Get member blocks.

Definition at line 163 of file DpRecordSerializableAc.hpp.

◆ get_id()

FwDpIdType Svc::DpRecord::get_id ( ) const

inline

Get member id.

Definition at line 133 of file DpRecordSerializableAc.hpp.

◆ get_priority()

U32 Svc::DpRecord::get_priority ( ) const

inline

Get member priority.

Definition at line 151 of file DpRecordSerializableAc.hpp.

◆ get_size()

U64 Svc::DpRecord::get_size ( ) const

inline

Get member size.

Definition at line 157 of file DpRecordSerializableAc.hpp.

◆ get_state()

Fw::DpState::T Svc::DpRecord::get_state ( ) const

inline

Get member state.

Definition at line 169 of file DpRecordSerializableAc.hpp.

◆ get_tSec()

U32 Svc::DpRecord::get_tSec ( ) const

inline

Get member tSec.

Definition at line 139 of file DpRecordSerializableAc.hpp.

◆ get_tSub()

U32 Svc::DpRecord::get_tSub ( ) const

inline

Get member tSub.

Definition at line 145 of file DpRecordSerializableAc.hpp.

◆ operator!=()

bool Svc::DpRecord::operator!= ( const DpRecord & obj ) const

Inequality operator.

Parameters

obj	The other object

Definition at line 97 of file DpRecordSerializableAc.cpp.

◆ operator=()

DpRecord & Svc::DpRecord::operator= ( const DpRecord & obj )

Copy assignment operator.

Parameters

obj	The source object

Definition at line 71 of file DpRecordSerializableAc.cpp.

◆ operator==()

bool Svc::DpRecord::operator== ( const DpRecord & obj ) const

Equality operator.

Parameters

obj	The other object

Definition at line 82 of file DpRecordSerializableAc.cpp.

◆ serializedSize()

FwSizeType Svc::DpRecord::serializedSize ( ) const

Get the dynamic serialized size of the struct.

Definition at line 198 of file DpRecordSerializableAc.cpp.

◆ serializeTo()

Fw::SerializeStatus Svc::DpRecord::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 118 of file DpRecordSerializableAc.cpp.

◆ set()

void Svc::DpRecord::set	(	FwDpIdType	id,
		U32	tSec,
		U32	tSub,
		U32	priority,
		U64	size,
		U32	blocks,
		Fw::DpState::T	state
	)

Set all members.

Definition at line 269 of file DpRecordSerializableAc.cpp.

◆ set_blocks()

void Svc::DpRecord::set_blocks ( U32 blocks )

Set member blocks.

Definition at line 319 of file DpRecordSerializableAc.cpp.

◆ set_id()

void Svc::DpRecord::set_id ( FwDpIdType id )

Set member id.

Definition at line 289 of file DpRecordSerializableAc.cpp.

◆ set_priority()

void Svc::DpRecord::set_priority ( U32 priority )

Set member priority.

Definition at line 307 of file DpRecordSerializableAc.cpp.

◆ set_size()

void Svc::DpRecord::set_size ( U64 size )

Set member size.

Definition at line 313 of file DpRecordSerializableAc.cpp.

◆ set_state()

void Svc::DpRecord::set_state ( Fw::DpState::T state )

Set member state.

Definition at line 325 of file DpRecordSerializableAc.cpp.

◆ set_tSec()

void Svc::DpRecord::set_tSec ( U32 tSec )

Set member tSec.

Definition at line 295 of file DpRecordSerializableAc.cpp.

◆ set_tSub()

void Svc::DpRecord::set_tSub ( U32 tSub )

Set member tSub.

Definition at line 301 of file DpRecordSerializableAc.cpp.

Member Data Documentation

◆ m_blocks

U32 Svc::DpRecord::m_blocks

protected

Definition at line 221 of file DpRecordSerializableAc.hpp.

◆ m_id

FwDpIdType Svc::DpRecord::m_id

protected

Definition at line 216 of file DpRecordSerializableAc.hpp.

◆ m_priority

U32 Svc::DpRecord::m_priority

protected

Definition at line 219 of file DpRecordSerializableAc.hpp.

◆ m_size

U64 Svc::DpRecord::m_size

protected

Definition at line 220 of file DpRecordSerializableAc.hpp.

◆ m_state

Fw::DpState Svc::DpRecord::m_state

protected

Definition at line 222 of file DpRecordSerializableAc.hpp.

◆ m_tSec

U32 Svc::DpRecord::m_tSec

protected

Definition at line 217 of file DpRecordSerializableAc.hpp.

◆ m_tSub

U32 Svc::DpRecord::m_tSub

protected

Definition at line 218 of file DpRecordSerializableAc.hpp.

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

Svc/DpCatalog/DpRecordSerializableAc.hpp
Svc/DpCatalog/DpRecordSerializableAc.cpp

Public Types

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ DpRecord() [1/3]

◆ DpRecord() [2/3]

◆ DpRecord() [3/3]

Member Function Documentation

◆ deserializeFrom()

◆ get_blocks()

◆ get_id()

◆ get_priority()

◆ get_size()

◆ get_state()

◆ get_tSec()

◆ get_tSub()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ serializedSize()

◆ serializeTo()

◆ set()

◆ set_blocks()

◆ set_id()

◆ set_priority()

◆ set_size()

◆ set_state()

◆ set_tSec()

◆ set_tSub()

Member Data Documentation

◆ m_blocks

◆ m_id

◆ m_priority

◆ m_size

◆ m_state

◆ m_tSec

◆ m_tSub