Skip to content

Commit

Permalink
deploy: e59af19
Browse files Browse the repository at this point in the history
  • Loading branch information
@lia-viam
lia-viam committed Dec 5, 2024
1 parent 13a2403 commit add9640
Show file tree
Hide file tree
Showing 164 changed files with 10,175 additions and 2,088 deletions.
330 changes: 186 additions & 144 deletions annotated.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion arm_8hpp_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -255,7 +255,7 @@
<div class="ttc" id="astructviam_1_1sdk_1_1Arm_1_1KinematicsDataURDF_html"><div class="ttname"><a href="structviam_1_1sdk_1_1Arm_1_1KinematicsDataURDF.html">viam::sdk::Arm::KinematicsDataURDF</a></div><div class="ttdef"><b>Definition</b> arm.hpp:53</div></div>
<div class="ttc" id="astructviam_1_1sdk_1_1Arm_1_1KinematicsDataUnspecified_html"><div class="ttname"><a href="structviam_1_1sdk_1_1Arm_1_1KinematicsDataUnspecified.html">viam::sdk::Arm::KinematicsDataUnspecified</a></div><div class="ttdef"><b>Definition</b> arm.hpp:49</div></div>
<div class="ttc" id="astructviam_1_1sdk_1_1Arm_1_1MoveOptions_html"><div class="ttname"><a href="structviam_1_1sdk_1_1Arm_1_1MoveOptions.html">viam::sdk::Arm::MoveOptions</a></div><div class="ttdoc">Movement specifications for move_through_join_positions.</div><div class="ttdef"><b>Definition</b> arm.hpp:63</div></div>
<div class="ttc" id="astructviam_1_1sdk_1_1pose_html"><div class="ttname"><a href="structviam_1_1sdk_1_1pose.html">viam::sdk::pose</a></div><div class="ttdef"><b>Definition</b> pose.hpp:18</div></div>
<div class="ttc" id="astructviam_1_1sdk_1_1pose_html"><div class="ttname"><a href="structviam_1_1sdk_1_1pose.html">viam::sdk::pose</a></div><div class="ttdef"><b>Definition</b> pose.hpp:30</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Expand Down
2 changes: 1 addition & 1 deletion arm__client_8hpp_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@
<div class="ttc" id="aclassviam_1_1sdk_1_1impl_1_1ArmClient_html_ade7188c3473c99d2952dfddf5b9dd617"><div class="ttname"><a href="classviam_1_1sdk_1_1impl_1_1ArmClient.html#ade7188c3473c99d2952dfddf5b9dd617">viam::sdk::impl::ArmClient::get_kinematics</a></div><div class="ttdeci">Arm::KinematicsData get_kinematics(const ProtoStruct &amp;extra) override</div><div class="ttdoc">Get the kinematics data associated with the arm.</div></div>
<div class="ttc" id="aclassviam_1_1sdk_1_1impl_1_1ArmClient_html_af04abb33323a81ee5f5ebe712923347b"><div class="ttname"><a href="classviam_1_1sdk_1_1impl_1_1ArmClient.html#af04abb33323a81ee5f5ebe712923347b">viam::sdk::impl::ArmClient::move_through_joint_positions</a></div><div class="ttdeci">void move_through_joint_positions(const std::vector&lt; std::vector&lt; double &gt; &gt; &amp;positions, const Arm::MoveOptions &amp;options, const ProtoStruct &amp;extra) override</div><div class="ttdoc">Move each joint on the arm through the positions specified in.</div></div>
<div class="ttc" id="astructviam_1_1sdk_1_1Arm_1_1MoveOptions_html"><div class="ttname"><a href="structviam_1_1sdk_1_1Arm_1_1MoveOptions.html">viam::sdk::Arm::MoveOptions</a></div><div class="ttdoc">Movement specifications for move_through_join_positions.</div><div class="ttdef"><b>Definition</b> arm.hpp:63</div></div>
<div class="ttc" id="astructviam_1_1sdk_1_1pose_html"><div class="ttname"><a href="structviam_1_1sdk_1_1pose.html">viam::sdk::pose</a></div><div class="ttdef"><b>Definition</b> pose.hpp:18</div></div>
<div class="ttc" id="astructviam_1_1sdk_1_1pose_html"><div class="ttname"><a href="structviam_1_1sdk_1_1pose.html">viam::sdk::pose</a></div><div class="ttdef"><b>Definition</b> pose.hpp:30</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Expand Down
10 changes: 5 additions & 5 deletions base_2impl_8hpp_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -108,8 +108,8 @@
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"><a class="line" href="classMyBase.html#a87169d048da1ca6f0e43ca4be1782fe1"> 23</a></span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classMyBase.html#a87169d048da1ca6f0e43ca4be1782fe1">is_moving</a>() <span class="keyword">override</span>;</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"><a class="line" href="classMyBase.html#af529f81b9a197327a08d63a19bc59bd8"> 24</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classMyBase.html#af529f81b9a197327a08d63a19bc59bd8">stop</a>(<span class="keyword">const</span> ProtoStruct&amp; extra) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"><a class="line" href="classMyBase.html#a15fd6a8b8e98d5eb0d969c584eebe02e"> 25</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classMyBase.html#a15fd6a8b8e98d5eb0d969c584eebe02e">set_power</a>(<span class="keyword">const</span> <a class="code hl_class" href="classviam_1_1sdk_1_1Vector3.html">Vector3</a>&amp; linear,</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">const</span> <a class="code hl_class" href="classviam_1_1sdk_1_1Vector3.html">Vector3</a>&amp; angular,</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"><a class="line" href="classMyBase.html#a15fd6a8b8e98d5eb0d969c584eebe02e"> 25</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classMyBase.html#a15fd6a8b8e98d5eb0d969c584eebe02e">set_power</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structviam_1_1sdk_1_1Vector3.html">Vector3</a>&amp; linear,</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">const</span> <a class="code hl_struct" href="structviam_1_1sdk_1_1Vector3.html">Vector3</a>&amp; angular,</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">const</span> ProtoStruct&amp; extra) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"><a class="line" href="classMyBase.html#ac4a3f8e49119096dace7ab68de7c98d7"> 29</a></span> ProtoStruct <a class="code hl_function" href="classMyBase.html#ac4a3f8e49119096dace7ab68de7c98d7">do_command</a>(<span class="keyword">const</span> ProtoStruct&amp; command) <span class="keyword">override</span>;</div>
Expand All @@ -127,8 +127,8 @@
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> }</div>
</div>
<div class="foldopen" id="foldopen00039" data-start="{" data-end="}">
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="classMyBase.html#a4240ae82c75a13f30f1394bcf7fb91fd"> 39</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classMyBase.html#a4240ae82c75a13f30f1394bcf7fb91fd">set_velocity</a>(<span class="keyword">const</span> <a class="code hl_class" href="classviam_1_1sdk_1_1Vector3.html">Vector3</a>&amp; linear,</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">const</span> <a class="code hl_class" href="classviam_1_1sdk_1_1Vector3.html">Vector3</a>&amp; angular,</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="classMyBase.html#a4240ae82c75a13f30f1394bcf7fb91fd"> 39</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classMyBase.html#a4240ae82c75a13f30f1394bcf7fb91fd">set_velocity</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structviam_1_1sdk_1_1Vector3.html">Vector3</a>&amp; linear,</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">const</span> <a class="code hl_struct" href="structviam_1_1sdk_1_1Vector3.html">Vector3</a>&amp; angular,</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">const</span> ProtoStruct&amp; extra)<span class="keyword"> override </span>{</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <span class="keywordflow">throw</span> std::runtime_error(<span class="stringliteral">&quot;set_velocity unimplemented&quot;</span>);</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> }</div>
Expand All @@ -154,9 +154,9 @@
<div class="ttc" id="aclassviam_1_1sdk_1_1Base_html"><div class="ttname"><a href="classviam_1_1sdk_1_1Base.html">viam::sdk::Base</a></div><div class="ttdoc">A Base is the platform that the other parts of a mobile robot attach to.</div><div class="ttdef"><b>Definition</b> base.hpp:25</div></div>
<div class="ttc" id="aclassviam_1_1sdk_1_1Reconfigurable_html"><div class="ttname"><a href="classviam_1_1sdk_1_1Reconfigurable.html">viam::sdk::Reconfigurable</a></div><div class="ttdef"><b>Definition</b> reconfigurable.hpp:9</div></div>
<div class="ttc" id="aclassviam_1_1sdk_1_1ResourceConfig_html"><div class="ttname"><a href="classviam_1_1sdk_1_1ResourceConfig.html">viam::sdk::ResourceConfig</a></div><div class="ttdef"><b>Definition</b> resource.hpp:23</div></div>
<div class="ttc" id="aclassviam_1_1sdk_1_1Vector3_html"><div class="ttname"><a href="classviam_1_1sdk_1_1Vector3.html">viam::sdk::Vector3</a></div><div class="ttdef"><b>Definition</b> linear_algebra.hpp:15</div></div>
<div class="ttc" id="amotor_8hpp_html"><div class="ttname"><a href="motor_8hpp.html">motor.hpp</a></div><div class="ttdoc">Defines a Motor component.</div></div>
<div class="ttc" id="astructviam_1_1sdk_1_1Base_1_1properties_html"><div class="ttname"><a href="structviam_1_1sdk_1_1Base_1_1properties.html">viam::sdk::Base::properties</a></div><div class="ttdoc">Information about the physical base.</div><div class="ttdef"><b>Definition</b> base.hpp:29</div></div>
<div class="ttc" id="astructviam_1_1sdk_1_1Vector3_html"><div class="ttname"><a href="structviam_1_1sdk_1_1Vector3.html">viam::sdk::Vector3</a></div><div class="ttdef"><b>Definition</b> linear_algebra.hpp:25</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Expand Down
14 changes: 7 additions & 7 deletions base_8hpp_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -130,23 +130,23 @@
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"><a class="line" href="classviam_1_1sdk_1_1Base.html#a349532f90aa2693972bf1536468e2e41"> 67</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classviam_1_1sdk_1_1Base.html#a349532f90aa2693972bf1536468e2e41">spin</a>(<span class="keywordtype">double</span> angle_deg, <span class="keywordtype">double</span> degs_per_sec, <span class="keyword">const</span> ProtoStruct&amp; extra) = 0;</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> </div>
<div class="foldopen" id="foldopen00073" data-start="{" data-end="}">
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"><a class="line" href="classviam_1_1sdk_1_1Base.html#a4afeee00c6dc7ccf9d8b6258fc663b88"> 73</a></span> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classviam_1_1sdk_1_1Base.html#a4afeee00c6dc7ccf9d8b6258fc663b88">set_power</a>(<span class="keyword">const</span> <a class="code hl_class" href="classviam_1_1sdk_1_1Vector3.html">Vector3</a>&amp; linear, <span class="keyword">const</span> <a class="code hl_class" href="classviam_1_1sdk_1_1Vector3.html">Vector3</a>&amp; angular) {</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"><a class="line" href="classviam_1_1sdk_1_1Base.html#a4afeee00c6dc7ccf9d8b6258fc663b88"> 73</a></span> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classviam_1_1sdk_1_1Base.html#a4afeee00c6dc7ccf9d8b6258fc663b88">set_power</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structviam_1_1sdk_1_1Vector3.html">Vector3</a>&amp; linear, <span class="keyword">const</span> <a class="code hl_struct" href="structviam_1_1sdk_1_1Vector3.html">Vector3</a>&amp; angular) {</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> <span class="keywordflow">return</span> <a class="code hl_function" href="classviam_1_1sdk_1_1Base.html#a4afeee00c6dc7ccf9d8b6258fc663b88">set_power</a>(linear, angular, {});</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> }</div>
</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> </div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"><a class="line" href="classviam_1_1sdk_1_1Base.html#acfaf8dcfe35d2a836684c724d775ac21"> 82</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classviam_1_1sdk_1_1Base.html#acfaf8dcfe35d2a836684c724d775ac21">set_power</a>(<span class="keyword">const</span> <a class="code hl_class" href="classviam_1_1sdk_1_1Vector3.html">Vector3</a>&amp; linear,</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> <span class="keyword">const</span> <a class="code hl_class" href="classviam_1_1sdk_1_1Vector3.html">Vector3</a>&amp; angular,</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"><a class="line" href="classviam_1_1sdk_1_1Base.html#acfaf8dcfe35d2a836684c724d775ac21"> 82</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classviam_1_1sdk_1_1Base.html#acfaf8dcfe35d2a836684c724d775ac21">set_power</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structviam_1_1sdk_1_1Vector3.html">Vector3</a>&amp; linear,</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> <span class="keyword">const</span> <a class="code hl_struct" href="structviam_1_1sdk_1_1Vector3.html">Vector3</a>&amp; angular,</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> <span class="keyword">const</span> ProtoStruct&amp; extra) = 0;</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> </div>
<div class="foldopen" id="foldopen00089" data-start="{" data-end="}">
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"><a class="line" href="classviam_1_1sdk_1_1Base.html#ad969e703314a8819284d43b22f84b1e6"> 89</a></span> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classviam_1_1sdk_1_1Base.html#ad969e703314a8819284d43b22f84b1e6">set_velocity</a>(<span class="keyword">const</span> <a class="code hl_class" href="classviam_1_1sdk_1_1Vector3.html">Vector3</a>&amp; linear, <span class="keyword">const</span> <a class="code hl_class" href="classviam_1_1sdk_1_1Vector3.html">Vector3</a>&amp; angular) {</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"><a class="line" href="classviam_1_1sdk_1_1Base.html#ad969e703314a8819284d43b22f84b1e6"> 89</a></span> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classviam_1_1sdk_1_1Base.html#ad969e703314a8819284d43b22f84b1e6">set_velocity</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structviam_1_1sdk_1_1Vector3.html">Vector3</a>&amp; linear, <span class="keyword">const</span> <a class="code hl_struct" href="structviam_1_1sdk_1_1Vector3.html">Vector3</a>&amp; angular) {</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> <span class="keywordflow">return</span> <a class="code hl_function" href="classviam_1_1sdk_1_1Base.html#ad969e703314a8819284d43b22f84b1e6">set_velocity</a>(linear, angular, {});</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> }</div>
</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> </div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"><a class="line" href="classviam_1_1sdk_1_1Base.html#a809bdac1a82eeb8334cc1fb95a5c1b5b"> 97</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classviam_1_1sdk_1_1Base.html#a809bdac1a82eeb8334cc1fb95a5c1b5b">set_velocity</a>(<span class="keyword">const</span> <a class="code hl_class" href="classviam_1_1sdk_1_1Vector3.html">Vector3</a>&amp; linear,</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> <span class="keyword">const</span> <a class="code hl_class" href="classviam_1_1sdk_1_1Vector3.html">Vector3</a>&amp; angular,</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"><a class="line" href="classviam_1_1sdk_1_1Base.html#a809bdac1a82eeb8334cc1fb95a5c1b5b"> 97</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classviam_1_1sdk_1_1Base.html#a809bdac1a82eeb8334cc1fb95a5c1b5b">set_velocity</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structviam_1_1sdk_1_1Vector3.html">Vector3</a>&amp; linear,</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> <span class="keyword">const</span> <a class="code hl_struct" href="structviam_1_1sdk_1_1Vector3.html">Vector3</a>&amp; angular,</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> <span class="keyword">const</span> ProtoStruct&amp; extra) = 0;</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> </div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"><a class="line" href="classviam_1_1sdk_1_1Base.html#a2a00ecd60f9aa192ce609d3e552ee24c"> 102</a></span> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classviam_1_1sdk_1_1Base.html#a2a00ecd60f9aa192ce609d3e552ee24c">is_moving</a>() = 0;</div>
Expand Down Expand Up @@ -205,9 +205,9 @@
<div class="ttc" id="aclassviam_1_1sdk_1_1Component_html"><div class="ttname"><a href="classviam_1_1sdk_1_1Component.html">viam::sdk::Component</a></div><div class="ttdef"><b>Definition</b> component.hpp:10</div></div>
<div class="ttc" id="aclassviam_1_1sdk_1_1Resource_html_a52ea612e31f5c09785b500bd2610d97d"><div class="ttname"><a href="classviam_1_1sdk_1_1Resource.html#a52ea612e31f5c09785b500bd2610d97d">viam::sdk::Resource::name</a></div><div class="ttdeci">virtual std::string name() const</div><div class="ttdoc">Return the resource's name.</div></div>
<div class="ttc" id="aclassviam_1_1sdk_1_1Stoppable_html"><div class="ttname"><a href="classviam_1_1sdk_1_1Stoppable.html">viam::sdk::Stoppable</a></div><div class="ttdef"><b>Definition</b> stoppable.hpp:8</div></div>
<div class="ttc" id="aclassviam_1_1sdk_1_1Vector3_html"><div class="ttname"><a href="classviam_1_1sdk_1_1Vector3.html">viam::sdk::Vector3</a></div><div class="ttdef"><b>Definition</b> linear_algebra.hpp:15</div></div>
<div class="ttc" id="astructviam_1_1sdk_1_1API_1_1traits_html"><div class="ttname"><a href="structviam_1_1sdk_1_1API_1_1traits.html">viam::sdk::API::traits</a></div><div class="ttdef"><b>Definition</b> resource_api.hpp:50</div></div>
<div class="ttc" id="astructviam_1_1sdk_1_1Base_1_1properties_html"><div class="ttname"><a href="structviam_1_1sdk_1_1Base_1_1properties.html">viam::sdk::Base::properties</a></div><div class="ttdoc">Information about the physical base.</div><div class="ttdef"><b>Definition</b> base.hpp:29</div></div>
<div class="ttc" id="astructviam_1_1sdk_1_1Vector3_html"><div class="ttname"><a href="structviam_1_1sdk_1_1Vector3.html">viam::sdk::Vector3</a></div><div class="ttdef"><b>Definition</b> linear_algebra.hpp:25</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Expand Down
Loading

0 comments on commit add9640

Please sign in to comment.