SimulationGroup.java

/*******************************************************************************
 * This file is part of the Appliance Energy Detector, a free household appliance energy disaggregation intelligence engine and webapp.
 * 
 * Copyright (C) 2011,2012 Taylor Raack <traack@raack.info>
 * 
 * The Appliance Energy Detector is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
 * 
 * The Appliance Energy Detector 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 Affero General Public License for more details.
 * 
 * You should have received a copy of the GNU Affero General Public License along with the Appliance Energy Detector.  If not, see <http://www.gnu.org/licenses/>.
 * 
 * According to sec. 7 of the GNU Affero General Public License, version 3, the terms of the AGPL are supplemented with the following terms:
 * 
 * If you modify this Program, or any covered work, by linking or combining it with any of the following programs (or modified versions of those libraries), containing parts covered by the terms of those libraries licenses, the licensors of this Program grant you additional permission to convey the resulting work:
 * 
 * Javabeans(TM) Activation Framework 1.1 (activation) - Common Development and Distribution License Version 1.0
 * AspectJ 1.6.9 (aspectjrt and aspectjweaver) - Eclipse Public License 1.0
 * EMMA 2.0.5312 (emma and emma_ant) - Common Public License Version 1.0
 * JAXB Project Libraries 2.2.2 (jaxb-api, jaxb-impl, jaxb-xjc) - Common Development and Distribution License Version 1.0
 * Java Standard Template Library 1.2 (jstl) - Common Development and Distribution License Version 1.0
 * Java Servlet Pages API 2.1 (jsp-api) - Common Development and Distribution License Version 1.0
 * Java Transaction API 1.1 (jta) - Common Development and Distribution License Version 1.0
 * JavaMail(TM) 1.4.1 (mail) - Common Development and Distribution License Version 1.0
 * XML Pull Parser 3 (xpp3) - Indiana University Extreme! Lab Software License Version 1.1.1
 * 
 * The interactive user interface of the software display an attribution notice containing the phrase "Appliance Energy Detector". Interactive user interfaces of unmodified and modified versions must display Appropriate Legal Notices according to sec. 5 of the GNU Affero General Public License, version 3, when you propagate an unmodified or modified version of the Program. In accordance with sec. 7 b) of the GNU Affero General Public License, version 3, these Appropriate Legal Notices must prominently display either a) "Initial Development by <a href='http://www.linkedin.com/in/taylorraack'>Taylor Raack</a>" if displayed in a web browser or b) "Initial Development by Taylor Raack (http://www.linkedin.com/in/taylorraack)" if displayed otherwise.
 ******************************************************************************/
package info.raack.appliancedetection.evaluation.model;

import info.raack.appliancedetection.evaluation.model.appliance.SimulatedAppliance;

import java.util.Date;
import java.util.List;

import org.apache.commons.lang.time.DurationFormatUtils;

import edu.cmu.hcii.stepgreen.data.ted.data.SecondData;

public class SimulationGroup {
	private int id;
	
	private List<Simulation> simulations;
	
	private int durationInSeconds;
	private int numAppliances;
	private int labelsPerOnOff;
	private int onConcurrency;
	
	protected Date startTime;
	
	private boolean done;
	
	private int numSimulations;
	
	public SimulationGroup(int numSimulations, Date startTime, int duration, int numAppliances, int onConcurrency, int labelsPerAppliance) {
		this.durationInSeconds = duration;
		this.numAppliances = numAppliances;
		this.labelsPerOnOff = labelsPerAppliance;
		this.onConcurrency = onConcurrency;
		this.startTime = startTime;
		this.numSimulations = numSimulations;
	}

	public int getId() {
		return id;
	}

	public void setId(int id) {
		this.id = id;
	}

	public List<Simulation> getSimulations() {
		return simulations;
	}

	public void setSimulations(List<Simulation> simulations) {
		this.simulations = simulations;
	}

	public int getDurationInSeconds() {
		return durationInSeconds;
	}

	public void setDurationInSeconds(int durationInSeconds) {
		this.durationInSeconds = durationInSeconds;
	}

	public int getNumAppliances() {
		return numAppliances;
	}

	public void setNumAppliances(int numAppliances) {
		this.numAppliances = numAppliances;
	}

	public int getLabelsPerOnOff() {
		return labelsPerOnOff;
	}

	public void setLabelsPerOnOff(int labelsPerOnOff) {
		this.labelsPerOnOff = labelsPerOnOff;
	}

	public int getOnConcurrency() {
		return onConcurrency;
	}

	public void setOnConcurrency(int onConcurrency) {
		this.onConcurrency = onConcurrency;
	}

	public Date getStartTime() {
		return startTime;
	}

	public void setStartTime(Date startTime) {
		this.startTime = startTime;
	}

	public boolean isDone() {
		return done;
	}

	public void setDone(boolean done) {
		this.done = done;
	}
	
	public int getNumSimulations() {
		return simulations != null ? simulations.size() : numSimulations;
	}

	public void setNumSimulations(int numSimulations) {
		if(simulations != null) {
			throw new RuntimeException("Cannot set the simulation number if simulations are already linked");
		}
		this.numSimulations = numSimulations;
	}

	public String toString() {
		return startTime + "; " + getNumSimulations() + " simulations; " + DurationFormatUtils.formatDurationWords((long)durationInSeconds * (long)1000, true, true) + "; " + numAppliances + " appliances; " + labelsPerOnOff + " labels per appliance; " + onConcurrency + " max appliances on at once";
	}
}