Automated documentation update

ChimeraTK · Oct 17, 2024 · 7afa461 · 7afa461
1 parent 2aaea34
commit 7afa461
Show file tree

Hide file tree

Showing 599 changed files with 1,369 additions and 1,305 deletions.
diff --git a/AmtfDbAccess/head/graph_legend.html b/AmtfDbAccess/head/graph_legend.html
@@ -129,7 +129,7 @@
 </div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
-Generated on Tue Oct 15 2024 17:56:33 for AmtfDbAccess library by &#160;<a href="http://www.doxygen.org/index.html">
+Generated on Wed Oct 16 2024 17:58:10 for AmtfDbAccess library by &#160;<a href="http://www.doxygen.org/index.html">
 <img class="footer" src="doxygen.png" alt="doxygen"/>
 </a> 1.8.17
 </small></address>

diff --git a/AmtfDbAccess/head/index.html b/AmtfDbAccess/head/index.html
@@ -69,7 +69,7 @@
 </div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
-Generated on Tue Oct 15 2024 17:56:33 for AmtfDbAccess library by &#160;<a href="http://www.doxygen.org/index.html">
+Generated on Wed Oct 16 2024 17:58:10 for AmtfDbAccess library by &#160;<a href="http://www.doxygen.org/index.html">
 <img class="footer" src="doxygen.png" alt="doxygen"/>
 </a> 1.8.17
 </small></address>

diff --git a/ChimeraTK-ApplicationCore/head/.git-describe b/ChimeraTK-ApplicationCore/head/.git-describe
@@ -1 +1 @@
-03.09.00-25-g6115fba
+04.00.00
diff --git a/ChimeraTK-ApplicationCore/head/html/_application_8cc_source.html b/ChimeraTK-ApplicationCore/head/html/_application_8cc_source.html
@@ -392,7 +392,7 @@
 <div class="ttc" id="aclass_chimera_t_k_1_1_application_html_a697d4a47ece6750203eecbff97039773"><div class="ttname"><a href="class_chimera_t_k_1_1_application.html#a697d4a47ece6750203eecbff97039773">ChimeraTK::Application::initialise</a></div><div class="ttdeci">void initialise() override</div><div class="ttdef"><b>Definition:</b> <a href="_application_8cc_source.html#l00106">Application.cc:106</a></div></div>
 <div class="ttc" id="aclass_chimera_t_k_1_1_x_m_l_generator_html"><div class="ttname"><a href="class_chimera_t_k_1_1_x_m_l_generator.html">ChimeraTK::XMLGenerator</a></div><div class="ttdoc">Generate XML representation of variables.</div><div class="ttdef"><b>Definition:</b> <a href="_x_m_l_generator_visitor_8h_source.html#l00023">XMLGeneratorVisitor.h:23</a></div></div>
 <div class="ttc" id="aclass_chimera_t_k_1_1_application_html_a6815195c956c091a6558a316f8fd9976"><div class="ttname"><a href="class_chimera_t_k_1_1_application.html#a6815195c956c091a6558a316f8fd9976">ChimeraTK::Application::run</a></div><div class="ttdeci">void run() override</div><div class="ttdoc">Execute the module.</div><div class="ttdef"><b>Definition:</b> <a href="_application_8cc_source.html#l00134">Application.cc:134</a></div></div>
-<div class="ttc" id="anamespace_chimera_t_k_1_1_utilities_html_a4af6a2239a8b0ee9eafa26faf00a2e9a"><div class="ttname"><a href="namespace_chimera_t_k_1_1_utilities.html#a4af6a2239a8b0ee9eafa26faf00a2e9a">ChimeraTK::Utilities::checkName</a></div><div class="ttdeci">bool checkName(const std::string &amp;name, bool allowDotsAndSlashes)</div><div class="ttdoc">Check given name for characters which are not allowed in variable or module names.</div><div class="ttdef"><b>Definition:</b> <a href="_utilities_8cc_source.html#l00086">Utilities.cc:86</a></div></div>
+<div class="ttc" id="anamespace_chimera_t_k_1_1_utilities_html_a4af6a2239a8b0ee9eafa26faf00a2e9a"><div class="ttname"><a href="namespace_chimera_t_k_1_1_utilities.html#a4af6a2239a8b0ee9eafa26faf00a2e9a">ChimeraTK::Utilities::checkName</a></div><div class="ttdeci">bool checkName(const std::string &amp;name, bool allowDotsAndSlashes)</div><div class="ttdoc">Check given name for characters which are not allowed in variable or module names.</div><div class="ttdef"><b>Definition:</b> <a href="_utilities_8cc_source.html#l00087">Utilities.cc:87</a></div></div>
 <div class="ttc" id="aclass_chimera_t_k_1_1_application_html_adae3e915ddddc8f428a724352a671792"><div class="ttname"><a href="class_chimera_t_k_1_1_application.html#adae3e915ddddc8f428a724352a671792">ChimeraTK::Application::_circularDependencyDetector</a></div><div class="ttdeci">detail::CircularDependencyDetector _circularDependencyDetector</div><div class="ttdef"><b>Definition:</b> <a href="_application_8h_source.html#l00240">Application.h:240</a></div></div>
 <div class="ttc" id="aclass_chimera_t_k_1_1_application_html_aa3c1c63e078d14fb104431a15951a070"><div class="ttname"><a href="class_chimera_t_k_1_1_application.html#aa3c1c63e078d14fb104431a15951a070">ChimeraTK::Application::getInstance</a></div><div class="ttdeci">static Application &amp; getInstance()</div><div class="ttdoc">Obtain instance of the application.</div><div class="ttdef"><b>Definition:</b> <a href="_application_8cc_source.html#l00261">Application.cc:261</a></div></div>
 <div class="ttc" id="anamespace_chimera_t_k_html_afd1ff17ff1ee9c50c855b99af5b0c580"><div class="ttname"><a href="namespace_chimera_t_k.html#afd1ff17ff1ee9c50c855b99af5b0c580">ChimeraTK::logger</a></div><div class="ttdeci">Logger::StreamProxy logger(Logger::Severity severity, std::string context)</div><div class="ttdoc">Convenience function to obtain the logger stream.</div><div class="ttdef"><b>Definition:</b> <a href="_logger_8h_source.html#l00124">Logger.h:124</a></div></div>

diff --git a/ChimeraTK-ApplicationCore/head/html/_device_manager_8cc_source.html b/ChimeraTK-ApplicationCore/head/html/_device_manager_8cc_source.html
@@ -499,7 +499,7 @@
 <div class="ttc" id="aclass_chimera_t_k_1_1_device_manager_html_a0f0dff488e465fd497706830dda52280"><div class="ttname"><a href="class_chimera_t_k_1_1_device_manager.html#a0f0dff488e465fd497706830dda52280">ChimeraTK::DeviceManager::decrementDataFaultCounter</a></div><div class="ttdeci">void decrementDataFaultCounter() override</div><div class="ttdoc">Decrement the fault counter and set the data validity flag to ok if the counter has reached 0.</div><div class="ttdef"><b>Definition:</b> <a href="_device_manager_8cc_source.html#l00354">DeviceManager.cc:354</a></div></div>
 <div class="ttc" id="aclass_chimera_t_k_1_1_application_module_html"><div class="ttname"><a href="class_chimera_t_k_1_1_application_module.html">ChimeraTK::ApplicationModule</a></div><div class="ttdef"><b>Definition:</b> <a href="_application_module_8h_source.html#l00024">ApplicationModule.h:24</a></div></div>
 <div class="ttc" id="aclass_chimera_t_k_1_1_device_manager_html_a37b6f37dd97f310089c6d0c6da37e12e"><div class="ttname"><a href="class_chimera_t_k_1_1_device_manager.html#a37b6f37dd97f310089c6d0c6da37e12e">ChimeraTK::DeviceManager::getNodesList</a></div><div class="ttdeci">std::vector&lt; VariableNetworkNode &gt; getNodesList() const</div><div class="ttdoc">Create and return list of VariableNetworkNodes for all device registers.</div><div class="ttdef"><b>Definition:</b> <a href="_device_manager_8cc_source.html#l00018">DeviceManager.cc:18</a></div></div>
-<div class="ttc" id="anamespace_chimera_t_k_1_1_utilities_html_a4df2e58a7e941872744fa8435e544954"><div class="ttname"><a href="namespace_chimera_t_k_1_1_utilities.html#a4df2e58a7e941872744fa8435e544954">ChimeraTK::Utilities::escapeName</a></div><div class="ttdeci">std::string escapeName(const std::string &amp;name, bool allowDotsAndSlashes)</div><div class="ttdoc">Convert all characters which are not allowed in variable or module names into underscores followed by...</div><div class="ttdef"><b>Definition:</b> <a href="_utilities_8cc_source.html#l00043">Utilities.cc:43</a></div></div>
+<div class="ttc" id="anamespace_chimera_t_k_1_1_utilities_html_a4df2e58a7e941872744fa8435e544954"><div class="ttname"><a href="namespace_chimera_t_k_1_1_utilities.html#a4df2e58a7e941872744fa8435e544954">ChimeraTK::Utilities::escapeName</a></div><div class="ttdeci">std::string escapeName(const std::string &amp;name, bool allowDotsAndSlashes)</div><div class="ttdoc">Convert all characters which are not allowed in variable or module names into underscores followed by...</div><div class="ttdef"><b>Definition:</b> <a href="_utilities_8cc_source.html#l00044">Utilities.cc:44</a></div></div>
 <div class="ttc" id="astruct_chimera_t_k_1_1_status_with_message_html_ac2fc29383de2ccd91d29d10c8dc15825"><div class="ttname"><a href="struct_chimera_t_k_1_1_status_with_message.html#ac2fc29383de2ccd91d29d10c8dc15825">ChimeraTK::StatusWithMessage::write</a></div><div class="ttdeci">void write(StatusOutput::Status status, std::string message)</div><div class="ttdoc">Set the status and the message and write the outputs.</div><div class="ttdef"><b>Definition:</b> <a href="_status_with_message_8cc_source.html#l00019">StatusWithMessage.cc:19</a></div></div>
 <div class="ttc" id="astruct_chimera_t_k_1_1_variable_direction_html_a0640f33372cd401d80c0a95c2d5dec35add0fabb0f15a1db73adfe3f6d107b71e"><div class="ttname"><a href="struct_chimera_t_k_1_1_variable_direction.html#a0640f33372cd401d80c0a95c2d5dec35add0fabb0f15a1db73adfe3f6d107b71e">ChimeraTK::VariableDirection::feeding</a></div><div class="ttdeci">@ feeding</div><div class="ttdef"><b>Definition:</b> <a href="_flags_8h_source.html#l00018">Flags.h:18</a></div></div>
 <div class="ttc" id="aclass_chimera_t_k_1_1_device_manager_html_a1c744dbf1b4d19d54301dc03bed17e10"><div class="ttname"><a href="class_chimera_t_k_1_1_device_manager.html#a1c744dbf1b4d19d54301dc03bed17e10">ChimeraTK::DeviceManager::_owner</a></div><div class="ttdeci">Application * _owner</div><div class="ttdef"><b>Definition:</b> <a href="_device_manager_8h_source.html#l00143">DeviceManager.h:143</a></div></div>

diff --git a/ChimeraTK-ApplicationCore/head/html/_device_module_8cc_source.html b/ChimeraTK-ApplicationCore/head/html/_device_module_8cc_source.html
@@ -270,13 +270,13 @@
 <div class="ttc" id="aclass_chimera_t_k_1_1_device_module_html_a4a9e010d61ef112b7d688e72cbfc20a3"><div class="ttname"><a href="class_chimera_t_k_1_1_device_module.html#a4a9e010d61ef112b7d688e72cbfc20a3">ChimeraTK::DeviceModule::addInitialisationHandler</a></div><div class="ttdeci">void addInitialisationHandler(std::function&lt; void(ChimeraTK::Device &amp;)&gt; initialisationHandler)</div><div class="ttdef"><b>Definition:</b> <a href="_device_module_8cc_source.html#l00160">DeviceModule.cc:160</a></div></div>
 <div class="ttc" id="aclass_chimera_t_k_1_1_model_1_1_directory_proxy_html"><div class="ttname"><a href="class_chimera_t_k_1_1_model_1_1_directory_proxy.html">ChimeraTK::Model::DirectoryProxy</a></div><div class="ttdef"><b>Definition:</b> <a href="_model_8h_source.html#l00424">Model.h:424</a></div></div>
 <div class="ttc" id="aclass_chimera_t_k_1_1_variable_network_node_html_a443218227432b46cd4a023b53dff8f67"><div class="ttname"><a href="class_chimera_t_k_1_1_variable_network_node.html#a443218227432b46cd4a023b53dff8f67">ChimeraTK::VariableNetworkNode::isValid</a></div><div class="ttdeci">bool isValid() const</div><div class="ttdef"><b>Definition:</b> <a href="_variable_network_node_8h_source.html#l00122">VariableNetworkNode.h:122</a></div></div>
-<div class="ttc" id="anamespace_chimera_t_k_1_1_utilities_html_a995362cedaec84fbf8ee820a3de8a511"><div class="ttname"><a href="namespace_chimera_t_k_1_1_utilities.html#a995362cedaec84fbf8ee820a3de8a511">ChimeraTK::Utilities::getUnqualifiedName</a></div><div class="ttdeci">std::string getUnqualifiedName(const std::string &amp;qualifiedName)</div><div class="ttdoc">Return the last component of the given qualified path name.</div><div class="ttdef"><b>Definition:</b> <a href="_utilities_8cc_source.html#l00017">Utilities.cc:17</a></div></div>
+<div class="ttc" id="anamespace_chimera_t_k_1_1_utilities_html_a995362cedaec84fbf8ee820a3de8a511"><div class="ttname"><a href="namespace_chimera_t_k_1_1_utilities.html#a995362cedaec84fbf8ee820a3de8a511">ChimeraTK::Utilities::getUnqualifiedName</a></div><div class="ttdeci">std::string getUnqualifiedName(const std::string &amp;qualifiedName)</div><div class="ttdoc">Return the last component of the given qualified path name.</div><div class="ttdef"><b>Definition:</b> <a href="_utilities_8cc_source.html#l00018">Utilities.cc:18</a></div></div>
 <div class="ttc" id="aclass_chimera_t_k_1_1_device_module_html_a866cf974d4a178d389753536be5a88db"><div class="ttname"><a href="class_chimera_t_k_1_1_device_module.html#a866cf974d4a178d389753536be5a88db">ChimeraTK::DeviceModule::reportException</a></div><div class="ttdeci">void reportException(std::string errMsg)</div><div class="ttdoc">Use this function to report an exception.</div><div class="ttdef"><b>Definition:</b> <a href="_device_module_8cc_source.html#l00166">DeviceModule.cc:166</a></div></div>
 <div class="ttc" id="aclass_chimera_t_k_1_1_set_d_map_file_path_html_af26dc5d3424bb7cd09cca261b50a9c65"><div class="ttname"><a href="class_chimera_t_k_1_1_set_d_map_file_path.html#af26dc5d3424bb7cd09cca261b50a9c65">ChimeraTK::SetDMapFilePath::SetDMapFilePath</a></div><div class="ttdeci">SetDMapFilePath(const std::string &amp;dmapFilePath)</div><div class="ttdef"><b>Definition:</b> <a href="_device_module_8cc_source.html#l00172">DeviceModule.cc:172</a></div></div>
 <div class="ttc" id="aclass_chimera_t_k_1_1_module_group_html"><div class="ttname"><a href="class_chimera_t_k_1_1_module_group.html">ChimeraTK::ModuleGroup</a></div><div class="ttdef"><b>Definition:</b> <a href="_module_group_8h_source.html#l00016">ModuleGroup.h:16</a></div></div>
 <div class="ttc" id="aclass_chimera_t_k_1_1_model_1_1_device_module_proxy_html"><div class="ttname"><a href="class_chimera_t_k_1_1_model_1_1_device_module_proxy.html">ChimeraTK::Model::DeviceModuleProxy</a></div><div class="ttdef"><b>Definition:</b> <a href="_model_8h_source.html#l00354">Model.h:354</a></div></div>
 <div class="ttc" id="a_utilities_8h_html"><div class="ttname"><a href="_utilities_8h.html">Utilities.h</a></div></div>
-<div class="ttc" id="anamespace_chimera_t_k_1_1_utilities_html_a7794e94545a8b22daead4e95d1231247"><div class="ttname"><a href="namespace_chimera_t_k_1_1_utilities.html#a7794e94545a8b22daead4e95d1231247">ChimeraTK::Utilities::getPathName</a></div><div class="ttdeci">std::string getPathName(const std::string &amp;qualifiedName)</div><div class="ttdoc">Return all but the last components of the given qualified name.</div><div class="ttdef"><b>Definition:</b> <a href="_utilities_8cc_source.html#l00027">Utilities.cc:27</a></div></div>
+<div class="ttc" id="anamespace_chimera_t_k_1_1_utilities_html_a7794e94545a8b22daead4e95d1231247"><div class="ttname"><a href="namespace_chimera_t_k_1_1_utilities.html#a7794e94545a8b22daead4e95d1231247">ChimeraTK::Utilities::getPathName</a></div><div class="ttdeci">std::string getPathName(const std::string &amp;qualifiedName)</div><div class="ttdoc">Return all but the last components of the given qualified name.</div><div class="ttdef"><b>Definition:</b> <a href="_utilities_8cc_source.html#l00028">Utilities.cc:28</a></div></div>
 <div class="ttc" id="aclass_chimera_t_k_1_1_device_module_html"><div class="ttname"><a href="class_chimera_t_k_1_1_device_module.html">ChimeraTK::DeviceModule</a></div><div class="ttdef"><b>Definition:</b> <a href="_device_module_8h_source.html#l00020">DeviceModule.h:20</a></div></div>
 <div class="ttc" id="a_module_group_8h_html"><div class="ttname"><a href="_module_group_8h.html">ModuleGroup.h</a></div></div>
 <div class="ttc" id="anamespace_chimera_t_k_1_1_model_html_af38a5cbeee2077f99ee3f4b683ecc367"><div class="ttname"><a href="namespace_chimera_t_k_1_1_model.html#af38a5cbeee2077f99ee3f4b683ecc367">ChimeraTK::Model::isVariable</a></div><div class="ttdeci">constexpr bool isVariable(const PROPERTY_OR_PROXY &amp;)</div><div class="ttdef"><b>Definition:</b> <a href="_model_8h_source.html#l00659">Model.h:659</a></div></div>

diff --git a/ChimeraTK-ApplicationCore/head/html/_entity_owner_8h_source.html b/ChimeraTK-ApplicationCore/head/html/_entity_owner_8h_source.html
@@ -242,7 +242,7 @@
 <div class="ttc" id="aclass_chimera_t_k_1_1_entity_owner_html_aa856db8bf289b50c32116089e3d95e8f"><div class="ttname"><a href="class_chimera_t_k_1_1_entity_owner.html#aa856db8bf289b50c32116089e3d95e8f">ChimeraTK::EntityOwner::ModuleType</a></div><div class="ttdeci">ModuleType</div><div class="ttdef"><b>Definition:</b> <a href="_entity_owner_8h_source.html#l00114">EntityOwner.h:114</a></div></div>
 <div class="ttc" id="aclass_chimera_t_k_1_1_entity_owner_html_a260d2a06bf851b4b685ae498cf5a2237"><div class="ttname"><a href="class_chimera_t_k_1_1_entity_owner.html#a260d2a06bf851b4b685ae498cf5a2237">ChimeraTK::EntityOwner::registerAccessor</a></div><div class="ttdeci">void registerAccessor(VariableNetworkNode accessor)</div><div class="ttdoc">Called inside the constructor of Accessor: adds the accessor to the list.</div><div class="ttdef"><b>Definition:</b> <a href="_entity_owner_8cc_source.html#l00095">EntityOwner.cc:95</a></div></div>
 <div class="ttc" id="aclass_chimera_t_k_1_1_entity_owner_html_a83a34142cea47d7396de8a3657004ef7"><div class="ttname"><a href="class_chimera_t_k_1_1_entity_owner.html#a83a34142cea47d7396de8a3657004ef7">ChimeraTK::EntityOwner::getCurrentVersionNumber</a></div><div class="ttdeci">virtual VersionNumber getCurrentVersionNumber() const =0</div><div class="ttdoc">Return the current version number which has been received with the last push-type read operation.</div></div>
-<div class="ttc" id="anamespace_chimera_t_k_1_1_utilities_html_a4df2e58a7e941872744fa8435e544954"><div class="ttname"><a href="namespace_chimera_t_k_1_1_utilities.html#a4df2e58a7e941872744fa8435e544954">ChimeraTK::Utilities::escapeName</a></div><div class="ttdeci">std::string escapeName(const std::string &amp;name, bool allowDotsAndSlashes)</div><div class="ttdoc">Convert all characters which are not allowed in variable or module names into underscores followed by...</div><div class="ttdef"><b>Definition:</b> <a href="_utilities_8cc_source.html#l00043">Utilities.cc:43</a></div></div>
+<div class="ttc" id="anamespace_chimera_t_k_1_1_utilities_html_a4df2e58a7e941872744fa8435e544954"><div class="ttname"><a href="namespace_chimera_t_k_1_1_utilities.html#a4df2e58a7e941872744fa8435e544954">ChimeraTK::Utilities::escapeName</a></div><div class="ttdeci">std::string escapeName(const std::string &amp;name, bool allowDotsAndSlashes)</div><div class="ttdoc">Convert all characters which are not allowed in variable or module names into underscores followed by...</div><div class="ttdef"><b>Definition:</b> <a href="_utilities_8cc_source.html#l00044">Utilities.cc:44</a></div></div>
 <div class="ttc" id="aclass_chimera_t_k_1_1_entity_owner_html_a2e6036e82c5f3b01bc062ceb431f94bb"><div class="ttname"><a href="class_chimera_t_k_1_1_entity_owner.html#a2e6036e82c5f3b01bc062ceb431f94bb">ChimeraTK::EntityOwner::decrementDataFaultCounter</a></div><div class="ttdeci">virtual void decrementDataFaultCounter()=0</div><div class="ttdoc">Decrement the fault counter and set the data validity flag to ok if the counter has reached 0.</div></div>
 <div class="ttc" id="aclass_chimera_t_k_1_1_entity_owner_html_aba60e1945471166d25fec22172788b08"><div class="ttname"><a href="class_chimera_t_k_1_1_entity_owner.html#aba60e1945471166d25fec22172788b08">ChimeraTK::EntityOwner::addTag</a></div><div class="ttdeci">void addTag(const std::string &amp;tag)</div><div class="ttdoc">Add a tag to all Application-type nodes inside this group.</div><div class="ttdef"><b>Definition:</b> <a href="_entity_owner_8cc_source.html#l00124">EntityOwner.cc:124</a></div></div>
 <div class="ttc" id="aclass_chimera_t_k_1_1_entity_owner_html_a9a32600fa633b1cd991ba8f2bd3ac6b3"><div class="ttname"><a href="class_chimera_t_k_1_1_entity_owner.html#a9a32600fa633b1cd991ba8f2bd3ac6b3">ChimeraTK::EntityOwner::getDataValidity</a></div><div class="ttdeci">virtual DataValidity getDataValidity() const =0</div><div class="ttdoc">Return the data validity flag.</div></div>