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

returns from a function call More...

#include <Svc/FpySequencer/FpySequencer_ReturnDirectiveSerializableAc.hpp>

Inheritance diagram for Svc::FpySequencer_ReturnDirective:
Fw::Serializable

Public Types

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

Public Member Functions

 FpySequencer_ReturnDirective ()
 Constructor (default value) More...
 
 FpySequencer_ReturnDirective (Svc::Fpy::StackSizeType returnValSize, Svc::Fpy::StackSizeType callArgsSize)
 Member constructor. More...
 
 FpySequencer_ReturnDirective (const FpySequencer_ReturnDirective &obj)
 Copy constructor. More...
 
FpySequencer_ReturnDirectiveoperator= (const FpySequencer_ReturnDirective &obj)
 Copy assignment operator. More...
 
bool operator== (const FpySequencer_ReturnDirective &obj) const
 Equality operator. More...
 
bool operator!= (const FpySequencer_ReturnDirective &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...
 
Svc::Fpy::StackSizeType get_returnValSize () const
 Get member returnValSize. More...
 
Svc::Fpy::StackSizeType get_callArgsSize () const
 Get member callArgsSize. More...
 
void set (Svc::Fpy::StackSizeType returnValSize, Svc::Fpy::StackSizeType callArgsSize)
 Set all members. More...
 
void set_returnValSize (Svc::Fpy::StackSizeType returnValSize)
 Set member returnValSize. More...
 
void set_callArgsSize (Svc::Fpy::StackSizeType callArgsSize)
 Set member callArgsSize. 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

Svc::Fpy::StackSizeType m_returnValSize
 
Svc::Fpy::StackSizeType m_callArgsSize
 

Additional Inherited Members

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

Detailed Description

returns from a function call

Definition at line 19 of file FpySequencer_ReturnDirectiveSerializableAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
SERIALIZED_SIZE 

The size of the serial representation.

Definition at line 29 of file FpySequencer_ReturnDirectiveSerializableAc.hpp.

Constructor & Destructor Documentation

◆ FpySequencer_ReturnDirective() [1/3]

Svc::FpySequencer_ReturnDirective::FpySequencer_ReturnDirective ( )

Constructor (default value)

Definition at line 17 of file FpySequencer_ReturnDirectiveSerializableAc.cpp.

◆ FpySequencer_ReturnDirective() [2/3]

Svc::FpySequencer_ReturnDirective::FpySequencer_ReturnDirective ( Svc::Fpy::StackSizeType  returnValSize,
Svc::Fpy::StackSizeType  callArgsSize 
)

Member constructor.

Definition at line 26 of file FpySequencer_ReturnDirectiveSerializableAc.cpp.

◆ FpySequencer_ReturnDirective() [3/3]

Svc::FpySequencer_ReturnDirective::FpySequencer_ReturnDirective ( const FpySequencer_ReturnDirective obj)

Copy constructor.

Parameters
objThe source object

Definition at line 38 of file FpySequencer_ReturnDirectiveSerializableAc.cpp.

Member Function Documentation

◆ deserializeFrom()

Fw::SerializeStatus Svc::FpySequencer_ReturnDirective::deserializeFrom ( Fw::SerialBufferBase buffer,
Fw::Endianness  mode = Fw::Endianness::BIG 
)
virtual

Deserialization.

Parameters
bufferThe serial buffer
modeEndianness of serialized buffer

Implements Fw::Serializable.

Definition at line 113 of file FpySequencer_ReturnDirectiveSerializableAc.cpp.

◆ get_callArgsSize()

Svc::Fpy::StackSizeType Svc::FpySequencer_ReturnDirective::get_callArgsSize ( ) const
inline

Get member callArgsSize.

Definition at line 128 of file FpySequencer_ReturnDirectiveSerializableAc.hpp.

◆ get_returnValSize()

Svc::Fpy::StackSizeType Svc::FpySequencer_ReturnDirective::get_returnValSize ( ) const
inline

Get member returnValSize.

Definition at line 122 of file FpySequencer_ReturnDirectiveSerializableAc.hpp.

◆ operator!=()

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

Inequality operator.

Parameters
objThe other object

Definition at line 72 of file FpySequencer_ReturnDirectiveSerializableAc.cpp.

◆ operator=()

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

Copy assignment operator.

Parameters
objThe source object

Definition at line 51 of file FpySequencer_ReturnDirectiveSerializableAc.cpp.

◆ operator==()

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

Equality operator.

Parameters
objThe other object

Definition at line 62 of file FpySequencer_ReturnDirectiveSerializableAc.cpp.

◆ serializedSize()

FwSizeType Svc::FpySequencer_ReturnDirective::serializedSize ( ) const

Get the dynamic serialized size of the struct.

Definition at line 133 of file FpySequencer_ReturnDirectiveSerializableAc.cpp.

◆ serializeTo()

Fw::SerializeStatus Svc::FpySequencer_ReturnDirective::serializeTo ( Fw::SerialBufferBase buffer,
Fw::Endianness  mode = Fw::Endianness::BIG 
) const
virtual

Serialization.

Parameters
bufferThe serial buffer
modeEndianness of serialized buffer

Implements Fw::Serializable.

Definition at line 93 of file FpySequencer_ReturnDirectiveSerializableAc.cpp.

◆ set()

void Svc::FpySequencer_ReturnDirective::set ( Svc::Fpy::StackSizeType  returnValSize,
Svc::Fpy::StackSizeType  callArgsSize 
)

Set all members.

Definition at line 169 of file FpySequencer_ReturnDirectiveSerializableAc.cpp.

◆ set_callArgsSize()

void Svc::FpySequencer_ReturnDirective::set_callArgsSize ( Svc::Fpy::StackSizeType  callArgsSize)

Set member callArgsSize.

Definition at line 185 of file FpySequencer_ReturnDirectiveSerializableAc.cpp.

◆ set_returnValSize()

void Svc::FpySequencer_ReturnDirective::set_returnValSize ( Svc::Fpy::StackSizeType  returnValSize)

Set member returnValSize.

Definition at line 179 of file FpySequencer_ReturnDirectiveSerializableAc.cpp.

Member Data Documentation

◆ m_callArgsSize

Svc::Fpy::StackSizeType Svc::FpySequencer_ReturnDirective::m_callArgsSize
protected

◆ m_returnValSize

Svc::Fpy::StackSizeType Svc::FpySequencer_ReturnDirective::m_returnValSize
protected

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