#include <Fw/Time/Time.hpp>

Inheritance diagram for Fw::Time:

Public Types
enum	{ SERIALIZED_SIZE }

enum	Comparison { LT = -1, EQ = 0, GT = 1, INCOMPARABLE = 2 }
	The type of a comparison result. More...

Public Types inherited from Fw::Serializable
using	SizeType = FwSizeType

Public Member Functions
	Time ()

	Time (const Time &other)

	Time (U32 seconds, U32 useconds)

	Time (TimeBase timeBase, U32 seconds, U32 useconds)

	Time (TimeBase timeBase, FwTimeContextStoreType context, U32 seconds, U32 useconds)

virtual	~Time ()

void	set (U32 seconds, U32 useconds)

void	set (TimeBase timeBase, U32 seconds, U32 useconds)

void	set (TimeBase timeBase, FwTimeContextStoreType context, U32 seconds, U32 useconds)

void	setTimeBase (TimeBase timeBase)

void	setTimeContext (FwTimeContextStoreType context)

U32	getSeconds () const

U32	getUSeconds () const

TimeBase	getTimeBase () const

FwTimeContextStoreType	getContext () const

SerializeStatus	serializeTo (SerializeBufferBase &buffer) const override
	serialize contents to buffer More...

SerializeStatus	deserializeFrom (SerializeBufferBase &buffer) override
	deserialize contents from buffer More...

SerializeStatus	serialize (SerializeBufferBase &buffer) const override

SerializeStatus	deserialize (SerializeBufferBase &buffer) override

bool	operator== (const Time &other) const

bool	operator!= (const Time &other) const

bool	operator> (const Time &other) const

bool	operator< (const Time &other) const

bool	operator>= (const Time &other) const

bool	operator<= (const Time &other) const

Time &	operator= (const Time &other)

void	add (U32 seconds, U32 mseconds)

Static Public Member Functions
static Time	zero (TimeBase timeBase=TimeBase::TB_NONE)

static Comparison	compare (const Time &time1, const Time &time2)

static Time	add (const Time &a, const Time &b)

static Time	sub (const Time &minuend, const Time &subtrahend)

Friends
class	TimeTester

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

virtual	~Serializable ()
	destructor More...

Detailed Description

Definition at line 11 of file Time.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
SERIALIZED_SIZE

Definition at line 17 of file Time.hpp.

◆ Comparison

enum Fw::Time::Comparison

The type of a comparison result.

Enumerator
LT
EQ
GT
INCOMPARABLE

Definition at line 52 of file Time.hpp.

Constructor & Destructor Documentation

◆ Time() [1/5]

Fw::Time::Time ( )

Definition at line 7 of file Time.cpp.

◆ Time() [2/5]

Fw::Time::Time ( const Time & other )

Definition at line 17 of file Time.cpp.

◆ Time() [3/5]

Fw::Time::Time	(	U32	seconds,
		U32	useconds
	)

Definition at line 21 of file Time.cpp.

◆ Time() [4/5]

Fw::Time::Time	(	TimeBase	timeBase,
		U32	seconds,
		U32	useconds
	)

Definition at line 25 of file Time.cpp.

◆ Time() [5/5]

Fw::Time::Time	(	TimeBase	timeBase,
		FwTimeContextStoreType	context,
		U32	seconds,
		U32	useconds
	)

Definition at line 37 of file Time.cpp.

◆ ~Time()

Fw::Time::~Time ( )

virtual

Definition at line 14 of file Time.cpp.

Member Function Documentation

◆ add() [1/2]

Time Fw::Time::add	(	const Time &	a,
		const Time &	b
	)

static

Add two times

Returns: The result

Parameters

a	Time a
b	Time b

Definition at line 166 of file Time.cpp.

◆ add() [2/2]

void Fw::Time::add	(	U32	seconds,
		U32	mseconds
	)

Definition at line 221 of file Time.cpp.

◆ compare()

Time::Comparison Fw::Time::compare	(	const Time &	time1,
		const Time &	time2
	)

static

Compare two times

Returns: The result

Parameters

time1	Time 1
time2	Time 2

Definition at line 136 of file Time.cpp.

◆ deserialize()

SerializeStatus Fw::Time::deserialize ( SerializeBufferBase & buffer )

overridevirtual

Reimplemented from Fw::Serializable.

Definition at line 108 of file Time.cpp.

◆ deserializeFrom()

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

overridevirtual

deserialize contents from buffer

Reimplemented from Fw::Serializable.

Definition at line 91 of file Time.cpp.

◆ getContext()

FwTimeContextStoreType Fw::Time::getContext ( ) const

Definition at line 124 of file Time.cpp.

◆ getSeconds()

U32 Fw::Time::getSeconds ( ) const

Definition at line 112 of file Time.cpp.

◆ getTimeBase()

TimeBase Fw::Time::getTimeBase ( ) const

Definition at line 120 of file Time.cpp.

◆ getUSeconds()

U32 Fw::Time::getUSeconds ( ) const

Definition at line 116 of file Time.cpp.

◆ operator!=()

bool Fw::Time::operator!= ( const Time & other ) const

Definition at line 56 of file Time.cpp.

◆ operator<()

bool Fw::Time::operator< ( const Time & other ) const

Definition at line 64 of file Time.cpp.

◆ operator<=()

bool Fw::Time::operator<= ( const Time & other ) const

Definition at line 73 of file Time.cpp.

◆ operator=()

Time & Fw::Time::operator= ( const Time & other )

Definition at line 45 of file Time.cpp.

◆ operator==()

bool Fw::Time::operator== ( const Time & other ) const

Definition at line 52 of file Time.cpp.

◆ operator>()

bool Fw::Time::operator> ( const Time & other ) const

Definition at line 60 of file Time.cpp.

◆ operator>=()

bool Fw::Time::operator>= ( const Time & other ) const

Definition at line 68 of file Time.cpp.

◆ serialize()

SerializeStatus Fw::Time::serialize ( SerializeBufferBase & buffer ) const

overridevirtual

Reimplemented from Fw::Serializable.

Definition at line 104 of file Time.cpp.

◆ serializeTo()

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

overridevirtual

serialize contents to buffer

Reimplemented from Fw::Serializable.

Definition at line 78 of file Time.cpp.

◆ set() [1/3]

void Fw::Time::set	(	U32	seconds,
		U32	useconds
	)

Definition at line 29 of file Time.cpp.

◆ set() [2/3]

void Fw::Time::set	(	TimeBase	timeBase,
		U32	seconds,
		U32	useconds
	)

Definition at line 33 of file Time.cpp.

◆ set() [3/3]

void Fw::Time::set	(	TimeBase	timeBase,
		FwTimeContextStoreType	context,
		U32	seconds,
		U32	useconds
	)

Definition at line 41 of file Time.cpp.

◆ setTimeBase()

void Fw::Time::setTimeBase ( TimeBase timeBase )

Definition at line 232 of file Time.cpp.

◆ setTimeContext()

void Fw::Time::setTimeContext ( FwTimeContextStoreType context )

Definition at line 236 of file Time.cpp.

◆ sub()

Time Fw::Time::sub	(	const Time &	minuend,
		const Time &	subtrahend
	)

static

Subtract subtrahend from minuend

Returns: The result

Parameters

minuend	Value being subtracted from
subtrahend	Value being subtracted

Definition at line 193 of file Time.cpp.

◆ zero()

Time Fw::Time::zero ( TimeBase timeBase = TimeBase::TB_NONE )

static

Returns: time zero

Definition at line 129 of file Time.cpp.

Friends And Related Function Documentation

◆ TimeTester

friend class TimeTester

friend

Definition at line 13 of file Time.hpp.

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

Fw/Time/Time.hpp
Fw/Time/Time.cpp

Public Types

Public Member Functions

Static Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ Comparison

Constructor & Destructor Documentation

◆ Time() [1/5]

◆ Time() [2/5]

◆ Time() [3/5]

◆ Time() [4/5]

◆ Time() [5/5]

◆ ~Time()

Member Function Documentation

◆ add() [1/2]

◆ add() [2/2]

◆ compare()

◆ deserialize()

◆ deserializeFrom()

◆ getContext()

◆ getSeconds()

◆ getTimeBase()

◆ getUSeconds()

◆ operator!=()

◆ operator<()

◆ operator<=()

◆ operator=()

◆ operator==()

◆ operator>()

◆ operator>=()

◆ serialize()

◆ serializeTo()

◆ set() [1/3]

◆ set() [2/3]

◆ set() [3/3]

◆ setTimeBase()

◆ setTimeContext()

◆ sub()

◆ zero()

Friends And Related Function Documentation

◆ TimeTester