zoriya/Bomberman
1
0
Fork 0
mirror of https://github.com/zoriya/Bomberman.git synced 2026-06-04 10:44:42 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
Documentation
Bomberman/classBBM_1_1TimerComponent.html
T
AnonymusRaccoon adc7dd8d5c Deploying the documentation
2021-06-26 11:31:13 +00:00

400 lines
26 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Bomberman: BBM::TimerComponent 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">Bomberman
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</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="namespaceBBM.html">BBM</a></li><li class="navelem"><a class="el" href="classBBM_1_1TimerComponent.html">TimerComponent</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="classBBM_1_1TimerComponent-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">BBM::TimerComponent Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="TimerComponent_8hpp_source.html">TimerComponent.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for BBM::TimerComponent:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classBBM_1_1TimerComponent__inherit__graph.svg" width="184" height="404"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
<div class="dynheader">
Collaboration diagram for BBM::TimerComponent:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classBBM_1_1TimerComponent__coll__graph.svg" width="372" height="1256"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</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:a002a2a069ef2cffda16d0a13e2e3c4a8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWAL_1_1Component.html#ad27cb4b0bdc95b6245f6b5a8c56cc78a">Component</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBBM_1_1TimerComponent.html#a002a2a069ef2cffda16d0a13e2e3c4a8">clone</a> (<a class="el" href="classWAL_1_1Entity.html">WAL::Entity</a> &amp;entity) const override</td></tr>
<tr class="memdesc:a002a2a069ef2cffda16d0a13e2e3c4a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clone a component for another or the same entity. <a href="classBBM_1_1TimerComponent.html#a002a2a069ef2cffda16d0a13e2e3c4a8">More...</a><br /></td></tr>
<tr class="separator:a002a2a069ef2cffda16d0a13e2e3c4a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af486c37bf20e572ee75841aa5ec39982"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBBM_1_1TimerComponent.html#af486c37bf20e572ee75841aa5ec39982">TimerComponent</a> (<a class="el" href="classWAL_1_1Entity.html">WAL::Entity</a> &amp;entity, std::chrono::nanoseconds delay)</td></tr>
<tr class="memdesc:af486c37bf20e572ee75841aa5ec39982"><td class="mdescLeft">&#160;</td><td class="mdescRight">A default constructor. <a href="classBBM_1_1TimerComponent.html#af486c37bf20e572ee75841aa5ec39982">More...</a><br /></td></tr>
<tr class="separator:af486c37bf20e572ee75841aa5ec39982"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae159852538f5dd5f1675e2e33b83d258"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBBM_1_1TimerComponent.html#ae159852538f5dd5f1675e2e33b83d258">TimerComponent</a> (<a class="el" href="classWAL_1_1Entity.html">WAL::Entity</a> &amp;entity, std::chrono::nanoseconds delay, const <a class="el" href="classWAL_1_1Callback.html">WAL::Callback</a>&lt; <a class="el" href="classWAL_1_1Entity.html">WAL::Entity</a> &amp;, <a class="el" href="classWAL_1_1Wal.html">WAL::Wal</a> &amp; &gt; &amp;timerCallback)</td></tr>
<tr class="memdesc:ae159852538f5dd5f1675e2e33b83d258"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a timer with a callback. <a href="classBBM_1_1TimerComponent.html#ae159852538f5dd5f1675e2e33b83d258">More...</a><br /></td></tr>
<tr class="separator:ae159852538f5dd5f1675e2e33b83d258"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1c7e578d725c01458303661bffa059fa"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBBM_1_1TimerComponent.html#a1c7e578d725c01458303661bffa059fa">TimerComponent</a> (const <a class="el" href="classBBM_1_1TimerComponent.html">TimerComponent</a> &amp;)=default</td></tr>
<tr class="memdesc:a1c7e578d725c01458303661bffa059fa"><td class="mdescLeft">&#160;</td><td class="mdescRight">A timer component is copy constructable. <a href="classBBM_1_1TimerComponent.html#a1c7e578d725c01458303661bffa059fa">More...</a><br /></td></tr>
<tr class="separator:a1c7e578d725c01458303661bffa059fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab007853700f240c52fd8a9a8f6219ee0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBBM_1_1TimerComponent.html#ab007853700f240c52fd8a9a8f6219ee0">~TimerComponent</a> () override=default</td></tr>
<tr class="memdesc:ab007853700f240c52fd8a9a8f6219ee0"><td class="mdescLeft">&#160;</td><td class="mdescRight">A default destructor. <a href="classBBM_1_1TimerComponent.html#ab007853700f240c52fd8a9a8f6219ee0">More...</a><br /></td></tr>
<tr class="separator:ab007853700f240c52fd8a9a8f6219ee0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7e4c02b20706af34d7debf1497920a18"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classBBM_1_1TimerComponent.html">TimerComponent</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBBM_1_1TimerComponent.html#a7e4c02b20706af34d7debf1497920a18">operator=</a> (const <a class="el" href="classBBM_1_1TimerComponent.html">TimerComponent</a> &amp;)=delete</td></tr>
<tr class="memdesc:a7e4c02b20706af34d7debf1497920a18"><td class="mdescLeft">&#160;</td><td class="mdescRight">A component is not assignable. <a href="classBBM_1_1TimerComponent.html#a7e4c02b20706af34d7debf1497920a18">More...</a><br /></td></tr>
<tr class="separator:a7e4c02b20706af34d7debf1497920a18"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classWAL_1_1Component"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classWAL_1_1Component')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classWAL_1_1Component.html">WAL::Component</a></td></tr>
<tr class="memitem:a155fb97f22714a0f489af7442d7d3253 inherit pub_methods_classWAL_1_1Component"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWAL_1_1Component.html">Component</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWAL_1_1Component.html#a155fb97f22714a0f489af7442d7d3253">operator=</a> (const <a class="el" href="classWAL_1_1Component.html">Component</a> &amp;)=delete</td></tr>
<tr class="memdesc:a155fb97f22714a0f489af7442d7d3253 inherit pub_methods_classWAL_1_1Component"><td class="mdescLeft">&#160;</td><td class="mdescRight">A component can't be assigned. <a href="classWAL_1_1Component.html#a155fb97f22714a0f489af7442d7d3253">More...</a><br /></td></tr>
<tr class="separator:a155fb97f22714a0f489af7442d7d3253 inherit pub_methods_classWAL_1_1Component"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d8e13fdc53a63b0b1f8d15576f98cf8 inherit pub_methods_classWAL_1_1Component"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWAL_1_1Component.html#a3d8e13fdc53a63b0b1f8d15576f98cf8">~Component</a> ()=default</td></tr>
<tr class="memdesc:a3d8e13fdc53a63b0b1f8d15576f98cf8 inherit pub_methods_classWAL_1_1Component"><td class="mdescLeft">&#160;</td><td class="mdescRight">A virtual destructor. <a href="classWAL_1_1Component.html#a3d8e13fdc53a63b0b1f8d15576f98cf8">More...</a><br /></td></tr>
<tr class="separator:a3d8e13fdc53a63b0b1f8d15576f98cf8 inherit pub_methods_classWAL_1_1Component"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4acae0960f4232caf8395b2465dde8cc inherit pub_methods_classWAL_1_1Component"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWAL_1_1Component.html#a4acae0960f4232caf8395b2465dde8cc">onStart</a> ()</td></tr>
<tr class="memdesc:a4acae0960f4232caf8395b2465dde8cc inherit pub_methods_classWAL_1_1Component"><td class="mdescLeft">&#160;</td><td class="mdescRight">The entity or this component has just been enabled. <a href="classWAL_1_1Component.html#a4acae0960f4232caf8395b2465dde8cc">More...</a><br /></td></tr>
<tr class="separator:a4acae0960f4232caf8395b2465dde8cc inherit pub_methods_classWAL_1_1Component"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0f3f4fe54fd06de1e685835977fef050 inherit pub_methods_classWAL_1_1Component"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWAL_1_1Component.html#a0f3f4fe54fd06de1e685835977fef050">onStop</a> ()</td></tr>
<tr class="memdesc:a0f3f4fe54fd06de1e685835977fef050 inherit pub_methods_classWAL_1_1Component"><td class="mdescLeft">&#160;</td><td class="mdescRight">The entity or this component has just been disable. <a href="classWAL_1_1Component.html#a0f3f4fe54fd06de1e685835977fef050">More...</a><br /></td></tr>
<tr class="separator:a0f3f4fe54fd06de1e685835977fef050 inherit pub_methods_classWAL_1_1Component"><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:ac9cdd65bcdae368affe9e8d4ed629cc0"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBBM_1_1TimerComponent.html#ac9cdd65bcdae368affe9e8d4ed629cc0">disabled</a> = false</td></tr>
<tr class="memdesc:ac9cdd65bcdae368affe9e8d4ed629cc0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is the ticking of this component disabled? <a href="classBBM_1_1TimerComponent.html#ac9cdd65bcdae368affe9e8d4ed629cc0">More...</a><br /></td></tr>
<tr class="separator:ac9cdd65bcdae368affe9e8d4ed629cc0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a17a4b756f83895450b3aaee03ead5129"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWAL_1_1Callback.html">WAL::Callback</a>&lt; <a class="el" href="classWAL_1_1Entity.html">WAL::Entity</a> &amp;, <a class="el" href="classWAL_1_1Wal.html">WAL::Wal</a> &amp; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBBM_1_1TimerComponent.html#a17a4b756f83895450b3aaee03ead5129">callback</a></td></tr>
<tr class="memdesc:a17a4b756f83895450b3aaee03ead5129"><td class="mdescLeft">&#160;</td><td class="mdescRight">The callback to call when the timer ring. <a href="classBBM_1_1TimerComponent.html#a17a4b756f83895450b3aaee03ead5129">More...</a><br /></td></tr>
<tr class="separator:a17a4b756f83895450b3aaee03ead5129"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a022b3940c9703087d45d98648d9aa31f"><td class="memItemLeft" align="right" valign="top">std::chrono::nanoseconds&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBBM_1_1TimerComponent.html#a022b3940c9703087d45d98648d9aa31f">ringIn</a></td></tr>
<tr class="memdesc:a022b3940c9703087d45d98648d9aa31f"><td class="mdescLeft">&#160;</td><td class="mdescRight">The ring delay of this timer component. <a href="classBBM_1_1TimerComponent.html#a022b3940c9703087d45d98648d9aa31f">More...</a><br /></td></tr>
<tr class="separator:a022b3940c9703087d45d98648d9aa31f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_methods_classWAL_1_1Component"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classWAL_1_1Component')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classWAL_1_1Component.html">WAL::Component</a></td></tr>
<tr class="memitem:ad27cb4b0bdc95b6245f6b5a8c56cc78a inherit pro_methods_classWAL_1_1Component"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWAL_1_1Component.html#ad27cb4b0bdc95b6245f6b5a8c56cc78a">Component</a> (<a class="el" href="classWAL_1_1Entity.html">Entity</a> &amp;entity)</td></tr>
<tr class="memdesc:ad27cb4b0bdc95b6245f6b5a8c56cc78a inherit pro_methods_classWAL_1_1Component"><td class="mdescLeft">&#160;</td><td class="mdescRight">A component can't be instantiated, it should be derived. <a href="classWAL_1_1Component.html#ad27cb4b0bdc95b6245f6b5a8c56cc78a">More...</a><br /></td></tr>
<tr class="separator:ad27cb4b0bdc95b6245f6b5a8c56cc78a inherit pro_methods_classWAL_1_1Component"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3a3306df3733bfa77c70d789b650984b inherit pro_methods_classWAL_1_1Component"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWAL_1_1Component.html#a3a3306df3733bfa77c70d789b650984b">Component</a> (const <a class="el" href="classWAL_1_1Component.html">Component</a> &amp;)=default</td></tr>
<tr class="memdesc:a3a3306df3733bfa77c70d789b650984b inherit pro_methods_classWAL_1_1Component"><td class="mdescLeft">&#160;</td><td class="mdescRight">A component can't be instantiated, it should be derived. <a href="classWAL_1_1Component.html#a3a3306df3733bfa77c70d789b650984b">More...</a><br /></td></tr>
<tr class="separator:a3a3306df3733bfa77c70d789b650984b inherit pro_methods_classWAL_1_1Component"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_attribs_classWAL_1_1Component"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classWAL_1_1Component')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classWAL_1_1Component.html">WAL::Component</a></td></tr>
<tr class="memitem:a3841f7c8cc4eeb9d1e97b3182976d89f inherit pro_attribs_classWAL_1_1Component"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWAL_1_1Entity.html">Entity</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWAL_1_1Component.html#a3841f7c8cc4eeb9d1e97b3182976d89f">_entity</a></td></tr>
<tr class="memdesc:a3841f7c8cc4eeb9d1e97b3182976d89f inherit pro_attribs_classWAL_1_1Component"><td class="mdescLeft">&#160;</td><td class="mdescRight">The entity that own this component. <a href="classWAL_1_1Component.html#a3841f7c8cc4eeb9d1e97b3182976d89f">More...</a><br /></td></tr>
<tr class="separator:a3841f7c8cc4eeb9d1e97b3182976d89f inherit pro_attribs_classWAL_1_1Component"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="af486c37bf20e572ee75841aa5ec39982"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af486c37bf20e572ee75841aa5ec39982">&#9670;&nbsp;</a></span>TimerComponent() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">BBM::TimerComponent::TimerComponent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classWAL_1_1Entity.html">WAL::Entity</a> &amp;&#160;</td>
<td class="paramname"><em>entity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::chrono::nanoseconds&#160;</td>
<td class="paramname"><em>delay</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>A default constructor. </p>
</div>
</div>
<a id="ae159852538f5dd5f1675e2e33b83d258"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae159852538f5dd5f1675e2e33b83d258">&#9670;&nbsp;</a></span>TimerComponent() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">BBM::TimerComponent::TimerComponent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classWAL_1_1Entity.html">WAL::Entity</a> &amp;&#160;</td>
<td class="paramname"><em>entity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::chrono::nanoseconds&#160;</td>
<td class="paramname"><em>delay</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classWAL_1_1Callback.html">WAL::Callback</a>&lt; <a class="el" href="classWAL_1_1Entity.html">WAL::Entity</a> &amp;, <a class="el" href="classWAL_1_1Wal.html">WAL::Wal</a> &amp; &gt; &amp;&#160;</td>
<td class="paramname"><em>timerCallback</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a timer with a callback. </p>
</div>
</div>
<a id="a1c7e578d725c01458303661bffa059fa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1c7e578d725c01458303661bffa059fa">&#9670;&nbsp;</a></span>TimerComponent() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">BBM::TimerComponent::TimerComponent </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classBBM_1_1TimerComponent.html">TimerComponent</a> &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>A timer component is copy constructable. </p>
</div>
</div>
<a id="ab007853700f240c52fd8a9a8f6219ee0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab007853700f240c52fd8a9a8f6219ee0">&#9670;&nbsp;</a></span>~TimerComponent()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">BBM::TimerComponent::~TimerComponent </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>A default destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a002a2a069ef2cffda16d0a13e2e3c4a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a002a2a069ef2cffda16d0a13e2e3c4a8">&#9670;&nbsp;</a></span>clone()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWAL_1_1Component.html">WAL::Component</a> * BBM::TimerComponent::clone </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classWAL_1_1Entity.html">WAL::Entity</a> &amp;&#160;</td>
<td class="paramname"><em>entity</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Clone a component for another or the same entity. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">entity</td><td>The entity that owns the ne component. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classWAL_1_1Component.html#a0bbee4f657e10fd190a28d15afe63e93">WAL::Component</a>.</p>
</div>
</div>
<a id="a7e4c02b20706af34d7debf1497920a18"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7e4c02b20706af34d7debf1497920a18">&#9670;&nbsp;</a></span>operator=()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classBBM_1_1TimerComponent.html">TimerComponent</a>&amp; BBM::TimerComponent::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classBBM_1_1TimerComponent.html">TimerComponent</a> &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>A component is not assignable. </p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a17a4b756f83895450b3aaee03ead5129"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a17a4b756f83895450b3aaee03ead5129">&#9670;&nbsp;</a></span>callback</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWAL_1_1Callback.html">WAL::Callback</a>&lt;<a class="el" href="classWAL_1_1Entity.html">WAL::Entity</a> &amp;, <a class="el" href="classWAL_1_1Wal.html">WAL::Wal</a> &amp;&gt; BBM::TimerComponent::callback</td>
</tr>
</table>
</div><div class="memdoc">
<p>The callback to call when the timer ring. </p>
</div>
</div>
<a id="ac9cdd65bcdae368affe9e8d4ed629cc0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac9cdd65bcdae368affe9e8d4ed629cc0">&#9670;&nbsp;</a></span>disabled</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool BBM::TimerComponent::disabled = false</td>
</tr>
</table>
</div><div class="memdoc">
<p>Is the ticking of this component disabled? </p>
</div>
</div>
<a id="a022b3940c9703087d45d98648d9aa31f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a022b3940c9703087d45d98648d9aa31f">&#9670;&nbsp;</a></span>ringIn</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::chrono::nanoseconds BBM::TimerComponent::ringIn</td>
</tr>
</table>
</div><div class="memdoc">
<p>The ring delay of this timer component. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>sources/Component/Timer/<a class="el" href="TimerComponent_8hpp_source.html">TimerComponent.hpp</a></li>
<li>sources/Component/Timer/<a class="el" href="TimerComponent_8cpp.html">TimerComponent.cpp</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.17
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink