[Kst] www/areas/extragear/apps/kst/kstscript/docs
Andrew Walker
arwalker at sumusltd.com
Tue Feb 24 20:21:06 CET 2009
SVN commit 931094 by arwalker:
update DataVector kstScript documentation
M +70 -5 DataVector.html
--- trunk/www/areas/extragear/apps/kst/kstscript/docs/DataVector.html #931093:931094
@@ -17,10 +17,10 @@
Inherits: <a class="link" href="Vector.html">Vector</a><br>
</div>
<br><span class="title">Constructors:</span><ul>
-<a class="link" href="#constructor_1">DataVector</a> ( source, field [, start [, n [, skip [, ave]]]] )<br>
+<a class="link" href="#constructor_1">DataVector</a> ( source, field [, start [, n [, skip [, ave]]]] )<br><a class="link" href="#constructor_2">DataVector</a> ( source, field, typeStart, r, typeCount, count [, skip [, ave]] )<br>
</ul>
<span class="title">Methods:</span><ul>
-<a class="link" href="#method_reload">reload</a> ( )<br><a class="link" href="#method_changeFile">changeFile</a> ( source )<br><a class="link" href="#method_changeFrames">changeFrames</a> ( start, count [, skip [, ave]] )<br><a class="link" href="#method_changeFramesByTime">changeFramesByTime</a> ( typeStart, start, typeCount, count [, skip [, ave]] )<br>
+<a class="link" href="#method_reload">reload</a> ( )<br><a class="link" href="#method_changeFile">changeFile</a> ( source )<br><a class="link" href="#method_changeFrames">changeFrames</a> ( start, count [, skip [, ave]] )<br><a class="link" href="#method_changeFramesByTime">changeFramesByTime</a> ( typeStart, r, typeCount, count [, skip [, ave]] )<br>
</ul>
<span class="title">Properties:</span><ul>
<a class="link" href="#property_valid">valid</a><br><a class="link" href="#property_skip">skip</a><br><a class="link" href="#property_boxcar">boxcar</a><br><a class="link" href="#property_readToEnd">readToEnd</a><br><a class="link" href="#property_countFromEnd">countFromEnd</a><br><a class="link" href="#property_skipLength">skipLength</a><br><a class="link" href="#property_startFrame">startFrame</a><br><a class="link" href="#property_startFrameRequested">startFrameRequested</a><br><a class="link" href="#property_frames">frames</a><br><a class="link" href="#property_framesRequested">framesRequested</a><br><a class="link" href="#property_samplesPerFrame">samplesPerFrame</a><br><a class="link" href="#property_field">field</a><br><a class="link" href="#property_dataSource">dataSource</a><br>
@@ -55,6 +55,71 @@
</div>
<p></p>
</ul>
+<br><br><span class="subTitle"><a name="constructor_2"></a><b>DataVector ( <a class="link" href="DataSource.html">DataSource</a> source, string field, string typeStart, <a class="link" href="numbe.html">numbe</a> r, string typeCount, number count [, number skip [, boolean ave]] )</b></span><br><ul>
+<div class="parameters">
+<a class="link" href="DataSource.html">DataSource</a> <b>source</b> -
+ The DataSource to load data from. This may be
+ a string containing the url of the DataSource to
+ load. If so, it will attempt to reuse an
+ existing DataSource instance, or fall back to
+ a new DataSource object. It may also be
+ specified as a DataSource object.
+
+ <br>string <b>field</b> -
+ The field to load from the source.
+
+ <br>string <b>typeStart</b> -
+ The type of the value specifying the start position.
+ The permissible values are as follows:
+ <ul>
+ <li>frames</li>
+ <li>date</li>
+ <li>ms (milliseconds)</li>
+ <li>s (seconds)</li>
+ <li>m (minutes)</li>
+ <li>h (hours)</li>
+ <li>days</li>
+ <li>weeks</li>
+ <li>months</li>
+ <li>years</li>
+ </ul>
+ <ul>
+ The date entry uses the format yyyy:mm:dd:hh:mm.ss (e.g. 2009:2:13:13:10.12).
+ If any of the leading elements are omitted then the current year, month, day, etc. are assumed.
+ If the year is less than 0, then it is assumed to be given relative to 1970 (e.g. -10 becomes 1980), else if the year is less than 100 it is assumed to be relative to 2000 (e.g. 9 becomes 2009), else the year is taken as given.
+ </ul>
+
+ <br><a class="link" href="numbe.html">numbe</a> <b>r</b> -
+ /string start The starting frame, date, or time offset.
+
+ <br>string <b>typeCount</b> -
+ The type of the value specifying the count
+
+ <br>number <b>count</b> -
+ The number of frames or time duration to read.
+ The permissible values are as follows:
+ <ul>
+ <li>frames</li>
+ <li>ms (milliseconds)</li>
+ <li>s (seconds)</li>
+ <li>m (minutes)</li>
+ <li>h (hours)</li>
+ <li>days</li>
+ <li>weeks</li>
+ <li>months</li>
+ <li>years</li>
+ </ul>
+
+ <br>number <b>skip</b> -
+ The number of samples to skip by.
+
+ [OPTIONAL]<br>boolean <b>ave</b> -
+ Set to true to do boxcar filtering.
+
+ [OPTIONAL]<br>
+</div>
+<p></p>
+</ul>
<br><br><span class="subTitle"><a name="method_reload"></a><b>void reload ( )</b></span><br><ul>
<div class="parameters"></div>
<p></p>
@@ -92,7 +157,7 @@
</p>
</ul>
-<br><br><span class="subTitle"><a name="method_changeFramesByTime"></a><b>void changeFramesByTime ( string typeStart, number start, string typeCount, number count [, number skip [, boolean ave]] )</b></span><br><ul>
+<br><br><span class="subTitle"><a name="method_changeFramesByTime"></a><b>void changeFramesByTime ( string typeStart, <a class="link" href="numbe.html">numbe</a> r, string typeCount, number count [, number skip [, boolean ave]] )</b></span><br><ul>
<div class="parameters">string <b>typeStart</b> -
The type of the value specifying the start position.
The permissible values are as follows:
@@ -114,8 +179,8 @@
If the year is less than 0, then it is assumed to be given relative to 1970 (e.g. -10 becomes 1980), else if the year is less than 100 it is assumed to be relative to 2000 (e.g. 9 becomes 2009), else the year is taken as given.
</ul>
- <br>number <b>start</b> -
- The starting frame, date, or time offset.
+ <br><a class="link" href="numbe.html">numbe</a> <b>r</b> -
+ /string start The starting frame, date, or time offset.
<br>string <b>typeCount</b> -
The type of the value specifying the count
More information about the Kst
mailing list