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

#include <Svc/FpySequencer/SequenceSerializableAc.hpp>

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

Public Types

enum  { SERIALIZED_SIZE }
 
using Type_of_args = U8[16]
 The type of args. More...
 
using Type_of_statements = Svc::Fpy::Statement[1024]
 The type of statements. More...
 
- Public Types inherited from Fw::Serializable
using SizeType = FwSizeType
 

Public Member Functions

 Sequence ()
 Constructor (default value) More...
 
 Sequence (const Svc::Fpy::Header &header, const Type_of_args &args, const Type_of_statements &statements, const Svc::Fpy::Footer &footer)
 Member constructor. More...
 
 Sequence (const Sequence &obj)
 Copy constructor. More...
 
 Sequence (const Svc::Fpy::Header &header, U8 args, const Svc::Fpy::Statement &statements, const Svc::Fpy::Footer &footer)
 Member constructor (scalar values for arrays) More...
 
Sequenceoperator= (const Sequence &obj)
 Copy assignment operator. More...
 
bool operator== (const Sequence &obj) const
 Equality operator. More...
 
bool operator!= (const Sequence &obj) const
 Inequality operator. More...
 
Fw::SerializeStatus serializeTo (Fw::SerializeBufferBase &buffer) const
 Serialization. More...
 
Fw::SerializeStatus deserializeFrom (Fw::SerializeBufferBase &buffer)
 Deserialization. More...
 
FwSizeType serializedSize () const
 Get the dynamic serialized size of the struct. More...
 
Svc::Fpy::Headerget_header ()
 Get member header. More...
 
const Svc::Fpy::Headerget_header () const
 Get member header (const) More...
 
Type_of_argsget_args ()
 Get member args. More...
 
const Type_of_argsget_args () const
 Get member args (const) More...
 
Type_of_statementsget_statements ()
 Get member statements. More...
 
const Type_of_statementsget_statements () const
 Get member statements (const) More...
 
Svc::Fpy::Footerget_footer ()
 Get member footer. More...
 
const Svc::Fpy::Footerget_footer () const
 Get member footer (const) More...
 
void set (const Svc::Fpy::Header &header, const Type_of_args &args, const Type_of_statements &statements, const Svc::Fpy::Footer &footer)
 Set all members. More...
 
void set_header (const Svc::Fpy::Header &header)
 Set member header. More...
 
void set_args (const Type_of_args &args)
 Set member args. More...
 
void set_statements (const Type_of_statements &statements)
 Set member statements. More...
 
void set_footer (const Svc::Fpy::Footer &footer)
 Set member footer. More...
 
- Public Member Functions inherited from Fw::Serializable
 DEPRECATED (SerializeStatus serialize(SerializeBufferBase &buffer) const, "Use serializeTo(SerializeBufferBase& buffer) instead")
 
 DEPRECATED (SerializeStatus deserialize(SerializeBufferBase &buffer), "Use deserializeFrom(SerializeBufferBase& buffer) instead")
 

Protected Attributes

Svc::Fpy::Header m_header
 
U8 m_args [16]
 
Svc::Fpy::Statement m_statements [1024]
 
Svc::Fpy::Footer m_footer
 

Additional Inherited Members

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

Detailed Description

Definition at line 22 of file SequenceSerializableAc.hpp.

Member Typedef Documentation

◆ Type_of_args

The type of args.

Definition at line 33 of file SequenceSerializableAc.hpp.

◆ Type_of_statements

The type of statements.

Definition at line 36 of file SequenceSerializableAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
SERIALIZED_SIZE 

The size of the serial representation.

Definition at line 44 of file SequenceSerializableAc.hpp.

Constructor & Destructor Documentation

◆ Sequence() [1/4]

Svc::Fpy::Sequence::Sequence ( )

Constructor (default value)

Definition at line 19 of file SequenceSerializableAc.cpp.

◆ Sequence() [2/4]

Svc::Fpy::Sequence::Sequence ( const Svc::Fpy::Header header,
const Type_of_args args,
const Type_of_statements statements,
const Svc::Fpy::Footer footer 
)

Member constructor.

Definition at line 33 of file SequenceSerializableAc.cpp.

◆ Sequence() [3/4]

Svc::Fpy::Sequence::Sequence ( const Sequence obj)

Copy constructor.

Parameters
objThe source object

Definition at line 52 of file SequenceSerializableAc.cpp.

◆ Sequence() [4/4]

Svc::Fpy::Sequence::Sequence ( const Svc::Fpy::Header header,
U8  args,
const Svc::Fpy::Statement statements,
const Svc::Fpy::Footer footer 
)

Member constructor (scalar values for arrays)

Definition at line 66 of file SequenceSerializableAc.cpp.

Member Function Documentation

◆ deserializeFrom()

Fw::SerializeStatus Svc::Fpy::Sequence::deserializeFrom ( Fw::SerializeBufferBase buffer)
virtual

Deserialization.

Parameters
bufferThe serial buffer

Implements Fw::Serializable.

Definition at line 178 of file SequenceSerializableAc.cpp.

◆ get_args() [1/2]

Type_of_args& Svc::Fpy::Sequence::get_args ( )
inline

Get member args.

Definition at line 159 of file SequenceSerializableAc.hpp.

◆ get_args() [2/2]

const Type_of_args& Svc::Fpy::Sequence::get_args ( ) const
inline

Get member args (const)

Definition at line 165 of file SequenceSerializableAc.hpp.

◆ get_footer() [1/2]

Svc::Fpy::Footer& Svc::Fpy::Sequence::get_footer ( )
inline

Get member footer.

Definition at line 183 of file SequenceSerializableAc.hpp.

◆ get_footer() [2/2]

const Svc::Fpy::Footer& Svc::Fpy::Sequence::get_footer ( ) const
inline

Get member footer (const)

Definition at line 189 of file SequenceSerializableAc.hpp.

◆ get_header() [1/2]

Svc::Fpy::Header& Svc::Fpy::Sequence::get_header ( )
inline

Get member header.

Definition at line 147 of file SequenceSerializableAc.hpp.

◆ get_header() [2/2]

const Svc::Fpy::Header& Svc::Fpy::Sequence::get_header ( ) const
inline

Get member header (const)

Definition at line 153 of file SequenceSerializableAc.hpp.

◆ get_statements() [1/2]

Type_of_statements& Svc::Fpy::Sequence::get_statements ( )
inline

Get member statements.

Definition at line 171 of file SequenceSerializableAc.hpp.

◆ get_statements() [2/2]

const Type_of_statements& Svc::Fpy::Sequence::get_statements ( ) const
inline

Get member statements (const)

Definition at line 177 of file SequenceSerializableAc.hpp.

◆ operator!=()

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

Inequality operator.

Parameters
objThe other object

Definition at line 128 of file SequenceSerializableAc.cpp.

◆ operator=()

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

Copy assignment operator.

Parameters
objThe source object

Definition at line 89 of file SequenceSerializableAc.cpp.

◆ operator==()

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

Equality operator.

Parameters
objThe other object

Definition at line 100 of file SequenceSerializableAc.cpp.

◆ serializedSize()

FwSizeType Svc::Fpy::Sequence::serializedSize ( ) const

Get the dynamic serialized size of the struct.

Definition at line 207 of file SequenceSerializableAc.cpp.

◆ serializeTo()

Fw::SerializeStatus Svc::Fpy::Sequence::serializeTo ( Fw::SerializeBufferBase buffer) const
virtual

Serialization.

Parameters
bufferThe serial buffer

Implements Fw::Serializable.

Definition at line 149 of file SequenceSerializableAc.cpp.

◆ set()

void Svc::Fpy::Sequence::set ( const Svc::Fpy::Header header,
const Type_of_args args,
const Type_of_statements statements,
const Svc::Fpy::Footer footer 
)

Set all members.

Definition at line 273 of file SequenceSerializableAc.cpp.

◆ set_args()

void Svc::Fpy::Sequence::set_args ( const Type_of_args args)

Set member args.

Definition at line 298 of file SequenceSerializableAc.cpp.

◆ set_footer()

void Svc::Fpy::Sequence::set_footer ( const Svc::Fpy::Footer footer)

Set member footer.

Definition at line 314 of file SequenceSerializableAc.cpp.

◆ set_header()

void Svc::Fpy::Sequence::set_header ( const Svc::Fpy::Header header)

Set member header.

Definition at line 292 of file SequenceSerializableAc.cpp.

◆ set_statements()

void Svc::Fpy::Sequence::set_statements ( const Type_of_statements statements)

Set member statements.

Definition at line 306 of file SequenceSerializableAc.cpp.

Member Data Documentation

◆ m_args

U8 Svc::Fpy::Sequence::m_args[16]
protected

Definition at line 225 of file SequenceSerializableAc.hpp.

◆ m_footer

Svc::Fpy::Footer Svc::Fpy::Sequence::m_footer
protected

Definition at line 227 of file SequenceSerializableAc.hpp.

◆ m_header

Svc::Fpy::Header Svc::Fpy::Sequence::m_header
protected

Definition at line 224 of file SequenceSerializableAc.hpp.

◆ m_statements

Svc::Fpy::Statement Svc::Fpy::Sequence::m_statements[1024]
protected

Definition at line 226 of file SequenceSerializableAc.hpp.


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