Far to large commit - but only documentation

* started a new chapter about advanced topics - currently only a stub * major update to the overview section in the UG * some updates tot he dataspace section in the UG Update #110
ess-dmsc · Nov 3, 2017 · fbd1bd3 · fbd1bd3
1 parent 38f21ea
commit fbd1bd3
Show file tree

Hide file tree

Showing 20 changed files with 2,766 additions and 1 deletion.
diff --git a/design/model.notation b/design/model.notation
diff --git a/design/model.uml b/design/model.uml
@@ -237,6 +237,10 @@ free-standing functions with the first argument being
 the parent or base object. 
 
 Such an approach needs to be discussed to. </body>
+      </ownedComment>
+      <ownedComment xmi:type="uml:Comment" xmi:id="_gISdgMB5EeeTRsWcQr6V8g" annotatedElement="_OxETAMB5EeeTRsWcQr6V8g">
+        <body>We would need something like 
+this for the container adapter.</body>
       </ownedComment>
       <packagedElement xmi:type="uml:Class" xmi:id="_VYW3UJObEeeoI7oI9Ds2zg" name="Node">
         <ownedAttribute xmi:type="uml:Property" xmi:id="_GVXlEa3NEeeC8tqFVijy6A" name="link" type="_jXRCUPhEEearHstUE6s_yg" aggregation="composite" association="_GVWW8K3NEeeC8tqFVijy6A">
@@ -461,6 +465,15 @@ Such an approach needs to be discussed to. </body>
         <ownedEnd xmi:type="uml:Property" xmi:id="_RB0iELpBEeeNd9VwTnWPtA" name="link" type="_jXRCUPhEEearHstUE6s_yg" association="_RBys4LpBEeeNd9VwTnWPtA"/>
         <ownedEnd xmi:type="uml:Property" xmi:id="_RBz7ArpBEeeNd9VwTnWPtA" name="path" type="_wv4CEJObEeeoI7oI9Ds2zg" aggregation="composite" association="_RBys4LpBEeeNd9VwTnWPtA"/>
       </packagedElement>
+      <packagedElement xmi:type="uml:Class" xmi:id="_H62CEMB5EeeTRsWcQr6V8g" name="ScalarDataset">
+        <generalization xmi:type="uml:Generalization" xmi:id="_ZLBwcMB5EeeTRsWcQr6V8g" general="_YThA4JObEeeoI7oI9Ds2zg"/>
+      </packagedElement>
+      <packagedElement xmi:type="uml:Class" xmi:id="_OxETAMB5EeeTRsWcQr6V8g" name="ExtensibleDataset">
+        <generalization xmi:type="uml:Generalization" xmi:id="_ayCKgMB5EeeTRsWcQr6V8g" general="_SYJHYMB5EeeTRsWcQr6V8g"/>
+      </packagedElement>
+      <packagedElement xmi:type="uml:Class" xmi:id="_SYJHYMB5EeeTRsWcQr6V8g" name="ChunkedDataset">
+        <generalization xmi:type="uml:Generalization" xmi:id="_aWp2EMB5EeeTRsWcQr6V8g" general="_YThA4JObEeeoI7oI9Ds2zg"/>
+      </packagedElement>
       <profileApplication xmi:type="uml:ProfileApplication" xmi:id="_04wLcP88EeaZaM7lOsGynA">
         <eAnnotations xmi:type="ecore:EAnnotation" xmi:id="_3XNNwJWQEee7vqXOLcolPQ" source="PapyrusVersion">
           <details xmi:type="ecore:EStringToStringMapEntry" xmi:id="_3XNNwZWQEee7vqXOLcolPQ" key="Version" value="0.0.11"/>
@@ -897,6 +910,52 @@ Such an approach needs to be discussed to. </body>
         <signature xmi:type="uml:RedefinableTemplateSignature" href="stdcpp.uml#_80gXYO-hEeaKneflegtjzg"/>
       </templateBinding>
     </packagedElement>
+    <packagedElement xmi:type="uml:Class" xmi:id="_hlkwUMB4EeeTRsWcQr6V8g" name="Storage"/>
+    <packagedElement xmi:type="uml:Class" xmi:id="_k5exEMB4EeeTRsWcQr6V8g" name="DiskStorage">
+      <generalization xmi:type="uml:Generalization" xmi:id="_ILe3YMB_EeeTRsWcQr6V8g" general="_hlkwUMB4EeeTRsWcQr6V8g"/>
+    </packagedElement>
+    <packagedElement xmi:type="uml:Class" xmi:id="_mPY0EMB4EeeTRsWcQr6V8g" name="MemoryStorage">
+      <generalization xmi:type="uml:Generalization" xmi:id="_IsTsgMB_EeeTRsWcQr6V8g" general="_hlkwUMB4EeeTRsWcQr6V8g"/>
+    </packagedElement>
+    <packagedElement xmi:type="uml:Class" xmi:id="_gEeCkMB7EeeTRsWcQr6V8g" name="VarLengthDataStorage">
+      <generalization xmi:type="uml:Generalization" xmi:id="_GuzeAMB_EeeTRsWcQr6V8g" general="_mPY0EMB4EeeTRsWcQr6V8g"/>
+    </packagedElement>
+    <packagedElement xmi:type="uml:Class" xmi:id="_kesLIMB7EeeTRsWcQr6V8g" name="VarLengthStringStorage">
+      <generalization xmi:type="uml:Generalization" xmi:id="_HIrWkMB_EeeTRsWcQr6V8g" general="_mPY0EMB4EeeTRsWcQr6V8g"/>
+    </packagedElement>
+    <packagedElement xmi:type="uml:Class" xmi:id="_mw3pIMB7EeeTRsWcQr6V8g" name="FixedLengthStringStorage">
+      <generalization xmi:type="uml:Generalization" xmi:id="_HvVt8MB_EeeTRsWcQr6V8g" general="_mPY0EMB4EeeTRsWcQr6V8g"/>
+    </packagedElement>
+    <packagedElement xmi:type="uml:Class" xmi:id="_EVtAAMB8EeeTRsWcQr6V8g" name="MemoryStorageFactory"/>
+    <packagedElement xmi:type="uml:Usage" xmi:id="_WE17QMB8EeeTRsWcQr6V8g" name="file_dataspace" client="_EVtAAMB8EeeTRsWcQr6V8g" supplier="_hzOugJOZEeeoI7oI9Ds2zg"/>
+    <packagedElement xmi:type="uml:Association" xmi:id="_I61l0MCBEeeTRsWcQr6V8g" name="memory_space" memberEnd="_I64pIMCBEeeTRsWcQr6V8g _I65QMMCBEeeTRsWcQr6V8g">
+      <eAnnotations xmi:type="ecore:EAnnotation" xmi:id="_I63bAMCBEeeTRsWcQr6V8g" source="org.eclipse.papyrus">
+        <details xmi:type="ecore:EStringToStringMapEntry" xmi:id="_I64CEMCBEeeTRsWcQr6V8g" key="nature" value="UML_Nature"/>
+      </eAnnotations>
+      <ownedEnd xmi:type="uml:Property" xmi:id="_I65QMMCBEeeTRsWcQr6V8g" name="memorystorage" type="_mPY0EMB4EeeTRsWcQr6V8g" association="_I61l0MCBEeeTRsWcQr6V8g"/>
+      <ownedEnd xmi:type="uml:Property" xmi:id="_I64pIMCBEeeTRsWcQr6V8g" name="dataspace" type="_hzOugJOZEeeoI7oI9Ds2zg" aggregation="composite" association="_I61l0MCBEeeTRsWcQr6V8g"/>
+    </packagedElement>
+    <packagedElement xmi:type="uml:Association" xmi:id="_OJxI0MCBEeeTRsWcQr6V8g" name="memory_type" memberEnd="_OJxv4sCBEeeTRsWcQr6V8g _OJyW8MCBEeeTRsWcQr6V8g">
+      <eAnnotations xmi:type="ecore:EAnnotation" xmi:id="_OJxv4MCBEeeTRsWcQr6V8g" source="org.eclipse.papyrus">
+        <details xmi:type="ecore:EStringToStringMapEntry" xmi:id="_OJxv4cCBEeeTRsWcQr6V8g" key="nature" value="UML_Nature"/>
+      </eAnnotations>
+      <ownedEnd xmi:type="uml:Property" xmi:id="_OJyW8MCBEeeTRsWcQr6V8g" name="memorystorage" type="_mPY0EMB4EeeTRsWcQr6V8g" association="_OJxI0MCBEeeTRsWcQr6V8g"/>
+      <ownedEnd xmi:type="uml:Property" xmi:id="_OJxv4sCBEeeTRsWcQr6V8g" name="datatype" type="_2RxIIJL9EeeoI7oI9Ds2zg" aggregation="composite" association="_OJxI0MCBEeeTRsWcQr6V8g"/>
+    </packagedElement>
+    <packagedElement xmi:type="uml:Association" xmi:id="_lCEWQMCBEeeTRsWcQr6V8g" name="file_space" memberEnd="_lCE9UsCBEeeTRsWcQr6V8g _lCFkYMCBEeeTRsWcQr6V8g">
+      <eAnnotations xmi:type="ecore:EAnnotation" xmi:id="_lCE9UMCBEeeTRsWcQr6V8g" source="org.eclipse.papyrus">
+        <details xmi:type="ecore:EStringToStringMapEntry" xmi:id="_lCE9UcCBEeeTRsWcQr6V8g" key="nature" value="UML_Nature"/>
+      </eAnnotations>
+      <ownedEnd xmi:type="uml:Property" xmi:id="_lCFkYMCBEeeTRsWcQr6V8g" name="diskstorage" type="_k5exEMB4EeeTRsWcQr6V8g" association="_lCEWQMCBEeeTRsWcQr6V8g"/>
+      <ownedEnd xmi:type="uml:Property" xmi:id="_lCE9UsCBEeeTRsWcQr6V8g" name="dataspace" type="_hzOugJOZEeeoI7oI9Ds2zg" aggregation="composite" association="_lCEWQMCBEeeTRsWcQr6V8g"/>
+    </packagedElement>
+    <packagedElement xmi:type="uml:Association" xmi:id="_pJznsMCBEeeTRsWcQr6V8g" name="file_type" memberEnd="_pJ010cCBEeeTRsWcQr6V8g _pJ010sCBEeeTRsWcQr6V8g">
+      <eAnnotations xmi:type="ecore:EAnnotation" xmi:id="_pJ0OwMCBEeeTRsWcQr6V8g" source="org.eclipse.papyrus">
+        <details xmi:type="ecore:EStringToStringMapEntry" xmi:id="_pJ010MCBEeeTRsWcQr6V8g" key="nature" value="UML_Nature"/>
+      </eAnnotations>
+      <ownedEnd xmi:type="uml:Property" xmi:id="_pJ010sCBEeeTRsWcQr6V8g" name="diskstorage" type="_k5exEMB4EeeTRsWcQr6V8g" association="_pJznsMCBEeeTRsWcQr6V8g"/>
+      <ownedEnd xmi:type="uml:Property" xmi:id="_pJ010cCBEeeTRsWcQr6V8g" name="datatype" type="_2RxIIJL9EeeoI7oI9Ds2zg" aggregation="composite" association="_pJznsMCBEeeTRsWcQr6V8g"/>
+    </packagedElement>
     <profileApplication xmi:type="uml:ProfileApplication" xmi:id="_NY5wMP8sEeaZaM7lOsGynA">
       <eAnnotations xmi:type="ecore:EAnnotation" xmi:id="_iBnpkJR6EeeoI7oI9Ds2zg" source="PapyrusVersion">
         <details xmi:type="ecore:EStringToStringMapEntry" xmi:id="_iBnpkZR6EeeoI7oI9Ds2zg" key="Version" value="0.0.11"/>

diff --git a/doc/source/CMakeLists.txt b/doc/source/CMakeLists.txt
@@ -10,3 +10,4 @@ add_subdirectory(images)
 add_subdirectory(users_guide)
 add_subdirectory(design)
 add_subdirectory(api_reference)
+add_subdirectory(advanced)
diff --git a/doc/source/advanced/CMakeLists.txt b/doc/source/advanced/CMakeLists.txt
@@ -0,0 +1,8 @@
+set(SOURCES index.rst
+            io.rst
+            cpp_datastructures.rst
+            hdf5_handlers.rst
+        )
+
+add_sphinx_source(${SOURCES})
+copy_to_current_build(${SOURCES})
diff --git a/doc/source/advanced/cpp_datastructures.rst b/doc/source/advanced/cpp_datastructures.rst
@@ -0,0 +1,8 @@
+============================
+C++ data structures and HDF5
+============================
+
+.. todo::
+
+    Add here some content about C++ data structures and about the principal
+    difficulties with them when working with HDF5.
diff --git a/doc/source/advanced/hdf5_handlers.rst b/doc/source/advanced/hdf5_handlers.rst
@@ -0,0 +1,10 @@
+
+========================
+HDF5 handlers in *h5cpp*
+========================
+
+
+.. todo:: 
+
+    Add here some content basically about :cpp:class:`hdf5::ObjectHandle` and 
+    how it is releated with :cpp:type:`hid_t`. 
diff --git a/doc/source/advanced/index.rst b/doc/source/advanced/index.rst
@@ -0,0 +1,10 @@
+===============
+Advanced topics
+===============
+
+
+.. toctree:: 
+   :maxdepth: 1
+
+   io
+   hdf5_handlers
diff --git a/doc/source/advanced/io.rst b/doc/source/advanced/io.rst
@@ -0,0 +1,15 @@
+===========
+Advanced IO
+===========
+
+This section deals with advanced IO topics. IO is a complex subject and it 
+would be hard to discuss all nouances in the users guide where we want to 
+point out only the major aspects. Once you have mastered the users guide 
+this chapter is a good staring point for further exploring the capabilities 
+of *h5cpp*. 
+
+
+.. toctree::
+   :maxdepth: 1
+
+   cpp_datastructures
diff --git a/doc/source/images/32bit_integer.svg b/doc/source/images/32bit_integer.svg
diff --git a/doc/source/images/CMakeLists.txt b/doc/source/images/CMakeLists.txt
@@ -13,6 +13,12 @@ set(IMAGES attribute_manager_uml.png
            static_dataspace.svg
            dynamic_dataspace_bounded.svg
            dynamic_dataspace_unbounded.svg
+           hdf5_selection_manager.svg
+           memory_buffer_40byte.svg
+           32bit_integer.svg
+           dataspace_high_level.svg
+           storage_models.svg
+           memory_storage_example.svg
            )
 
 add_sphinx_source(${IMAGES})