F´ Flight Software - C/C++ Documentation  NASA-v1.5.0
A framework for building embedded system applications to NASA flight quality standards.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Os::IntervalTimer Class Reference

#include <Os/IntervalTimer.hpp>

Classes

struct  RawTime
 

Public Member Functions

 IntervalTimer ()
 Constructor. More...
 
virtual ~IntervalTimer ()
 Destructor. More...
 
void start (void)
 
void stop (void)
 
U32 getDiffUsec (void)
 
 IntervalTimer (IntervalTimer &)
 Disabled copy constructor. More...
 

Static Public Member Functions

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

Public Attributes

PRIVATE __pad0__: RawTime m_startTime
 Stored start time. More...
 
RawTime m_stopTime
 Stored end time. More...
 

Detailed Description

Definition at line 13 of file IntervalTimer.hpp.

Constructor & Destructor Documentation

◆ IntervalTimer() [1/2]

Os::IntervalTimer::IntervalTimer ( )

Constructor.

Definition at line 5 of file IntervalTimer.cpp.

◆ ~IntervalTimer()

Os::IntervalTimer::~IntervalTimer ( )
virtual

Destructor.

Definition at line 7 of file IntervalTimer.cpp.

◆ IntervalTimer() [2/2]

Os::IntervalTimer::IntervalTimer ( IntervalTimer )

Disabled copy constructor.

Member Function Documentation

◆ getDiffUsec() [1/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 14 of file IntervalTimer.cpp.

◆ getDiffUsec() [2/2]

U32 Os::IntervalTimer::getDiffUsec ( void  )

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.

◆ 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 9 of file IntervalTimer.cpp.

◆ start()

void Os::IntervalTimer::start ( void  )

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 ( void  )

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.

Member Data Documentation

◆ __pad0__

PRIVATE Os::IntervalTimer::__pad0__

Stored start time.

Definition at line 67 of file IntervalTimer.hpp.

◆ m_stopTime

RawTime Os::IntervalTimer::m_stopTime

Stored end time.

Definition at line 71 of file IntervalTimer.hpp.


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