Svc::TimeOffset Class Reference

#include <Svc/Ports/TimeConverterPorts/TimeOffsetSerializableAc.hpp>

Inheritance diagram for Svc::TimeOffset:

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

Public Member Functions
	TimeOffset ()
	Constructor (default value) More...
	TimeOffset (TimeBase::T from, TimeBase::T to, I64 offset_us)
	Member constructor. More...
	TimeOffset (const TimeOffset &obj)
	Copy constructor. More...
TimeOffset &	operator= (const TimeOffset &obj)
	Copy assignment operator. More...
bool	operator== (const TimeOffset &obj) const
	Equality operator. More...
bool	operator!= (const TimeOffset &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...
TimeBase::T	get_from () const
	Get member from. More...
TimeBase::T	get_to () const
	Get member to. More...
I64	get_offset_us () const
	Get member offset_us. More...
void	set (TimeBase::T from, TimeBase::T to, I64 offset_us)
	Set all members. More...
void	set_from (TimeBase::T from)
	Set member from. More...
void	set_to (TimeBase::T to)
	Set member to. More...
void	set_offset_us (I64 offset_us)
	Set member offset_us. 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
TimeBase	m_from
TimeBase	m_to
I64	m_offset_us

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

Detailed Description

An offset between a pair of time bases. A time in the "from" base is converted into the "to" base by adding offset_us microseconds

Definition at line 20 of file TimeOffsetSerializableAc.hpp.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
SERIALIZED_SIZE	The size of the serial representation.

Definition at line 30 of file TimeOffsetSerializableAc.hpp.

Constructor & Destructor Documentation

TimeOffset() [1/3]

Svc::TimeOffset::TimeOffset

(

)

Constructor (default value)

Definition at line 17 of file TimeOffsetSerializableAc.cpp.

TimeOffset() [2/3]

Svc::TimeOffset::TimeOffset	(	TimeBase::T	from,
		TimeBase::T	to,
		I64	offset_us
	)

Member constructor.

Definition at line 27 of file TimeOffsetSerializableAc.cpp.

TimeOffset() [3/3]

Svc::TimeOffset::TimeOffset

(

const TimeOffset &

obj

)

Copy constructor.

Parameters

obj	The source object

Definition at line 41 of file TimeOffsetSerializableAc.cpp.

Member Function Documentation

deserializeFrom()

Fw::SerializeStatus Svc::TimeOffset::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 122 of file TimeOffsetSerializableAc.cpp.

get_from()

TimeBase::T Svc::TimeOffset::get_from ( ) const

inline

Get member from.

Definition at line 125 of file TimeOffsetSerializableAc.hpp.

get_offset_us()

I64 Svc::TimeOffset::get_offset_us ( ) const

inline

Get member offset_us.

Definition at line 137 of file TimeOffsetSerializableAc.hpp.

get_to()

TimeBase::T Svc::TimeOffset::get_to ( ) const

inline

Get member to.

Definition at line 131 of file TimeOffsetSerializableAc.hpp.

operator!=()

bool Svc::TimeOffset::operator!=

(

const TimeOffset &

obj

)

const

Inequality operator.

Parameters

obj	The other object

Definition at line 77 of file TimeOffsetSerializableAc.cpp.

operator=()

TimeOffset & Svc::TimeOffset::operator=

(

const TimeOffset &

obj

)

Copy assignment operator.

Parameters

obj	The source object

Definition at line 55 of file TimeOffsetSerializableAc.cpp.

operator==()

bool Svc::TimeOffset::operator==

(

const TimeOffset &

obj

)

const

Equality operator.

Parameters

obj	The other object

Definition at line 66 of file TimeOffsetSerializableAc.cpp.

serializedSize()

FwSizeType Svc::TimeOffset::serializedSize

(

)

const

Get the dynamic serialized size of the struct.

Definition at line 146 of file TimeOffsetSerializableAc.cpp.

serializeTo()

Fw::SerializeStatus Svc::TimeOffset::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 98 of file TimeOffsetSerializableAc.cpp.

set()

void Svc::TimeOffset::set	(	TimeBase::T	from,
		TimeBase::T	to,
		I64	offset_us
	)

Set all members.

Definition at line 189 of file TimeOffsetSerializableAc.cpp.

set_from()

void Svc::TimeOffset::set_from

(

TimeBase::T

from

)

Set member from.

Definition at line 201 of file TimeOffsetSerializableAc.cpp.

set_offset_us()

void Svc::TimeOffset::set_offset_us

(

I64

offset_us

)

Set member offset_us.

Definition at line 213 of file TimeOffsetSerializableAc.cpp.

set_to()

void Svc::TimeOffset::set_to

(

TimeBase::T

to

)

Set member to.

Definition at line 207 of file TimeOffsetSerializableAc.cpp.

Member Data Documentation

m_from

TimeBase Svc::TimeOffset::m_from

protected

Definition at line 168 of file TimeOffsetSerializableAc.hpp.

m_offset_us

I64 Svc::TimeOffset::m_offset_us

protected

Definition at line 170 of file TimeOffsetSerializableAc.hpp.

m_to

TimeBase Svc::TimeOffset::m_to

protected

Definition at line 169 of file TimeOffsetSerializableAc.hpp.

---

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

• Svc/Ports/TimeConverterPorts/TimeOffsetSerializableAc.hpp
• Svc/Ports/TimeConverterPorts/TimeOffsetSerializableAc.cpp