org.omscentral.modules.analysis.esp.EnsembleListLabel Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of oms Show documentation
Object Modeling System (OMS) is a pure Java object-oriented framework. OMS v3.+ is a highly interoperable and lightweight modeling framework for component-based model and simulation development on multiple platforms.
There is a newer version: 3.5.12
Show newest version
/*
 * $Id: EnsembleListLabel.java 7cba5ba59d73 2018-11-29 [email protected] $
 * 
 * This file is part of the Object Modeling System (OMS),
 * 2007-2012, Olaf David and others, Colorado State University.
 *
 * OMS is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, version 2.1.
 *
 * OMS is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with OMS.  If not, see .
 */
package org.omscentral.modules.analysis.esp;

/**
 *
 * @author  markstro
 */
public class EnsembleListLabel {

    private double traceVolume;
    private double tracePeak;
    private double timeToPeak;
    private TimeSeriesCookie forecast;
    private double actVolumeProb;
    private double roundVolumeProb;
    private double actPeakProb;
    private double roundPeakProb;
    private int volumeRank;
    private int peakRank;
    private Format probFormat = new Format("%5.1f");
    private EnsembleData ensembleData;

    public EnsembleListLabel(TimeSeriesCookie forecast, EnsembleData ensembleData) {
        this.forecast = forecast;
        this.ensembleData = ensembleData;
    }

    public EnsembleListLabel(EnsembleListLabel ell) {
        this.traceVolume = ell.traceVolume;
        this.tracePeak = ell.tracePeak;
        this.timeToPeak = ell.timeToPeak;
        this.forecast = ell.forecast;
        this.actVolumeProb = ell.actVolumeProb;
        this.roundVolumeProb = ell.roundVolumeProb;
        this.actPeakProb = ell.actPeakProb;
        this.roundPeakProb = ell.roundPeakProb;
        this.volumeRank = ell.volumeRank;
        this.peakRank = ell.peakRank;
        this.ensembleData = ell.ensembleData;
    }

    public String toString() {
        if (ensembleData == null) {
            return forecast.getName();
        } else if (ensembleData.getSortOrder() == ensembleData.YEAR) {
            return forecast.getName();
        } else if (ensembleData.getSortOrder() == ensembleData.VOLUME) {
            return getEspToolVolumeLabel();
        } else if (ensembleData.getSortOrder() == ensembleData.PEAK) {
            return getEspToolPeakLabel();
        }
        return forecast.getName();
    }

    public String getTraceName() {
        return forecast.getName();
    }

    public int getTraceYear() {
        return Integer.parseInt(forecast.getName());
    }

    public String getEspToolVolumeLabel() {
        return forecast.getName() + "   [actP=" + probFormat.form(actVolumeProb) + " dmiP=" + probFormat.form(roundVolumeProb) + "]";
    }

    public String getEspToolPeakLabel() {
        return forecast.getName() + "   [actP=" + probFormat.form(actPeakProb) + " dmiP= " + probFormat.form(roundPeakProb) + "]";
    }

    /**
     * Getter for property traceVolumes.
     * @return Value of property traceVolumes.
     */
    public double getTraceVolume() {
        return this.traceVolume;
    }

    /**
     * Setter for property traceVolumes.
     * @param traceVolume New value of property traceVolumes.
     */
    public void setTraceVolume(double traceVolume) {
        this.traceVolume = traceVolume;
    }

    /**
     * Getter for property tracePeaks.
     * @return Value of property tracePeaks.
     */
    public double getTracePeak() {
        return this.tracePeak;
    }

    /**
     * Setter for property tracePeaks.
     * @param tracePeak New value of property tracePeaks.
     */
    public void setTracePeak(double tracePeak) {
        this.tracePeak = tracePeak;
    }

    /**
     * Getter for property timeToPeak.
     * @return Value of property timeToPeak.
     */
    public double getTimeToPeak() {
        return this.timeToPeak;
    }

    /**
     * Setter for property timeToPeak.
     * @param timeToPeak New value of property timeToPeak.
     */
    public void setTimeToPeak(double timeToPeak) {
        this.timeToPeak = timeToPeak;
    }

    /**
     * Getter for property forecast.
     * @return Value of property forecast.
     */
    public TimeSeriesCookie getForecast() {
        return this.forecast;
    }

    /**
     * Setter for property forecast.
     * @param forecast New value of property forecast.
     */
    public void setForecast(TimeSeriesCookie forecast) {
        this.forecast = forecast;
    }

    /**
     * Getter for property actVolumeProb.
     * @return Value of property actVolumeProb.
     */
    public double getActVolumeProb() {
        return this.actVolumeProb;
    }

    /**
     * Setter for property actVolumeProb.
     * @param actVolumeProb New value of property actVolumeProb.
     */
    public void setActVolumeProb(double actVolumeProb) {
        this.actVolumeProb = actVolumeProb;
    }

    /**
     * Getter for property roundVolumeProb.
     * @return Value of property roundVolumeProb.
     */
    public double getRoundVolumeProb() {
        return this.roundVolumeProb;
    }

    /**
     * Setter for property roundVolumeProb.
     * @param roundVolumeProb New value of property roundVolumeProb.
     */
    public void setRoundVolumeProb(double roundVolumeProb) {
        this.roundVolumeProb = roundVolumeProb;
    }

    /**
     * Getter for property actPeakProb.
     * @return Value of property actPeakProb.
     */
    public double getActPeakProb() {
        return this.actPeakProb;
    }

    /**
     * Setter for property actPeakProb.
     * @param actPeakProb New value of property actPeakProb.
     */
    public void setActPeakProb(double actPeakProb) {
        this.actPeakProb = actPeakProb;
    }

    /**
     * Getter for property roundPeakProb.
     * @return Value of property roundPeakProb.
     */
    public double getRoundPeakProb() {
        return this.roundPeakProb;
    }

    /**
     * Setter for property roundPeakProb.
     * @param roundPeakProb New value of property roundPeakProb.
     */
    public void setRoundPeakProb(double roundPeakProb) {
        this.roundPeakProb = roundPeakProb;
    }

    /**
     * Getter for property volumeRank.
     * @return Value of property volumeRank.
     */
    public int getVolumeRank() {
        return this.volumeRank;
    }

    /**
     * Setter for property volumeRank.
     * @param volumeRank New value of property volumeRank.
     */
    public void setVolumeRank(int volumeRank) {
        this.volumeRank = volumeRank;
    }

    /**
     * Getter for property peakRank.
     * @return Value of property peakRank.
     */
    public int getPeakRank() {
        return this.peakRank;
    }

    /**
     * Setter for property peakRank.
     * @param peakRank New value of property peakRank.
     */
    public void setPeakRank(int peakRank) {
        this.peakRank = peakRank;
    }
}