| Ewout van Bekkum | 3c61ae9 | 2020-10-30 15:52:25 -0700 | [diff] [blame] | 1 | .. _module-pw_chrono_stl: |
| 2 | |
| 3 | ------------- |
| 4 | pw_chrono_stl |
| 5 | ------------- |
| 6 | ``pw_chrono_stl`` is a collection of ``pw_chrono`` backends that are implemented |
| 7 | using STL's ``std::chrono`` library. |
| 8 | |
| 9 | .. warning:: |
| 10 | This module is under construction, not ready for use, and the documentation |
| 11 | is incomplete. |
| 12 | |
| 13 | SystemClock backend |
| 14 | ------------------- |
| 15 | The STL based ``system_clock`` backend implements the ``pw_chrono:system_clock`` |
| 16 | facade by using the ``std::chrono::steady_clock``. Note that the |
| 17 | ``std::chrono::system_clock`` cannot be used as this is not always a monotonic |
| 18 | clock source. |
| 19 | |
| 20 | See the documentation for ``pw_chrono`` for further details. |
| 21 | |
| 22 | Build targets |
| 23 | ------------- |
| 24 | The GN build for ``pw_chrono_stl`` has one target: ``system_clock``. |
| Ewout van Bekkum | 01a32af | 2020-11-30 11:34:48 -0800 | [diff] [blame^] | 25 | The ``system_clock`` target provides the |
| 26 | ``pw_chrono_backend/system_clock_config.h`` and |
| 27 | ``pw_chrono_backend/system_clock_inline.h`` headers and the backend for the |
| 28 | ``pw_chrono:system_clock``. |