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:

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...
Statement &	operator= (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::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::DirectiveId::T	get_opCode () const
	Get member opCode. More...
Fw::StatementArgBuffer &	get_argBuf ()
	Get member argBuf. More...
const Fw::StatementArgBuffer &	get_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
	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::DirectiveId	m_opCode
Fw::StatementArgBuffer	m_argBuf

Additional Inherited Members
Protected Member Functions inherited from Fw::Serializable
	Serializable ()
	Default constructor. More...
virtual	~Serializable ()
	Virtual 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

obj	The source object

Definition at line 40 of file StatementSerializableAc.cpp.

Member Function Documentation

deserializeFrom()

Fw::SerializeStatus Svc::Fpy::Statement::deserializeFrom ( Fw::SerialBufferBase &  buffer, Fw::Endianness  mode = Fw::Endianness::BIG  )

virtual

Deserialization.

Parameters

buffer	The serial buffer
mode	Endianness of serialized buffer

Implements Fw::Serializable.

Definition at line 115 of file StatementSerializableAc.cpp.

get_argBuf() [1/2]

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

inline

Get member argBuf.

Definition at line 131 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 137 of file StatementSerializableAc.hpp.

get_opCode()

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

inline

Get member opCode.

Definition at line 125 of file StatementSerializableAc.hpp.

operator!=()

bool Svc::Fpy::Statement::operator!=

(

const Statement &

obj

)

const

Inequality operator.

Parameters

obj	The other object

Definition at line 74 of file StatementSerializableAc.cpp.

operator=()

Statement & Svc::Fpy::Statement::operator=

(

const Statement &

obj

)

Copy assignment operator.

Parameters

obj	The source object

Definition at line 53 of file StatementSerializableAc.cpp.

operator==()

bool Svc::Fpy::Statement::operator==

(

const Statement &

obj

)

const

Equality operator.

Parameters

obj	The 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 135 of file StatementSerializableAc.cpp.

serializeTo()

Fw::SerializeStatus Svc::Fpy::Statement::serializeTo ( Fw::SerialBufferBase &  buffer, Fw::Endianness  mode = Fw::Endianness::BIG  ) const

virtual

Serialization.

Parameters

buffer	The serial buffer
mode	Endianness of serialized 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 171 of file StatementSerializableAc.cpp.

set_argBuf()

void Svc::Fpy::Statement::set_argBuf

(

const Fw::StatementArgBuffer &

argBuf

)

Set member argBuf.

Definition at line 187 of file StatementSerializableAc.cpp.

set_opCode()

void Svc::Fpy::Statement::set_opCode

(

Svc::Fpy::DirectiveId::T

opCode

)

Set member opCode.

Definition at line 181 of file StatementSerializableAc.cpp.

Member Data Documentation

m_argBuf

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

protected

Definition at line 165 of file StatementSerializableAc.hpp.

m_opCode

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

protected

Definition at line 164 of file StatementSerializableAc.hpp.

---

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

• Svc/FpySequencer/StatementSerializableAc.hpp
• Svc/FpySequencer/StatementSerializableAc.cpp