Mercurial > hg > vamp-website

diff code-doc/structVamp_1_1PluginBase_1_1ParameterDescriptor.html @ 21:cc0be37dc9d3 website

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Updates for 2.0
author cannam
date Tue, 09 Dec 2008 11:02:57 +0000
parents 351c4ebce5f9
children 0976232e353b
line wrap: on
line diff
--- a/code-doc/structVamp_1_1PluginBase_1_1ParameterDescriptor.html	Mon Nov 24 15:17:08 2008 +0000
+++ b/code-doc/structVamp_1_1PluginBase_1_1ParameterDescriptor.html	Tue Dec 09 11:02:57 2008 +0000
@@ -4,7 +4,7 @@
 <link href="doxygen.css" rel="stylesheet" type="text/css">
 <link href="tabs.css" rel="stylesheet" type="text/css">
 </head><body>
-<!-- Generated by Doxygen 1.5.5 -->
+<!-- Generated by Doxygen 1.5.6 -->
 <div class="navigation" id="top">
   <div class="tabs">
     <ul>
@@ -26,15 +26,18 @@
   </div>
 </div>
 <div class="contents">
-<h1>Vamp::PluginBase::ParameterDescriptor Struct Reference</h1><!-- doxytag: class="Vamp::PluginBase::ParameterDescriptor" --><code>#include &lt;<a class="el" href="PluginBase_8h-source.html">PluginBase.h</a>&gt;</code>
+<h1>Vamp::PluginBase::ParameterDescriptor Struct Reference</h1><!-- doxytag: class="Vamp::PluginBase::ParameterDescriptor" --><code>#include &lt;<a class="el" href="vamp-sdk_2PluginBase_8h-source.html">PluginBase.h</a>&gt;</code>
 <p>
 
 <p>
 <a href="structVamp_1_1PluginBase_1_1ParameterDescriptor-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
 
-<p>Definition at line <a class="el" href="PluginBase_8h-source.html#l00125">125</a> of file <a class="el" href="PluginBase_8h-source.html">PluginBase.h</a>.</p>
+<p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00130">130</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p>
 <table border="0" cellpadding="0" cellspacing="0">
 <tr><td></td></tr>
+<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#5b793130e9746b2302317b3c9a9c1395">ParameterDescriptor</a> ()</td></tr>
+
 <tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#116fd9f0dc94c2bc4bbc60b5443c598c">identifier</a></td></tr>
 
@@ -67,6 +70,28 @@
 
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Names for the quantized values.  <a href="#94df96f53835980b4739965007ff222b"></a><br></td></tr>
 </table>
+<hr><h2>Constructor &amp; Destructor Documentation</h2>
+<a class="anchor" name="5b793130e9746b2302317b3c9a9c1395"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::ParameterDescriptor" ref="5b793130e9746b2302317b3c9a9c1395" args="()" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">Vamp::PluginBase::ParameterDescriptor::ParameterDescriptor           </td>
+          <td>(</td>
+          <td class="paramname">          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td><code> [inline]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+<p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00199">199</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p>
+
+</div>
+</div><p>
 <hr><h2>Member Data Documentation</h2>
 <a class="anchor" name="116fd9f0dc94c2bc4bbc60b5443c598c"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::identifier" ref="116fd9f0dc94c2bc4bbc60b5443c598c" args="" -->
 <div class="memitem">
@@ -83,9 +108,9 @@
 The name of the parameter, in computer-usable form. 
 <p>
 Should be reasonably short, and may only contain the characters [a-zA-Z0-9_-]. 
-<p>Definition at line <a class="el" href="PluginBase_8h-source.html#l00132">132</a> of file <a class="el" href="PluginBase_8h-source.html">PluginBase.h</a>.</p>
+<p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00137">137</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p>
 
-<p>Referenced by <a class="el" href="PluginHostAdapter_8cpp-source.html#l00187">Vamp::PluginHostAdapter::getParameterDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p>
+<p>Referenced by <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00124">FixedTempoEstimator::D::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p>
 
 </div>
 </div><p>
@@ -104,9 +129,9 @@
 The human-readable name of the parameter. 
 <p>
 
-<p>Definition at line <a class="el" href="PluginBase_8h-source.html#l00137">137</a> of file <a class="el" href="PluginBase_8h-source.html">PluginBase.h</a>.</p>
+<p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00142">142</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p>
 
-<p>Referenced by <a class="el" href="PluginHostAdapter_8cpp-source.html#l00187">Vamp::PluginHostAdapter::getParameterDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p>
+<p>Referenced by <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00124">FixedTempoEstimator::D::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p>
 
 </div>
 </div><p>
@@ -125,9 +150,9 @@
 A human-readable short text describing the parameter. 
 <p>
 May be empty if the name has said it all already. 
-<p>Definition at line <a class="el" href="PluginBase_8h-source.html#l00143">143</a> of file <a class="el" href="PluginBase_8h-source.html">PluginBase.h</a>.</p>
+<p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00148">148</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p>
 
-<p>Referenced by <a class="el" href="PluginHostAdapter_8cpp-source.html#l00187">Vamp::PluginHostAdapter::getParameterDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p>
+<p>Referenced by <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00124">FixedTempoEstimator::D::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p>
 
 </div>
 </div><p>
@@ -146,9 +171,9 @@
 The unit of the parameter, in human-readable form. 
 <p>
 
-<p>Definition at line <a class="el" href="PluginBase_8h-source.html#l00148">148</a> of file <a class="el" href="PluginBase_8h-source.html">PluginBase.h</a>.</p>
+<p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00153">153</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p>
 
-<p>Referenced by <a class="el" href="PluginHostAdapter_8cpp-source.html#l00187">Vamp::PluginHostAdapter::getParameterDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p>
+<p>Referenced by <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00124">FixedTempoEstimator::D::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p>
 
 </div>
 </div><p>
@@ -167,9 +192,9 @@
 The minimum value of the parameter. 
 <p>
 
-<p>Definition at line <a class="el" href="PluginBase_8h-source.html#l00153">153</a> of file <a class="el" href="PluginBase_8h-source.html">PluginBase.h</a>.</p>
+<p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00158">158</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p>
 
-<p>Referenced by <a class="el" href="PluginHostAdapter_8cpp-source.html#l00187">Vamp::PluginHostAdapter::getParameterDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p>
+<p>Referenced by <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00124">FixedTempoEstimator::D::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p>
 
 </div>
 </div><p>
@@ -188,9 +213,9 @@
 The maximum value of the parameter. 
 <p>
 
-<p>Definition at line <a class="el" href="PluginBase_8h-source.html#l00158">158</a> of file <a class="el" href="PluginBase_8h-source.html">PluginBase.h</a>.</p>
+<p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00163">163</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p>
 
-<p>Referenced by <a class="el" href="PluginHostAdapter_8cpp-source.html#l00187">Vamp::PluginHostAdapter::getParameterDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p>
+<p>Referenced by <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00124">FixedTempoEstimator::D::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p>
 
 </div>
 </div><p>
@@ -209,9 +234,9 @@
 The default value of the parameter. 
 <p>
 The plugin should ensure that parameters have this value on initialisation (i.e. the host is not required to explicitly set parameters if it wants to use their default values). 
-<p>Definition at line <a class="el" href="PluginBase_8h-source.html#l00166">166</a> of file <a class="el" href="PluginBase_8h-source.html">PluginBase.h</a>.</p>
+<p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00171">171</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p>
 
-<p>Referenced by <a class="el" href="PluginHostAdapter_8cpp-source.html#l00187">Vamp::PluginHostAdapter::getParameterDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p>
+<p>Referenced by <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00124">FixedTempoEstimator::D::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p>
 
 </div>
 </div><p>
@@ -230,9 +255,9 @@
 True if the parameter values are quantized to a particular resolution. 
 <p>
 
-<p>Definition at line <a class="el" href="PluginBase_8h-source.html#l00172">172</a> of file <a class="el" href="PluginBase_8h-source.html">PluginBase.h</a>.</p>
+<p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00177">177</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p>
 
-<p>Referenced by <a class="el" href="PluginHostAdapter_8cpp-source.html#l00187">Vamp::PluginHostAdapter::getParameterDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p>
+<p>Referenced by <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00124">FixedTempoEstimator::D::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p>
 
 </div>
 </div><p>
@@ -251,9 +276,7 @@
 Quantization resolution of the parameter values (e.g. 
 <p>
 1.0 if they are all integers). Undefined if isQuantized is false. 
-<p>Definition at line <a class="el" href="PluginBase_8h-source.html#l00179">179</a> of file <a class="el" href="PluginBase_8h-source.html">PluginBase.h</a>.</p>
-
-<p>Referenced by <a class="el" href="PluginHostAdapter_8cpp-source.html#l00187">Vamp::PluginHostAdapter::getParameterDescriptors()</a>.</p>
+<p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00184">184</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p>
 
 </div>
 </div><p>
@@ -273,17 +296,15 @@
 <p>
 If isQuantized is true, this may either be empty or contain one string for each of the quantize steps from minValue up to maxValue inclusive. Undefined if isQuantized is false.<p>
 If these names are provided, they should be shown to the user in preference to the values themselves. The user may never see the actual numeric values unless they are also encoded in the names. 
-<p>Definition at line <a class="el" href="PluginBase_8h-source.html#l00192">192</a> of file <a class="el" href="PluginBase_8h-source.html">PluginBase.h</a>.</p>
-
-<p>Referenced by <a class="el" href="PluginHostAdapter_8cpp-source.html#l00187">Vamp::PluginHostAdapter::getParameterDescriptors()</a>.</p>
+<p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00197">197</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p>
 
 </div>
 </div><p>
 <hr>The documentation for this struct was generated from the following file:<ul>
-<li><a class="el" href="PluginBase_8h-source.html">PluginBase.h</a></ul>
+<li><a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a></ul>
 </div>
-<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jul 9 11:36:10 2008 for VampPluginSDK by&nbsp;
+<hr size="1"><address style="text-align: right;"><small>Generated on Mon Dec 8 14:37:21 2008 for VampPluginSDK by&nbsp;
 <a href="http://www.doxygen.org/index.html">
-<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
+<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
 </body>
 </html>