ATimer.3 936 B

1234567891011121314151617181920212223242526272829303132333435
  1. .TH "ATimer" 3 "Tue Aug 9 2022" "openPilotLog" \" -*- nroff -*-
  2. .ad l
  3. .nh
  4. .SH NAME
  5. ATimer \- The \fBATimer\fP class provides an easy to use performance timer\&.
  6. .SH SYNOPSIS
  7. .br
  8. .PP
  9. .PP
  10. \fC#include <atimer\&.h>\fP
  11. .PP
  12. Inherits QObject\&.
  13. .SS "Public Member Functions"
  14. .in +1c
  15. .ti -1c
  16. .RI "\fBATimer\fP (QObject *parent=nullptr)"
  17. .br
  18. .ti -1c
  19. .RI "long \fBtimeNow\fP ()"
  20. .br
  21. .RI "timeNow takes an intermediate timing and returns miliseconds elapsed\&. "
  22. .in -1c
  23. .SH "Detailed Description"
  24. .PP
  25. The \fBATimer\fP class provides an easy to use performance timer\&.
  26. It automatically stops when going out of scope and prints the elapsed time to the console\&. Intermediate timings can be manually obtained with \fBtimeNow()\fP\&.
  27. .PP
  28. It can be given a QObject as a parent to time its lifetime or can be used without parent in any context\&.
  29. .SH "Author"
  30. .PP
  31. Generated automatically by Doxygen for openPilotLog from the source code\&.