[Fawkes Git] branch/jrothe/realsense: realsense: add documentation to some methods

Johannes Rothe johannes.rothe at rwth-aachen.de
Fri Aug 26 15:46:03 CEST 2016


Changes have been pushed for the project "Fawkes Robotics Software Framework".

Gitweb: http://git.fawkesrobotics.org/fawkes.git
Trac:   http://trac.fawkesrobotics.org

The branch, jrothe/realsense has been updated
        to  210cc9e53f6a4d4b0274409483d66422d5639919 (commit)
      from  75260dfa9714ca23dbb232311d076e18b1c63838 (commit)

http://git.fawkesrobotics.org/fawkes.git/jrothe/realsense

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.

- *Log* ---------------------------------------------------------------
commit 210cc9e53f6a4d4b0274409483d66422d5639919
Author:     Johannes Rothe <johannes.rothe at rwth-aachen.de>
AuthorDate: Fri Aug 26 15:45:13 2016 +0200
Commit:     Johannes Rothe <johannes.rothe at rwth-aachen.de>
CommitDate: Fri Aug 26 15:45:13 2016 +0200

    realsense: add documentation to some methods

http://git.fawkesrobotics.org/fawkes.git/commit/210cc9e
http://trac.fawkesrobotics.org/changeset/210cc9e

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -


- *Summary* -----------------------------------------------------------
 src/plugins/realsense/realsense_thread.cpp |   18 ++++++++++++++++++
 1 files changed, 18 insertions(+), 0 deletions(-)


- *Diffs* -------------------------------------------------------------

- *commit* 210cc9e53f6a4d4b0274409483d66422d5639919 - - - - - - - - - -
Author:  Johannes Rothe <johannes.rothe at rwth-aachen.de>
Date:    Fri Aug 26 15:45:13 2016 +0200
Subject: realsense: add documentation to some methods

 src/plugins/realsense/realsense_thread.cpp |   18 ++++++++++++++++++
 1 files changed, 18 insertions(+), 0 deletions(-)

_Diff for modified files_:
diff --git a/src/plugins/realsense/realsense_thread.cpp b/src/plugins/realsense/realsense_thread.cpp
index bdbeb6a..3b8c74f 100644
--- a/src/plugins/realsense/realsense_thread.cpp
+++ b/src/plugins/realsense/realsense_thread.cpp
@@ -106,6 +106,9 @@ RealsenseThread::finalize()
   //TODO Documentation with librealsense
 }
 
+/* Create RS context and start the depth stream
+ * @return true when succesfull
+ */
 bool
 RealsenseThread::connect_and_start_camera()
 {
@@ -132,6 +135,9 @@ RealsenseThread::connect_and_start_camera()
   return true;
 }
 
+/* Get the rs_device pointer and printout camera details
+ * @return rs_device
+ */
 rs_device * RealsenseThread::get_camera()
 {
   //assume we only have one camera connected so take index 0
@@ -151,6 +157,9 @@ rs_device * RealsenseThread::get_camera()
   return rs_detected_device;
 }
 
+/*
+ * Enable the depth stream from rs_device
+ */
 void RealsenseThread::enable_depth_stream()
 {
   rs_enable_stream_preset(rs_device_, rs_stream_type_, RS_PRESET_BEST_QUALITY, &rs_error_);
@@ -164,6 +173,9 @@ void RealsenseThread::enable_depth_stream()
   }
 }
 
+/*
+ * printout and free the rs_error if available
+ */
 void RealsenseThread::log_error()
 {
   if (rs_error_){
@@ -172,6 +184,9 @@ void RealsenseThread::log_error()
   }
 }
 
+/*
+ * Testing function to log the depth pixel distancens
+ */
 void
 RealsenseThread::log_depths(const uint16_t * image)
 {
@@ -186,6 +201,9 @@ RealsenseThread::log_depths(const uint16_t * image)
   logger->log_info(name(), "%s\n\n\n\n\n", out.c_str());
 }
 
+/*
+ * Stop the device and delete the context properly
+ */
 void
 RealsenseThread::stop_camera()
 {




-- 
Fawkes Robotics Framework                 http://www.fawkesrobotics.org


More information about the fawkes-commits mailing list