IpssAnalysisCaseFunc.java

/*
 * @(#)IpssScenarioHelper.java   
 *
 * Copyright (C) 2006-2010 www.interpss.org
 *
 * This program 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; either version 2.1
 * of the License, or (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * @Author Mike Zhou
 * @Version 1.0
 * @Date 09/01/2011
 * 
 *   Revision History
 *   ================
 *
 */

package org.ieee.odm.model.ext.ipss;

import static org.ieee.odm.ODMObjectFactory.OdmObjFactory;

import org.ieee.odm.schema.ActivePowerUnitType;
import org.ieee.odm.schema.PTradingEDHourlyAnalysisXmlType;
import org.ieee.odm.schema.PowerTradingInfoXmlType;
import org.ieee.odm.schema.PtAclfAnalysisXmlType;
import org.ieee.odm.schema.PtAnalysisOutputXmlType;
import org.ieee.odm.schema.PtCaseDataXmlType;
import org.ieee.odm.schema.PtEDispatchFileXmlType;

/**
 * InterPSS extension analysis case help funcions
 * 
 * @author mzhou
 *
 */
public class IpssAnalysisCaseFunc {
	/**
	 * initialize the PTradingEDHourlyAnalysis object
	 * 
	 * @param pt
	 */
	public static void initPTradingEDHourlyAnalysis(PTradingEDHourlyAnalysisXmlType pt) {
		
		PtCaseDataXmlType casedata = OdmObjFactory.createPtCaseDataXmlType();
		pt.setCaseData(casedata);
		
		PtEDispatchFileXmlType edfile = OdmObjFactory.createPtEDispatchFileXmlType();
		casedata.setEdFile(edfile);
		edfile.setFilename("ED file ...");
		edfile.setGenPFactor(0.9);
		edfile.setLossPercent(2.5);
		edfile.setLoadPFactor(0.98);

		casedata.setInterfaceLimitFilename("Interface limit file ...");
		
		PtAclfAnalysisXmlType aclf = OdmObjFactory.createPtAclfAnalysisXmlType();
		pt.setAclfAnalysis(aclf);
		
		aclf.setHour("12:00");
		
		aclf.setGenQAdjustment(false);
		aclf.setSwingBusPQAlloc(false);
		
		PtAnalysisOutputXmlType outOpt = OdmObjFactory.createPtAnalysisOutputXmlType();
		pt.setOutputOption(outOpt);
		outOpt.setBusVoltageUpperLimitPU(1.15);
		outOpt.setBusVoltageLowerLimitPU(0.80);
		outOpt.setLargeGSFPoints(5);
		outOpt.setBusVoltageViolation(true);
		outOpt.setBranchLimitViolation(false);
		outOpt.setInterfaceLimitViolation(false);
		outOpt.setZoneSummary(true);
		outOpt.setAreaSummary(true);
	}
	
	/**
	 * create a PowerTradingInfoXml object with default values
	 * 
	 * @return
	 */
	public static PowerTradingInfoXmlType createDefaultPtInfo() {
		PowerTradingInfoXmlType ptInfo = OdmObjFactory.createPowerTradingInfoXmlType();
		ptInfo.setLoadDist(OdmObjFactory.createPtLoadDistributionXmlType());
		setDefaultPtInfo(ptInfo);
		return ptInfo;
	}

	/**
	 * set the PowerTradingInfoXml object with default values
	 * 
	 */
	public static void setDefaultPtInfo(PowerTradingInfoXmlType ptInfo) {
		ptInfo.getLoadDist().setMinLoadForDistFactor(OdmObjFactory.createActivePowerXmlType());
		ptInfo.getLoadDist().getMinLoadForDistFactor().setValue(5.0);
		ptInfo.getLoadDist().getMinLoadForDistFactor().setUnit(ActivePowerUnitType.MW);
		ptInfo.getLoadDist().setAggregateGen(OdmObjFactory.createAggregateGenXmlType());
	}
}