Add documentation for installation and python module #27
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,118 +1,5 @@ | ||
| # CARMA Clock Python Module | ||
| This directory includes the source files for building the CARMA Clock Python Module bindings with [pybind11](https://pybind11.readthedocs.io/en/stable/). It includes a `src/carma_clock-py.cpp` file which calls the pybind11 library functions/macros to build python module bindings and a `/cmake/dependencies.cmake` file which pulls in pybind11 and finds python3 for CMake. It also includes a CMake test for which runs the `python_wrapper.test.py` to ensure the resulting library built can be imported as a python module. | ||
| ## Dependencies | ||
| The CMake dependencies script relies on [CPM](https://github.com/cpm-cmake/CPM.cmake) and Python3 to be installed and discoverable to CMake. | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,17 +1,36 @@ | ||
| #include <pybind11/pybind11.h> | ||
| #include <string> | ||
| #include <carma_clock.h> | ||
| namespace py = pybind11; | ||
|
|
||
|
There was a problem hiding this comment. Formatting changes |
||
| PYBIND11_MODULE(libcarma_clock, m) | ||
| { | ||
| m.doc() = R"(CARMA Time Module provides the CarmaClock object, which is a | ||
|
There was a problem hiding this comment. New module documentation string. |
||
| wrapper for direct calls to system time. It is intended for use when it is | ||
| necessary to have control over each increment in time. An example of a use | ||
| case is in a simulation environment where time may progress non-linearly. | ||
| The CarmaClock constructor takes a boolean parameter to indicate whether | ||
| to directly make calls to system time or to use its internal store value | ||
| for time. Calls to its update() method will update the internal stored value, | ||
| while calls to its now* or sleep* will return or unblock threads depending | ||
| on the stored value respectively.)"; | ||
|
|
||
| py::class_<fwha_stol::lib::time::CarmaClock>(m, "CarmaClock") | ||
| .def(py::init<bool>(), py::arg("simulation_mode") = false) | ||
|
There was a problem hiding this comment. optional, but apparently we can also add method documentation like this |
||
| .def("nowInSeconds", &fwha_stol::lib::time::CarmaClock::nowInSeconds , | ||
| R"(Get current time in seconds)") | ||
| .def("nowInMilliseconds", &fwha_stol::lib::time::CarmaClock::nowInMilliseconds , | ||
| R"(Get current time in milliseconds)") | ||
| .def("update", &fwha_stol::lib::time::CarmaClock::update, py::arg("current_time"), | ||
| R"("Update current time to value (ms). Only valid for simulation mode True)") | ||
| .def("is_simulation_mode", &fwha_stol::lib::time::CarmaClock::is_simulation_mode, | ||
| R"(Return True if simulation mode set to True and False if not.)") | ||
| .def("wait_for_initialization", &fwha_stol::lib::time::CarmaClock::wait_for_initialization, | ||
| R"(Method will block thread until update() is called on CarmaClock. | ||
| This method should be called once before any calls to sleep or now methods | ||
| to ensure that time has a value.)") | ||
| .def("sleep_until", &fwha_stol::lib::time::CarmaClock::sleep_until, py::arg("future_time"), | ||
| R"(Method will block thread until given time (ms))") | ||
| .def("sleep_for", &fwha_stol::lib::time::CarmaClock::sleep_for, py::arg("time_to_sleep"), | ||
| R"(Method will block thread for given time (ms))"); | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Something I noticed. This is the carma-clock-1 package. It can't depend on itself