org.mbari.siam.utils
Class BasicSummaryRecord

java.lang.Object
  extended by org.mbari.siam.utils.BasicSummaryRecord

public class BasicSummaryRecord
extends java.lang.Object

BasicSummaryRecord consists of multiple fields representing numeric values. each field stores the mean, standard deviation, minimum, and maximum.


Field Summary
protected  java.util.Vector _fields
           
protected  boolean _recompute
           
protected  long _startTime
           
protected  long _stopTime
           
 
Constructor Summary
BasicSummaryRecord()
           
 
Method Summary
 void addSample(DevicePacket packet, PacketParser parser)
          Add another sample to the statistics
 void compute()
          Compute mean and standard deviation for all fields in summary record.
 void reset()
           
 boolean summarizeField(java.lang.String fieldName)
          Return true if specified field should be summarized; else return false.
 java.lang.String toString()
          Generate string representation of record.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

_recompute

protected boolean _recompute

_startTime

protected long _startTime

_stopTime

protected long _stopTime

_fields

protected java.util.Vector _fields
Constructor Detail

BasicSummaryRecord

public BasicSummaryRecord()
Method Detail

reset

public void reset()

addSample

public void addSample(DevicePacket packet,
                      PacketParser parser)
               throws NotSupportedException,
                      java.text.ParseException
Add another sample to the statistics

Throws:
NotSupportedException
java.text.ParseException

compute

public void compute()
Compute mean and standard deviation for all fields in summary record.


summarizeField

public boolean summarizeField(java.lang.String fieldName)
Return true if specified field should be summarized; else return false. By default, always returns true; subclass can override method to summarize only specific fields.


toString

public java.lang.String toString()
Generate string representation of record.

Overrides:
toString in class java.lang.Object


Copyright © 2003 MBARI.

The Monterey Bay Aquarium Research Institute (MBARI) provides this documentation and code "as is", with no warranty, express or implied, of its quality or consistency. It is provided without support and without obligation on the part of MBARI to assist in its use, correction, modification, or enhancement.