Skip to content

Commit

Permalink
Updated overview section
Browse files Browse the repository at this point in the history 
Intermixed now UML and abstract description. This keeps related things
together and hopefully makes it easier for the reader to see the
mapping between HDF5 concepts and h5cpp.

Update #110
  • Loading branch information
@eugenwintersberger
eugenwintersberger committed Jan 4, 2018
1 parent 6252dbd commit a3cc551
Show file tree
Hide file tree
Showing 10 changed files with 1,095 additions and 185 deletions.
445 changes: 376 additions & 69 deletions doc/design/model.notation
View file

Large diffs are not rendered by default.

41 changes: 37 additions & 4 deletions doc/design/model.uml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,9 @@ spezialization of this type. </body>
<packagedElement xmi:type="uml:Class" xmi:id="_kLJoIJOZEeeoI7oI9Ds2zg" name="Null">
<generalization xmi:type="uml:Generalization" xmi:id="_pcdJsJOZEeeoI7oI9Ds2zg" general="_hzOugJOZEeeoI7oI9Ds2zg"/>
</packagedElement>
<packagedElement xmi:type="uml:Class" xmi:id="_3qLzsJOZEeeoI7oI9Ds2zg" name="Selection"/>
<packagedElement xmi:type="uml:Class" xmi:id="_3qLzsJOZEeeoI7oI9Ds2zg" name="Selection">
<nestedClassifier xmi:type="uml:DataType" xmi:id="_Xlut8PFKEeesZZqzx-B7Xg" name="SharedPointer"/>
</packagedElement>
<packagedElement xmi:type="uml:Class" xmi:id="_4pulIJOZEeeoI7oI9Ds2zg" name="Points">
<generalization xmi:type="uml:Generalization" xmi:id="_-wDqMJOZEeeoI7oI9Ds2zg" general="_3qLzsJOZEeeoI7oI9Ds2zg"/>
</packagedElement>
Expand Down Expand Up @@ -155,6 +157,37 @@ spezialization of this type. </body>
<ownedParameter xmi:type="uml:Parameter" xmi:id="_z-lZ8JPAEeeoI7oI9Ds2zg" name="return" type="_hzOugJOZEeeoI7oI9Ds2zg" direction="return"/>
</ownedOperation>
</packagedElement>
<packagedElement xmi:type="uml:Class" xmi:id="_Baj7APFEEeesZZqzx-B7Xg" name="SelectionList"/>
<packagedElement xmi:type="uml:Class" xmi:id="_C7zrUPFEEeesZZqzx-B7Xg" name="OperationWithSelection">
<ownedAttribute xmi:type="uml:Property" xmi:id="_dm60UPFKEeesZZqzx-B7Xg" name="operation" type="_hsZRQJOaEeeoI7oI9Ds2zg"/>
<ownedAttribute xmi:type="uml:Property" xmi:id="_iaTq0PFKEeesZZqzx-B7Xg" name="selection" type="_Xlut8PFKEeesZZqzx-B7Xg"/>
</packagedElement>
<packagedElement xmi:type="uml:Class" xmi:id="_e-TFsPFEEeesZZqzx-B7Xg" name="View"/>
<packagedElement xmi:type="uml:Class" xmi:id="_9y8pMPFFEeesZZqzx-B7Xg" name="SelectionList"/>
<packagedElement xmi:type="uml:Association" xmi:id="_Yz2qwPFGEeesZZqzx-B7Xg" memberEnd="_Yz5uEPFGEeesZZqzx-B7Xg _Yz68MfFGEeesZZqzx-B7Xg" navigableOwnedEnd="_Yz5uEPFGEeesZZqzx-B7Xg">
<eAnnotations xmi:type="ecore:EAnnotation" xmi:id="_Yz5HAPFGEeesZZqzx-B7Xg" source="org.eclipse.papyrus">
<details xmi:type="ecore:EStringToStringMapEntry" xmi:id="_Yz5HAfFGEeesZZqzx-B7Xg" key="nature" value="UML_Nature"/>
</eAnnotations>
<ownedEnd xmi:type="uml:Property" xmi:id="_Yz68MfFGEeesZZqzx-B7Xg" name="view" type="_e-TFsPFEEeesZZqzx-B7Xg" association="_Yz2qwPFGEeesZZqzx-B7Xg"/>
<ownedEnd xmi:type="uml:Property" xmi:id="_Yz5uEPFGEeesZZqzx-B7Xg" name="dataspace" type="_hzOugJOZEeeoI7oI9Ds2zg" aggregation="composite" association="_Yz2qwPFGEeesZZqzx-B7Xg">
<lowerValue xmi:type="uml:LiteralInteger" xmi:id="_Yz6VIPFGEeesZZqzx-B7Xg" value="1"/>
<upperValue xmi:type="uml:LiteralUnlimitedNatural" xmi:id="_Yz68MPFGEeesZZqzx-B7Xg" value="1"/>
</ownedEnd>
</packagedElement>
<packagedElement xmi:type="uml:Usage" xmi:id="_bEeCgPFGEeesZZqzx-B7Xg" name="applies selections" client="_e-TFsPFEEeesZZqzx-B7Xg" supplier="_9y8pMPFFEeesZZqzx-B7Xg"/>
<packagedElement xmi:type="uml:Association" xmi:id="_vQbosPFKEeesZZqzx-B7Xg" memberEnd="_vQc20fFKEeesZZqzx-B7Xg _vQn18PFKEeesZZqzx-B7Xg">
<eAnnotations xmi:type="ecore:EAnnotation" xmi:id="_vQcPwPFKEeesZZqzx-B7Xg" source="org.eclipse.papyrus">
<details xmi:type="ecore:EStringToStringMapEntry" xmi:id="_vQc20PFKEeesZZqzx-B7Xg" key="nature" value="UML_Nature"/>
</eAnnotations>
<ownedEnd xmi:type="uml:Property" xmi:id="_vQn18PFKEeesZZqzx-B7Xg" name="selectionlist" type="_9y8pMPFFEeesZZqzx-B7Xg" association="_vQbosPFKEeesZZqzx-B7Xg">
<lowerValue xmi:type="uml:LiteralInteger" xmi:id="_xfv_8PFKEeesZZqzx-B7Xg" value="1"/>
<upperValue xmi:type="uml:LiteralUnlimitedNatural" xmi:id="_xfzqUPFKEeesZZqzx-B7Xg" value="1"/>
</ownedEnd>
<ownedEnd xmi:type="uml:Property" xmi:id="_vQc20fFKEeesZZqzx-B7Xg" name="operationwithselection" type="_C7zrUPFEEeesZZqzx-B7Xg" aggregation="composite" association="_vQbosPFKEeesZZqzx-B7Xg">
<lowerValue xmi:type="uml:LiteralInteger" xmi:id="_vQfTEPFKEeesZZqzx-B7Xg"/>
<upperValue xmi:type="uml:LiteralUnlimitedNatural" xmi:id="_vQjkgPFKEeesZZqzx-B7Xg" value="*"/>
</ownedEnd>
</packagedElement>
</packagedElement>
<packagedElement xmi:type="uml:Package" xmi:id="_08wsUP55EeaZ1-3y1hN2zw" name="datatype">
<ownedComment xmi:type="uml:Comment" xmi:id="_ZGRloJO-EeeoI7oI9Ds2zg" annotatedElement="_IOvAwJO-EeeoI7oI9Ds2zg">
Expand Down Expand Up @@ -273,12 +306,12 @@ this for the container adapter.</body>
</ownedAttribute>
</packagedElement>
<packagedElement xmi:type="uml:Class" xmi:id="_YThA4JObEeeoI7oI9Ds2zg" name="Dataset">
<generalization xmi:type="uml:Generalization" xmi:id="_f6TzIJObEeeoI7oI9Ds2zg" general="_VYW3UJObEeeoI7oI9Ds2zg"/>
<generalization xmi:type="uml:Generalization" xmi:id="_lT7iUPFVEeesZZqzx-B7Xg" general="_VYW3UJObEeeoI7oI9Ds2zg"/>
<ownedOperation xmi:type="uml:Operation" xmi:id="_tw0XgJO9EeeoI7oI9Ds2zg" name="read"/>
<ownedOperation xmi:type="uml:Operation" xmi:id="_v8FVMJO9EeeoI7oI9Ds2zg" name="write"/>
</packagedElement>
<packagedElement xmi:type="uml:Class" xmi:id="_aiYFIJObEeeoI7oI9Ds2zg" name="Datatype">
<generalization xmi:type="uml:Generalization" xmi:id="_geA9IJObEeeoI7oI9Ds2zg" general="_VYW3UJObEeeoI7oI9Ds2zg"/>
<generalization xmi:type="uml:Generalization" xmi:id="_lypeoPFVEeesZZqzx-B7Xg" general="_VYW3UJObEeeoI7oI9Ds2zg"/>
</packagedElement>
<packagedElement xmi:type="uml:Class" xmi:id="_hTt2EJObEeeoI7oI9Ds2zg" name="NodeView">
<generalization xmi:type="uml:Generalization" xmi:id="_9NkoIJO3EeeoI7oI9Ds2zg" general="_3rKvgJO3EeeoI7oI9Ds2zg"/>
Expand Down Expand Up @@ -359,7 +392,7 @@ this for the container adapter.</body>
</ownedOperation>
</packagedElement>
<packagedElement xmi:type="uml:Class" xmi:id="_W5TFoJObEeeoI7oI9Ds2zg" name="Group">
<generalization xmi:type="uml:Generalization" xmi:id="_fXKCwJObEeeoI7oI9Ds2zg" general="_VYW3UJObEeeoI7oI9Ds2zg"/>
<generalization xmi:type="uml:Generalization" xmi:id="_mR8CsPFVEeesZZqzx-B7Xg" general="_VYW3UJObEeeoI7oI9Ds2zg"/>
<ownedAttribute xmi:type="uml:Property" xmi:id="_yvPIYJO0EeeoI7oI9Ds2zg" name="nodes" visibility="public" type="_hTt2EJObEeeoI7oI9Ds2zg" aggregation="composite"/>
<ownedAttribute xmi:type="uml:Property" xmi:id="_4I7J4JO0EeeoI7oI9Ds2zg" name="links" type="_iV99QJObEeeoI7oI9Ds2zg" aggregation="composite"/>
<ownedOperation xmi:type="uml:Operation" xmi:id="_8rHqEJOxEeeoI7oI9Ds2zg" name="create_dataset">
Expand Down
3 changes: 3 additions & 0 deletions doc/source/images/CMakeLists.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@ set(IMAGES attribute_manager_uml.png
hyperslab_1.svg
hyperslab_2.svg
hyperslab_3.svg
node_types.svg
node.svg
h5cpp_link.svg
)

add_sphinx_source(${IMAGES})
Expand Down
123 changes: 123 additions & 0 deletions doc/source/images/h5cpp_link.svg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit a3cc551

Please sign in to comment.