Fw::TimeValue Class Reference

Data structure for Time. More...

#include <Fw/Time/TimeValueSerializableAc.hpp>

Inheritance diagram for Fw::TimeValue:

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

Public Member Functions
	TimeValue ()
	Constructor (default value) More...
	TimeValue (TimeBase::T timeBase, FwTimeContextStoreType timeContext, U32 seconds, U32 useconds)
	Member constructor. More...
	TimeValue (const TimeValue &obj)
	Copy constructor. More...
TimeValue &	operator= (const TimeValue &obj)
	Copy assignment operator. More...
bool	operator== (const TimeValue &obj) const
	Equality operator. More...
bool	operator!= (const TimeValue &obj) const
	Inequality operator. More...
Fw::SerializeStatus	serializeTo (Fw::SerializeBufferBase &buffer) const
	Serialization. More...
Fw::SerializeStatus	deserializeFrom (Fw::SerializeBufferBase &buffer)
	Deserialization. More...
FwSizeType	serializedSize () const
	Get the dynamic serialized size of the struct. More...
TimeBase::T	get_timeBase () const
	Get member timeBase. More...
FwTimeContextStoreType	get_timeContext () const
	Get member timeContext. More...
U32	get_seconds () const
	Get member seconds. More...
U32	get_useconds () const
	Get member useconds. More...
void	set (TimeBase::T timeBase, FwTimeContextStoreType timeContext, U32 seconds, U32 useconds)
	Set all members. More...
void	set_timeBase (TimeBase::T timeBase)
	Set member timeBase. More...
void	set_timeContext (FwTimeContextStoreType timeContext)
	Set member timeContext. More...
void	set_seconds (U32 seconds)
	Set member seconds. More...
void	set_useconds (U32 useconds)
	Set member useconds. More...
Public Member Functions inherited from Fw::Serializable
SerializeStatus	serialize (SerializeBufferBase &buffer) const
SerializeStatus	deserialize (SerializeBufferBase &buffer)

Protected Attributes
TimeBase	m_timeBase
FwTimeContextStoreType	m_timeContext
U32	m_seconds
U32	m_useconds

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

Detailed Description

Data structure for Time.

Definition at line 20 of file TimeValueSerializableAc.hpp.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
SERIALIZED_SIZE	The size of the serial representation.

Definition at line 30 of file TimeValueSerializableAc.hpp.

Constructor & Destructor Documentation

TimeValue() [1/3]

Fw::TimeValue::TimeValue

(

)

Constructor (default value)

Definition at line 17 of file TimeValueSerializableAc.cpp.

TimeValue() [2/3]

Fw::TimeValue::TimeValue	(	TimeBase::T	timeBase,
		FwTimeContextStoreType	timeContext,
		U32	seconds,
		U32	useconds
	)

Member constructor.

Definition at line 28 of file TimeValueSerializableAc.cpp.

TimeValue() [3/3]

Fw::TimeValue::TimeValue

(

const TimeValue &

obj

)

Copy constructor.

Parameters

obj	The source object

Definition at line 44 of file TimeValueSerializableAc.cpp.

Member Function Documentation

deserializeFrom()

Fw::SerializeStatus Fw::TimeValue::deserializeFrom ( Fw::SerializeBufferBase &  buffer )

virtual

Deserialization.

Parameters

buffer

The serial buffer

Implements Fw::Serializable.

Definition at line 128 of file TimeValueSerializableAc.cpp.

get_seconds()

U32 Fw::TimeValue::get_seconds ( ) const

inline

Get member seconds.

Definition at line 137 of file TimeValueSerializableAc.hpp.

get_timeBase()

TimeBase::T Fw::TimeValue::get_timeBase ( ) const

inline

Get member timeBase.

Definition at line 125 of file TimeValueSerializableAc.hpp.

get_timeContext()

FwTimeContextStoreType Fw::TimeValue::get_timeContext ( ) const

inline

Get member timeContext.

Definition at line 131 of file TimeValueSerializableAc.hpp.

get_useconds()

U32 Fw::TimeValue::get_useconds ( ) const

inline

Get member useconds.

Definition at line 143 of file TimeValueSerializableAc.hpp.

operator!=()

bool Fw::TimeValue::operator!=

(

const TimeValue &

obj

)

const

Inequality operator.

Parameters

obj	The other object

Definition at line 82 of file TimeValueSerializableAc.cpp.

operator=()

TimeValue & Fw::TimeValue::operator=

(

const TimeValue &

obj

)

Copy assignment operator.

Parameters

obj	The source object

Definition at line 59 of file TimeValueSerializableAc.cpp.

operator==()

bool Fw::TimeValue::operator==

(

const TimeValue &

obj

)

const

Equality operator.

Parameters

obj	The other object

Definition at line 70 of file TimeValueSerializableAc.cpp.

serializedSize()

FwSizeType Fw::TimeValue::serializedSize

(

)

const

Get the dynamic serialized size of the struct.

Definition at line 153 of file TimeValueSerializableAc.cpp.

serializeTo()

Fw::SerializeStatus Fw::TimeValue::serializeTo ( Fw::SerializeBufferBase &  buffer ) const

virtual

Serialization.

Parameters

buffer

The serial buffer

Implements Fw::Serializable.

Definition at line 103 of file TimeValueSerializableAc.cpp.

set()

void Fw::TimeValue::set	(	TimeBase::T	timeBase,
		FwTimeContextStoreType	timeContext,
		U32	seconds,
		U32	useconds
	)

Set all members.

Definition at line 203 of file TimeValueSerializableAc.cpp.

set_seconds()

void Fw::TimeValue::set_seconds

(

U32

seconds

)

Set member seconds.

Definition at line 229 of file TimeValueSerializableAc.cpp.

set_timeBase()

void Fw::TimeValue::set_timeBase

(

TimeBase::T

timeBase

)

Set member timeBase.

Definition at line 217 of file TimeValueSerializableAc.cpp.

set_timeContext()

void Fw::TimeValue::set_timeContext

(

FwTimeContextStoreType

timeContext

)

Set member timeContext.

Definition at line 223 of file TimeValueSerializableAc.cpp.

set_useconds()

void Fw::TimeValue::set_useconds

(

U32

useconds

)

Set member useconds.

Definition at line 235 of file TimeValueSerializableAc.cpp.

Member Data Documentation

m_seconds

U32 Fw::TimeValue::m_seconds

protected

Definition at line 180 of file TimeValueSerializableAc.hpp.

m_timeBase

TimeBase Fw::TimeValue::m_timeBase

protected

Definition at line 178 of file TimeValueSerializableAc.hpp.

m_timeContext

FwTimeContextStoreType Fw::TimeValue::m_timeContext

protected

Definition at line 179 of file TimeValueSerializableAc.hpp.

m_useconds

U32 Fw::TimeValue::m_useconds

protected

Definition at line 181 of file TimeValueSerializableAc.hpp.

---

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

• Fw/Time/TimeValueSerializableAc.hpp
• Fw/Time/TimeValueSerializableAc.cpp