Fw::TimeInterval Class Reference

#include <Fw/Time/TimeInterval.hpp>

Inheritance diagram for Fw::TimeInterval:

Public Types
enum	{ SERIALIZED_SIZE = sizeof(U32) * 2 }
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
	TimeInterval ()=default
	~TimeInterval ()=default
	TimeInterval (const TimeInterval &other)
	TimeInterval (U32 seconds, U32 useconds)
	TimeInterval (const Time &start, const Time &end)
void	set (U32 seconds, U32 useconds)
U32	getSeconds () const
U32	getUSeconds () const
SerializeStatus	serializeTo (SerializeBufferBase &buffer) const override
	serialize contents to buffer More...
SerializeStatus	deserializeFrom (SerializeBufferBase &buffer) override
	deserialize contents from buffer More...
void	add (U32 seconds, U32 mseconds)
bool	operator== (const TimeInterval &other) const
bool	operator!= (const TimeInterval &other) const
bool	operator> (const TimeInterval &other) const
bool	operator< (const TimeInterval &other) const
bool	operator>= (const TimeInterval &other) const
bool	operator<= (const TimeInterval &other) const
TimeInterval &	operator= (const TimeInterval &other)
Public Member Functions inherited from Fw::Serializable
	DEPRECATED (SerializeStatus serialize(SerializeBufferBase &buffer) const, "Use serializeTo(SerializeBufferBase& buffer) instead")
	DEPRECATED (SerializeStatus deserialize(SerializeBufferBase &buffer), "Use deserializeFrom(SerializeBufferBase& buffer) instead")

Static Public Member Functions
static Comparison	compare (const TimeInterval &time1, const TimeInterval &time2)
static TimeInterval	add (const TimeInterval &a, const TimeInterval &b)
static TimeInterval	sub (const TimeInterval &t1, const TimeInterval &t2)

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

Detailed Description

Examples:

/opt/jenkins/workspace/F_Prime_Infrastructure/fprime-website-publishing/fprime/Os/IntervalTimer.hpp.

Definition at line 20 of file TimeInterval.hpp.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
SERIALIZED_SIZE

Definition at line 22 of file TimeInterval.hpp.

Comparison

enum Fw::TimeInterval::Comparison

The type of a comparison result.

Enumerator
LT
EQ
GT
INCOMPARABLE

Definition at line 45 of file TimeInterval.hpp.

Constructor & Destructor Documentation

TimeInterval() [1/4]

Fw::TimeInterval::TimeInterval ( )

default

~TimeInterval()

Fw::TimeInterval::~TimeInterval ( )

default

TimeInterval() [2/4]

TimeInterval::TimeInterval

(

const TimeInterval &

other

)

Definition at line 5 of file TimeInterval.cpp.

TimeInterval() [3/4]

TimeInterval::TimeInterval	(	U32	seconds,
		U32	useconds
	)

Definition at line 9 of file TimeInterval.cpp.

TimeInterval() [4/4]

TimeInterval::TimeInterval	(	const Time &	start,
		const Time &	end
	)

Definition at line 13 of file TimeInterval.cpp.

Member Function Documentation

add() [1/2]

void TimeInterval::add	(	U32	seconds,
		U32	mseconds
	)

Definition at line 122 of file TimeInterval.cpp.

add() [2/2]

TimeInterval TimeInterval::add ( const TimeInterval &  a, const TimeInterval &  b  )

static

Add two time intervals Adds the seconds and microseconds fields of two time intervals together

Returns

TimeInterval result

Parameters

a	TimeInterval a
b	TimeInterval b

Definition at line 93 of file TimeInterval.cpp.

compare()

TimeInterval::Comparison TimeInterval::compare ( const TimeInterval &  time1, const TimeInterval &  time2  )

static

Compare two time intervals A time interval is considered greater than another if it spans a longer duration The comparison is done on the seconds first, then the microseconds if the seconds are equal

Returns

TimeInterval result

Parameters

time1	TimeInterval 1
time2	TimeInterval 2

Definition at line 74 of file TimeInterval.cpp.

deserializeFrom()

SerializeStatus TimeInterval::deserializeFrom ( SerializeBufferBase &  buffer )

overridevirtual

deserialize contents from buffer

Implements Fw::Serializable.

Definition at line 61 of file TimeInterval.cpp.

getSeconds()

U32 TimeInterval::getSeconds

(

)

const

Definition at line 66 of file TimeInterval.cpp.

getUSeconds()

U32 TimeInterval::getUSeconds

(

)

const

Definition at line 70 of file TimeInterval.cpp.

operator!=()

bool TimeInterval::operator!=

(

const TimeInterval &

other

)

const

Definition at line 34 of file TimeInterval.cpp.

operator<()

bool TimeInterval::operator<

(

const TimeInterval &

other

)

const

Definition at line 42 of file TimeInterval.cpp.

operator<=()

bool TimeInterval::operator<=

(

const TimeInterval &

other

)

const

Definition at line 51 of file TimeInterval.cpp.

operator=()

TimeInterval & TimeInterval::operator=

(

const TimeInterval &

other

)

Definition at line 23 of file TimeInterval.cpp.

operator==()

bool TimeInterval::operator==

(

const TimeInterval &

other

)

const

Definition at line 30 of file TimeInterval.cpp.

operator>()

bool TimeInterval::operator>

(

const TimeInterval &

other

)

const

Definition at line 38 of file TimeInterval.cpp.

operator>=()

bool TimeInterval::operator>=

(

const TimeInterval &

other

)

const

Definition at line 46 of file TimeInterval.cpp.

serializeTo()

SerializeStatus TimeInterval::serializeTo ( SerializeBufferBase &  buffer ) const

overridevirtual

serialize contents to buffer

Implements Fw::Serializable.

Definition at line 56 of file TimeInterval.cpp.

set()

void TimeInterval::set	(	U32	seconds,
		U32	useconds
	)

Definition at line 17 of file TimeInterval.cpp.

sub()

TimeInterval TimeInterval::sub ( const TimeInterval &  t1, const TimeInterval &  t2  )

static

Subtract two time intervals This computes the absolute value of the difference between two time intervals For example if t1=(0s, 5us) and t2=(0s, 3us), the result is (0s, 2us). This operation is commutative, i.e. the result is the same regardless of the order of the arguments.

Returns

TimeInterval result

Parameters

t1	TimeInterval 1
t2	TimeInterval 2

Definition at line 105 of file TimeInterval.cpp.

---

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

• Fw/Time/TimeInterval.hpp
• Fw/Time/TimeInterval.cpp