DeltaTimeUtil (spartanLib2 API)

java.lang.Object

org.chsrobotics.lib.util.DeltaTimeUtil

public class DeltaTimeUtil extends Object

Class to simplify a common robot code action: getting a time elapsed between two points.

This class relies on WPI's Timer.getFPGATimestamp() method for its source of time.

Constructor Summary

Constructors

Constructor

Description

DeltaTimeUtil()

Constructs an instance of DeltaTimeUtil.
Method Summary

Modifier and Type

Method

Description

double

getTimeSecondsSinceLastCall()

Returns the time elapsed between now and the comparison base.

double

getTimeSecondsSinceLastCallNoReset()

Returns the time elapsed between now and the comparison base.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- DeltaTimeUtil
  
  public DeltaTimeUtil()
  
  Constructs an instance of DeltaTimeUtil.
  The comparison base is initially set to the time as this is constructed.
Method Details
- getTimeSecondsSinceLastCall
  
  public double getTimeSecondsSinceLastCall()
  
  Returns the time elapsed between now and the comparison base. The comparison base is set to now after computation of the elapsed time.
  Time determined by WPI's Timer.getFPGATimestamp() method.
  
  Returns:
  
  Time, in seconds, elapsed between now and the comparison base.
- getTimeSecondsSinceLastCallNoReset
  
  public double getTimeSecondsSinceLastCallNoReset()
  
  Returns the time elapsed between now and the comparison base. The comparison base is not changed following this call.
  Time determined by WPI's Timer.getFPGATimestamp() method.
  
  Returns:
  
  Time, in seconds, elapsed between now and the comparison base.