Svc::ComDataContextPair Class Reference

#include <Svc/Ports/CommsPorts/ComDataContextPairSerializableAc.hpp>

Inheritance diagram for Svc::ComDataContextPair:

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

Public Member Functions
	ComDataContextPair ()
	Constructor (default value) More...
	ComDataContextPair (const Fw::Buffer &data, const ComCfg::FrameContext &context)
	Member constructor. More...
	ComDataContextPair (const ComDataContextPair &obj)
	Copy constructor. More...
ComDataContextPair &	operator= (const ComDataContextPair &obj)
	Copy assignment operator. More...
bool	operator== (const ComDataContextPair &obj) const
	Equality operator. More...
bool	operator!= (const ComDataContextPair &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::Buffer &	get_data ()
	Get member data. More...
const Fw::Buffer &	get_data () const
	Get member data (const) More...
ComCfg::FrameContext &	get_context ()
	Get member context. More...
const ComCfg::FrameContext &	get_context () const
	Get member context (const) More...
void	set (const Fw::Buffer &data, const ComCfg::FrameContext &context)
	Set all members. More...
void	set_data (const Fw::Buffer &data)
	Set member data. More...
void	set_context (const ComCfg::FrameContext &context)
	Set member context. More...
Public Member Functions inherited from Fw::Serializable
Serializable &	operator= (const Serializable &src)=default
	TODO: this operator should be deleted, this must be done after RawTime is modified though. More...
	DEPRECATED (SerializeStatus serialize(SerialBufferBase &buffer) const, "Use serializeTo(SerialBufferBase& buffer) instead")
	DEPRECATED (SerializeStatus deserialize(SerialBufferBase &buffer), "Use deserializeFrom(SerialBufferBase& buffer) instead")

Protected Attributes
Fw::Buffer	m_data
ComCfg::FrameContext	m_context

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

Detailed Description

Struct representing a communications data buffer along with context information for use storing the inputs ComDataWithContext port

Definition at line 21 of file ComDataContextPairSerializableAc.hpp.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
SERIALIZED_SIZE	The size of the serial representation.

Definition at line 31 of file ComDataContextPairSerializableAc.hpp.

Constructor & Destructor Documentation

ComDataContextPair() [1/3]

Svc::ComDataContextPair::ComDataContextPair

(

)

Constructor (default value)

Definition at line 17 of file ComDataContextPairSerializableAc.cpp.

ComDataContextPair() [2/3]

Svc::ComDataContextPair::ComDataContextPair	(	const Fw::Buffer &	data,
		const ComCfg::FrameContext &	context
	)

Member constructor.

Definition at line 26 of file ComDataContextPairSerializableAc.cpp.

ComDataContextPair() [3/3]

Svc::ComDataContextPair::ComDataContextPair

(

const ComDataContextPair &

obj

)

Copy constructor.

Parameters

obj	The source object

Definition at line 38 of file ComDataContextPairSerializableAc.cpp.

Member Function Documentation

deserializeFrom()

Fw::SerializeStatus Svc::ComDataContextPair::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 113 of file ComDataContextPairSerializableAc.cpp.

get_context() [1/2]

ComCfg::FrameContext& Svc::ComDataContextPair::get_context ( )

inline

Get member context.

Definition at line 136 of file ComDataContextPairSerializableAc.hpp.

get_context() [2/2]

const ComCfg::FrameContext& Svc::ComDataContextPair::get_context ( ) const

inline

Get member context (const)

Definition at line 142 of file ComDataContextPairSerializableAc.hpp.

get_data() [1/2]

Fw::Buffer& Svc::ComDataContextPair::get_data ( )

inline

Get member data.

Definition at line 124 of file ComDataContextPairSerializableAc.hpp.

get_data() [2/2]

const Fw::Buffer& Svc::ComDataContextPair::get_data ( ) const

inline

Get member data (const)

Definition at line 130 of file ComDataContextPairSerializableAc.hpp.

operator!=()

bool Svc::ComDataContextPair::operator!=

(

const ComDataContextPair &

obj

)

const

Inequality operator.

Parameters

obj	The other object

Definition at line 72 of file ComDataContextPairSerializableAc.cpp.

operator=()

ComDataContextPair & Svc::ComDataContextPair::operator=

(

const ComDataContextPair &

obj

)

Copy assignment operator.

Parameters

obj	The source object

Definition at line 51 of file ComDataContextPairSerializableAc.cpp.

operator==()

bool Svc::ComDataContextPair::operator==

(

const ComDataContextPair &

obj

)

const

Equality operator.

Parameters

obj	The other object

Definition at line 62 of file ComDataContextPairSerializableAc.cpp.

serializedSize()

FwSizeType Svc::ComDataContextPair::serializedSize

(

)

const

Get the dynamic serialized size of the struct.

Definition at line 133 of file ComDataContextPairSerializableAc.cpp.

serializeTo()

Fw::SerializeStatus Svc::ComDataContextPair::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 93 of file ComDataContextPairSerializableAc.cpp.

set()

void Svc::ComDataContextPair::set	(	const Fw::Buffer &	data,
		const ComCfg::FrameContext &	context
	)

Set all members.

Definition at line 169 of file ComDataContextPairSerializableAc.cpp.

set_context()

void Svc::ComDataContextPair::set_context

(

const ComCfg::FrameContext &

context

)

Set member context.

Definition at line 185 of file ComDataContextPairSerializableAc.cpp.

set_data()

void Svc::ComDataContextPair::set_data

(

const Fw::Buffer &

data

)

Set member data.

Definition at line 179 of file ComDataContextPairSerializableAc.cpp.

Member Data Documentation

m_context

ComCfg::FrameContext Svc::ComDataContextPair::m_context

protected

Definition at line 170 of file ComDataContextPairSerializableAc.hpp.

m_data

Fw::Buffer Svc::ComDataContextPair::m_data

protected

Definition at line 169 of file ComDataContextPairSerializableAc.hpp.

---

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

• Svc/Ports/CommsPorts/ComDataContextPairSerializableAc.hpp
• Svc/Ports/CommsPorts/ComDataContextPairSerializableAc.cpp