CARMA C++
carma::services::Delay Class Reference

Trivial class for handling delays. More...

#include <carma/services/Delay.h>

Public Member Functions

 Delay ()
 Constructor. More...
 
void flipDelay ()
 
void flipRate ()
 
double meters () const
 Get the delay, in meters. More...
 
double metersPerSecond () const
 Get the delay rate, in meters/sec. More...
 
double nanoSeconds () const
 Get the delay, in nanoseconds. More...
 
double nanoSecondsPerSecond () const
 Get the delay, in nanoseconds/sec. More...
 
const Delay operator+ (const Delay &delay) const
 Add two Delays. More...
 
Delayoperator+= (const Delay &delay)
 
Delayoperator+= (const Delay delay)
 
const Delay operator- (const Delay &delay) const
 Subtract two Delays. More...
 
Delayoperator-= (const Delay &delay)
 
Delayoperator-= (const Delay delay)
 
double secondsPerSecond () const
 Get the delay rate, in seconds/sec. More...
 
void setDelayInMeters (double delayInMeters)
 Set the delay, in meters. More...
 
void setDelayInNanoSeconds (double delayInNanoSec)
 Set the delay, in nanoSeconds. More...
 
void setDelayRateInMeters (double delayRateInMeters)
 Set the delay rate, in meters/second. More...
 
void setDelayRateInNanoSeconds (double delayRateInNanoSec)
 Set the delay rate, in nanoSeconds/second. More...
 
virtual ~Delay ()
 Destructor. More...
 

Friends

std::ostream & operator<< (std::ostream &os, Delay delay)
 Allows cout << Delay. More...
 

Detailed Description

Trivial class for handling delays.

Definition at line 18 of file Delay.h.

Constructor & Destructor Documentation

carma::services::Delay::Delay ( )

Constructor.

virtual carma::services::Delay::~Delay ( )
virtual

Destructor.

Member Function Documentation

double carma::services::Delay::meters ( ) const

Get the delay, in meters.

Definition at line 62 of file Delay.h.

double carma::services::Delay::metersPerSecond ( ) const

Get the delay rate, in meters/sec.

Definition at line 69 of file Delay.h.

double carma::services::Delay::nanoSeconds ( ) const

Get the delay, in nanoseconds.

Definition at line 76 of file Delay.h.

double carma::services::Delay::nanoSecondsPerSecond ( ) const

Get the delay, in nanoseconds/sec.

Definition at line 83 of file Delay.h.

const Delay carma::services::Delay::operator+ ( const Delay delay) const

Add two Delays.

const Delay carma::services::Delay::operator- ( const Delay delay) const

Subtract two Delays.

double carma::services::Delay::secondsPerSecond ( ) const

Get the delay rate, in seconds/sec.

Definition at line 90 of file Delay.h.

void carma::services::Delay::setDelayInMeters ( double  delayInMeters)

Set the delay, in meters.

Definition at line 34 of file Delay.h.

void carma::services::Delay::setDelayInNanoSeconds ( double  delayInNanoSec)

Set the delay, in nanoSeconds.

Definition at line 48 of file Delay.h.

void carma::services::Delay::setDelayRateInMeters ( double  delayRateInMeters)

Set the delay rate, in meters/second.

Definition at line 41 of file Delay.h.

void carma::services::Delay::setDelayRateInNanoSeconds ( double  delayRateInNanoSec)

Set the delay rate, in nanoSeconds/second.

Definition at line 55 of file Delay.h.

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os,
Delay  delay 
)
friend

Allows cout << Delay.


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