summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authoralisonjm <alisonjm>2011-04-25 21:55:20 +0000
committeralisonjm <alisonjm>2011-04-25 21:55:20 +0000
commitbd6ce63f8589e1740ab63513ee5bdf8ef4b8cfd7 (patch)
treeeb80990fc5675c6e72b5a99f19e63ee839662b88 /doc
parent9c3f11e7da282c74a1e3aa765222ca270d90825a (diff)
First add of documentation for rrdFilter. Copied in large part from rrdFile_js.html. May be inaccurate, has not been reviewed yet by Igor.
Diffstat (limited to 'doc')
-rw-r--r--doc/lib/rrdFilter_js.html519
1 files changed, 519 insertions, 0 deletions
diff --git a/doc/lib/rrdFilter_js.html b/doc/lib/rrdFilter_js.html
new file mode 100644
index 0000000..a4f48e9
--- /dev/null
+++ b/doc/lib/rrdFilter_js.html
@@ -0,0 +1,519 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+<HTML>
+<HEAD>
+ <META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=utf-8">
+ <TITLE>rrdFilter module</TITLE>
+ <META NAME="GENERATOR" CONTENT="OpenOffice.org 3.0 (Linux)">
+ <META NAME="CREATED" CONTENT="20090209;18445600">
+ <META NAME="CHANGED" CONTENT="20090209;19214700">
+ <META NAME="Info 1" CONTENT="">
+ <META NAME="Info 2" CONTENT="">
+ <META NAME="Info 3" CONTENT="">
+ <META NAME="Info 4" CONTENT="">
+ <STYLE TYPE="text/css">
+ <!--
+ @page { margin: 0.79in }
+ TD P { margin-bottom: 0.08in }
+ H1 { margin-bottom: 0.08in }
+ H1.western { font-family: "Liberation Sans", sans-serif; font-size: 22pt }
+ P { margin-bottom: 0.08in }
+ H2.heading-2-western { font-family: "Liberation Serif", serif; font-size: 16pt }
+ TH P { margin-bottom: 0.08in }
+ A:link { so-language: zxx }
+ -->
+ </STYLE>
+</HEAD>
+<BODY LANG="en-US" DIR="LTR">
+<H1 CLASS="western">rrdFilter module</H1>
+<TABLE WIDTH=50% CELLPADDING=2 CELLSPACING=2>
+ <TR>
+ <TD>
+ <HR>
+ <P>The <A HREF="../../src/lib/rrdFile.js">rrdFile Javascript
+ module</A> implements a set of classes that can be used to extract
+ information from <A HREF="http://oss.oetiker.ch/rrdtool/">RRD
+ archives</A> loaded as binary file objects.</P>
+ <HR>
+ </TD>
+ </TR>
+</TABLE>
+<H2 CLASS="heading-2-western">Overview</H2>
+<P>The rrdFilter module is allows filters to be applied to DSs (datasources).</P>
+<P>(These classes should have almost idential instantiations to their rrdFile module equivilents.)</P>
+<P>Filters can either be a list of DSs to filter out (*FilterDS), or a user-created and customized filter object (*FilterOp - for example, mathematical functions like summing and averaging DSs).
+<P>Clases included in this module:
+<UL><LI>RRDRRAFilterDS
+<LI>RRDFilterDS
+<LI>RRDDSFilterOp
+<LI>RRDRRAFIlterOp
+<LI>RRDFilterOp.</UL>
+
+<H2 CLASS="heading-2-western"><A NAME="RRDRRAFilterDS"></A>Class RRDRRAFilterDS</H2>
+<P> This class filters out a subset of DSs from an RRA identified by index or name. </P>
+<P>The constructor has two arguments: rrd_rra (the RRA) and ds_list (the list of DSs to filter).</P>
+
+<P>This class implements the following methods:</P>
+<DIV ALIGN=RIGHT>
+ <TABLE WIDTH=90% BORDER=1 CELLPADDING=2 CELLSPACING=3>
+ <COL WIDTH=51*>
+ <COL WIDTH=205*>
+ <THEAD>
+ <TR VALIGN=TOP>
+ <TH WIDTH=20%>
+ <P ALIGN=LEFT>Method</P>
+ </TH>
+ <TH WIDTH=80%>
+ <P ALIGN=LEFT>Description</P>
+ </TH>
+ </TR>
+ </THEAD>
+ <TBODY>
+ <TR VALIGN=TOP>
+ <TD WIDTH=20%>
+ <P>getIdx()</P>
+ </TD>
+ <TD WIDTH=80%>
+ <P>Return which RRA it is in the RRD file.</P>
+ </TD>
+ </TR>
+ <TR VALIGN=TOP>
+ <TD WIDTH=20%>
+ <P>getNrRows()</P>
+ </TD>
+ <TD WIDTH=80%>
+ <P>Return the number of rows in the RRA.</P>
+ </TD>
+ </TR>
+ <TR VALIGN=TOP>
+ <TD WIDTH=20%>
+ <P>getNrDSs()</P>
+ </TD>
+ <TD WIDTH=80%>
+ <P>Return the number of DSs in the RRD file.</P>
+ </TD>
+ </TR>
+ <TR VALIGN=TOP>
+ <TD WIDTH=20%>
+ <P>getStep()</P>
+ </TD>
+ <TD WIDTH=80%>
+ <P>Return the number of seconds between rows.</P>
+ </TD>
+ </TR>
+ <TR VALIGN=TOP>
+ <TD WIDTH=20%>
+ <P>getCFName()</P>
+ </TD>
+ <TD WIDTH=80%>
+ <P>Return the <A HREF="http://oss.oetiker.ch/rrdtool/doc/rrdcreate.en.html#IRRA_CF_cf_arguments">Consolidation
+ Function</A> used by the RRA.</P>
+ </TD>
+ </TR>
+ <TR VALIGN=TOP>
+ <TD WIDTH=20%>
+ <P>getEl(r,d)</P>
+ </TD>
+ <TD WIDTH=80%>
+ <P>Return the value for the d-th DS in the r-th row.</P>
+ </TD>
+ </TR>
+ <TR VALIGN=TOP>
+ <TD WIDTH=20%>
+ <P>getElFast(r,d)</P>
+ </TD>
+ <TD WIDTH=80%>
+ <P>Return the low-precision value for the d-th DS in the r-th row.</P>
+ </TD>
+ </TR>
+ </TBODY>
+ </TABLE>
+</DIV>
+<H2 CLASS="heading-2-western"><A NAME="RRDFilterDS"></A>Class RRDFilterDS</H2>
+<P> This class filters out a subset of DSs from an RRD identified by index or name. </P>
+<P>This class implements the following methods:</P>
+<DIV ALIGN=RIGHT>
+ <TABLE WIDTH=90% BORDER=1 CELLPADDING=2 CELLSPACING=3>
+ <COL WIDTH=51*>
+ <COL WIDTH=205*>
+ <THEAD>
+ <TR VALIGN=TOP>
+ <TH WIDTH=20%>
+ <P ALIGN=LEFT>Method</P>
+ </TH>
+ <TH WIDTH=80%>
+ <P ALIGN=LEFT>Description</P>
+ </TH>
+ </TR>
+ </THEAD>
+ <TBODY>
+ <TR VALIGN=TOP>
+ <TD WIDTH=20%>
+ <P>getMinSteps()</P>
+ </TD>
+ <TD WIDTH=80%>
+ <P>Return the base <A HREF="http://oss.oetiker.ch/rrdtool/doc/rrdcreate.en.html#I__step__s_step__default__300_seconds_">interval
+ in seconds</A> that was used to feed the RRD file.</P>
+ </TD>
+ </TR>
+ <TR VALIGN=TOP>
+ <TD WIDTH=20%>
+ <P>getLastUpdate()</P>
+ </TD>
+ <TD WIDTH=80%>
+ <P>Return the timestamp of the <A HREF="http://oss.oetiker.ch/rrdtool/doc/rrdlastupdate.en.html">last
+ update</A>.</P>
+ </TD>
+ </TR>
+ <TR VALIGN=TOP>
+ <TD WIDTH=20%>
+ <P>getNrDSs()</P>
+ </TD>
+ <TD WIDTH=80%>
+ <P>Return the number of <A HREF="http://oss.oetiker.ch/rrdtool/doc/rrdcreate.en.html#IDS_ds_name_DST_dst_arguments">Data
+ Sources</A> present in the RRD file.
+ </P>
+ </TD>
+ </TR>
+ <TR VALIGN=TOP>
+ <TD WIDTH=20%>
+ <P>getDSNames()</P>
+ </TD>
+ <TD WIDTH=80%>
+ <P>Return the names of the <A HREF="http://oss.oetiker.ch/rrdtool/doc/rrdcreate.en.html#IDS_ds_name_DST_dst_arguments">Data
+ Sources</A> present in the RRD file.
+ </P>
+ </TD>
+<TR VALIGN=TOP>
+ <TD WIDTH=20%>
+ <P>getDS(id)</P>
+ </TD>
+ <TD WIDTH=80%>
+ <P>If id is a number, return an object of type <A HREF="#RRDDS">RRDDS</A> holding
+ the information about the id-th <A HREF="http://oss.oetiker.ch/rrdtool/doc/rrdcreate.en.html#IDS_ds_name_DST_dst_arguments">Data
+ Source</A>.</P>
+ <P>If id is a string, return an object of type <A HREF="#RRDDS">RRDDS</A> holding
+ the information about the <A HREF="http://oss.oetiker.ch/rrdtool/doc/rrdcreate.en.html#IDS_ds_name_DST_dst_arguments">Data
+ Source</A> with the requested name.</P>
+ </TD>
+ </TR>
+ <TR VALIGN=TOP>
+ <TD WIDTH=20%>
+ <P>getNrRRAs()</P>
+ </TD>
+ <TD WIDTH=80%>
+ <P>Return the number of <A HREF="http://oss.oetiker.ch/rrdtool/doc/rrdcreate.en.html#IRRA_CF_cf_arguments">Round
+ Robin Archives</A> present in the RRD file.</P>
+ </TD>
+ </TR>
+ <TR VALIGN=TOP>
+ <TD WIDTH=20%>
+ <P>getRRAInfo(n)</P>
+ </TD>
+ <TD WIDTH=80%>
+ <P>Return an object of type <A HREF="#RRDRRAInfo">RRDRRAInfo</A>
+ holding the information about the n-th <A HREF="http://oss.oetiker.ch/rrdtool/doc/rrdcreate.en.html#IRRA_CF_cf_arguments">Round
+ Robin Archive</A>.</P>
+ </TD>
+ <TR VALIGN=TOP>
+ <TD WIDTH=20%>
+ <P>getRRA(n)</P>
+ </TD>
+ <TD WIDTH=80%>
+ <P>Return an object of type <A HREF="#RRDRRA">RRDRRA</A> that
+ can be used to access the values stored in the n-th <A HREF="http://oss.oetiker.ch/rrdtool/doc/rrdcreate.en.html#IRRA_CF_cf_arguments">Round
+ Robin Archive</A>.</P>
+ </TD>
+ </TR>
+ </TBODY>
+ </TABLE>
+</DIV>
+<HR>
+<H2 CLASS="heading-2-western"><A NAME="RRDDSFilterOP"></A>Class RRDDSFilterOp</H2>
+<P>This class filters DSs from an RRD by using a user-provided filter object. </P>
+<P>This object must implement the following interface:</P>
+<UL>
+<LI>getName() - Symbolic name give to this function
+<LI>getDSName() - list of DSs used in computing the result (names or indexes)
+<LI>computeResult(val_list) - val_list contains the values of the requested DSs (in the same order)
+</UL>
+<P>For example, a summing function:</P>
+<UL>
+<P>function SumDS(ds1,ds2){
+<UL><P>this.getName() = function() {return ds1+"+"+ds2} </P>
+<P>this.getDSName = function() {return [ds1,ds2]}</P>
+<P>this.computeResult = function(val_list) {return val_list[0]+val_list[1]}}</P>
+</UL></UL>
+<P>This class has three arguments: rrd_file, op_object (the filter object) and my_idx (index of new DS in case old one was modified by a filter).
+<P>This class implements the following methods:</P>
+<DIV ALIGN=RIGHT>
+ <TABLE WIDTH=90% BORDER=1 CELLPADDING=2 CELLSPACING=3>
+ <COL WIDTH=51*>
+ <COL WIDTH=205*>
+ <THEAD>
+ <TR VALIGN=TOP>
+ <TH WIDTH=20%>
+ <P ALIGN=LEFT>Method</P>
+ </TH>
+ <TH WIDTH=80%>
+ <P ALIGN=LEFT>Description</P>
+ </TH>
+ </TR>
+ </THEAD>
+ <TBODY>
+ <TR VALIGN=TOP>
+ <TD WIDTH=20%>
+ <P>getIdx()</P>
+ </TD>
+ <TD WIDTH=80%>
+ <P>Return which DS it is in the RRD file.</P>
+ </TD>
+ </TR>
+ <TR VALIGN=TOP>
+ <TD WIDTH=20%>
+ <P>getName()</P>
+ </TD>
+ <TD WIDTH=80%>
+ <P>Return the name of the data source.</P>
+ </TD>
+ </TR>
+ <TR VALIGN=TOP>
+ <TD WIDTH=20%>
+ <P>getType()</P>
+ </TD>
+ <TD WIDTH=80%>
+ <P>Return the <A HREF="http://oss.oetiker.ch/rrdtool/doc/rrdcreate.en.html#IDS_ds_name_DST_dst_arguments">type</A>
+ of the data source.</P>
+ </TD>
+ </TR>
+ <TR VALIGN=TOP>
+ <TD WIDTH=20%>
+ <P>getMin()</P>
+ </TD>
+ <TD ROWSPAN=2 WIDTH=80%>
+ <P>Return the minimum and maximum value the data source can
+ contain.
+ </P>
+ <P>If either is not defined, <I>undefined</I> is returned.</P>
+ </TD>
+ </TR>
+ <TR VALIGN=TOP>
+ <TD WIDTH=20%>
+ <P>getMax()</P>
+ </TD>
+ </TR>
+ <TR VALIGN=TOP>
+ <TD WIDTH=20%>
+ <P>getRealDSList()</P>
+ </TD>
+ <TD WIDTH=80%>
+ <P>Returns which DSs is being used in the Filter.</P>
+ </TD>
+ </TR>
+ <TR VALIGN=TOP>
+ <TD WIDTH=20%>
+ <P>ComputeResult()</P>
+ </TD>
+ <TD WIDTH=80%>
+ <P>Return the computed result of the filter object on the DSs.</P>
+ </TD>
+ </TR>
+ </TBODY>
+
+ </TABLE>
+</DIV>
+<H2 CLASS="heading-2-western"><A NAME="RRDRRAFilterOP"></A>Class RRDRRAFilterDS</H2>
+<P> This class filters out a subset of DSs from an RRA using by a filter object. </P>
+<P>The constructor has two arguments: rrd_rra (the RRA) and ds_list (the list of DS filters).</P>
+
+<P>This class also implements the following methods:</P>
+<DIV ALIGN=RIGHT>
+ <TABLE WIDTH=90% BORDER=1 CELLPADDING=2 CELLSPACING=3>
+ <COL WIDTH=51*>
+ <COL WIDTH=205*>
+ <THEAD>
+ <TR VALIGN=TOP>
+ <TH WIDTH=20%>
+ <P ALIGN=LEFT>Method</P>
+ </TH>
+ <TH WIDTH=80%>
+ <P ALIGN=LEFT>Description</P>
+ </TH>
+ </TR>
+ </THEAD>
+ <TBODY>
+ <TR VALIGN=TOP>
+ <TD WIDTH=20%>
+ <P>getIdx()</P>
+ </TD>
+ <TD WIDTH=80%>
+ <P>Return which RRA it is in the RRD file.</P>
+ </TD>
+ </TR>
+ <TR VALIGN=TOP>
+ <TD WIDTH=20%>
+ <P>getNrRows()</P>
+ </TD>
+ <TD WIDTH=80%>
+ <P>Return the number of rows in the RRA.</P>
+ </TD>
+ </TR>
+ <TR VALIGN=TOP>
+ <TD WIDTH=20%>
+ <P>getNrDSs()</P>
+ </TD>
+ <TD WIDTH=80%>
+ <P>Return the number of DSs in the RRD file.</P>
+ </TD>
+ </TR>
+ <TR VALIGN=TOP>
+ <TD WIDTH=20%>
+ <P>getStep()</P>
+ </TD>
+ <TD WIDTH=80%>
+ <P>Return the number of seconds between rows.</P>
+ </TD>
+ </TR>
+ <TR VALIGN=TOP>
+ <TD WIDTH=20%>
+ <P>getCFName()</P>
+ </TD>
+ <TD WIDTH=80%>
+ <P>Return the <A HREF="http://oss.oetiker.ch/rrdtool/doc/rrdcreate.en.html#IRRA_CF_cf_arguments">Consolidation
+ Function</A> used by the RRA.</P>
+ </TD>
+ </TR>
+ <TR VALIGN=TOP>
+ <TD WIDTH=20%>
+ <P>getEl(r,d)</P>
+ </TD>
+ <TD WIDTH=80%>
+ <P>Return the value for the d-th DS in the r-th row.</P>
+ </TD>
+ </TR>
+ <TR VALIGN=TOP>
+ <TD WIDTH=20%>
+ <P>getElFast(r,d)</P>
+ </TD>
+ <TD WIDTH=80%>
+ <P>Return the low-precision value for the d-th DS in the r-th row.</P>
+ </TD>
+ </TR>
+ </TBODY>
+ </TABLE>
+</DIV>
+<H2 CLASS="heading-2-western"><A NAME="RRDFilterOp"></A>Class RRDFilterOp</H2>
+<P>This class filters all of the DSs in an RRD by an accompning list of filters - one filter for each DS.</UL>
+<P>Its arguments are: rrd_file and op_obj_list (list of ds filtersr;list length must be the same as the number of DSs in the RRD).
+<P>This class implements the following methods:</P>
+<DIV ALIGN=RIGHT>
+ <TABLE WIDTH=90% BORDER=1 CELLPADDING=2 CELLSPACING=3>
+ <COL WIDTH=51*>
+ <COL WIDTH=205*>
+ <THEAD>
+ <TR VALIGN=TOP>
+ <TH WIDTH=20%>
+ <P ALIGN=LEFT>Method</P>
+ </TH>
+ <TH WIDTH=80%>
+ <P ALIGN=LEFT>Description</P>
+ </TH>
+ </TR>
+ </THEAD>
+ <TBODY>
+ <TR VALIGN=TOP>
+ <TD WIDTH=20%>
+ <P>getMinSteps()</P>
+ </TD>
+ <TD WIDTH=80%>
+ <P>Return the base <A HREF="http://oss.oetiker.ch/rrdtool/doc/rrdcreate.en.html#I__step__s_step__default__300_seconds_">interval
+ in seconds</A> that was used to feed the RRD file.</P>
+ </TD>
+ </TR>
+ <TR VALIGN=TOP>
+ <TD WIDTH=20%>
+ <P>getLastUpdate()</P>
+ </TD>
+ <TD WIDTH=80%>
+ <P>Return the timestamp of the <A HREF="http://oss.oetiker.ch/rrdtool/doc/rrdlastupdate.en.html">last
+ update</A>.</P>
+ </TD>
+ </TR>
+ <TR VALIGN=TOP>
+ <TD WIDTH=20%>
+ <P>getNrDSs()</P>
+ </TD>
+ <TD WIDTH=80%>
+ <P>Return the number of <A HREF="http://oss.oetiker.ch/rrdtool/doc/rrdcreate.en.html#IDS_ds_name_DST_dst_arguments">Data
+ Sources</A> present in the RRD file.
+ </P>
+ </TD>
+ </TR>
+ <TR VALIGN=TOP>
+ <TD WIDTH=20%>
+ <P>getDSNames()</P>
+ </TD>
+ <TD WIDTH=80%>
+ <P>Return the names of the <A HREF="http://oss.oetiker.ch/rrdtool/doc/rrdcreate.en.html#IDS_ds_name_DST_dst_arguments">Data
+ Sources</A> present in the RRD file.
+ </P>
+ </TD>
+<TR VALIGN=TOP>
+ <TD WIDTH=20%>
+ <P>getDS(id)</P>
+ </TD>
+ <TD WIDTH=80%>
+ <P>If id is a number, return an object of type <A HREF="#RRDDS">RRDDS</A> holding
+ the information about the id-th <A HREF="http://oss.oetiker.ch/rrdtool/doc/rrdcreate.en.html#IDS_ds_name_DST_dst_arguments">Data
+ Source</A>.</P>
+ <P>If id is a string, return an object of type <A HREF="#RRDDS">RRDDS</A> holding
+ the information about the <A HREF="http://oss.oetiker.ch/rrdtool/doc/rrdcreate.en.html#IDS_ds_name_DST_dst_arguments">Data
+ Source</A> with the requested name.</P>
+ </TD>
+ </TR>
+ <TR VALIGN=TOP>
+ <TD WIDTH=20%>
+ <P>getNrRRAs()</P>
+ </TD>
+ <TD WIDTH=80%>
+ <P>Return the number of <A HREF="http://oss.oetiker.ch/rrdtool/doc/rrdcreate.en.html#IRRA_CF_cf_arguments">Round
+ Robin Archives</A> present in the RRD file.</P>
+ </TD>
+ </TR>
+ <TR VALIGN=TOP>
+ <TD WIDTH=20%>
+ <P>getRRAInfo(n)</P>
+ </TD>
+ <TD WIDTH=80%>
+ <P>Return an object of type <A HREF="#RRDRRAInfo">RRDRRAInfo</A>
+ holding the information about the n-th <A HREF="http://oss.oetiker.ch/rrdtool/doc/rrdcreate.en.html#IRRA_CF_cf_arguments">Round
+ Robin Archive</A>.</P>
+ </TD>
+ <TR VALIGN=TOP>
+ <TD WIDTH=20%>
+ <P>getRRA(n)</P>
+ </TD>
+ <TD WIDTH=80%>
+ <P>Return an object of type <A HREF="#RRDRRA">RRDRRA</A> that
+ can be used to access the values stored in the n-th <A HREF="http://oss.oetiker.ch/rrdtool/doc/rrdcreate.en.html#IRRA_CF_cf_arguments">Round
+ Robin Archive</A>.</P>
+ </TD>
+ </TR>
+ </TBODY>
+ </TABLE>
+</DIV>
+<TABLE WIDTH=50% CELLPADDING=2 CELLSPACING=2>
+ <TR>
+ <TD>
+ <HR>
+ <P>This module is part of the <A HREF="index.html">javascriptRRD
+ package</A> hosted at <A HREF="http://javascriptrrd.sourceforge.net/">http://javascriptrrd.sourceforge.net</A>.
+ <BR>It is licensed under the <A HREF="http://www.opensource.org/licenses/mit-license.php">MIT
+ license</A>.
+ </P>
+ <HR>
+ </TD>
+ </TR>
+</TABLE>
+
+</BODY>
+</HTML>
generated by cgit v1.2.3-2-g168b (git 2.25.1) at 2024-10-31 23:06:02 +0000