<!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"/>
<title>SLV2: Collections of values/objects</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">SLV2 <span id="projectnumber">0.6.6</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>Collections of values/objects</h1> </div>
</div>
<div class="contents">
<p>Ordered collections of typed values which are fast for random access by index (i.e.
<a href="#_details">More...</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__slv2__collections.html#ga35cd03984bd0691a0bc34bba236c630b">slv2_plugins_free</a> (SLV2World world, SLV2Plugins plugins)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="group__slv2__collections.html#ga56153ceb788339033aa09608eca46970">slv2_plugins_size</a> (SLV2Plugins plugins)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">SLV2Plugin </td><td class="memItemRight" valign="bottom"><a class="el" href="group__slv2__collections.html#ga6d32f0d3ae66ba3e0b67a1d4866163cd">slv2_plugins_get_by_uri</a> (SLV2Plugins plugins, SLV2Value uri)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">SLV2Plugin </td><td class="memItemRight" valign="bottom"><a class="el" href="group__slv2__collections.html#gafd2c9e947e9c68c3451c6bb9e78aa330">slv2_plugins_get_at</a> (SLV2Plugins plugins, unsigned index)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">SLV2PluginClass </td><td class="memItemRight" valign="bottom"><a class="el" href="group__slv2__collections.html#ga0e00631c2eb0015911193a3aefbd43ae">slv2_plugin_classes_get_by_uri</a> (SLV2PluginClasses classes, SLV2Value uri)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__slv2__collections.html#ga388b3c593f35af97b3810ba9140cf96d">slv2_values_contains</a> (SLV2Values values, SLV2Value value)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">SLV2UI </td><td class="memItemRight" valign="bottom"><a class="el" href="group__slv2__collections.html#ga934838df06bdcc0901412c4fa576e7de">slv2_uis_get_by_uri</a> (SLV2UIs list, SLV2Value uri)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>a fancy array). </p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga35cd03984bd0691a0bc34bba236c630b"></a><!-- doxytag: member="collections.h::slv2_plugins_free" ref="ga35cd03984bd0691a0bc34bba236c630b" args="(SLV2World world, SLV2Plugins plugins)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void slv2_plugins_free </td>
<td>(</td>
<td class="paramtype">SLV2World </td>
<td class="paramname"><em>world</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">SLV2Plugins </td>
<td class="paramname"><em>plugins</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Free a plugin collection. </p>
<p>Freeing a plugin collection does not destroy the plugins it contains (plugins are owned by the world). <em>plugins</em> is invalid after this call. Time = O(1) </p>
</div>
</div>
<a class="anchor" id="ga56153ceb788339033aa09608eca46970"></a><!-- doxytag: member="collections.h::slv2_plugins_size" ref="ga56153ceb788339033aa09608eca46970" args="(SLV2Plugins plugins)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned slv2_plugins_size </td>
<td>(</td>
<td class="paramtype">SLV2Plugins </td>
<td class="paramname"><em>plugins</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the number of plugins in the collection. </p>
<p>Time = O(1) </p>
</div>
</div>
<a class="anchor" id="ga6d32f0d3ae66ba3e0b67a1d4866163cd"></a><!-- doxytag: member="collections.h::slv2_plugins_get_by_uri" ref="ga6d32f0d3ae66ba3e0b67a1d4866163cd" args="(SLV2Plugins plugins, SLV2Value uri)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SLV2Plugin slv2_plugins_get_by_uri </td>
<td>(</td>
<td class="paramtype">SLV2Plugins </td>
<td class="paramname"><em>plugins</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">SLV2Value </td>
<td class="paramname"><em>uri</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a plugin from the collection by URI. </p>
<p>Return value is shared (stored in <em>plugins</em>) and must not be freed or modified by the caller in any way.</p>
<p>Time = O(log2(n))</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>NULL if plugin with <em>url</em> not found in <em>plugins</em>. </dd></dl>
</div>
</div>
<a class="anchor" id="gafd2c9e947e9c68c3451c6bb9e78aa330"></a><!-- doxytag: member="collections.h::slv2_plugins_get_at" ref="gafd2c9e947e9c68c3451c6bb9e78aa330" args="(SLV2Plugins plugins, unsigned index)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SLV2Plugin slv2_plugins_get_at </td>
<td>(</td>
<td class="paramtype">SLV2Plugins </td>
<td class="paramname"><em>plugins</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>index</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a plugin from the plugins by index. </p>
<p><em>index</em> has no significance other than as an index into this plugins. Any <em>index</em> not less than slv2_plugins_get_length(plugins) will return NULL, so all plugins in a plugins can be enumerated by repeated calls to this function starting with <em>index</em> = 0.</p>
<p>Time = O(1)</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>NULL if <em>index</em> out of range. </dd></dl>
</div>
</div>
<a class="anchor" id="ga0e00631c2eb0015911193a3aefbd43ae"></a><!-- doxytag: member="collections.h::slv2_plugin_classes_get_by_uri" ref="ga0e00631c2eb0015911193a3aefbd43ae" args="(SLV2PluginClasses classes, SLV2Value uri)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SLV2PluginClass slv2_plugin_classes_get_by_uri </td>
<td>(</td>
<td class="paramtype">SLV2PluginClasses </td>
<td class="paramname"><em>classes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">SLV2Value </td>
<td class="paramname"><em>uri</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a plugin class from the collection by URI. </p>
<p>Return value is shared (stored in <em>classes</em>) and must not be freed or modified by the caller in any way.</p>
<p>Time = O(log2(n))</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>NULL if plugin with <em>url</em> not found in <em>classes</em>. </dd></dl>
</div>
</div>
<a class="anchor" id="ga388b3c593f35af97b3810ba9140cf96d"></a><!-- doxytag: member="collections.h::slv2_values_contains" ref="ga388b3c593f35af97b3810ba9140cf96d" args="(SLV2Values values, SLV2Value value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool slv2_values_contains </td>
<td>(</td>
<td class="paramtype">SLV2Values </td>
<td class="paramname"><em>values</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">SLV2Value </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return whether <em>values</em> contains <em>value</em>. </p>
<p>Time = O(n) </p>
</div>
</div>
<a class="anchor" id="ga934838df06bdcc0901412c4fa576e7de"></a><!-- doxytag: member="collections.h::slv2_uis_get_by_uri" ref="ga934838df06bdcc0901412c4fa576e7de" args="(SLV2UIs list, SLV2Value uri)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SLV2UI slv2_uis_get_by_uri </td>
<td>(</td>
<td class="paramtype">SLV2UIs </td>
<td class="paramname"><em>list</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">SLV2Value </td>
<td class="paramname"><em>uri</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a plugin from the list by URI. </p>
<p>Return value is shared (stored in <em>list</em>) and must not be freed or modified by the caller in any way.</p>
<p>Time = O(log2(n))</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>NULL if plugin with <em>url</em> not found in <em>list</em>. </dd></dl>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Thu Mar 24 2011 03:54:39 for SLV2 by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
</body>
</html>
