Sophie

Sophie

distrib > Mageia > 5 > i586 > by-pkgid > eb4b034508697cc17e7c9cfffe7f772b > files > 732

uhd-doc-3.7.2-3.mga5.noarch.rpm

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.8"/>
<title>UHD: uhd::sensor_value_t Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">UHD
   &#160;<span id="projectnumber">003.007.002-0-unknown</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.8 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Macros</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceuhd.html">uhd</a></li><li class="navelem"><a class="el" href="structuhd_1_1sensor__value__t.html">sensor_value_t</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structuhd_1_1sensor__value__t-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">uhd::sensor_value_t Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="sensors_8hpp_source.html">sensors.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a1f6bf20f81b094c002bf06e3903a37e1"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structuhd_1_1sensor__value__t.html#a1f6bf20f81b094c002bf06e3903a37e1">data_type_t</a> { <a class="el" href="structuhd_1_1sensor__value__t.html#a1f6bf20f81b094c002bf06e3903a37e1a67990358f836e48528775f518d975469">BOOLEAN</a> = 'b', 
<a class="el" href="structuhd_1_1sensor__value__t.html#a1f6bf20f81b094c002bf06e3903a37e1a4a2aba4eb1ecd810969cc49619d56dd6">INTEGER</a> = 'i', 
<a class="el" href="structuhd_1_1sensor__value__t.html#a1f6bf20f81b094c002bf06e3903a37e1a3229a783186316b52f65c25b778b2092">REALNUM</a> = 'r', 
<a class="el" href="structuhd_1_1sensor__value__t.html#a1f6bf20f81b094c002bf06e3903a37e1adbeee2b0ceac9a9f1aa4ae8ea7fdfc0a">STRING</a> = 's'
 }</td></tr>
<tr class="memdesc:a1f6bf20f81b094c002bf06e3903a37e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enumeration of possible data types in a sensor.  <a href="structuhd_1_1sensor__value__t.html#a1f6bf20f81b094c002bf06e3903a37e1">More...</a><br /></td></tr>
<tr class="separator:a1f6bf20f81b094c002bf06e3903a37e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aae71375d044230a276cc1e388a121431"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structuhd_1_1sensor__value__t.html#aae71375d044230a276cc1e388a121431">sensor_value_t</a> (const std::string &amp;<a class="el" href="structuhd_1_1sensor__value__t.html#ab4b8d5a3fd84787ab0e4412ba506bec9">name</a>, bool <a class="el" href="structuhd_1_1sensor__value__t.html#a666232ef39d59354a0b1fd86729e46f5">value</a>, const std::string &amp;utrue, const std::string &amp;ufalse)</td></tr>
<tr class="separator:aae71375d044230a276cc1e388a121431"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5d69fb116f970f6ac48df00b72e537d6"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structuhd_1_1sensor__value__t.html#a5d69fb116f970f6ac48df00b72e537d6">sensor_value_t</a> (const std::string &amp;<a class="el" href="structuhd_1_1sensor__value__t.html#ab4b8d5a3fd84787ab0e4412ba506bec9">name</a>, signed <a class="el" href="structuhd_1_1sensor__value__t.html#a666232ef39d59354a0b1fd86729e46f5">value</a>, const std::string &amp;<a class="el" href="structuhd_1_1sensor__value__t.html#a8d5dc734f949f0a47dd9b79ff0027848">unit</a>, const std::string &amp;formatter=&quot;%d&quot;)</td></tr>
<tr class="separator:a5d69fb116f970f6ac48df00b72e537d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab9386893a66633a42d1db12cb2e26201"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structuhd_1_1sensor__value__t.html#ab9386893a66633a42d1db12cb2e26201">sensor_value_t</a> (const std::string &amp;<a class="el" href="structuhd_1_1sensor__value__t.html#ab4b8d5a3fd84787ab0e4412ba506bec9">name</a>, double <a class="el" href="structuhd_1_1sensor__value__t.html#a666232ef39d59354a0b1fd86729e46f5">value</a>, const std::string &amp;<a class="el" href="structuhd_1_1sensor__value__t.html#a8d5dc734f949f0a47dd9b79ff0027848">unit</a>, const std::string &amp;formatter=&quot;%f&quot;)</td></tr>
<tr class="separator:ab9386893a66633a42d1db12cb2e26201"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa876b287a1bb599fda6f734071444a7b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structuhd_1_1sensor__value__t.html#aa876b287a1bb599fda6f734071444a7b">sensor_value_t</a> (const std::string &amp;<a class="el" href="structuhd_1_1sensor__value__t.html#ab4b8d5a3fd84787ab0e4412ba506bec9">name</a>, const std::string &amp;<a class="el" href="structuhd_1_1sensor__value__t.html#a666232ef39d59354a0b1fd86729e46f5">value</a>, const std::string &amp;<a class="el" href="structuhd_1_1sensor__value__t.html#a8d5dc734f949f0a47dd9b79ff0027848">unit</a>)</td></tr>
<tr class="separator:aa876b287a1bb599fda6f734071444a7b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7f13d9bb325c9086e81696b87a8eb000"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structuhd_1_1sensor__value__t.html#a7f13d9bb325c9086e81696b87a8eb000">to_bool</a> (void) const </td></tr>
<tr class="memdesc:a7f13d9bb325c9086e81696b87a8eb000"><td class="mdescLeft">&#160;</td><td class="mdescRight">convert the sensor value to a boolean  <a href="#a7f13d9bb325c9086e81696b87a8eb000">More...</a><br /></td></tr>
<tr class="separator:a7f13d9bb325c9086e81696b87a8eb000"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a09400ec176747fdecaf3cda5edfb97b0"><td class="memItemLeft" align="right" valign="top">signed&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structuhd_1_1sensor__value__t.html#a09400ec176747fdecaf3cda5edfb97b0">to_int</a> (void) const </td></tr>
<tr class="memdesc:a09400ec176747fdecaf3cda5edfb97b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">convert the sensor value to an integer  <a href="#a09400ec176747fdecaf3cda5edfb97b0">More...</a><br /></td></tr>
<tr class="separator:a09400ec176747fdecaf3cda5edfb97b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8214aaebee9b354ca986f73a8e08ce75"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structuhd_1_1sensor__value__t.html#a8214aaebee9b354ca986f73a8e08ce75">to_real</a> (void) const </td></tr>
<tr class="memdesc:a8214aaebee9b354ca986f73a8e08ce75"><td class="mdescLeft">&#160;</td><td class="mdescRight">convert the sensor value to real number  <a href="#a8214aaebee9b354ca986f73a8e08ce75">More...</a><br /></td></tr>
<tr class="separator:a8214aaebee9b354ca986f73a8e08ce75"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa89abff3fbdbd8e21e7a8d1b6ca3b7e9"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structuhd_1_1sensor__value__t.html#aa89abff3fbdbd8e21e7a8d1b6ca3b7e9">to_pp_string</a> (void) const </td></tr>
<tr class="memdesc:aa89abff3fbdbd8e21e7a8d1b6ca3b7e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert this sensor value into a printable string.  <a href="#aa89abff3fbdbd8e21e7a8d1b6ca3b7e9">More...</a><br /></td></tr>
<tr class="separator:aa89abff3fbdbd8e21e7a8d1b6ca3b7e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:ab4b8d5a3fd84787ab0e4412ba506bec9"><td class="memItemLeft" align="right" valign="top">const std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structuhd_1_1sensor__value__t.html#ab4b8d5a3fd84787ab0e4412ba506bec9">name</a></td></tr>
<tr class="memdesc:ab4b8d5a3fd84787ab0e4412ba506bec9"><td class="mdescLeft">&#160;</td><td class="mdescRight">The name of the sensor value.  <a href="#ab4b8d5a3fd84787ab0e4412ba506bec9">More...</a><br /></td></tr>
<tr class="separator:ab4b8d5a3fd84787ab0e4412ba506bec9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a666232ef39d59354a0b1fd86729e46f5"><td class="memItemLeft" align="right" valign="top">const std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structuhd_1_1sensor__value__t.html#a666232ef39d59354a0b1fd86729e46f5">value</a></td></tr>
<tr class="separator:a666232ef39d59354a0b1fd86729e46f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d5dc734f949f0a47dd9b79ff0027848"><td class="memItemLeft" align="right" valign="top">const std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structuhd_1_1sensor__value__t.html#a8d5dc734f949f0a47dd9b79ff0027848">unit</a></td></tr>
<tr class="separator:a8d5dc734f949f0a47dd9b79ff0027848"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa3ecb2fbe3f59e41b236b5eaa03b2722"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structuhd_1_1sensor__value__t.html#a1f6bf20f81b094c002bf06e3903a37e1">data_type_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structuhd_1_1sensor__value__t.html#aa3ecb2fbe3f59e41b236b5eaa03b2722">type</a></td></tr>
<tr class="memdesc:aa3ecb2fbe3f59e41b236b5eaa03b2722"><td class="mdescLeft">&#160;</td><td class="mdescRight">The data type of the value.  <a href="#aa3ecb2fbe3f59e41b236b5eaa03b2722">More...</a><br /></td></tr>
<tr class="separator:aa3ecb2fbe3f59e41b236b5eaa03b2722"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A sensor value stores a sensor reading as a string with unit and data type. The sensor value class can be used in the following way:</p>
<p><a class="el" href="structuhd_1_1sensor__value__t.html">sensor_value_t</a> ref_lock_sensor("Reference", my_lock, "unlocked", "locked"); std::cout &lt;&lt; ref_lock_sensor.to_pp_string() &lt;&lt; std::endl; //prints Reference: locked</p>
<p><a class="el" href="structuhd_1_1sensor__value__t.html">sensor_value_t</a> temp_sensor("Temperature", my_temp, "C"); std::cout &lt;&lt; temp_sensor.to_pp_string() &lt;&lt; std::endl; //prints Temperature: 38.5 C </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a class="anchor" id="a1f6bf20f81b094c002bf06e3903a37e1"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="structuhd_1_1sensor__value__t.html#a1f6bf20f81b094c002bf06e3903a37e1">uhd::sensor_value_t::data_type_t</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Enumeration of possible data types in a sensor. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="a1f6bf20f81b094c002bf06e3903a37e1a67990358f836e48528775f518d975469"></a>BOOLEAN&#160;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a1f6bf20f81b094c002bf06e3903a37e1a4a2aba4eb1ecd810969cc49619d56dd6"></a>INTEGER&#160;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a1f6bf20f81b094c002bf06e3903a37e1a3229a783186316b52f65c25b778b2092"></a>REALNUM&#160;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a1f6bf20f81b094c002bf06e3903a37e1adbeee2b0ceac9a9f1aa4ae8ea7fdfc0a"></a>STRING&#160;</td><td class="fielddoc">
</td></tr>
</table>

</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="aae71375d044230a276cc1e388a121431"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uhd::sensor_value_t::sensor_value_t </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>value</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>utrue</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>ufalse</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Create a sensor value from a boolean. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>the name of the sensor </td></tr>
    <tr><td class="paramname">value</td><td>the value true or false </td></tr>
    <tr><td class="paramname">utrue</td><td>the unit string when value is true </td></tr>
    <tr><td class="paramname">ufalse</td><td>the unit string when value is false </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a5d69fb116f970f6ac48df00b72e537d6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uhd::sensor_value_t::sensor_value_t </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">signed&#160;</td>
          <td class="paramname"><em>value</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>unit</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>formatter</em> = <code>&quot;%d&quot;</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Create a sensor value from an integer. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>the name of the sensor </td></tr>
    <tr><td class="paramname">value</td><td>the signed integer value </td></tr>
    <tr><td class="paramname">unit</td><td>the associated unit type </td></tr>
    <tr><td class="paramname">formatter</td><td>the formatter string </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="ab9386893a66633a42d1db12cb2e26201"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uhd::sensor_value_t::sensor_value_t </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>value</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>unit</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>formatter</em> = <code>&quot;%f&quot;</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Create a sensor value from a real number. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>the name of the sensor </td></tr>
    <tr><td class="paramname">value</td><td>the real number value </td></tr>
    <tr><td class="paramname">unit</td><td>the associated unit type </td></tr>
    <tr><td class="paramname">formatter</td><td>the formatter string </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="aa876b287a1bb599fda6f734071444a7b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uhd::sensor_value_t::sensor_value_t </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>value</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>unit</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Create a sensor value from a string. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>the name of the sensor </td></tr>
    <tr><td class="paramname">value</td><td>the real number value </td></tr>
    <tr><td class="paramname">unit</td><td>the associated unit type </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a7f13d9bb325c9086e81696b87a8eb000"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool uhd::sensor_value_t::to_bool </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>convert the sensor value to a boolean </p>

</div>
</div>
<a class="anchor" id="a09400ec176747fdecaf3cda5edfb97b0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">signed uhd::sensor_value_t::to_int </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>convert the sensor value to an integer </p>

</div>
</div>
<a class="anchor" id="aa89abff3fbdbd8e21e7a8d1b6ca3b7e9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::string uhd::sensor_value_t::to_pp_string </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Convert this sensor value into a printable string. </p>

</div>
</div>
<a class="anchor" id="a8214aaebee9b354ca986f73a8e08ce75"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double uhd::sensor_value_t::to_real </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>convert the sensor value to real number </p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="ab4b8d5a3fd84787ab0e4412ba506bec9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const std::string uhd::sensor_value_t::name</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The name of the sensor value. </p>

</div>
</div>
<a class="anchor" id="aa3ecb2fbe3f59e41b236b5eaa03b2722"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="structuhd_1_1sensor__value__t.html#a1f6bf20f81b094c002bf06e3903a37e1">data_type_t</a> uhd::sensor_value_t::type</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The data type of the value. </p>

</div>
</div>
<a class="anchor" id="a8d5dc734f949f0a47dd9b79ff0027848"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const std::string uhd::sensor_value_t::unit</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The sensor value's unit type. For boolean types, this will be the one of the two units depending upon the value of the boolean true or false. </p>

</div>
</div>
<a class="anchor" id="a666232ef39d59354a0b1fd86729e46f5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const std::string uhd::sensor_value_t::value</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The sensor value as a string. For integer and real number types, this will be the output of the formatter. For boolean types, the value will be the string literal "true" or "false". </p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/uhd/types/<a class="el" href="sensors_8hpp_source.html">sensors.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Oct 15 2014 11:47:53 for UHD by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.8
</small></address>
</body>
</html>