Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-06-24 01:31:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

[wpilib] Improve interrupt docs (NFC) (#3679)

Browse Source
This commit is contained in:
sciencewhiz
2021-10-26 23:35:01 -07:00
committed by GitHub
parent 558151061e
commit d1842ea8fb
4 changed files with 62 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
wpilibc/src/main/native/include/frc/SynchronousInterrupt.h
View File

@@ -13,7 +13,7 @@ namespace frc {
class DigitalSource;
/**
* Class for handling ssynchronous interrupts.
* Class for handling synchronous (blocking) interrupts.
*
* <p> By default, interrupts will occur on rising edge.
*
@@ -30,16 +30,22 @@ class SynchronousInterrupt {
/**
* Construct a Synchronous Interrupt from a Digital Source.
*
* @param source the DigitalSource the interrupts are triggered from
*/
explicit SynchronousInterrupt(DigitalSource& source);
/**
* Construct a Synchronous Interrupt from a Digital Source.
*
* @param source the DigitalSource the interrupts are triggered from
*/
explicit SynchronousInterrupt(DigitalSource* source);
/**
* Construct a Synchronous Interrupt from a Digital Source.
*
* @param source the DigitalSource the interrupts are triggered from
*/
explicit SynchronousInterrupt(std::shared_ptr<DigitalSource> source);
@@ -72,6 +78,8 @@ class SynchronousInterrupt {
/**
* Get the timestamp (relative to FPGA Time) of the last rising edge.
*
* @return the timestamp in seconds relative to getFPGATime
*/
units::second_t GetRisingTimestamp();