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

Data structure representing a data product. More...

#include <Svc/DpCatalog/DpRecordSerializableAc.hpp>

Inheritance diagram for Svc::DpRecord:
Fw::Serializable

Public Types

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

Public Member Functions

 DpRecord ()
 Constructor (default value) More...
 
 DpRecord (U32 id, U32 tSec, U32 tSub, U32 priority, U64 size, Fw::DpState::T state)
 Member constructor. More...
 
 DpRecord (const DpRecord &obj)
 Copy constructor. More...
 
DpRecordoperator= (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 serialize (Fw::SerializeBufferBase &buffer) const
 Serialization. More...
 
Fw::SerializeStatus deserialize (Fw::SerializeBufferBase &buffer)
 Deserialization. More...
 
U32 getid () const
 Get member id. More...
 
U32 gettSec () const
 Get member tSec. More...
 
U32 gettSub () const
 Get member tSub. More...
 
U32 getpriority () const
 Get member priority. More...
 
U64 getsize () const
 Get member size. More...
 
Fw::DpState::T getstate () const
 Get member state. More...
 
void set (U32 id, U32 tSec, U32 tSub, U32 priority, U64 size, Fw::DpState::T state)
 Set all members. More...
 
void setid (U32 id)
 Set member id. More...
 
void settSec (U32 tSec)
 Set member tSec. More...
 
void settSub (U32 tSub)
 Set member tSub. More...
 
void setpriority (U32 priority)
 Set member priority. More...
 
void setsize (U64 size)
 Set member size. More...
 
void setstate (Fw::DpState::T state)
 Set member state. More...
 

Protected Attributes

U32 m_id
 
U32 m_tSec
 
U32 m_tSub
 
U32 m_priority
 
U64 m_size
 
Fw::DpState m_state
 

Additional Inherited Members

- Protected Member Functions inherited from Fw::Serializable
 Serializable ()
 Default constructor. More...
 
virtual ~Serializable ()
 destructor More...
 

Detailed Description

Data structure representing a data product.

Definition at line 19 of file DpRecordSerializableAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
SERIALIZED_SIZE 

The size of the serial representation.

Definition at line 29 of file DpRecordSerializableAc.hpp.

Constructor & Destructor Documentation

◆ DpRecord() [1/3]

Svc::DpRecord::DpRecord ( )

Constructor (default value)

Definition at line 16 of file DpRecordSerializableAc.cpp.

◆ DpRecord() [2/3]

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

Member constructor.

Definition at line 29 of file DpRecordSerializableAc.cpp.

◆ DpRecord() [3/3]

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

Copy constructor.

Parameters
objThe source object

Definition at line 49 of file DpRecordSerializableAc.cpp.

Member Function Documentation

◆ deserialize()

Fw::SerializeStatus Svc::DpRecord::deserialize ( Fw::SerializeBufferBase buffer)
virtual

Deserialization.

Parameters
bufferThe serial buffer

Implements Fw::Serializable.

Definition at line 144 of file DpRecordSerializableAc.cpp.

◆ getid()

U32 Svc::DpRecord::getid ( ) const
inline

Get member id.

Definition at line 125 of file DpRecordSerializableAc.hpp.

◆ getpriority()

U32 Svc::DpRecord::getpriority ( ) const
inline

Get member priority.

Definition at line 143 of file DpRecordSerializableAc.hpp.

◆ getsize()

U64 Svc::DpRecord::getsize ( ) const
inline

Get member size.

Definition at line 149 of file DpRecordSerializableAc.hpp.

◆ getstate()

Fw::DpState::T Svc::DpRecord::getstate ( ) const
inline

Get member state.

Definition at line 155 of file DpRecordSerializableAc.hpp.

◆ gettSec()

U32 Svc::DpRecord::gettSec ( ) const
inline

Get member tSec.

Definition at line 131 of file DpRecordSerializableAc.hpp.

◆ gettSub()

U32 Svc::DpRecord::gettSub ( ) const
inline

Get member tSub.

Definition at line 137 of file DpRecordSerializableAc.hpp.

◆ operator!=()

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

Inequality operator.

Parameters
objThe other object

Definition at line 90 of file DpRecordSerializableAc.cpp.

◆ operator=()

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

Copy assignment operator.

Parameters
objThe source object

Definition at line 66 of file DpRecordSerializableAc.cpp.

◆ operator==()

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

Equality operator.

Parameters
objThe other object

Definition at line 77 of file DpRecordSerializableAc.cpp.

◆ serialize()

Fw::SerializeStatus Svc::DpRecord::serialize ( Fw::SerializeBufferBase buffer) const
virtual

Serialization.

Parameters
bufferThe serial buffer

Implements Fw::Serializable.

Definition at line 111 of file DpRecordSerializableAc.cpp.

◆ set()

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

Set all members.

Definition at line 215 of file DpRecordSerializableAc.cpp.

◆ setid()

void Svc::DpRecord::setid ( U32  id)

Set member id.

Definition at line 233 of file DpRecordSerializableAc.cpp.

◆ setpriority()

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

Set member priority.

Definition at line 251 of file DpRecordSerializableAc.cpp.

◆ setsize()

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

Set member size.

Definition at line 257 of file DpRecordSerializableAc.cpp.

◆ setstate()

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

Set member state.

Definition at line 263 of file DpRecordSerializableAc.cpp.

◆ settSec()

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

Set member tSec.

Definition at line 239 of file DpRecordSerializableAc.cpp.

◆ settSub()

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

Set member tSub.

Definition at line 245 of file DpRecordSerializableAc.cpp.

Member Data Documentation

◆ m_id

U32 Svc::DpRecord::m_id
protected

Definition at line 198 of file DpRecordSerializableAc.hpp.

◆ m_priority

U32 Svc::DpRecord::m_priority
protected

Definition at line 201 of file DpRecordSerializableAc.hpp.

◆ m_size

U64 Svc::DpRecord::m_size
protected

Definition at line 202 of file DpRecordSerializableAc.hpp.

◆ m_state

Fw::DpState Svc::DpRecord::m_state
protected

Definition at line 203 of file DpRecordSerializableAc.hpp.

◆ m_tSec

U32 Svc::DpRecord::m_tSec
protected

Definition at line 199 of file DpRecordSerializableAc.hpp.

◆ m_tSub

U32 Svc::DpRecord::m_tSub
protected

Definition at line 200 of file DpRecordSerializableAc.hpp.


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