classhueplusplus_1_1_brightness_strategy.html 13.5 KB

Edit Raw Blame History Permalink

<!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>hueplusplus: hueplusplus::BrightnessStrategy Class 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/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></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 id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">hueplusplus
   &#160;<span id="projectnumber">1.0.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</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="namespacehueplusplus.html">hueplusplus</a></li><li class="navelem"><a class="el" href="classhueplusplus_1_1_brightness_strategy.html">BrightnessStrategy</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classhueplusplus_1_1_brightness_strategy-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">hueplusplus::BrightnessStrategy Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">

<p>Virtual base class for all BrightnessStrategies.
 <a href="classhueplusplus_1_1_brightness_strategy.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_brightness_strategy_8h_source.html">hueplusplus/BrightnessStrategy.h</a>&gt;</code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for hueplusplus::BrightnessStrategy:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classhueplusplus_1_1_brightness_strategy__inherit__graph.png" border="0" usemap="#hueplusplus_1_1_brightness_strategy_inherit__map" alt="Inheritance graph"/></div>
<map name="hueplusplus_1_1_brightness_strategy_inherit__map" id="hueplusplus_1_1_brightness_strategy_inherit__map">
<area shape="rect" id="node2" href="classhueplusplus_1_1_simple_brightness_strategy.html" title="Class implementing the functions of BrightnessStrategy. " alt="" coords="10,80,233,121"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<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:a2b1aa7994c5fa8cbfc20e59c4bb133ad"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_brightness_strategy.html#a2b1aa7994c5fa8cbfc20e59c4bb133ad">setBrightness</a> (unsigned int bri, uint8_t transition, <a class="el" href="classhueplusplus_1_1_light.html">Light</a> &amp;light) const =0</td></tr>
<tr class="memdesc:a2b1aa7994c5fa8cbfc20e59c4bb133ad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Virtual function for changing a lights brightness with a specified transition.  <a href="#a2b1aa7994c5fa8cbfc20e59c4bb133ad">More...</a><br /></td></tr>
<tr class="separator:a2b1aa7994c5fa8cbfc20e59c4bb133ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aff420173a780d5bdcabdf46938bb3cb8"><td class="memItemLeft" align="right" valign="top">virtual unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_brightness_strategy.html#aff420173a780d5bdcabdf46938bb3cb8">getBrightness</a> (<a class="el" href="classhueplusplus_1_1_light.html">Light</a> &amp;light) const =0</td></tr>
<tr class="memdesc:aff420173a780d5bdcabdf46938bb3cb8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Virtual function that returns the current brightnessof the light.  <a href="#aff420173a780d5bdcabdf46938bb3cb8">More...</a><br /></td></tr>
<tr class="separator:aff420173a780d5bdcabdf46938bb3cb8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a48832602c53d6921a9c0a7cf0d7789e3"><td class="memItemLeft" align="right" valign="top">virtual unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_brightness_strategy.html#a48832602c53d6921a9c0a7cf0d7789e3">getBrightness</a> (const <a class="el" href="classhueplusplus_1_1_light.html">Light</a> &amp;light) const =0</td></tr>
<tr class="memdesc:a48832602c53d6921a9c0a7cf0d7789e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Virtual function that returns the current brightness of the light.  <a href="#a48832602c53d6921a9c0a7cf0d7789e3">More...</a><br /></td></tr>
<tr class="separator:a48832602c53d6921a9c0a7cf0d7789e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a533d29c87d26c662582f2fb52978e80b"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_brightness_strategy.html#a533d29c87d26c662582f2fb52978e80b">~BrightnessStrategy</a> ()=default</td></tr>
<tr class="memdesc:a533d29c87d26c662582f2fb52978e80b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Virtual dtor.  <a href="#a533d29c87d26c662582f2fb52978e80b">More...</a><br /></td></tr>
<tr class="separator:a533d29c87d26c662582f2fb52978e80b"><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>Virtual base class for all BrightnessStrategies. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a533d29c87d26c662582f2fb52978e80b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a533d29c87d26c662582f2fb52978e80b">&#9670;&nbsp;</a></span>~BrightnessStrategy()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual hueplusplus::BrightnessStrategy::~BrightnessStrategy </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Virtual dtor. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aff420173a780d5bdcabdf46938bb3cb8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff420173a780d5bdcabdf46938bb3cb8">&#9670;&nbsp;</a></span>getBrightness() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual unsigned int hueplusplus::BrightnessStrategy::getBrightness </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classhueplusplus_1_1_light.html">Light</a> &amp;&#160;</td>
          <td class="paramname"><em>light</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Virtual function that returns the current brightnessof the light. </p>
<p>Should update the lights state by calling refreshState() </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">light</td><td>A reference of the light </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Unsigned int representing the brightness </dd></dl>

<p>Implemented in <a class="el" href="classhueplusplus_1_1_simple_brightness_strategy.html#a8e9c818098ffc9501d3f0b3fcc25ae6b">hueplusplus::SimpleBrightnessStrategy</a>.</p>

</div>
</div>
<a id="a48832602c53d6921a9c0a7cf0d7789e3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a48832602c53d6921a9c0a7cf0d7789e3">&#9670;&nbsp;</a></span>getBrightness() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual unsigned int hueplusplus::BrightnessStrategy::getBrightness </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classhueplusplus_1_1_light.html">Light</a> &amp;&#160;</td>
          <td class="paramname"><em>light</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Virtual function that returns the current brightness of the light. </p>
<dl class="section note"><dt>Note</dt><dd>This should not update the lights state </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">light</td><td>A const reference of the light </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Unsigned int representing the brightness </dd></dl>

<p>Implemented in <a class="el" href="classhueplusplus_1_1_simple_brightness_strategy.html#a5b7e947195fc285d15f32a07e1484cd8">hueplusplus::SimpleBrightnessStrategy</a>.</p>

</div>
</div>
<a id="a2b1aa7994c5fa8cbfc20e59c4bb133ad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2b1aa7994c5fa8cbfc20e59c4bb133ad">&#9670;&nbsp;</a></span>setBrightness()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool hueplusplus::BrightnessStrategy::setBrightness </td>
          <td>(</td>
          <td class="paramtype">unsigned int&#160;</td>
          <td class="paramname"><em>bri</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>transition</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classhueplusplus_1_1_light.html">Light</a> &amp;&#160;</td>
          <td class="paramname"><em>light</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Virtual function for changing a lights brightness with a specified transition. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">bri</td><td>The brightness raning from 0 = off to 255 = fully lit </td></tr>
    <tr><td class="paramname">transition</td><td>The time it takes to fade to the new brightness in multiples of 100ms, 4 = 400ms and should be seen as the default </td></tr>
    <tr><td class="paramname">light</td><td>A reference of the light </td></tr>
  </table>
  </dd>
</dl>

<p>Implemented in <a class="el" href="classhueplusplus_1_1_simple_brightness_strategy.html#a672760ff447c05b23c932b61fb862a61">hueplusplus::SimpleBrightnessStrategy</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/hueplusplus/<a class="el" href="_brightness_strategy_8h_source.html">BrightnessStrategy.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>