Skip to content

Commit

Permalink
feat(docs): add UML diagram
Browse files Browse the repository at this point in the history
  • Loading branch information
TheGamer1002 committed Jan 14, 2025
1 parent f480d6a commit 44f58c5
Showing 1 changed file with 94 additions and 0 deletions.
94 changes: 94 additions & 0 deletions Codebase UML Diagram.drawio
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
<mxfile host="app.diagrams.net" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:134.0) Gecko/20100101 Firefox/134.0" version="26.0.5">
<diagram id="C5RBs43oDa-KdzZeNtuy" name="Page-1">
<mxGraphModel dx="1362" dy="858" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="827" pageHeight="1169" math="0" shadow="0">
<root>
<mxCell id="WIyWlLk6GJQsqaUBKTNV-0" />
<mxCell id="WIyWlLk6GJQsqaUBKTNV-1" parent="WIyWlLk6GJQsqaUBKTNV-0" />
<mxCell id="fgNusIh10R2qpGMmoOiT-0" value="&lt;div&gt;RobotContainer&lt;/div&gt;" style="swimlane;fontStyle=1;align=center;verticalAlign=top;childLayout=stackLayout;horizontal=1;startSize=26;horizontalStack=0;resizeParent=1;resizeParentMax=0;resizeLast=0;collapsible=1;marginBottom=0;whiteSpace=wrap;html=1;" vertex="1" collapsed="1" parent="WIyWlLk6GJQsqaUBKTNV-1">
<mxGeometry x="10" y="610" width="120" height="30" as="geometry">
<mxRectangle x="460" y="400" width="160" height="86" as="alternateBounds" />
</mxGeometry>
</mxCell>
<mxCell id="fgNusIh10R2qpGMmoOiT-1" value="+ field: type" style="text;strokeColor=none;fillColor=none;align=left;verticalAlign=top;spacingLeft=4;spacingRight=4;overflow=hidden;rotatable=0;points=[[0,0.5],[1,0.5]];portConstraint=eastwest;whiteSpace=wrap;html=1;" vertex="1" parent="fgNusIh10R2qpGMmoOiT-0">
<mxGeometry y="26" width="160" height="26" as="geometry" />
</mxCell>
<mxCell id="fgNusIh10R2qpGMmoOiT-2" value="" style="line;strokeWidth=1;fillColor=none;align=left;verticalAlign=middle;spacingTop=-1;spacingLeft=3;spacingRight=3;rotatable=0;labelPosition=right;points=[];portConstraint=eastwest;strokeColor=inherit;" vertex="1" parent="fgNusIh10R2qpGMmoOiT-0">
<mxGeometry y="52" width="160" height="8" as="geometry" />
</mxCell>
<mxCell id="fgNusIh10R2qpGMmoOiT-3" value="+ method(type): type" style="text;strokeColor=none;fillColor=none;align=left;verticalAlign=top;spacingLeft=4;spacingRight=4;overflow=hidden;rotatable=0;points=[[0,0.5],[1,0.5]];portConstraint=eastwest;whiteSpace=wrap;html=1;" vertex="1" parent="fgNusIh10R2qpGMmoOiT-0">
<mxGeometry y="60" width="160" height="26" as="geometry" />
</mxCell>
<mxCell id="fgNusIh10R2qpGMmoOiT-8" value="subsystems" style="shape=folder;fontStyle=1;spacingTop=10;tabWidth=40;tabHeight=14;tabPosition=left;html=1;whiteSpace=wrap;" vertex="1" parent="WIyWlLk6GJQsqaUBKTNV-1">
<mxGeometry x="240" y="220" width="70" height="50" as="geometry" />
</mxCell>
<mxCell id="fgNusIh10R2qpGMmoOiT-29" value="Subsystems" style="swimlane;whiteSpace=wrap;html=1;" vertex="1" parent="WIyWlLk6GJQsqaUBKTNV-1">
<mxGeometry x="390" y="80" width="620" height="660" as="geometry" />
</mxCell>
<mxCell id="fgNusIh10R2qpGMmoOiT-9" value="ElevatorSubsystem" style="swimlane;fontStyle=1;align=center;verticalAlign=top;childLayout=stackLayout;horizontal=1;startSize=20;horizontalStack=0;resizeParent=1;resizeParentMax=0;resizeLast=0;collapsible=1;marginBottom=0;whiteSpace=wrap;html=1;" vertex="1" parent="fgNusIh10R2qpGMmoOiT-29">
<mxGeometry x="20" y="50" width="170" height="120" as="geometry">
<mxRectangle x="20" y="50" width="140" height="30" as="alternateBounds" />
</mxGeometry>
</mxCell>
<mxCell id="fgNusIh10R2qpGMmoOiT-10" value="&lt;div&gt;+ position: Double&lt;/div&gt;&lt;div&gt;&lt;span style=&quot;white-space: pre;&quot;&gt;&#x9;get(): getCurrentPosition()&lt;/span&gt;&lt;/div&gt;&lt;div&gt;&lt;span style=&quot;white-space: pre;&quot;&gt;&lt;span style=&quot;white-space: pre;&quot;&gt;&#x9;&lt;/span&gt;set(): goToPosition()&lt;br&gt;&lt;/span&gt;&lt;/div&gt;" style="text;strokeColor=none;fillColor=none;align=left;verticalAlign=top;spacingLeft=4;spacingRight=4;overflow=hidden;rotatable=0;points=[[0,0.5],[1,0.5]];portConstraint=eastwest;whiteSpace=wrap;html=1;" vertex="1" parent="fgNusIh10R2qpGMmoOiT-9">
<mxGeometry y="20" width="170" height="50" as="geometry" />
</mxCell>
<mxCell id="fgNusIh10R2qpGMmoOiT-11" value="" style="line;strokeWidth=1;fillColor=none;align=left;verticalAlign=middle;spacingTop=-1;spacingLeft=3;spacingRight=3;rotatable=0;labelPosition=right;points=[];portConstraint=eastwest;strokeColor=inherit;" vertex="1" parent="fgNusIh10R2qpGMmoOiT-9">
<mxGeometry y="70" width="170" height="8" as="geometry" />
</mxCell>
<mxCell id="fgNusIh10R2qpGMmoOiT-12" value="&lt;div&gt;- goToPosition(Double): Unit&lt;/div&gt;&lt;div&gt;- getCurrentPosition(): Double&lt;br&gt;&lt;/div&gt;" style="text;strokeColor=none;fillColor=none;align=left;verticalAlign=top;spacingLeft=4;spacingRight=4;overflow=hidden;rotatable=0;points=[[0,0.5],[1,0.5]];portConstraint=eastwest;whiteSpace=wrap;html=1;" vertex="1" parent="fgNusIh10R2qpGMmoOiT-9">
<mxGeometry y="78" width="170" height="42" as="geometry" />
</mxCell>
<mxCell id="fgNusIh10R2qpGMmoOiT-13" value="DrivebaseSubsystem" style="swimlane;fontStyle=1;align=center;verticalAlign=top;childLayout=stackLayout;horizontal=1;startSize=26;horizontalStack=0;resizeParent=1;resizeParentMax=0;resizeLast=0;collapsible=1;marginBottom=0;whiteSpace=wrap;html=1;" vertex="1" parent="fgNusIh10R2qpGMmoOiT-29">
<mxGeometry x="420" y="50" width="160" height="94" as="geometry" />
</mxCell>
<mxCell id="fgNusIh10R2qpGMmoOiT-14" value="+ field: type" style="text;strokeColor=none;fillColor=none;align=left;verticalAlign=top;spacingLeft=4;spacingRight=4;overflow=hidden;rotatable=0;points=[[0,0.5],[1,0.5]];portConstraint=eastwest;whiteSpace=wrap;html=1;" vertex="1" parent="fgNusIh10R2qpGMmoOiT-13">
<mxGeometry y="26" width="160" height="34" as="geometry" />
</mxCell>
<mxCell id="fgNusIh10R2qpGMmoOiT-15" value="" style="line;strokeWidth=1;fillColor=none;align=left;verticalAlign=middle;spacingTop=-1;spacingLeft=3;spacingRight=3;rotatable=0;labelPosition=right;points=[];portConstraint=eastwest;strokeColor=inherit;" vertex="1" parent="fgNusIh10R2qpGMmoOiT-13">
<mxGeometry y="60" width="160" height="8" as="geometry" />
</mxCell>
<mxCell id="fgNusIh10R2qpGMmoOiT-16" value="+ addVisionMeasurement" style="text;strokeColor=none;fillColor=none;align=left;verticalAlign=top;spacingLeft=4;spacingRight=4;overflow=hidden;rotatable=0;points=[[0,0.5],[1,0.5]];portConstraint=eastwest;whiteSpace=wrap;html=1;" vertex="1" parent="fgNusIh10R2qpGMmoOiT-13">
<mxGeometry y="68" width="160" height="26" as="geometry" />
</mxCell>
<mxCell id="fgNusIh10R2qpGMmoOiT-17" value="ClimberSubsystem" style="swimlane;fontStyle=1;align=center;verticalAlign=top;childLayout=stackLayout;horizontal=1;startSize=26;horizontalStack=0;resizeParent=1;resizeParentMax=0;resizeLast=0;collapsible=1;marginBottom=0;whiteSpace=wrap;html=1;" vertex="1" parent="fgNusIh10R2qpGMmoOiT-29">
<mxGeometry x="390" y="304" width="160" height="110" as="geometry">
<mxRectangle x="270" y="390" width="140" height="30" as="alternateBounds" />
</mxGeometry>
</mxCell>
<mxCell id="fgNusIh10R2qpGMmoOiT-18" value="+ field: type" style="text;strokeColor=none;fillColor=none;align=left;verticalAlign=top;spacingLeft=4;spacingRight=4;overflow=hidden;rotatable=0;points=[[0,0.5],[1,0.5]];portConstraint=eastwest;whiteSpace=wrap;html=1;" vertex="1" parent="fgNusIh10R2qpGMmoOiT-17">
<mxGeometry y="26" width="160" height="26" as="geometry" />
</mxCell>
<mxCell id="fgNusIh10R2qpGMmoOiT-19" value="" style="line;strokeWidth=1;fillColor=none;align=left;verticalAlign=middle;spacingTop=-1;spacingLeft=3;spacingRight=3;rotatable=0;labelPosition=right;points=[];portConstraint=eastwest;strokeColor=inherit;" vertex="1" parent="fgNusIh10R2qpGMmoOiT-17">
<mxGeometry y="52" width="160" height="8" as="geometry" />
</mxCell>
<mxCell id="fgNusIh10R2qpGMmoOiT-20" value="&lt;div&gt;+ engage(): void&lt;/div&gt;&lt;div&gt;+ disengage(): void&lt;br&gt;&lt;/div&gt;" style="text;strokeColor=none;fillColor=none;align=left;verticalAlign=top;spacingLeft=4;spacingRight=4;overflow=hidden;rotatable=0;points=[[0,0.5],[1,0.5]];portConstraint=eastwest;whiteSpace=wrap;html=1;" vertex="1" parent="fgNusIh10R2qpGMmoOiT-17">
<mxGeometry y="60" width="160" height="50" as="geometry" />
</mxCell>
<mxCell id="fgNusIh10R2qpGMmoOiT-21" value="ArmSubsystem" style="swimlane;fontStyle=1;align=center;verticalAlign=top;childLayout=stackLayout;horizontal=1;startSize=26;horizontalStack=0;resizeParent=1;resizeParentMax=0;resizeLast=0;collapsible=1;marginBottom=0;whiteSpace=wrap;html=1;" vertex="1" parent="fgNusIh10R2qpGMmoOiT-29">
<mxGeometry x="30" y="220" width="270" height="148" as="geometry" />
</mxCell>
<mxCell id="fgNusIh10R2qpGMmoOiT-22" value="&lt;div&gt;+ position: Units.Degrees&lt;/div&gt;&lt;div&gt;&lt;span style=&quot;white-space: pre;&quot;&gt;&#x9;&lt;/span&gt;get() = getPosition()&lt;/div&gt;&lt;div&gt;&lt;span style=&quot;white-space: pre;&quot;&gt;&#x9;&lt;/span&gt;set(value) = goToPosition(value)&lt;br&gt;&lt;/div&gt;" style="text;strokeColor=none;fillColor=none;align=left;verticalAlign=top;spacingLeft=4;spacingRight=4;overflow=hidden;rotatable=0;points=[[0,0.5],[1,0.5]];portConstraint=eastwest;whiteSpace=wrap;html=1;" vertex="1" parent="fgNusIh10R2qpGMmoOiT-21">
<mxGeometry y="26" width="270" height="64" as="geometry" />
</mxCell>
<mxCell id="fgNusIh10R2qpGMmoOiT-23" value="" style="line;strokeWidth=1;fillColor=none;align=left;verticalAlign=middle;spacingTop=-1;spacingLeft=3;spacingRight=3;rotatable=0;labelPosition=right;points=[];portConstraint=eastwest;strokeColor=inherit;" vertex="1" parent="fgNusIh10R2qpGMmoOiT-21">
<mxGeometry y="90" width="270" height="8" as="geometry" />
</mxCell>
<mxCell id="fgNusIh10R2qpGMmoOiT-24" value="&lt;div&gt;- goToPosition(Units.Degrees): void&lt;br&gt;&lt;/div&gt;- getPosition(): Units.Degrees" style="text;strokeColor=none;fillColor=none;align=left;verticalAlign=top;spacingLeft=4;spacingRight=4;overflow=hidden;rotatable=0;points=[[0,0.5],[1,0.5]];portConstraint=eastwest;whiteSpace=wrap;html=1;" vertex="1" parent="fgNusIh10R2qpGMmoOiT-21">
<mxGeometry y="98" width="270" height="50" as="geometry" />
</mxCell>
<mxCell id="fgNusIh10R2qpGMmoOiT-25" value="VisionSubsystem" style="swimlane;fontStyle=1;align=center;verticalAlign=top;childLayout=stackLayout;horizontal=1;startSize=26;horizontalStack=0;resizeParent=1;resizeParentMax=0;resizeLast=0;collapsible=1;marginBottom=0;whiteSpace=wrap;html=1;" vertex="1" parent="fgNusIh10R2qpGMmoOiT-29">
<mxGeometry x="380" y="462" width="160" height="86" as="geometry" />
</mxCell>
<mxCell id="fgNusIh10R2qpGMmoOiT-26" value="+ field: type" style="text;strokeColor=none;fillColor=none;align=left;verticalAlign=top;spacingLeft=4;spacingRight=4;overflow=hidden;rotatable=0;points=[[0,0.5],[1,0.5]];portConstraint=eastwest;whiteSpace=wrap;html=1;" vertex="1" parent="fgNusIh10R2qpGMmoOiT-25">
<mxGeometry y="26" width="160" height="26" as="geometry" />
</mxCell>
<mxCell id="fgNusIh10R2qpGMmoOiT-27" value="" style="line;strokeWidth=1;fillColor=none;align=left;verticalAlign=middle;spacingTop=-1;spacingLeft=3;spacingRight=3;rotatable=0;labelPosition=right;points=[];portConstraint=eastwest;strokeColor=inherit;" vertex="1" parent="fgNusIh10R2qpGMmoOiT-25">
<mxGeometry y="52" width="160" height="8" as="geometry" />
</mxCell>
<mxCell id="fgNusIh10R2qpGMmoOiT-28" value="+ method(type): type" style="text;strokeColor=none;fillColor=none;align=left;verticalAlign=top;spacingLeft=4;spacingRight=4;overflow=hidden;rotatable=0;points=[[0,0.5],[1,0.5]];portConstraint=eastwest;whiteSpace=wrap;html=1;" vertex="1" parent="fgNusIh10R2qpGMmoOiT-25">
<mxGeometry y="60" width="160" height="26" as="geometry" />
</mxCell>
</root>
</mxGraphModel>
</diagram>
</mxfile>

0 comments on commit 44f58c5

Please sign in to comment.