DUNE::Time::Counter< T > Class Template Reference

Detailed Description

template<typename T>
class DUNE::Time::Counter< T >

Simple time counter.

This class checks if the amount of time elapsed since the last call to reset() is greater than the top value.

Public Member Functions
	Counter (T top=0.0)
void	setTop (T top)
T	getTop (void) const
T	reset (void)
bool	overflow (void)
T	getRemaining (void) const
T	getElapsed (void) const

Constructor & Destructor Documentation

template<typename T>

DUNE::Time::Counter< T >::Counter ( T  top = 0.0 )

inline

Constructor.

Parameters

top	counter's top value.

Member Function Documentation

template<typename T>

T DUNE::Time::Counter< T >::getElapsed ( void  ) const

inline

Get elapsed time.

Returns

elapsed time (s).

Referenced by DUNE::Hardware::BasicDeviceDriver::BasicDeviceDriver().

template<typename T>

T DUNE::Time::Counter< T >::getRemaining ( void  ) const

inline

Get remaining time.

Returns

time remaining (s).

Referenced by DUNE::Hardware::BasicModem::readLine(), DUNE::Hardware::BasicModem::readRaw(), and DUNE::Hardware::UCTK::Interface::sendFrame().

template<typename T>

T DUNE::Time::Counter< T >::getTop ( void  ) const

inline

Get top value.

Returns

counter's top value.

template<typename T>

bool DUNE::Time::Counter< T >::overflow ( void  )

inline

Check if the counter has reached the top value.

Returns

true if an overflow occured, false otherwise.

Referenced by Actuators::PWM::ServoPwm::CheckGPIOSate(), DUNE::Navigation::BasicNavigation::checkUncertainty(), DUNE::Hardware::BasicDeviceDriver::consume(), DUNE::Control::PathController::consume(), DUNE::Navigation::StreamEstimator::consume(), DUNE::Control::BasicAutopilot::consume(), DUNE::Navigation::BasicNavigation::consume(), DUNE::Navigation::BasicNavigation::getAltitude(), DUNE::Hardware::BasicModem::isCooling(), DUNE::Monitors::VerticalMonitor::isProgressSlow(), DUNE::Daemon::onMain(), DUNE::Hardware::BasicModem::readRaw(), DUNE::Hardware::UCTK::Interface::sendFrame(), Transports::UDP::LimitedComms::setMyPosition(), Navigation::General::ROV::Task::task(), Control::ROV::RemoteOperation::Task::toggleWallTracker(), and Transports::FTP::Session::~Session().

template<typename T>

T DUNE::Time::Counter< T >::reset ( void  )

inline

Reset counter.

Referenced by Actuators::PWM::ServoPwm::CheckGPIOSate(), DUNE::Navigation::StreamEstimator::consume(), DUNE::Control::BasicAutopilot::consume(), DUNE::Navigation::BasicNavigation::consume(), DUNE::Time::Counter< float >::Counter(), DUNE::Monitors::VerticalMonitor::isProgressSlow(), DUNE::Daemon::onMain(), DUNE::Hardware::BasicModem::setBusy(), DUNE::Time::Counter< float >::setTop(), Navigation::General::ROV::Task::task(), Control::ROV::RemoteOperation::Task::toggleWallTracker(), and Transports::FTP::Session::~Session().

template<typename T>

void DUNE::Time::Counter< T >::setTop ( T  top )

inline

Set top value.

Parameters

top	counter's top value.

Referenced by Actuators::PWM::ServoPwm::CheckGPIOSate(), DUNE::Hardware::BasicDeviceDriver::consume(), DUNE::Control::PathController::consume(), DUNE::Control::BasicAutopilot::consume(), DUNE::Time::Counter< float >::Counter(), Transports::UDP::LimitedComms::LimitedComms(), DUNE::Daemon::onResourceInitialization(), Control::ROV::RemoteOperation::Task::onResourceInitialization(), DUNE::Navigation::BasicNavigation::onUpdateParameters(), DUNE::Control::BasicAutopilot::reset(), DUNE::Hardware::BasicModem::setTxRateMax(), DUNE::Navigation::StreamEstimator::StreamEstimator(), and DUNE::Monitors::VerticalMonitor::VerticalMonitor().

Collaboration diagram for DUNE::Time::Counter< T >: