dark0707
/
px4-firmware
forked from Archive/PX4-Autopilot
1
0
Fork 0
Code Pull Requests Activity

microRTPS_timesync.h: fix comments notation so to be properly generated in EmPy

This commit is contained in:
TSC21 2020-03-09 19:51:47 +00:00 committed by Nuno Marques
parent 1893c9e37e
commit 512c405834
1 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
msg/templates/urtps/microRTPS_timesync.h.em
View File

@ -141,22 +141,22 @@ public:
@[ end if]@
@[end if]@
/**
* @brief Get the time sync offset in nanoseconds
* @return The offset in nanosecods
*/
/**
* @@brief Get the time sync offset in nanoseconds
* @@return The offset in nanosecods
*/
inline int64_t getOffset() { return _offset_ns.load(); }
/**
* @brief Sums the time sync offset to the timestamp
* @param[in,out] timestamp The timestamp to add the offset to
*/
/**
* @@brief Sums the time sync offset to the timestamp
* @@param[in,out] timestamp The timestamp to add the offset to
*/
inline void addOffset(uint64_t& timestamp) { timestamp = (timestamp * 1000LL + _offset_ns.load()) / 1000ULL; }
/**
* @brief Substracts the time sync offset to the timestamp
* @param[in,out] timestamp The timestamp to subtract the offset of
*/
/**
* @@brief Substracts the time sync offset to the timestamp
* @@param[in,out] timestamp The timestamp to subtract the offset of
*/
inline void subtractOffset(uint64_t& timestamp) { timestamp = (timestamp * 1000LL - _offset_ns.load()) / 1000ULL; }
private:
@ -179,9 +179,9 @@ private:
std::unique_ptr<std::thread> _send_timesync_thread;
std::atomic<bool> _request_stop{false};
/**
* @brief Updates the offset of the time sync filter
* @param[in] offset The value of the offset to update to
*/
/**
* @@brief Updates the offset of the time sync filter
* @@param[in] offset The value of the offset to update to
*/
inline void updateOffset(const uint64_t& offset) { _offset_ns.store(offset, std::memory_order_relaxed); }
};