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

a statement is a directive opcode paired with an argument buffer More...

#include <Svc/FpySequencer/StatementSerializableAc.hpp>

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

Public Types

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

Public Member Functions

 Statement ()
 Constructor (default value) More...
 
 Statement (Svc::Fpy::DirectiveId::T opCode, const Fw::StatementArgBuffer &argBuf)
 Member constructor. More...
 
 Statement (const Statement &obj)
 Copy constructor. More...
 
Statementoperator= (const Statement &obj)
 Copy assignment operator. More...
 
bool operator== (const Statement &obj) const
 Equality operator. More...
 
bool operator!= (const Statement &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::DirectiveId::T get_opCode () const
 Get member opCode. More...
 
Fw::StatementArgBufferget_argBuf ()
 Get member argBuf. More...
 
const Fw::StatementArgBufferget_argBuf () const
 Get member argBuf (const) More...
 
void set (Svc::Fpy::DirectiveId::T opCode, const Fw::StatementArgBuffer &argBuf)
 Set all members. More...
 
void set_opCode (Svc::Fpy::DirectiveId::T opCode)
 Set member opCode. More...
 
void set_argBuf (const Fw::StatementArgBuffer &argBuf)
 Set member argBuf. More...
 
- Public Member Functions inherited from Fw::Serializable
SerializeStatus serialize (SerializeBufferBase &buffer) const
 
SerializeStatus deserialize (SerializeBufferBase &buffer)
 

Protected Attributes

Svc::Fpy::DirectiveId m_opCode
 
Fw::StatementArgBuffer m_argBuf
 

Additional Inherited Members

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

Detailed Description

a statement is a directive opcode paired with an argument buffer

Definition at line 22 of file StatementSerializableAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
SERIALIZED_SIZE 

The size of the serial representation.

Definition at line 32 of file StatementSerializableAc.hpp.

Constructor & Destructor Documentation

◆ Statement() [1/3]

Svc::Fpy::Statement::Statement ( )

Constructor (default value)

Definition at line 19 of file StatementSerializableAc.cpp.

◆ Statement() [2/3]

Svc::Fpy::Statement::Statement ( Svc::Fpy::DirectiveId::T  opCode,
const Fw::StatementArgBuffer argBuf 
)

Member constructor.

Definition at line 28 of file StatementSerializableAc.cpp.

◆ Statement() [3/3]

Svc::Fpy::Statement::Statement ( const Statement obj)

Copy constructor.

Parameters
objThe source object

Definition at line 40 of file StatementSerializableAc.cpp.

Member Function Documentation

◆ deserializeFrom()

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

Deserialization.

Parameters
bufferThe serial buffer

Implements Fw::Serializable.

Definition at line 112 of file StatementSerializableAc.cpp.

◆ get_argBuf() [1/2]

Fw::StatementArgBuffer& Svc::Fpy::Statement::get_argBuf ( )
inline

Get member argBuf.

Definition at line 129 of file StatementSerializableAc.hpp.

◆ get_argBuf() [2/2]

const Fw::StatementArgBuffer& Svc::Fpy::Statement::get_argBuf ( ) const
inline

Get member argBuf (const)

Definition at line 135 of file StatementSerializableAc.hpp.

◆ get_opCode()

Svc::Fpy::DirectiveId::T Svc::Fpy::Statement::get_opCode ( ) const
inline

Get member opCode.

Definition at line 123 of file StatementSerializableAc.hpp.

◆ operator!=()

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

Inequality operator.

Parameters
objThe other object

Definition at line 74 of file StatementSerializableAc.cpp.

◆ operator=()

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

Copy assignment operator.

Parameters
objThe source object

Definition at line 53 of file StatementSerializableAc.cpp.

◆ operator==()

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

Equality operator.

Parameters
objThe other object

Definition at line 64 of file StatementSerializableAc.cpp.

◆ serializedSize()

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

Get the dynamic serialized size of the struct.

Definition at line 129 of file StatementSerializableAc.cpp.

◆ serializeTo()

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

Serialization.

Parameters
bufferThe serial buffer

Implements Fw::Serializable.

Definition at line 95 of file StatementSerializableAc.cpp.

◆ set()

void Svc::Fpy::Statement::set ( Svc::Fpy::DirectiveId::T  opCode,
const Fw::StatementArgBuffer argBuf 
)

Set all members.

Definition at line 165 of file StatementSerializableAc.cpp.

◆ set_argBuf()

void Svc::Fpy::Statement::set_argBuf ( const Fw::StatementArgBuffer argBuf)

Set member argBuf.

Definition at line 181 of file StatementSerializableAc.cpp.

◆ set_opCode()

void Svc::Fpy::Statement::set_opCode ( Svc::Fpy::DirectiveId::T  opCode)

Set member opCode.

Definition at line 175 of file StatementSerializableAc.cpp.

Member Data Documentation

◆ m_argBuf

Fw::StatementArgBuffer Svc::Fpy::Statement::m_argBuf
protected

Definition at line 163 of file StatementSerializableAc.hpp.

◆ m_opCode

Svc::Fpy::DirectiveId Svc::Fpy::Statement::m_opCode
protected

Definition at line 162 of file StatementSerializableAc.hpp.


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