F´ Flight Software - C/C++ Documentation  devel
A framework for building embedded system applications to NASA flight quality standards.
Os::IntervalTimer Class Reference

#include <Os/IntervalTimer.hpp>

Classes

struct  RawTime
 

Public Member Functions

 IntervalTimer ()
 Constructor. More...
 
virtual ~IntervalTimer ()
 Destructor. More...
 
void start ()
 
void stop ()
 
U32 getDiffUsec ()
 

Static Public Member Functions

static U32 getDiffUsec (const RawTime &t1, const RawTime &t2)
 
static void getRawTime (RawTime &time)
 

Detailed Description

Definition at line 13 of file IntervalTimer.hpp.

Constructor & Destructor Documentation

◆ IntervalTimer()

Os::IntervalTimer::IntervalTimer ( )

Constructor.

Definition at line 19 of file IntervalTimerCommon.cpp.

◆ ~IntervalTimer()

Os::IntervalTimer::~IntervalTimer ( )
virtual

Destructor.

Definition at line 24 of file IntervalTimerCommon.cpp.

Member Function Documentation

◆ getDiffUsec() [1/2]

U32 Os::IntervalTimer::getDiffUsec ( )

Returns the difference in usecond difference between start and stop times. The caller must have called start and stop previously.

Returns
U32: microseconds difference in the interval

Definition at line 34 of file IntervalTimerCommon.cpp.

◆ getDiffUsec() [2/2]

U32 Os::IntervalTimer::getDiffUsec ( const RawTime t1,
const RawTime t2 
)
static

Returns the difference in microseconds between the supplied times t1, and t2. This calculation is done with respect to the semantic meaning of the times, and thus is dependent on the platform's representation of the RawTime object.

Returns
U32 microsecond difference between two supplied values, t1-t2.

Definition at line 10 of file IntervalTimer.cpp.

◆ getRawTime()

void Os::IntervalTimer::getRawTime ( RawTime time)
static

Fills the RawTime object supplied with the current raw time in a platform dependent way.

Definition at line 5 of file IntervalTimer.cpp.

◆ start()

void Os::IntervalTimer::start ( )

Capture a start time of the interval timed by the interval timer. This fills the start RawTime of the interval.

Definition at line 26 of file IntervalTimerCommon.cpp.

◆ stop()

void Os::IntervalTimer::stop ( )

Capture a stop time of the interval timed by the interval timer. This fills the stop RawTime of the interval.

Definition at line 30 of file IntervalTimerCommon.cpp.


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