Skip to content

Commit

Permalink
deploy: 056edfd
Browse files Browse the repository at this point in the history
  • Loading branch information
stuqdog committed Oct 7, 2024
1 parent 32daa09 commit 6f41adf
Show file tree
Hide file tree
Showing 20 changed files with 692 additions and 377 deletions.
71 changes: 39 additions & 32 deletions arm_8hpp_source.html

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions arm__client_8hpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">using </span><a class="code hl_function" href="classviam_1_1sdk_1_1Arm.html#a5604ac4418042783a0227e43c573a9ac">Arm::get_geometries</a>;</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">using </span><a class="code hl_function" href="classviam_1_1sdk_1_1Arm.html#a1a5198860ccffa77d21b6d0ea047b018">Arm::get_joint_positions</a>;</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">using </span><a class="code hl_function" href="classviam_1_1sdk_1_1Arm.html#a1684010009781539671c88c57bae7d68">Arm::get_kinematics</a>;</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">using </span><a class="code hl_function" href="classviam_1_1sdk_1_1Arm.html#a99e232accde4b5c98d73911654b13c29">Arm::move_to_joint_positions</a>;</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">using </span><a class="code hl_function" href="classviam_1_1sdk_1_1Arm.html#a48cc947a63a1c32bbe122017aab51849">Arm::move_to_joint_positions</a>;</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">using </span><a class="code hl_function" href="classviam_1_1sdk_1_1Arm.html#aee61208d32415894fca591554e394cdb">Arm::move_to_position</a>;</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">using </span><a class="code hl_function" href="classviam_1_1sdk_1_1Stoppable.html#a5248adce66d2ff61cf1c69daaf4cf754">Arm::stop</a>;</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> </div>
Expand All @@ -135,11 +135,11 @@
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span>} <span class="comment">// namespace viam</span></div>
<div class="ttc" id="aarm_8hpp_html"><div class="ttname"><a href="arm_8hpp.html">arm.hpp</a></div><div class="ttdoc">Defines an Arm component.</div></div>
<div class="ttc" id="aclassviam_1_1sdk_1_1Arm_html"><div class="ttname"><a href="classviam_1_1sdk_1_1Arm.html">viam::sdk::Arm</a></div><div class="ttdoc">An Arm represents a physical robot arm that exists in three-dimensional space.</div><div class="ttdef"><b>Definition</b> arm.hpp:28</div></div>
<div class="ttc" id="aclassviam_1_1sdk_1_1Arm_html_a1684010009781539671c88c57bae7d68"><div class="ttname"><a href="classviam_1_1sdk_1_1Arm.html#a1684010009781539671c88c57bae7d68">viam::sdk::Arm::get_kinematics</a></div><div class="ttdeci">KinematicsData get_kinematics()</div><div class="ttdoc">Get the kinematics data associated with the arm.</div><div class="ttdef"><b>Definition</b> arm.hpp:118</div></div>
<div class="ttc" id="aclassviam_1_1sdk_1_1Arm_html_a1684010009781539671c88c57bae7d68"><div class="ttname"><a href="classviam_1_1sdk_1_1Arm.html#a1684010009781539671c88c57bae7d68">viam::sdk::Arm::get_kinematics</a></div><div class="ttdeci">KinematicsData get_kinematics()</div><div class="ttdoc">Get the kinematics data associated with the arm.</div><div class="ttdef"><b>Definition</b> arm.hpp:123</div></div>
<div class="ttc" id="aclassviam_1_1sdk_1_1Arm_html_a1a5198860ccffa77d21b6d0ea047b018"><div class="ttname"><a href="classviam_1_1sdk_1_1Arm.html#a1a5198860ccffa77d21b6d0ea047b018">viam::sdk::Arm::get_joint_positions</a></div><div class="ttdeci">std::vector&lt; double &gt; get_joint_positions()</div><div class="ttdoc">Lists the joint positions in degrees of every joint on a robot arm.</div><div class="ttdef"><b>Definition</b> arm.hpp:88</div></div>
<div class="ttc" id="aclassviam_1_1sdk_1_1Arm_html_a5604ac4418042783a0227e43c573a9ac"><div class="ttname"><a href="classviam_1_1sdk_1_1Arm.html#a5604ac4418042783a0227e43c573a9ac">viam::sdk::Arm::get_geometries</a></div><div class="ttdeci">std::vector&lt; GeometryConfig &gt; get_geometries()</div><div class="ttdoc">Returns GeometryConfigs associated with the calling arm.</div><div class="ttdef"><b>Definition</b> arm.hpp:123</div></div>
<div class="ttc" id="aclassviam_1_1sdk_1_1Arm_html_a48cc947a63a1c32bbe122017aab51849"><div class="ttname"><a href="classviam_1_1sdk_1_1Arm.html#a48cc947a63a1c32bbe122017aab51849">viam::sdk::Arm::move_to_joint_positions</a></div><div class="ttdeci">void move_to_joint_positions(const std::vector&lt; double &gt; &amp;positions)</div><div class="ttdoc">Move each joint on the arm to the corresponding angle specified in.</div><div class="ttdef"><b>Definition</b> arm.hpp:97</div></div>
<div class="ttc" id="aclassviam_1_1sdk_1_1Arm_html_a5604ac4418042783a0227e43c573a9ac"><div class="ttname"><a href="classviam_1_1sdk_1_1Arm.html#a5604ac4418042783a0227e43c573a9ac">viam::sdk::Arm::get_geometries</a></div><div class="ttdeci">std::vector&lt; GeometryConfig &gt; get_geometries()</div><div class="ttdoc">Returns GeometryConfigs associated with the calling arm.</div><div class="ttdef"><b>Definition</b> arm.hpp:128</div></div>
<div class="ttc" id="aclassviam_1_1sdk_1_1Arm_html_a72ace37c311ae8bf430df9ccf3ad0775"><div class="ttname"><a href="classviam_1_1sdk_1_1Arm.html#a72ace37c311ae8bf430df9ccf3ad0775">viam::sdk::Arm::KinematicsData</a></div><div class="ttdeci">boost::variant&lt; KinematicsDataUnspecified, KinematicsDataSVA, KinematicsDataURDF &gt; KinematicsData</div><div class="ttdoc">The kinematics of the component.</div><div class="ttdef"><b>Definition</b> arm.hpp:61</div></div>
<div class="ttc" id="aclassviam_1_1sdk_1_1Arm_html_a99e232accde4b5c98d73911654b13c29"><div class="ttname"><a href="classviam_1_1sdk_1_1Arm.html#a99e232accde4b5c98d73911654b13c29">viam::sdk::Arm::move_to_joint_positions</a></div><div class="ttdeci">virtual void move_to_joint_positions(const std::vector&lt; double &gt; &amp;positions, const ProtoStruct &amp;extra)=0</div><div class="ttdoc">Move each joint on the arm to the corresponding angle specified in.</div></div>
<div class="ttc" id="aclassviam_1_1sdk_1_1Arm_html_ae5acbc1a20c1ad5814e10dde57b34c16"><div class="ttname"><a href="classviam_1_1sdk_1_1Arm.html#ae5acbc1a20c1ad5814e10dde57b34c16">viam::sdk::Arm::get_end_position</a></div><div class="ttdeci">pose get_end_position()</div><div class="ttdoc">Get the current position of the end of the arm.</div><div class="ttdef"><b>Definition</b> arm.hpp:68</div></div>
<div class="ttc" id="aclassviam_1_1sdk_1_1Arm_html_aee61208d32415894fca591554e394cdb"><div class="ttname"><a href="classviam_1_1sdk_1_1Arm.html#aee61208d32415894fca591554e394cdb">viam::sdk::Arm::move_to_position</a></div><div class="ttdeci">void move_to_position(const pose &amp;pose)</div><div class="ttdoc">Move the end of the arm to.</div><div class="ttdef"><b>Definition</b> arm.hpp:78</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>
Expand Down
2 changes: 1 addition & 1 deletion camera_8hpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,7 @@
<div class="ttc" id="astructviam_1_1sdk_1_1Camera_1_1properties_html_aa2707df5f858c380edc0a555d17aa92e"><div class="ttname"><a href="structviam_1_1sdk_1_1Camera_1_1properties.html#aa2707df5f858c380edc0a555d17aa92e">viam::sdk::Camera::properties::frame_rate</a></div><div class="ttdeci">float frame_rate</div><div class="ttdoc">Contains the camera's frame rate.</div><div class="ttdef"><b>Definition</b> camera.hpp:70</div></div>
<div class="ttc" id="astructviam_1_1sdk_1_1Camera_1_1properties_html_affdc2cf4e032a426abc02e4fe73df15f"><div class="ttname"><a href="structviam_1_1sdk_1_1Camera_1_1properties.html#affdc2cf4e032a426abc02e4fe73df15f">viam::sdk::Camera::properties::mime_types</a></div><div class="ttdeci">Camera::mime_types mime_types</div><div class="ttdoc">Contains the mime types the camera supports.</div><div class="ttdef"><b>Definition</b> camera.hpp:67</div></div>
<div class="ttc" id="astructviam_1_1sdk_1_1Camera_1_1raw__image_html"><div class="ttname"><a href="structviam_1_1sdk_1_1Camera_1_1raw__image.html">viam::sdk::Camera::raw_image</a></div><div class="ttdoc">the raw bytes, mime type of an image, and name of the source that produced it.</div><div class="ttdef"><b>Definition</b> camera.hpp:86</div></div>
<div class="ttc" id="astructviam_1_1sdk_1_1response__metadata_html"><div class="ttname"><a href="structviam_1_1sdk_1_1response__metadata.html">viam::sdk::response_metadata</a></div><div class="ttdef"><b>Definition</b> utils.hpp:24</div></div>
<div class="ttc" id="astructviam_1_1sdk_1_1response__metadata_html"><div class="ttname"><a href="structviam_1_1sdk_1_1response__metadata.html">viam::sdk::response_metadata</a></div><div class="ttdef"><b>Definition</b> utils.hpp:21</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Expand Down
25 changes: 13 additions & 12 deletions classviam_1_1sdk_1_1Arm-members.html
Original file line number Diff line number Diff line change
Expand Up @@ -98,18 +98,19 @@
<tr class="even"><td class="entry"><a class="el" href="classviam_1_1sdk_1_1Component.html#ae969386d6faa08e81f16fb55ce62aa5d">get_resource_name</a>(std::string name) const override</td><td class="entry"><a class="el" href="classviam_1_1sdk_1_1Component.html">viam::sdk::Component</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classviam_1_1sdk_1_1Arm.html#a03e67125cfd7e762a3ead084aa488b07">is_moving</a>()=0</td><td class="entry"><a class="el" href="classviam_1_1sdk_1_1Arm.html">viam::sdk::Arm</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classviam_1_1sdk_1_1Arm.html#a72ace37c311ae8bf430df9ccf3ad0775">KinematicsData</a> typedef</td><td class="entry"><a class="el" href="classviam_1_1sdk_1_1Arm.html">viam::sdk::Arm</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classviam_1_1sdk_1_1Arm.html#a99e232accde4b5c98d73911654b13c29">move_to_joint_positions</a>(const std::vector&lt; double &gt; &amp;positions, const ProtoStruct &amp;extra)=0</td><td class="entry"><a class="el" href="classviam_1_1sdk_1_1Arm.html">viam::sdk::Arm</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classviam_1_1sdk_1_1Arm.html#aee61208d32415894fca591554e394cdb">move_to_position</a>(const pose &amp;pose)</td><td class="entry"><a class="el" href="classviam_1_1sdk_1_1Arm.html">viam::sdk::Arm</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classviam_1_1sdk_1_1Arm.html#a09cbee10b6b87fb9151d390d0f4000f9">move_to_position</a>(const pose &amp;pose, const ProtoStruct &amp;extra)=0</td><td class="entry"><a class="el" href="classviam_1_1sdk_1_1Arm.html">viam::sdk::Arm</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classviam_1_1sdk_1_1Resource.html#a52ea612e31f5c09785b500bd2610d97d">name</a>() const</td><td class="entry"><a class="el" href="classviam_1_1sdk_1_1Resource.html">viam::sdk::Resource</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr bgcolor="#f0f0f0" class="odd"><td class="entry"><b>Resource</b>(std::string name) (defined in <a class="el" href="classviam_1_1sdk_1_1Resource.html">viam::sdk::Resource</a>)</td><td class="entry"><a class="el" href="classviam_1_1sdk_1_1Resource.html">viam::sdk::Resource</a></td><td class="entry"><span class="mlabel">explicit</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classviam_1_1sdk_1_1Stoppable.html#a1c8e7ba66f0bd9694a68c71043ab1d36">stop</a>(const ProtoStruct &amp;extra)=0</td><td class="entry"><a class="el" href="classviam_1_1sdk_1_1Stoppable.html">viam::sdk::Stoppable</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classviam_1_1sdk_1_1Stoppable.html#a5248adce66d2ff61cf1c69daaf4cf754">stop</a>()</td><td class="entry"><a class="el" href="classviam_1_1sdk_1_1Stoppable.html">viam::sdk::Stoppable</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classviam_1_1sdk_1_1Stoppable.html#a9b209a040efc8f4ea35abb92dafb5fea">stop_if_stoppable</a>(const std::shared_ptr&lt; Resource &gt; &amp;resource, const ProtoStruct &amp;extra)</td><td class="entry"><a class="el" href="classviam_1_1sdk_1_1Stoppable.html">viam::sdk::Stoppable</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classviam_1_1sdk_1_1Stoppable.html#ab7a35a13e39132052b910f5b8718f29d">stop_if_stoppable</a>(const std::shared_ptr&lt; Resource &gt; &amp;resource)</td><td class="entry"><a class="el" href="classviam_1_1sdk_1_1Stoppable.html">viam::sdk::Stoppable</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">static</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>Stoppable</b>() (defined in <a class="el" href="classviam_1_1sdk_1_1Stoppable.html">viam::sdk::Stoppable</a>)</td><td class="entry"><a class="el" href="classviam_1_1sdk_1_1Stoppable.html">viam::sdk::Stoppable</a></td><td class="entry"><span class="mlabel">explicit</span><span class="mlabel">protected</span></td></tr>
<tr bgcolor="#f0f0f0" class="odd"><td class="entry"><b>~Resource</b>() (defined in <a class="el" href="classviam_1_1sdk_1_1Resource.html">viam::sdk::Resource</a>)</td><td class="entry"><a class="el" href="classviam_1_1sdk_1_1Resource.html">viam::sdk::Resource</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>~Stoppable</b>() (defined in <a class="el" href="classviam_1_1sdk_1_1Stoppable.html">viam::sdk::Stoppable</a>)</td><td class="entry"><a class="el" href="classviam_1_1sdk_1_1Stoppable.html">viam::sdk::Stoppable</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classviam_1_1sdk_1_1Arm.html#a48cc947a63a1c32bbe122017aab51849">move_to_joint_positions</a>(const std::vector&lt; double &gt; &amp;positions)</td><td class="entry"><a class="el" href="classviam_1_1sdk_1_1Arm.html">viam::sdk::Arm</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classviam_1_1sdk_1_1Arm.html#a99e232accde4b5c98d73911654b13c29">move_to_joint_positions</a>(const std::vector&lt; double &gt; &amp;positions, const ProtoStruct &amp;extra)=0</td><td class="entry"><a class="el" href="classviam_1_1sdk_1_1Arm.html">viam::sdk::Arm</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classviam_1_1sdk_1_1Arm.html#aee61208d32415894fca591554e394cdb">move_to_position</a>(const pose &amp;pose)</td><td class="entry"><a class="el" href="classviam_1_1sdk_1_1Arm.html">viam::sdk::Arm</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classviam_1_1sdk_1_1Arm.html#a09cbee10b6b87fb9151d390d0f4000f9">move_to_position</a>(const pose &amp;pose, const ProtoStruct &amp;extra)=0</td><td class="entry"><a class="el" href="classviam_1_1sdk_1_1Arm.html">viam::sdk::Arm</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classviam_1_1sdk_1_1Resource.html#a52ea612e31f5c09785b500bd2610d97d">name</a>() const</td><td class="entry"><a class="el" href="classviam_1_1sdk_1_1Resource.html">viam::sdk::Resource</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>Resource</b>(std::string name) (defined in <a class="el" href="classviam_1_1sdk_1_1Resource.html">viam::sdk::Resource</a>)</td><td class="entry"><a class="el" href="classviam_1_1sdk_1_1Resource.html">viam::sdk::Resource</a></td><td class="entry"><span class="mlabel">explicit</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classviam_1_1sdk_1_1Stoppable.html#a1c8e7ba66f0bd9694a68c71043ab1d36">stop</a>(const ProtoStruct &amp;extra)=0</td><td class="entry"><a class="el" href="classviam_1_1sdk_1_1Stoppable.html">viam::sdk::Stoppable</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classviam_1_1sdk_1_1Stoppable.html#a5248adce66d2ff61cf1c69daaf4cf754">stop</a>()</td><td class="entry"><a class="el" href="classviam_1_1sdk_1_1Stoppable.html">viam::sdk::Stoppable</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classviam_1_1sdk_1_1Stoppable.html#a9b209a040efc8f4ea35abb92dafb5fea">stop_if_stoppable</a>(const std::shared_ptr&lt; Resource &gt; &amp;resource, const ProtoStruct &amp;extra)</td><td class="entry"><a class="el" href="classviam_1_1sdk_1_1Stoppable.html">viam::sdk::Stoppable</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classviam_1_1sdk_1_1Stoppable.html#ab7a35a13e39132052b910f5b8718f29d">stop_if_stoppable</a>(const std::shared_ptr&lt; Resource &gt; &amp;resource)</td><td class="entry"><a class="el" href="classviam_1_1sdk_1_1Stoppable.html">viam::sdk::Stoppable</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">static</span></td></tr>
<tr bgcolor="#f0f0f0" class="odd"><td class="entry"><b>Stoppable</b>() (defined in <a class="el" href="classviam_1_1sdk_1_1Stoppable.html">viam::sdk::Stoppable</a>)</td><td class="entry"><a class="el" href="classviam_1_1sdk_1_1Stoppable.html">viam::sdk::Stoppable</a></td><td class="entry"><span class="mlabel">explicit</span><span class="mlabel">protected</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>~Resource</b>() (defined in <a class="el" href="classviam_1_1sdk_1_1Resource.html">viam::sdk::Resource</a>)</td><td class="entry"><a class="el" href="classviam_1_1sdk_1_1Resource.html">viam::sdk::Resource</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr bgcolor="#f0f0f0" class="odd"><td class="entry"><b>~Stoppable</b>() (defined in <a class="el" href="classviam_1_1sdk_1_1Stoppable.html">viam::sdk::Stoppable</a>)</td><td class="entry"><a class="el" href="classviam_1_1sdk_1_1Stoppable.html">viam::sdk::Stoppable</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Expand Down
Loading

0 comments on commit 6f41adf

Please sign in to comment.