LightLib
PROS library for VEX V5: EKF/MCL localization, RAMSETE path following, high-level chassis API
Loading...
Searching...
No Matches
okapi::TimeUtil Class Reference

Utility class for holding an AbstractTimer, AbstractRate, and SettledUtil together in one class since they are commonly used together. More...

#include <timeUtil.hpp>

Public Member Functions

 TimeUtil (const Supplier< std::unique_ptr< AbstractTimer > > &itimerSupplier, const Supplier< std::unique_ptr< AbstractRate > > &irateSupplier, const Supplier< std::unique_ptr< SettledUtil > > &isettledUtilSupplier)
 
std::unique_ptr< AbstractTimergetTimer () const
 
std::unique_ptr< AbstractRategetRate () const
 
std::unique_ptr< SettledUtilgetSettledUtil () const
 
Supplier< std::unique_ptr< AbstractTimer > > getTimerSupplier () const
 
Supplier< std::unique_ptr< AbstractRate > > getRateSupplier () const
 
Supplier< std::unique_ptr< SettledUtil > > getSettledUtilSupplier () const
 

Protected Attributes

Supplier< std::unique_ptr< AbstractTimer > > timerSupplier
 
Supplier< std::unique_ptr< AbstractRate > > rateSupplier
 
Supplier< std::unique_ptr< SettledUtil > > settledUtilSupplier
 

Detailed Description

Utility class for holding an AbstractTimer, AbstractRate, and SettledUtil together in one class since they are commonly used together.

Definition at line 18 of file timeUtil.hpp.

Constructor & Destructor Documentation

◆ TimeUtil()

okapi::TimeUtil::TimeUtil ( const Supplier< std::unique_ptr< AbstractTimer > > &  itimerSupplier,
const Supplier< std::unique_ptr< AbstractRate > > &  irateSupplier,
const Supplier< std::unique_ptr< SettledUtil > > &  isettledUtilSupplier 
)

Member Function Documentation

◆ getRate()

std::unique_ptr< AbstractRate > okapi::TimeUtil::getRate ( ) const

◆ getRateSupplier()

Supplier< std::unique_ptr< AbstractRate > > okapi::TimeUtil::getRateSupplier ( ) const

◆ getSettledUtil()

std::unique_ptr< SettledUtil > okapi::TimeUtil::getSettledUtil ( ) const

◆ getSettledUtilSupplier()

Supplier< std::unique_ptr< SettledUtil > > okapi::TimeUtil::getSettledUtilSupplier ( ) const

◆ getTimer()

std::unique_ptr< AbstractTimer > okapi::TimeUtil::getTimer ( ) const

◆ getTimerSupplier()

Supplier< std::unique_ptr< AbstractTimer > > okapi::TimeUtil::getTimerSupplier ( ) const

Member Data Documentation

◆ rateSupplier

Supplier<std::unique_ptr<AbstractRate> > okapi::TimeUtil::rateSupplier
protected

Definition at line 38 of file timeUtil.hpp.

◆ settledUtilSupplier

Supplier<std::unique_ptr<SettledUtil> > okapi::TimeUtil::settledUtilSupplier
protected

Definition at line 39 of file timeUtil.hpp.

◆ timerSupplier

Supplier<std::unique_ptr<AbstractTimer> > okapi::TimeUtil::timerSupplier
protected

Definition at line 37 of file timeUtil.hpp.


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