/usr/share/doc/libjuce/apiref/classRuleBasedTopologySource.html is in libjuce-doc 4.3.0~repack-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 | <!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.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>JUCE: RuleBasedTopologySource 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">JUCE
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<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><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="classRuleBasedTopologySource-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">RuleBasedTopologySource Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This topology source holds and applies a set of rules for transforming one device topology into another one that may involve virtual and/or aggregate devices.
<a href="classRuleBasedTopologySource.html#details">More...</a></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 RuleBasedTopologySource:</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="classRuleBasedTopologySource.png" usemap="#RuleBasedTopologySource_map" alt=""/>
<map id="RuleBasedTopologySource_map" name="RuleBasedTopologySource_map">
<area href="classTopologySource.html" title="Base class for an entity that provides access to a blocks topology. " alt="TopologySource" shape="rect" coords="0,0,165,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structRuleBasedTopologySource_1_1Rule.html">Rule</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A rule that can transform parts of a topology. <a href="structRuleBasedTopologySource_1_1Rule.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </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:adc0c4f1a888357aa51f14a440f31aa2d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRuleBasedTopologySource.html#adc0c4f1a888357aa51f14a440f31aa2d">RuleBasedTopologySource</a> (<a class="el" href="classTopologySource.html">TopologySource</a> &)</td></tr>
<tr class="memdesc:adc0c4f1a888357aa51f14a440f31aa2d"><td class="mdescLeft"> </td><td class="mdescRight">Creates a <a class="el" href="classRuleBasedTopologySource.html" title="This topology source holds and applies a set of rules for transforming one device topology into anoth...">RuleBasedTopologySource</a> which wraps another <a class="el" href="classTopologySource.html" title="Base class for an entity that provides access to a blocks topology. ">TopologySource</a> passed in here. <a href="#adc0c4f1a888357aa51f14a440f31aa2d">More...</a><br /></td></tr>
<tr class="separator:adc0c4f1a888357aa51f14a440f31aa2d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac56f643544fbafbdf55ec28858398485"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRuleBasedTopologySource.html#ac56f643544fbafbdf55ec28858398485">~RuleBasedTopologySource</a> ()</td></tr>
<tr class="memdesc:ac56f643544fbafbdf55ec28858398485"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#ac56f643544fbafbdf55ec28858398485">More...</a><br /></td></tr>
<tr class="separator:ac56f643544fbafbdf55ec28858398485"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8421667b65f76e0393629b1eaa4546c4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structBlockTopology.html">BlockTopology</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRuleBasedTopologySource.html#a8421667b65f76e0393629b1eaa4546c4">getCurrentTopology</a> () const</td></tr>
<tr class="memdesc:a8421667b65f76e0393629b1eaa4546c4"><td class="mdescLeft"> </td><td class="mdescRight">Returns the currently active topology. <a href="#a8421667b65f76e0393629b1eaa4546c4">More...</a><br /></td></tr>
<tr class="separator:a8421667b65f76e0393629b1eaa4546c4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac2e356922f970bc90a49e61149718b73"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRuleBasedTopologySource.html#ac2e356922f970bc90a49e61149718b73">clearRules</a> ()</td></tr>
<tr class="memdesc:ac2e356922f970bc90a49e61149718b73"><td class="mdescLeft"> </td><td class="mdescRight">Clears the list of active rules. <a href="#ac2e356922f970bc90a49e61149718b73">More...</a><br /></td></tr>
<tr class="separator:ac2e356922f970bc90a49e61149718b73"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0ddf97d142e900ddd8800887a259c134"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRuleBasedTopologySource.html#a0ddf97d142e900ddd8800887a259c134">addRule</a> (<a class="el" href="structRuleBasedTopologySource_1_1Rule.html">Rule</a> *)</td></tr>
<tr class="memdesc:a0ddf97d142e900ddd8800887a259c134"><td class="mdescLeft"> </td><td class="mdescRight">Adds a rule to the list that will be applied. <a href="#a0ddf97d142e900ddd8800887a259c134">More...</a><br /></td></tr>
<tr class="separator:a0ddf97d142e900ddd8800887a259c134"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classTopologySource"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classTopologySource')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classTopologySource.html">TopologySource</a></td></tr>
<tr class="memitem:ade15ca0fdbe3f3b18dc587efce4cd22e inherit pub_methods_classTopologySource"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classTopologySource.html#ade15ca0fdbe3f3b18dc587efce4cd22e">~TopologySource</a> ()</td></tr>
<tr class="memdesc:ade15ca0fdbe3f3b18dc587efce4cd22e inherit pub_methods_classTopologySource"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="classTopologySource.html#ade15ca0fdbe3f3b18dc587efce4cd22e">More...</a><br /></td></tr>
<tr class="separator:ade15ca0fdbe3f3b18dc587efce4cd22e inherit pub_methods_classTopologySource"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a69466671a2d86f6eb2cc7581a3d33673 inherit pub_methods_classTopologySource"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTopologySource.html#a69466671a2d86f6eb2cc7581a3d33673">addListener</a> (<a class="el" href="structTopologySource_1_1Listener.html">Listener</a> *l)</td></tr>
<tr class="separator:a69466671a2d86f6eb2cc7581a3d33673 inherit pub_methods_classTopologySource"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a22c80cc4169578b03a30b94f17744955 inherit pub_methods_classTopologySource"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTopologySource.html#a22c80cc4169578b03a30b94f17744955">removeListener</a> (<a class="el" href="structTopologySource_1_1Listener.html">Listener</a> *l)</td></tr>
<tr class="separator:a22c80cc4169578b03a30b94f17744955 inherit pub_methods_classTopologySource"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a17364736db6eb6d0dd40a2caccd8f2e0 inherit pub_methods_classTopologySource"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTopologySource.html#a17364736db6eb6d0dd40a2caccd8f2e0">cancelAllActiveTouches</a> () noexcept</td></tr>
<tr class="memdesc:a17364736db6eb6d0dd40a2caccd8f2e0 inherit pub_methods_classTopologySource"><td class="mdescLeft"> </td><td class="mdescRight">Invoke this to force touches-off on all physical devices. <a href="classTopologySource.html#a17364736db6eb6d0dd40a2caccd8f2e0">More...</a><br /></td></tr>
<tr class="separator:a17364736db6eb6d0dd40a2caccd8f2e0 inherit pub_methods_classTopologySource"><td class="memSeparator" colspan="2"> </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_attribs_classTopologySource"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classTopologySource')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classTopologySource.html">TopologySource</a></td></tr>
<tr class="memitem:a3c9f12605642baff76d5da04e9452b3d inherit pro_attribs_classTopologySource"><td class="memItemLeft" align="right" valign="top">juce::ListenerList< <a class="el" href="structTopologySource_1_1Listener.html">Listener</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classTopologySource.html#a3c9f12605642baff76d5da04e9452b3d">listeners</a></td></tr>
<tr class="separator:a3c9f12605642baff76d5da04e9452b3d inherit pro_attribs_classTopologySource"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This topology source holds and applies a set of rules for transforming one device topology into another one that may involve virtual and/or aggregate devices. </p>
<p>Given an input <a class="el" href="classPhysicalTopologySource.html" title="This topology source manages the topology of the physical Blocks devices that are currently connected...">PhysicalTopologySource</a> and a set of <a class="el" href="structRuleBasedTopologySource_1_1Rule.html" title="A rule that can transform parts of a topology. ">Rule</a> objects, this class will apply the rules and present the resulting topology to clients. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="adc0c4f1a888357aa51f14a440f31aa2d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adc0c4f1a888357aa51f14a440f31aa2d">§ </a></span>RuleBasedTopologySource()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">RuleBasedTopologySource::RuleBasedTopologySource </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTopologySource.html">TopologySource</a> & </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a <a class="el" href="classRuleBasedTopologySource.html" title="This topology source holds and applies a set of rules for transforming one device topology into anoth...">RuleBasedTopologySource</a> which wraps another <a class="el" href="classTopologySource.html" title="Base class for an entity that provides access to a blocks topology. ">TopologySource</a> passed in here. </p>
</div>
</div>
<a id="ac56f643544fbafbdf55ec28858398485"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac56f643544fbafbdf55ec28858398485">§ </a></span>~RuleBasedTopologySource()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">RuleBasedTopologySource::~RuleBasedTopologySource </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a8421667b65f76e0393629b1eaa4546c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8421667b65f76e0393629b1eaa4546c4">§ </a></span>getCurrentTopology()</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="structBlockTopology.html">BlockTopology</a> RuleBasedTopologySource::getCurrentTopology </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the currently active topology. </p>
<p>Implements <a class="el" href="classTopologySource.html#a11df0f2057673fea795dec66428d465b">TopologySource</a>.</p>
</div>
</div>
<a id="ac2e356922f970bc90a49e61149718b73"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac2e356922f970bc90a49e61149718b73">§ </a></span>clearRules()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RuleBasedTopologySource::clearRules </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Clears the list of active rules. </p>
<p>Calling this method will cause an asynchronous topology update if the new rule-set results in a change to the topology. </p>
<p>Referenced by <a class="el" href="structRuleBasedTopologySource_1_1Rule.html#aff9c2f0ed4c1ac8b286f6d7304490b31">RuleBasedTopologySource::Rule::~Rule()</a>.</p>
</div>
</div>
<a id="a0ddf97d142e900ddd8800887a259c134"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0ddf97d142e900ddd8800887a259c134">§ </a></span>addRule()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RuleBasedTopologySource::addRule </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structRuleBasedTopologySource_1_1Rule.html">Rule</a> * </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds a rule to the list that will be applied. </p>
<p>The object passed-in will be owned by this object, so don't keep any references to it. Calling this method will cause an asynchronous topology update if the new rule-set results in a change to the topology. </p>
<p>Referenced by <a class="el" href="structRuleBasedTopologySource_1_1Rule.html#aff9c2f0ed4c1ac8b286f6d7304490b31">RuleBasedTopologySource::Rule::~Rule()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__RuleBasedTopologySource_8h.html">juce_RuleBasedTopologySource.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|