From 319d883880d1caddad81d2e390f8efbd8e236dde Mon Sep 17 00:00:00 2001 From: Dhanya Maliakal Date: Thu, 24 Aug 2017 16:47:27 +0200 Subject: [PATCH] modified user example in manual/manual-api and regenerated documentation --- RELEASE.txt | 22 ++++++++++----- .../angularCalibrationHowTo.html | 4 +-- .../html/angularCalibrationHowTo/index.html | 4 +-- .../html/angularCalibrationHowTo/node1.html | 2 +- .../html/angularCalibrationHowTo/node2.html | 2 +- .../html/angularCalibrationHowTo/node3.html | 2 +- .../html/angularCalibrationHowTo/node4.html | 2 +- .../html/angularCalibrationHowTo/node5.html | 4 +-- .../energyCalibrationHowTo.html | 4 +-- .../html/energyCalibrationHowTo/index.html | 4 +-- .../html/energyCalibrationHowTo/node1.html | 2 +- .../html/energyCalibrationHowTo/node2.html | 2 +- .../html/energyCalibrationHowTo/node3.html | 2 +- .../html/energyCalibrationHowTo/node4.html | 2 +- .../html/energyCalibrationHowTo/node5.html | 4 +-- .../slsDetectorClientDocs/acquisition.html | 2 +- .../html/slsDetectorClientDocs/actions.html | 2 +- .../html/slsDetectorClientDocs/advanced.html | 2 +- .../html/slsDetectorClientDocs/config.html | 4 +-- .../docs/html/slsDetectorClientDocs/ctb.html | 2 +- .../docs/html/slsDetectorClientDocs/data.html | 2 +- .../html/slsDetectorClientDocs/index.html | 2 +- .../html/slsDetectorClientDocs/network.html | 2 +- .../html/slsDetectorClientDocs/output.html | 2 +- .../html/slsDetectorClientDocs/pages.html | 2 +- .../html/slsDetectorClientDocs/receiver.html | 2 +- .../html/slsDetectorClientDocs/settings.html | 2 +- .../docs/html/slsDetectorClientDocs/test.html | 2 +- .../html/slsDetectorClientDocs/timing.html | 2 +- .../html/slsDetectorClientHowTo/index.html | 4 +-- .../html/slsDetectorClientHowTo/node1.html | 2 +- .../html/slsDetectorClientHowTo/node2.html | 2 +- .../html/slsDetectorClientHowTo/node3.html | 2 +- .../html/slsDetectorClientHowTo/node4.html | 25 +++++++++++------- .../html/slsDetectorClientHowTo/node5.html | 2 +- .../html/slsDetectorClientHowTo/node6.html | 4 +-- .../slsDetectorClientHowTo.html | 4 +-- .../docs/html/slsDetectorGuiHowTo/index.html | 4 +-- .../docs/html/slsDetectorGuiHowTo/node1.html | 2 +- .../docs/html/slsDetectorGuiHowTo/node10.html | 2 +- .../docs/html/slsDetectorGuiHowTo/node11.html | 2 +- .../docs/html/slsDetectorGuiHowTo/node12.html | 2 +- .../docs/html/slsDetectorGuiHowTo/node13.html | 2 +- .../docs/html/slsDetectorGuiHowTo/node14.html | 2 +- .../docs/html/slsDetectorGuiHowTo/node15.html | 2 +- .../docs/html/slsDetectorGuiHowTo/node16.html | 2 +- .../docs/html/slsDetectorGuiHowTo/node17.html | 4 +-- .../docs/html/slsDetectorGuiHowTo/node2.html | 2 +- .../docs/html/slsDetectorGuiHowTo/node3.html | 2 +- .../docs/html/slsDetectorGuiHowTo/node4.html | 2 +- .../docs/html/slsDetectorGuiHowTo/node5.html | 2 +- .../docs/html/slsDetectorGuiHowTo/node6.html | 2 +- .../docs/html/slsDetectorGuiHowTo/node7.html | 2 +- .../docs/html/slsDetectorGuiHowTo/node8.html | 2 +- .../docs/html/slsDetectorGuiHowTo/node9.html | 2 +- .../slsDetectorGuiHowTo.html | 4 +-- .../html/slsDetectorUsersDocs/annotated.html | 2 +- .../classdetectorData-members.html | 2 +- .../classdetectorData.html | 2 +- .../html/slsDetectorUsersDocs/classes.html | 2 +- .../classslsDetectorUsers-members.html | 2 +- .../classslsDetectorUsers.html | 2 +- .../classslsReceiverUsers-members.html | 2 +- .../classslsReceiverUsers.html | 2 +- .../slsDetectorUsersDocs/detectorData_8h.html | 2 +- .../detectorData_8h_source.html | 2 +- .../docs/html/slsDetectorUsersDocs/files.html | 2 +- .../html/slsDetectorUsersDocs/functions.html | 2 +- .../slsDetectorUsersDocs/functions_func.html | 2 +- .../slsDetectorUsersDocs/functions_vars.html | 2 +- .../html/slsDetectorUsersDocs/globals.html | 2 +- .../slsDetectorUsersDocs/globals_defs.html | 2 +- .../slsDetectorUsersDocs/globals_func.html | 2 +- .../slsDetectorUsersDocs/globals_vars.html | 2 +- .../docs/html/slsDetectorUsersDocs/index.html | 2 +- .../slsDetectorUsersDocs/mainClient_8cpp.html | 2 +- .../mainClient_8cpp_source.html | 6 ++--- .../mainReceiver_8cpp.html | 6 ++--- .../mainReceiver_8cpp_source.html | 4 +-- .../slsDetectorUsers_8h.html | 2 +- .../slsDetectorUsers_8h_source.html | 2 +- .../slsReceiverUsers_8h.html | 2 +- .../slsReceiverUsers_8h_source.html | 2 +- manual/docs/html/slsDetectors-FAQ/img36.png | Bin 11921 -> 11918 bytes manual/docs/html/slsDetectors-FAQ/index.html | 4 +-- manual/docs/html/slsDetectors-FAQ/node1.html | 2 +- manual/docs/html/slsDetectors-FAQ/node10.html | 2 +- manual/docs/html/slsDetectors-FAQ/node11.html | 2 +- manual/docs/html/slsDetectors-FAQ/node12.html | 2 +- manual/docs/html/slsDetectors-FAQ/node13.html | 2 +- manual/docs/html/slsDetectors-FAQ/node14.html | 2 +- manual/docs/html/slsDetectors-FAQ/node15.html | 2 +- manual/docs/html/slsDetectors-FAQ/node16.html | 2 +- manual/docs/html/slsDetectors-FAQ/node17.html | 2 +- manual/docs/html/slsDetectors-FAQ/node18.html | 2 +- manual/docs/html/slsDetectors-FAQ/node19.html | 2 +- manual/docs/html/slsDetectors-FAQ/node2.html | 2 +- manual/docs/html/slsDetectors-FAQ/node20.html | 2 +- manual/docs/html/slsDetectors-FAQ/node21.html | 2 +- manual/docs/html/slsDetectors-FAQ/node22.html | 2 +- manual/docs/html/slsDetectors-FAQ/node3.html | 2 +- manual/docs/html/slsDetectors-FAQ/node4.html | 2 +- manual/docs/html/slsDetectors-FAQ/node5.html | 2 +- manual/docs/html/slsDetectors-FAQ/node6.html | 2 +- manual/docs/html/slsDetectors-FAQ/node7.html | 2 +- manual/docs/html/slsDetectors-FAQ/node8.html | 2 +- manual/docs/html/slsDetectors-FAQ/node9.html | 2 +- .../slsDetectors-FAQ/slsDetectors-FAQ.html | 4 +-- manual/docs/pdf/angularCalibrationHowTo.pdf | Bin 460723 -> 460798 bytes manual/docs/pdf/energyCalibrationHowTo.pdf | Bin 417103 -> 417180 bytes manual/docs/pdf/slsDetectorClientDocs.pdf | Bin 126313 -> 126297 bytes manual/docs/pdf/slsDetectorClientHowTo.pdf | Bin 119890 -> 121176 bytes manual/docs/pdf/slsDetectorGuiHowTo.pdf | Bin 99849 -> 99931 bytes manual/docs/pdf/slsDetectorInstall.pdf | Bin 69960 -> 69890 bytes manual/docs/pdf/slsDetectorUsersDocs.pdf | Bin 279882 -> 279788 bytes manual/docs/pdf/slsDetectors-FAQ.pdf | Bin 860513 -> 860443 bytes manual/manual-api/Makefile | 7 ++--- manual/manual-api/detReceiver | Bin 15399 -> 670895 bytes manual/manual-api/detUser | Bin 13454 -> 670348 bytes manual/manual-api/libzmq.a | 1 + manual/manual-api/mainClient.cpp | 4 +-- manual/manual-api/mainReceiver.cpp | 2 +- manual/manual-api/zmq.h | 1 + 123 files changed, 166 insertions(+), 146 deletions(-) create mode 120000 manual/manual-api/libzmq.a create mode 120000 manual/manual-api/zmq.h diff --git a/RELEASE.txt b/RELEASE.txt index b4ad9c8f5..6699d402c 100644 --- a/RELEASE.txt +++ b/RELEASE.txt @@ -7,10 +7,20 @@ INTRODUCTION This document describes the differences between previous versions and 3.0.0 releases. -Manuals can be found under the 'manual/docs' folder. Both HTML and pdf versions are provided. +Manual (both HTML and pdf versions) are provided in + manual/docs/ -Documentation from Source Code can be found for the Command Line and for the API for -both HTML and pdf versions as slsDetectorClientDocs and slsDetectorUsersDocs respectively. +Documentation from Source Code can be found for the Command Line and for the API in + html: + manual/docs/html/slsDetectorClientDocs/index.html + manual/docs/html/slsDetectorUsersDocs/index.html + pdf: + manual/docs/pdf/slsDetectorClientDocs.pdf + manual/docs/pdf/slsDetectorUsersDocs.pdf + +Example including binaries for detector and receiver user classes can be found in + + manual/manual-api User documentation can also be accessed directly at this location: @@ -87,7 +97,7 @@ Reiterating, both 2.3 and 3.0 supports the following features: 4. Multiple Receivers have to be started as different processes, instead of threads due to static variables being used. Please refer example code provided in the - slsDetectorsPackage/users folder (mainReceiver.cpp). + slsDetectorsPackage/manual/manual-api folder (mainReceiver.cpp). @@ -147,9 +157,9 @@ New Features receiver streamer threads) via the command line - Users + Users-API ----- - 11. Users example forks new child processes for every extra receiver object. + 11. manual-api example forks new child processes for every extra receiver object. diff --git a/manual/docs/html/angularCalibrationHowTo/angularCalibrationHowTo.html b/manual/docs/html/angularCalibrationHowTo/angularCalibrationHowTo.html index 11a4a9e49..856ee5cd2 100644 --- a/manual/docs/html/angularCalibrationHowTo/angularCalibrationHowTo.html +++ b/manual/docs/html/angularCalibrationHowTo/angularCalibrationHowTo.html @@ -44,7 +44,7 @@ original version by: Nikos Drakos, CBLU, University of Leeds

Anna Bergamaschi

-

August 22, 2017

+

August 24, 2017

@@ -78,7 +78,7 @@ original version by: Nikos Drakos, CBLU, University of Leeds


Thattil Dhanya -2017-08-22 +2017-08-24
diff --git a/manual/docs/html/angularCalibrationHowTo/index.html b/manual/docs/html/angularCalibrationHowTo/index.html index 11a4a9e49..856ee5cd2 100644 --- a/manual/docs/html/angularCalibrationHowTo/index.html +++ b/manual/docs/html/angularCalibrationHowTo/index.html @@ -44,7 +44,7 @@ original version by: Nikos Drakos, CBLU, University of Leeds

Anna Bergamaschi

-

August 22, 2017

+

August 24, 2017

@@ -78,7 +78,7 @@ original version by: Nikos Drakos, CBLU, University of Leeds


Thattil Dhanya -2017-08-22 +2017-08-24
diff --git a/manual/docs/html/angularCalibrationHowTo/node1.html b/manual/docs/html/angularCalibrationHowTo/node1.html index 28865e6f3..a9c547610 100644 --- a/manual/docs/html/angularCalibrationHowTo/node1.html +++ b/manual/docs/html/angularCalibrationHowTo/node1.html @@ -180,7 +180,7 @@ These results show that the angular calibration allows a resolution in determin
Thattil Dhanya -2017-08-22 +2017-08-24
diff --git a/manual/docs/html/angularCalibrationHowTo/node2.html b/manual/docs/html/angularCalibrationHowTo/node2.html index 7229c62c9..30cefefe4 100644 --- a/manual/docs/html/angularCalibrationHowTo/node2.html +++ b/manual/docs/html/angularCalibrationHowTo/node2.html @@ -211,7 +211,7 @@ Acquisition GUI window to setup the motor position scan.
Thattil Dhanya -2017-08-22 +2017-08-24
diff --git a/manual/docs/html/angularCalibrationHowTo/node3.html b/manual/docs/html/angularCalibrationHowTo/node3.html index ac58a2b9f..7b37ceda1 100644 --- a/manual/docs/html/angularCalibrationHowTo/node3.html +++ b/manual/docs/html/angularCalibrationHowTo/node3.html @@ -180,7 +180,7 @@ After fitting all modules you can click on the Write Angular Calibration
Thattil Dhanya -2017-08-22 +2017-08-24
diff --git a/manual/docs/html/angularCalibrationHowTo/node4.html b/manual/docs/html/angularCalibrationHowTo/node4.html index 374edc53d..b6874747b 100644 --- a/manual/docs/html/angularCalibrationHowTo/node4.html +++ b/manual/docs/html/angularCalibrationHowTo/node4.html @@ -62,7 +62,7 @@ while for the GUI the file name should be specified in the configuration file (w

Thattil Dhanya -2017-08-22 +2017-08-24
diff --git a/manual/docs/html/angularCalibrationHowTo/node5.html b/manual/docs/html/angularCalibrationHowTo/node5.html index cb21fd97c..0b42645db 100644 --- a/manual/docs/html/angularCalibrationHowTo/node5.html +++ b/manual/docs/html/angularCalibrationHowTo/node5.html @@ -61,11 +61,11 @@ Mathematics Department, Macquarie University, Sydney. The command line arguments were:
latex2html -split 4 angularCalibrationHowTo.tex

-The translation was initiated by Thattil Dhanya on 2017-08-22 +The translation was initiated by Thattil Dhanya on 2017-08-24


Thattil Dhanya -2017-08-22 +2017-08-24
diff --git a/manual/docs/html/energyCalibrationHowTo/energyCalibrationHowTo.html b/manual/docs/html/energyCalibrationHowTo/energyCalibrationHowTo.html index 9b4b60f36..357ae05dd 100644 --- a/manual/docs/html/energyCalibrationHowTo/energyCalibrationHowTo.html +++ b/manual/docs/html/energyCalibrationHowTo/energyCalibrationHowTo.html @@ -44,7 +44,7 @@ original version by: Nikos Drakos, CBLU, University of Leeds

Anna Bergamaschi

-

August 22, 2017

+

August 24, 2017

@@ -78,7 +78,7 @@ original version by: Nikos Drakos, CBLU, University of Leeds


Thattil Dhanya -2017-08-22 +2017-08-24
diff --git a/manual/docs/html/energyCalibrationHowTo/index.html b/manual/docs/html/energyCalibrationHowTo/index.html index 9b4b60f36..357ae05dd 100644 --- a/manual/docs/html/energyCalibrationHowTo/index.html +++ b/manual/docs/html/energyCalibrationHowTo/index.html @@ -44,7 +44,7 @@ original version by: Nikos Drakos, CBLU, University of Leeds

Anna Bergamaschi

-

August 22, 2017

+

August 24, 2017

@@ -78,7 +78,7 @@ original version by: Nikos Drakos, CBLU, University of Leeds


Thattil Dhanya -2017-08-22 +2017-08-24
diff --git a/manual/docs/html/energyCalibrationHowTo/node1.html b/manual/docs/html/energyCalibrationHowTo/node1.html index 8a6aee3f5..42bca70c0 100644 --- a/manual/docs/html/energyCalibrationHowTo/node1.html +++ b/manual/docs/html/energyCalibrationHowTo/node1.html @@ -377,7 +377,7 @@ Median of the number of counts as a function of the threshold for X-rays of 12.5
Thattil Dhanya -2017-08-22 +2017-08-24
diff --git a/manual/docs/html/energyCalibrationHowTo/node2.html b/manual/docs/html/energyCalibrationHowTo/node2.html index 3778306a6..7419c9c10 100644 --- a/manual/docs/html/energyCalibrationHowTo/node2.html +++ b/manual/docs/html/energyCalibrationHowTo/node2.html @@ -180,7 +180,7 @@ Acquisition GUI window to setup the threshold scan.
Thattil Dhanya -2017-08-22 +2017-08-24
diff --git a/manual/docs/html/energyCalibrationHowTo/node3.html b/manual/docs/html/energyCalibrationHowTo/node3.html index e30f6f012..edd51edd3 100644 --- a/manual/docs/html/energyCalibrationHowTo/node3.html +++ b/manual/docs/html/energyCalibrationHowTo/node3.html @@ -184,7 +184,7 @@ Window to calibrate the modules.
Thattil Dhanya -2017-08-22 +2017-08-24
diff --git a/manual/docs/html/energyCalibrationHowTo/node4.html b/manual/docs/html/energyCalibrationHowTo/node4.html index a32dee7f1..ade53625f 100644 --- a/manual/docs/html/energyCalibrationHowTo/node4.html +++ b/manual/docs/html/energyCalibrationHowTo/node4.html @@ -68,7 +68,7 @@ By reloading the default detector settings, the calibration coefficients will be

Thattil Dhanya -2017-08-22 +2017-08-24
diff --git a/manual/docs/html/energyCalibrationHowTo/node5.html b/manual/docs/html/energyCalibrationHowTo/node5.html index 3c4dea960..3e02de691 100644 --- a/manual/docs/html/energyCalibrationHowTo/node5.html +++ b/manual/docs/html/energyCalibrationHowTo/node5.html @@ -61,11 +61,11 @@ Mathematics Department, Macquarie University, Sydney. The command line arguments were:
latex2html -split 4 energyCalibrationHowTo.tex

-The translation was initiated by Thattil Dhanya on 2017-08-22 +The translation was initiated by Thattil Dhanya on 2017-08-24


Thattil Dhanya -2017-08-22 +2017-08-24
diff --git a/manual/docs/html/slsDetectorClientDocs/acquisition.html b/manual/docs/html/slsDetectorClientDocs/acquisition.html index e4c3cba57..29999682d 100644 --- a/manual/docs/html/slsDetectorClientDocs/acquisition.html +++ b/manual/docs/html/slsDetectorClientDocs/acquisition.html @@ -78,7 +78,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); -
Generated on 22 Aug 2017 by  +
Generated on 24 Aug 2017 by  doxygen 1.6.1
diff --git a/manual/docs/html/slsDetectorClientDocs/actions.html b/manual/docs/html/slsDetectorClientDocs/actions.html index 0eeedac31..8d962b6c3 100644 --- a/manual/docs/html/slsDetectorClientDocs/actions.html +++ b/manual/docs/html/slsDetectorClientDocs/actions.html @@ -129,7 +129,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); -
Generated on 22 Aug 2017 by  +
Generated on 24 Aug 2017 by  doxygen 1.6.1
diff --git a/manual/docs/html/slsDetectorClientDocs/advanced.html b/manual/docs/html/slsDetectorClientDocs/advanced.html index 25e623fd3..853719233 100644 --- a/manual/docs/html/slsDetectorClientDocs/advanced.html +++ b/manual/docs/html/slsDetectorClientDocs/advanced.html @@ -54,7 +54,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); -
Generated on 22 Aug 2017 by  +
Generated on 24 Aug 2017 by  doxygen 1.6.1
diff --git a/manual/docs/html/slsDetectorClientDocs/config.html b/manual/docs/html/slsDetectorClientDocs/config.html index f298c34dd..b815af21c 100644 --- a/manual/docs/html/slsDetectorClientDocs/config.html +++ b/manual/docs/html/slsDetectorClientDocs/config.html @@ -53,7 +53,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); Data Structure

commands to configure detector data structure

    -
  • datastream enables/disables the 0MQ data stream (0MQ threads created) from receiver to client. Returns (int)
  • +
  • externalgui sets/gets external gui flag. 1 sets and enables the 0MQ data stream (0MQ threads created) from receiver to client, while 0 unsets and disables. Returns (int)