deploy: e331f2c

arm_8hpp_source.html

@@ -247,7 +247,7 @@
 <div class="ttc" id="aclassviam_1_1sdk_1_1Arm_html_aeed2dcf6c5f23a31730aec1fdf73db52"><div class="ttname"><a href="classviam_1_1sdk_1_1Arm.html#aeed2dcf6c5f23a31730aec1fdf73db52">viam::sdk::Arm::get_geometries</a></div><div class="ttdeci">virtual std::vector&lt; GeometryConfig &gt; get_geometries(const ProtoStruct &amp;extra)=0</div><div class="ttdoc">Returns GeometryConfigs associated with the calling arm.</div></div>
 <div class="ttc" id="aclassviam_1_1sdk_1_1Arm_html_af09c79cc80ccc6d407065cf69bcaca2a"><div class="ttname"><a href="classviam_1_1sdk_1_1Arm.html#af09c79cc80ccc6d407065cf69bcaca2a">viam::sdk::Arm::get_end_position</a></div><div class="ttdeci">virtual pose get_end_position(const ProtoStruct &amp;extra)=0</div><div class="ttdoc">Get the current position of the end of the arm.</div></div>
 <div class="ttc" id="aclassviam_1_1sdk_1_1Arm_html_afd2ecaaf6572ef29d81b92d2dbd4e1dd"><div class="ttname"><a href="classviam_1_1sdk_1_1Arm.html#afd2ecaaf6572ef29d81b92d2dbd4e1dd">viam::sdk::Arm::api</a></div><div class="ttdeci">API api() const override</div><div class="ttdoc">Returns the API associated with a particular resource.</div></div>
-<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:14</div></div>
+<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="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>

base_8hpp_source.html

@@ -202,7 +202,7 @@
 <div class="ttc" id="aclassviam_1_1sdk_1_1Base_html_acfaf8dcfe35d2a836684c724d775ac21"><div class="ttname"><a href="classviam_1_1sdk_1_1Base.html#acfaf8dcfe35d2a836684c724d775ac21">viam::sdk::Base::set_power</a></div><div class="ttdeci">virtual void set_power(const Vector3 &amp;linear, const Vector3 &amp;angular, const ProtoStruct &amp;extra)=0</div><div class="ttdoc">Sets the linear and angular power of a base -1 -&gt; 1 in terms of power for each direction.</div></div>
 <div class="ttc" id="aclassviam_1_1sdk_1_1Base_html_ad969e703314a8819284d43b22f84b1e6"><div class="ttname"><a href="classviam_1_1sdk_1_1Base.html#ad969e703314a8819284d43b22f84b1e6">viam::sdk::Base::set_velocity</a></div><div class="ttdeci">void set_velocity(const Vector3 &amp;linear, const Vector3 &amp;angular)</div><div class="ttdoc">Set the linear and angular velocity of a base.</div><div class="ttdef"><b>Definition</b> base.hpp:89</div></div>
 <div class="ttc" id="aclassviam_1_1sdk_1_1Base_html_afe3debc2840a61e979eb0f9b3d254cb8"><div class="ttname"><a href="classviam_1_1sdk_1_1Base.html#afe3debc2840a61e979eb0f9b3d254cb8">viam::sdk::Base::api</a></div><div class="ttdeci">API api() const override</div><div class="ttdoc">Returns the API associated with a particular resource.</div></div>
-<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:14</div></div>
+<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>

board_8hpp_source.html

@@ -292,7 +292,7 @@
 <div class="ttc" id="aclassviam_1_1sdk_1_1Board_html_af49ccd23ff2cb5fb88a2bc58596f191d"><div class="ttname"><a href="classviam_1_1sdk_1_1Board.html#af49ccd23ff2cb5fb88a2bc58596f191d">viam::sdk::Board::set_gpio</a></div><div class="ttdeci">virtual void set_gpio(const std::string &amp;pin, bool high, const ProtoStruct &amp;extra)=0</div><div class="ttdoc">Set the gpio high/low state of the given pin on a board.</div></div>
 <div class="ttc" id="aclassviam_1_1sdk_1_1Board_html_afa60b062e7f4ccbb43739b4eef8d3860"><div class="ttname"><a href="classviam_1_1sdk_1_1Board.html#afa60b062e7f4ccbb43739b4eef8d3860">viam::sdk::Board::set_power_mode</a></div><div class="ttdeci">virtual void set_power_mode(power_mode power_mode, const ProtoStruct &amp;extra, const boost::optional&lt; std::chrono::microseconds &gt; &amp;duration={})=0</div><div class="ttdoc">Sets the power consumption mode of the board to the requested setting for the given duration.</div></div>
 <div class="ttc" id="aclassviam_1_1sdk_1_1Board_html_afbff089e26c7d3f959e77561d578c17f"><div class="ttname"><a href="classviam_1_1sdk_1_1Board.html#afbff089e26c7d3f959e77561d578c17f">viam::sdk::Board::get_pwm_duty_cycle</a></div><div class="ttdeci">double get_pwm_duty_cycle(const std::string &amp;pin)</div><div class="ttdoc">Gets the duty cycle of the given pin on a board.</div><div class="ttdef"><b>Definition</b> board.hpp:104</div></div>
-<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:14</div></div>
+<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="astructtick_html"><div class="ttname"><a href="structtick.html">tick</a></div><div class="ttdoc">A board's digital interrupt.</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>

camera_8hpp_source.html

@@ -242,7 +242,7 @@
 <div class="ttc" id="aclassviam_1_1sdk_1_1Camera_html_ad07b74c95a1fb9435323b4bf590112cd"><div class="ttname"><a href="classviam_1_1sdk_1_1Camera.html#ad07b74c95a1fb9435323b4bf590112cd">viam::sdk::Camera::mime_types</a></div><div class="ttdeci">std::vector&lt; std::string &gt; mime_types</div><div class="ttdoc">The supported mime types of the camera— a type alias.</div><div class="ttdef"><b>Definition</b> camera.hpp:49</div></div>
 <div class="ttc" id="aclassviam_1_1sdk_1_1Camera_html_ae1347ee02a13c6027cc7cb166de3b56b"><div class="ttname"><a href="classviam_1_1sdk_1_1Camera.html#ae1347ee02a13c6027cc7cb166de3b56b">viam::sdk::Camera::normalize_mime_type</a></div><div class="ttdeci">static std::string normalize_mime_type(const std::string &amp;str)</div><div class="ttdoc">remove any extra suffix's from the mime type string.</div></div>
 <div class="ttc" id="aclassviam_1_1sdk_1_1Camera_html_af468b148e304181de0c3dc4a00482d3f"><div class="ttname"><a href="classviam_1_1sdk_1_1Camera.html#af468b148e304181de0c3dc4a00482d3f">viam::sdk::Camera::do_command</a></div><div class="ttdeci">virtual ProtoStruct do_command(const ProtoStruct &amp;command)=0</div><div class="ttdoc">Send/receive arbitrary commands to the resource.</div></div>
-<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:14</div></div>
+<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="astructdepth__map_html"><div class="ttname"><a href="structdepth__map.html">depth_map</a></div><div class="ttdoc">Represents the dimensions and depth values of a depth map.</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>

classGizmo-members.html

@@ -85,11 +85,12 @@
   <tr bgcolor="#f0f0f0" class="odd"><td class="entry"><b>do_one_client_stream</b>(std::vector&lt; std::string &gt; arg1)=0 (defined in <a class="el" href="classGizmo.html">Gizmo</a>)</td><td class="entry"><a class="el" href="classGizmo.html">Gizmo</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
   <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>do_one_server_stream</b>(std::string arg1)=0 (defined in <a class="el" href="classGizmo.html">Gizmo</a>)</td><td class="entry"><a class="el" href="classGizmo.html">Gizmo</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
   <tr bgcolor="#f0f0f0" class="odd"><td class="entry"><b>do_two</b>(bool arg1)=0 (defined in <a class="el" href="classGizmo.html">Gizmo</a>)</td><td class="entry"><a class="el" href="classGizmo.html">Gizmo</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_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 bgcolor="#f0f0f0" class="odd"><td class="entry"><b>Gizmo</b>(std::string name) (defined in <a class="el" href="classGizmo.html">Gizmo</a>)</td><td class="entry"><a class="el" href="classGizmo.html">Gizmo</a></td><td class="entry"><span class="mlabel">explicit</span><span class="mlabel">protected</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 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 class="even"><td class="entry"><a class="el" href="classviam_1_1sdk_1_1Component.html#ad7224bb892d0b88ad0f2547850380747">get_resource_name</a>() 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 bgcolor="#f0f0f0" class="odd"><td class="entry"><b>get_resource_name</b>(const std::string &amp;type) const (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">protected</span></td></tr>
+  <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>Gizmo</b>(std::string name) (defined in <a class="el" href="classGizmo.html">Gizmo</a>)</td><td class="entry"><a class="el" href="classGizmo.html">Gizmo</a></td><td class="entry"><span class="mlabel">explicit</span><span class="mlabel">protected</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 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>
 </table></div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>

classGizmo.html

@@ -114,9 +114,9 @@
 virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><b>do_two</b> (bool arg1)=0</td></tr>
 <tr class="separator:ad5f854efd25ca5eb531511702ad7f875"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="inherit_header pub_methods_classviam_1_1sdk_1_1Component"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_classviam_1_1sdk_1_1Component')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classviam_1_1sdk_1_1Component.html">viam::sdk::Component</a></td></tr>
-<tr class="memitem:ae969386d6faa08e81f16fb55ce62aa5d inherit pub_methods_classviam_1_1sdk_1_1Component" id="r_ae969386d6faa08e81f16fb55ce62aa5d"><td class="memItemLeft" align="right" valign="top">viam::common::v1::ResourceName&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classviam_1_1sdk_1_1Component.html#ae969386d6faa08e81f16fb55ce62aa5d">get_resource_name</a> (std::string <a class="el" href="classviam_1_1sdk_1_1Resource.html#a52ea612e31f5c09785b500bd2610d97d">name</a>) const override</td></tr>
-<tr class="memdesc:ae969386d6faa08e81f16fb55ce62aa5d inherit pub_methods_classviam_1_1sdk_1_1Component"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a <code>ResourceName</code> for a particular resource name.  <br /></td></tr>
-<tr class="separator:ae969386d6faa08e81f16fb55ce62aa5d inherit pub_methods_classviam_1_1sdk_1_1Component"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ad7224bb892d0b88ad0f2547850380747 inherit pub_methods_classviam_1_1sdk_1_1Component" id="r_ad7224bb892d0b88ad0f2547850380747"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classviam_1_1sdk_1_1Name.html">Name</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classviam_1_1sdk_1_1Component.html#ad7224bb892d0b88ad0f2547850380747">get_resource_name</a> () const override</td></tr>
+<tr class="memdesc:ad7224bb892d0b88ad0f2547850380747 inherit pub_methods_classviam_1_1sdk_1_1Component"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the <code><a class="el" href="classviam_1_1sdk_1_1Name.html" title="A name for specific instances of resources.">Name</a></code> for a particular resource.  <br /></td></tr>
+<tr class="separator:ad7224bb892d0b88ad0f2547850380747 inherit pub_methods_classviam_1_1sdk_1_1Component"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="inherit_header pub_methods_classviam_1_1sdk_1_1Resource"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_classviam_1_1sdk_1_1Resource')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classviam_1_1sdk_1_1Resource.html">viam::sdk::Resource</a></td></tr>
 <tr class="memitem:abf8ddf617ac01708fb4a8b2a868b27f0 inherit pub_methods_classviam_1_1sdk_1_1Resource" id="r_abf8ddf617ac01708fb4a8b2a868b27f0"><td class="memItemLeft" align="right" valign="top">
 &#160;</td><td class="memItemRight" valign="bottom"><b>Resource</b> (std::string <a class="el" href="classviam_1_1sdk_1_1Resource.html#a52ea612e31f5c09785b500bd2610d97d">name</a>)</td></tr>
@@ -135,6 +135,10 @@
 <tr class="memitem:a4071058aff087e7eab1c480e93ce7a60 inherit pro_methods_classviam_1_1sdk_1_1Component" id="r_a4071058aff087e7eab1c480e93ce7a60"><td class="memItemLeft" align="right" valign="top">
 &#160;</td><td class="memItemRight" valign="bottom"><b>Component</b> (std::string <a class="el" href="classviam_1_1sdk_1_1Resource.html#a52ea612e31f5c09785b500bd2610d97d">name</a>)</td></tr>
 <tr class="separator:a4071058aff087e7eab1c480e93ce7a60 inherit pro_methods_classviam_1_1sdk_1_1Component"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="inherit_header pro_methods_classviam_1_1sdk_1_1Resource"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pro_methods_classviam_1_1sdk_1_1Resource')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classviam_1_1sdk_1_1Resource.html">viam::sdk::Resource</a></td></tr>
+<tr class="memitem:a9888a8a9011bf58157b8c7d8af431225 inherit pro_methods_classviam_1_1sdk_1_1Resource" id="r_a9888a8a9011bf58157b8c7d8af431225"><td class="memItemLeft" align="right" valign="top">
+<a class="el" href="classviam_1_1sdk_1_1Name.html">Name</a>&#160;</td><td class="memItemRight" valign="bottom"><b>get_resource_name</b> (const std::string &amp;type) const</td></tr>
+<tr class="separator:a9888a8a9011bf58157b8c7d8af431225 inherit pro_methods_classviam_1_1sdk_1_1Resource"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 <h2 class="groupheader">Member Function Documentation</h2>
 <a id="acb9f710ab5a26b679a2fdde1be8a13ac" name="acb9f710ab5a26b679a2fdde1be8a13ac"></a>