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

#include <Svc/FpySequencer/HeaderSerializableAc.hpp>

Inheritance diagram for Svc::Fpy::Header:
Fw::Serializable

Public Types

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

Public Member Functions

 Header ()
 Constructor (default value) More...
 
 Header (U8 majorVersion, U8 minorVersion, U8 patchVersion, U8 schemaVersion, U8 argumentCount, U16 statementCount, U32 bodySize)
 Member constructor. More...
 
 Header (const Header &obj)
 Copy constructor. More...
 
Headeroperator= (const Header &obj)
 Copy assignment operator. More...
 
bool operator== (const Header &obj) const
 Equality operator. More...
 
bool operator!= (const Header &obj) const
 Inequality operator. More...
 
Fw::SerializeStatus serialize (Fw::SerializeBufferBase &buffer) const
 Serialization. More...
 
Fw::SerializeStatus deserialize (Fw::SerializeBufferBase &buffer)
 Deserialization. More...
 
U8 getmajorVersion () const
 Get member majorVersion. More...
 
U8 getminorVersion () const
 Get member minorVersion. More...
 
U8 getpatchVersion () const
 Get member patchVersion. More...
 
U8 getschemaVersion () const
 Get member schemaVersion. More...
 
U8 getargumentCount () const
 Get member argumentCount. More...
 
U16 getstatementCount () const
 Get member statementCount. More...
 
U32 getbodySize () const
 Get member bodySize. More...
 
void set (U8 majorVersion, U8 minorVersion, U8 patchVersion, U8 schemaVersion, U8 argumentCount, U16 statementCount, U32 bodySize)
 Set all members. More...
 
void setmajorVersion (U8 majorVersion)
 Set member majorVersion. More...
 
void setminorVersion (U8 minorVersion)
 Set member minorVersion. More...
 
void setpatchVersion (U8 patchVersion)
 Set member patchVersion. More...
 
void setschemaVersion (U8 schemaVersion)
 Set member schemaVersion. More...
 
void setargumentCount (U8 argumentCount)
 Set member argumentCount. More...
 
void setstatementCount (U16 statementCount)
 Set member statementCount. More...
 
void setbodySize (U32 bodySize)
 Set member bodySize. More...
 

Protected Attributes

U8 m_majorVersion
 
U8 m_minorVersion
 
U8 m_patchVersion
 
U8 m_schemaVersion
 
U8 m_argumentCount
 
U16 m_statementCount
 
U32 m_bodySize
 

Additional Inherited Members

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

Detailed Description

Definition at line 19 of file HeaderSerializableAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
SERIALIZED_SIZE 

The size of the serial representation.

Definition at line 29 of file HeaderSerializableAc.hpp.

Constructor & Destructor Documentation

◆ Header() [1/3]

Svc::Fpy::Header::Header ( )

Constructor (default value)

Definition at line 19 of file HeaderSerializableAc.cpp.

◆ Header() [2/3]

Svc::Fpy::Header::Header ( U8  majorVersion,
U8  minorVersion,
U8  patchVersion,
U8  schemaVersion,
U8  argumentCount,
U16  statementCount,
U32  bodySize 
)

Member constructor.

Definition at line 33 of file HeaderSerializableAc.cpp.

◆ Header() [3/3]

Svc::Fpy::Header::Header ( const Header obj)

Copy constructor.

Parameters
objThe source object

Definition at line 55 of file HeaderSerializableAc.cpp.

Member Function Documentation

◆ deserialize()

Fw::SerializeStatus Svc::Fpy::Header::deserialize ( Fw::SerializeBufferBase buffer)
virtual

Deserialization.

Parameters
bufferThe serial buffer

Implements Fw::Serializable.

Definition at line 157 of file HeaderSerializableAc.cpp.

◆ getargumentCount()

U8 Svc::Fpy::Header::getargumentCount ( ) const
inline

Get member argumentCount.

Definition at line 151 of file HeaderSerializableAc.hpp.

◆ getbodySize()

U32 Svc::Fpy::Header::getbodySize ( ) const
inline

Get member bodySize.

Definition at line 163 of file HeaderSerializableAc.hpp.

◆ getmajorVersion()

U8 Svc::Fpy::Header::getmajorVersion ( ) const
inline

Get member majorVersion.

Definition at line 127 of file HeaderSerializableAc.hpp.

◆ getminorVersion()

U8 Svc::Fpy::Header::getminorVersion ( ) const
inline

Get member minorVersion.

Definition at line 133 of file HeaderSerializableAc.hpp.

◆ getpatchVersion()

U8 Svc::Fpy::Header::getpatchVersion ( ) const
inline

Get member patchVersion.

Definition at line 139 of file HeaderSerializableAc.hpp.

◆ getschemaVersion()

U8 Svc::Fpy::Header::getschemaVersion ( ) const
inline

Get member schemaVersion.

Definition at line 145 of file HeaderSerializableAc.hpp.

◆ getstatementCount()

U16 Svc::Fpy::Header::getstatementCount ( ) const
inline

Get member statementCount.

Definition at line 157 of file HeaderSerializableAc.hpp.

◆ operator!=()

bool Svc::Fpy::Header::operator!= ( const Header obj) const

Inequality operator.

Parameters
objThe other object

Definition at line 99 of file HeaderSerializableAc.cpp.

◆ operator=()

Header & Svc::Fpy::Header::operator= ( const Header obj)

Copy assignment operator.

Parameters
objThe source object

Definition at line 73 of file HeaderSerializableAc.cpp.

◆ operator==()

bool Svc::Fpy::Header::operator== ( const Header obj) const

Equality operator.

Parameters
objThe other object

Definition at line 84 of file HeaderSerializableAc.cpp.

◆ serialize()

Fw::SerializeStatus Svc::Fpy::Header::serialize ( Fw::SerializeBufferBase buffer) const
virtual

Serialization.

Parameters
bufferThe serial buffer

Implements Fw::Serializable.

Definition at line 120 of file HeaderSerializableAc.cpp.

◆ set()

void Svc::Fpy::Header::set ( U8  majorVersion,
U8  minorVersion,
U8  patchVersion,
U8  schemaVersion,
U8  argumentCount,
U16  statementCount,
U32  bodySize 
)

Set all members.

Definition at line 228 of file HeaderSerializableAc.cpp.

◆ setargumentCount()

void Svc::Fpy::Header::setargumentCount ( U8  argumentCount)

Set member argumentCount.

Definition at line 272 of file HeaderSerializableAc.cpp.

◆ setbodySize()

void Svc::Fpy::Header::setbodySize ( U32  bodySize)

Set member bodySize.

Definition at line 284 of file HeaderSerializableAc.cpp.

◆ setmajorVersion()

void Svc::Fpy::Header::setmajorVersion ( U8  majorVersion)

Set member majorVersion.

Definition at line 248 of file HeaderSerializableAc.cpp.

◆ setminorVersion()

void Svc::Fpy::Header::setminorVersion ( U8  minorVersion)

Set member minorVersion.

Definition at line 254 of file HeaderSerializableAc.cpp.

◆ setpatchVersion()

void Svc::Fpy::Header::setpatchVersion ( U8  patchVersion)

Set member patchVersion.

Definition at line 260 of file HeaderSerializableAc.cpp.

◆ setschemaVersion()

void Svc::Fpy::Header::setschemaVersion ( U8  schemaVersion)

Set member schemaVersion.

Definition at line 266 of file HeaderSerializableAc.cpp.

◆ setstatementCount()

void Svc::Fpy::Header::setstatementCount ( U16  statementCount)

Set member statementCount.

Definition at line 278 of file HeaderSerializableAc.cpp.

Member Data Documentation

◆ m_argumentCount

U8 Svc::Fpy::Header::m_argumentCount
protected

Definition at line 214 of file HeaderSerializableAc.hpp.

◆ m_bodySize

U32 Svc::Fpy::Header::m_bodySize
protected

Definition at line 216 of file HeaderSerializableAc.hpp.

◆ m_majorVersion

U8 Svc::Fpy::Header::m_majorVersion
protected

Definition at line 210 of file HeaderSerializableAc.hpp.

◆ m_minorVersion

U8 Svc::Fpy::Header::m_minorVersion
protected

Definition at line 211 of file HeaderSerializableAc.hpp.

◆ m_patchVersion

U8 Svc::Fpy::Header::m_patchVersion
protected

Definition at line 212 of file HeaderSerializableAc.hpp.

◆ m_schemaVersion

U8 Svc::Fpy::Header::m_schemaVersion
protected

Definition at line 213 of file HeaderSerializableAc.hpp.

◆ m_statementCount

U16 Svc::Fpy::Header::m_statementCount
protected

Definition at line 215 of file HeaderSerializableAc.hpp.


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