peakml.io
Class ScanInfo

java.lang.Object
  peakml.Annotatable
      peakml.io.ScanInfo

public class ScanInfo
extends Annotatable

Central point for collecting all information about a scan. It has been chosen to maintain this information in a memory intensive class instance as it is expected that more information will be incorporated for scans.

Constructor Summary

ScanInfo(double retentiontime, Polarity polarity)
Constructs a new ScanInfo instance with the given retention-time and polarity.

Method Summary

Polarity	getPolarity() Returns the polarity of the scan.
double	getRetentionTime() Returns the retention time of the scan in seconds.
static java.lang.String	rtToString(double rt) Convenience function for converting a time-value in seconds to a readable string representation.

Methods inherited from class peakml.Annotatable

addAnnotation, addAnnotation, addAnnotation, addAnnotation, addAnnotation, addAnnotations, getAnnotation, getAnnotations, removeAllAnnotations, removeAnnotation

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScanInfo

public ScanInfo(double retentiontime,
                Polarity polarity)

Constructs a new ScanInfo instance with the given retention-time and polarity. The retention is required to be in seconds, which is taken care of by the parsers.

Parameters:

retentiontime - The retention time in seconds.

polarity - The polarity of the scan.

Method Detail

getRetentionTime

public double getRetentionTime()

Returns the retention time of the scan in seconds.

Returns:

The retention time in seconds.

getPolarity

public Polarity getPolarity()

Returns the polarity of the scan.

Returns:

The polarity of the scan.

rtToString

public static java.lang.String rtToString(double rt)

Convenience function for converting a time-value in seconds to a readable string representation.

Parameters:

rt - The time in seconds.

Returns:

The string represention of the given time.