📄 swarm.analysis.averager.protocol.html
字号:
<HTML><HEAD><TITLE>Averager</TITLE><METANAME="GENERATOR"CONTENT="Modular DocBook HTML Stylesheet Version 1.53"><LINKREL="HOME"TITLE="Documentation Set for Swarm 2.1.1"HREF="set.html"><LINKREL="UP"TITLE="Analysis Library"HREF="swarm.analysis.sgml.reference.html"><LINKREL="PREVIOUS"TITLE="ActiveOutFile"HREF="swarm.analysis.activeoutfile.protocol.html"><LINKREL="NEXT"TITLE="EZAverageSequence"HREF="swarm.analysis.ezaveragesequence.protocol.html"></HEAD><BODYCLASS="REFENTRY"BGCOLOR="#FFFFFF"TEXT="#000000"LINK="#0000FF"VLINK="#840084"ALINK="#0000FF"><DIVCLASS="NAVHEADER"><TABLEWIDTH="100%"BORDER="0"CELLPADDING="0"CELLSPACING="0"><TR><THCOLSPAN="3"ALIGN="center">Documentation Set for Swarm 2.1.1</TH></TR><TR><TDWIDTH="10%"ALIGN="left"VALIGN="bottom"><AHREF="swarm.analysis.activeoutfile.protocol.html">Prev</A></TD><TDWIDTH="80%"ALIGN="center"VALIGN="bottom">Reference IX. Analysis Library</TD><TDWIDTH="10%"ALIGN="right"VALIGN="bottom"><AHREF="swarm.analysis.ezaveragesequence.protocol.html">Next</A></TD></TR></TABLE><HRALIGN="LEFT"WIDTH="100%"></DIV><H1><ANAME="SWARM.ANALYSIS.AVERAGER.PROTOCOL">Averager</A></H1><DIVCLASS="REFNAMEDIV"><ANAME="AEN21542"></A><H2>Name</H2>Averager -- Averages together data, gives the data to whomever asks.</DIV><DIVCLASS="REFSECT1"><ANAME="AEN21545"></A><H2>Description</H2><P> Averager objects read a value (via a MessageProbe) from a collection (typically a list) of objects and collect statistics over them.</P></DIV><DIVCLASS="REFSECT1"><ANAME="AEN21548"></A><H2>Protocols adopted by Averager</H2><P> <AHREF="swarm.objectbase.messageprobe.protocol.html">MessageProbe</A> <AHREF="swarm.defobj.creatable.protocol.html">CREATABLE</A></P></DIV><DIVCLASS="REFSECT1"><ANAME="AEN21553"></A><H2>Methods</H2><DIVCLASS="REFSECT2"><ANAME="AEN21555"></A><H3>Phase: Creating</H3><P></P><UL><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ANALYSIS.AVERAGER.METHOD.PC.M704"></A><P></P>- <BCLASS="FUNCPROTOTYPE">setCollection:</B> <VARCLASS="PDPARAM">aCollection</VAR> <BR> Sets the collection of objects that will be probed.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ANALYSIS.AVERAGER.METHOD.PC.M228"></A><P></P>- <BCLASS="FUNCPROTOTYPE">createEnd</B><BR><P></P></DIV></LI></UL></DIV><DIVCLASS="REFSECT2"><ANAME="AEN21575"></A><H3>Phase: Using</H3><P></P><UL><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ANALYSIS.AVERAGER.METHOD.PU.M935"></A><P></P>- <BCLASS="FUNCPROTOTYPE">update</B><BR> The update method runs through the collection calling the selector on each object.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ANALYSIS.AVERAGER.METHOD.PU.M318"></A><P></P>- (double)<BCLASS="FUNCPROTOTYPE">getAverage</B><BR> The getAverage method averages the values the averager collects. The total and count are read out of the object to compute the average.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ANALYSIS.AVERAGER.METHOD.PU.M509"></A><P></P>- (double)<BCLASS="FUNCPROTOTYPE">getTotal</B><BR> The getTotal method sums the values the averager collects. The value is read out of the object, not computed everytime it is asked for.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ANALYSIS.AVERAGER.METHOD.PU.M429"></A><P></P>- (double)<BCLASS="FUNCPROTOTYPE">getMin</B><BR> The getMin method returns the minimum value the averager collects. The value is read out of the object, not computed everytime it is asked for.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ANALYSIS.AVERAGER.METHOD.PU.M348"></A><P></P>- (unsigned)<BCLASS="FUNCPROTOTYPE">getCount</B><BR> The getCount method returns the number of values the averager collects. <P></P></DIV></LI></UL></DIV></DIV><DIVCLASS="NAVFOOTER"><HRALIGN="LEFT"WIDTH="100%"><TABLEWIDTH="100%"BORDER="0"CELLPADDING="0"CELLSPACING="0"><TR><TDWIDTH="33%"ALIGN="left"VALIGN="top"><AHREF="swarm.analysis.activeoutfile.protocol.html">Prev</A></TD><TDWIDTH="34%"ALIGN="center"VALIGN="top"><AHREF="set.html">Home</A></TD><TDWIDTH="33%"ALIGN="right"VALIGN="top"><AHREF="swarm.analysis.ezaveragesequence.protocol.html">Next</A></TD></TR><TR><TDWIDTH="33%"ALIGN="left"VALIGN="top">ActiveOutFile</TD><TDWIDTH="34%"ALIGN="center"VALIGN="top"><AHREF="swarm.analysis.sgml.reference.html">Up</A></TD><TDWIDTH="33%"ALIGN="right"VALIGN="top">EZAverageSequence</TD></TR></TABLE></DIV></BODY></HTML>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -