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

#include <Svc/FpySequencer/FpySequencer_SequenceExecutionArgsSerializableAc.hpp>

Inheritance diagram for Svc::FpySequencer_SequenceExecutionArgs:
Fw::Serializable

Public Types

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

Public Member Functions

 FpySequencer_SequenceExecutionArgs ()
 Constructor (default value) More...
 
 FpySequencer_SequenceExecutionArgs (const Fw::StringBase &filePath, Svc::FpySequencer_BlockState::T block)
 Member constructor. More...
 
 FpySequencer_SequenceExecutionArgs (const FpySequencer_SequenceExecutionArgs &obj)
 Copy constructor. More...
 
FpySequencer_SequenceExecutionArgsoperator= (const FpySequencer_SequenceExecutionArgs &obj)
 Copy assignment operator. More...
 
bool operator== (const FpySequencer_SequenceExecutionArgs &obj) const
 Equality operator. More...
 
bool operator!= (const FpySequencer_SequenceExecutionArgs &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...
 
Fw::ExternalStringget_filePath ()
 Get member filePath. More...
 
const Fw::ExternalStringget_filePath () const
 Get member filePath (const) More...
 
Svc::FpySequencer_BlockState::T get_block () const
 Get member block. More...
 
void set (const Fw::StringBase &filePath, Svc::FpySequencer_BlockState::T block)
 Set all members. More...
 
void set_filePath (const Fw::StringBase &filePath)
 Set member filePath. More...
 
void set_block (Svc::FpySequencer_BlockState::T block)
 Set member block. 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

char m___fprime_ac_filePath_buffer [Fw::StringBase::BUFFER_SIZE(200)]
 
Fw::ExternalString m_filePath
 
Svc::FpySequencer_BlockState m_block
 

Additional Inherited Members

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

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
SERIALIZED_SIZE 

The size of the serial representation.

Definition at line 29 of file FpySequencer_SequenceExecutionArgsSerializableAc.hpp.

Constructor & Destructor Documentation

◆ FpySequencer_SequenceExecutionArgs() [1/3]

Svc::FpySequencer_SequenceExecutionArgs::FpySequencer_SequenceExecutionArgs ( )

Constructor (default value)

Definition at line 17 of file FpySequencer_SequenceExecutionArgsSerializableAc.cpp.

◆ FpySequencer_SequenceExecutionArgs() [2/3]

Svc::FpySequencer_SequenceExecutionArgs::FpySequencer_SequenceExecutionArgs ( const Fw::StringBase filePath,
Svc::FpySequencer_BlockState::T  block 
)

Member constructor.

Definition at line 26 of file FpySequencer_SequenceExecutionArgsSerializableAc.cpp.

◆ FpySequencer_SequenceExecutionArgs() [3/3]

Svc::FpySequencer_SequenceExecutionArgs::FpySequencer_SequenceExecutionArgs ( const FpySequencer_SequenceExecutionArgs obj)

Copy constructor.

Parameters
objThe source object

Definition at line 38 of file FpySequencer_SequenceExecutionArgsSerializableAc.cpp.

Member Function Documentation

◆ deserializeFrom()

Fw::SerializeStatus Svc::FpySequencer_SequenceExecutionArgs::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_SequenceExecutionArgsSerializableAc.cpp.

◆ get_block()

Svc::FpySequencer_BlockState::T Svc::FpySequencer_SequenceExecutionArgs::get_block ( ) const
inline

Get member block.

Definition at line 134 of file FpySequencer_SequenceExecutionArgsSerializableAc.hpp.

◆ get_filePath() [1/2]

Fw::ExternalString& Svc::FpySequencer_SequenceExecutionArgs::get_filePath ( )
inline

Get member filePath.

Definition at line 122 of file FpySequencer_SequenceExecutionArgsSerializableAc.hpp.

◆ get_filePath() [2/2]

const Fw::ExternalString& Svc::FpySequencer_SequenceExecutionArgs::get_filePath ( ) const
inline

Get member filePath (const)

Definition at line 128 of file FpySequencer_SequenceExecutionArgsSerializableAc.hpp.

◆ operator!=()

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

Inequality operator.

Parameters
objThe other object

Definition at line 72 of file FpySequencer_SequenceExecutionArgsSerializableAc.cpp.

◆ operator=()

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

Copy assignment operator.

Parameters
objThe source object

Definition at line 51 of file FpySequencer_SequenceExecutionArgsSerializableAc.cpp.

◆ operator==()

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

Equality operator.

Parameters
objThe other object

Definition at line 62 of file FpySequencer_SequenceExecutionArgsSerializableAc.cpp.

◆ serializedSize()

FwSizeType Svc::FpySequencer_SequenceExecutionArgs::serializedSize ( ) const

Get the dynamic serialized size of the struct.

Definition at line 133 of file FpySequencer_SequenceExecutionArgsSerializableAc.cpp.

◆ serializeTo()

Fw::SerializeStatus Svc::FpySequencer_SequenceExecutionArgs::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_SequenceExecutionArgsSerializableAc.cpp.

◆ set()

void Svc::FpySequencer_SequenceExecutionArgs::set ( const Fw::StringBase filePath,
Svc::FpySequencer_BlockState::T  block 
)

Set all members.

Definition at line 168 of file FpySequencer_SequenceExecutionArgsSerializableAc.cpp.

◆ set_block()

void Svc::FpySequencer_SequenceExecutionArgs::set_block ( Svc::FpySequencer_BlockState::T  block)

Set member block.

Definition at line 184 of file FpySequencer_SequenceExecutionArgsSerializableAc.cpp.

◆ set_filePath()

void Svc::FpySequencer_SequenceExecutionArgs::set_filePath ( const Fw::StringBase filePath)

Set member filePath.

Definition at line 178 of file FpySequencer_SequenceExecutionArgsSerializableAc.cpp.

Member Data Documentation

◆ m___fprime_ac_filePath_buffer

char Svc::FpySequencer_SequenceExecutionArgs::m___fprime_ac_filePath_buffer[Fw::StringBase::BUFFER_SIZE(200)]
protected

◆ m_block

Svc::FpySequencer_BlockState Svc::FpySequencer_SequenceExecutionArgs::m_block
protected

◆ m_filePath

Fw::ExternalString Svc::FpySequencer_SequenceExecutionArgs::m_filePath
protected

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