/**
* Set commands that do not require a circuit.
*
* <p>This is for setting global options that do not require an active circuit.
*/
public static boolean doSetCmd_NoCircuit() {
boolean success = true;
Parser parser = Parser.getInstance();
// Continue parsing command line
int paramPointer = -1;
String paramName = parser.getNextParam();
String param = parser.stringValue();
while (param.length() > 0) {
if (paramName.length() == 0) {
paramPointer += 1;
} else {
paramPointer = optionList.getCommand(paramName);
}
switch (paramPointer) {
case -1:
DSS.doSimpleMsg("Unknown parameter \"" + paramName + "\" for set command ", 130);
break;
case 14:
DSS.defaultEditor = param; // 'editor='
break;
case 56:
DSS.setDataPath(param); // set a legal data path
break;
case 66:
Executive.getInstance().setRecorderOn(Util.interpretYesNo(param));
break;
case 72:
DSS.defaultBaseFreq = parser.doubleValue();
break;
default:
DSS.doSimpleMsg(
"You must create a circuit to execute this \"set\" command: " + parser.getCommand(),
301);
success = false; // indicate that we could not process all set command
break;
}
paramName = parser.getNextParam();
param = parser.stringValue();
}
return success;
}
/** Get DSS options requested and put in the global result string. */
public static int doGetCmd() {
int paramPointer;
Circuit ckt = DSS.activeCircuit;
try {
DSS.globalResult = ""; // initialize for appending
// continue parsing command line
String paramName = Parser.getInstance().getNextParam();
String param = Parser.getInstance().stringValue();
// there will be no named parameters in this command and the params
// themselves will be the parameter name to return
while (param.length() > 0) {
paramPointer = optionList.getCommand(param);
switch (paramPointer) {
case -1:
DSS.doSimpleMsg("Unknown parameter \"" + paramName + "\" for Get command ", 133);
break;
case 0:
DSS.appendGlobalResult(ckt.getActiveCktElement().getDSSClassName());
break;
case 11:
DSS.appendGlobalResult(ckt.getActiveCktElement().getDSSClassName());
break;
case 1:
DSS.appendGlobalResult(ckt.getActiveCktElement().getName());
break;
case 12:
DSS.appendGlobalResult(ckt.getActiveCktElement().getName());
break;
case 2:
DSS.appendGlobalResult(String.valueOf(ckt.getSolution().getIntHour()));
break;
case 3:
DSS.appendGlobalResult(String.format("%g", ckt.getSolution().getDynaVars().t));
break;
case 4:
DSS.appendGlobalResult(String.valueOf(ckt.getSolution().getYear()));
break;
case 5:
DSS.appendGlobalResult(String.format("%g", ckt.getSolution().getFrequency()));
break;
case 6:
DSS.appendGlobalResult(String.format("%g", ckt.getSolution().getDynaVars().h));
break;
case 17:
DSS.appendGlobalResult(String.format("%g", ckt.getSolution().getDynaVars().h));
break;
case 7:
DSS.appendGlobalResult(Util.getSolutionModeID());
break;
case 8:
DSS.appendGlobalResult(Util.getRandomModeID());
break;
case 9:
DSS.appendGlobalResult(String.valueOf(ckt.getSolution().getNumberOfTimes()));
break;
case 10:
DSS.appendGlobalResult(
String.format(
"[ %d, %g ]",
String.valueOf(ckt.getSolution().getIntHour()),
ckt.getSolution().getDynaVars().t));
break;
case 13:
DSS.appendGlobalResult(ckt.getName());
break;
case 14:
DSS.appendGlobalResult(DSS.defaultEditor);
break;
case 15:
DSS.appendGlobalResult(
String.format("%g", ckt.getSolution().getConvergenceTolerance()));
break;
case 16:
DSS.appendGlobalResult(String.valueOf(ckt.getSolution().getMaxIterations()));
break;
case 18:
DSS.appendGlobalResult(Util.getLoadModel());
break;
case 19:
DSS.appendGlobalResult(String.format("%g", ckt.getLoadMultiplier()));
break;
case 20:
DSS.appendGlobalResult(String.format("%g", ckt.getNormalMinVolts()));
break;
case 21:
DSS.appendGlobalResult(String.format("%g", ckt.getNormalMaxVolts()));
break;
case 22:
DSS.appendGlobalResult(String.format("%g", ckt.getEmergMinVolts()));
break;
case 23:
DSS.appendGlobalResult(String.format("%g", ckt.getEmergMaxVolts()));
break;
case 24:
DSS.appendGlobalResult(
String.format("%g", ckt.getDefaultDailyShapeObj().getMean() * 100.0));
break;
case 25:
DSS.appendGlobalResult(
String.format("%g", ckt.getDefaultDailyShapeObj().getStdDev() * 100.0));
break;
case 26:
DSS.appendGlobalResult(ckt.getLoadDurCurve());
break;
case 27:
DSS.appendGlobalResult(String.format("%g", (ckt.getDefaultGrowthRate() - 1.0) * 100.0));
break;
case 28:
DSS.appendGlobalResult(String.format("%g", ckt.getAutoAddObj().getGenKW()));
break;
case 29:
DSS.appendGlobalResult(String.format("%g", ckt.getAutoAddObj().getGenPF()));
break;
case 30:
DSS.appendGlobalResult(String.format("%g", ckt.getAutoAddObj().getCapKVAr()));
break;
case 31:
switch (ckt.getAutoAddObj().getAddType()) {
case GEN:
DSS.appendGlobalResult("generator");
break;
case CAP:
DSS.appendGlobalResult("capacitor");
break;
}
break;
case 32:
if (ckt.isDuplicatesAllowed()) {
DSS.appendGlobalResult("Yes");
} else {
DSS.appendGlobalResult("No");
}
break;
case 33:
if (ckt.isZonesLocked()) {
DSS.appendGlobalResult("Yes");
} else {
DSS.appendGlobalResult("No");
}
break;
case 34:
DSS.appendGlobalResult(String.format("%g", ckt.getUEWeight()));
break;
case 35:
DSS.appendGlobalResult(String.format("%g", ckt.getLossWeight()));
break;
case 36:
DSS.appendGlobalResult(Util.intArrayToString(ckt.getUERegs(), ckt.getNumUERegs()));
break;
case 37:
DSS.appendGlobalResult(Util.intArrayToString(ckt.getLossRegs(), ckt.getNumLossRegs()));
break;
case 38:
DSS.globalResult = "(";
for (double vBase : ckt.getLegalVoltageBases())
DSS.globalResult += String.format("%g, ", vBase);
DSS.globalResult += ")";
break;
case 39:
switch (ckt.getSolution().getAlgorithm()) {
case NORMAL:
DSS.appendGlobalResult("normal");
break;
case NEWTON:
DSS.appendGlobalResult("newton");
break;
}
break;
case 40:
if (ckt.isTrapezoidalIntegration()) {
DSS.appendGlobalResult("Yes");
} else {
DSS.appendGlobalResult("No");
}
break;
case 41:
for (int i = 0; i < ckt.getAutoAddBusList().listSize(); i++)
DSS.appendGlobalResult(ckt.getAutoAddBusList().get(i));
break;
case 42:
DSS.appendGlobalResult(Util.getControlModeID());
break;
case 43:
if (ckt.getControlQueue().isTrace()) {
DSS.appendGlobalResult("Yes");
} else {
DSS.appendGlobalResult("No");
}
break;
case 44:
DSS.appendGlobalResult(String.format("%g", ckt.getGenMultiplier()));
break;
case 45:
DSS.appendGlobalResult(ckt.getDefaultDailyShapeObj().getName());
break;
case 46:
DSS.appendGlobalResult(ckt.getDefaultYearlyShapeObj().getName());
break;
case 47:
DSS.appendGlobalResult("Get function not applicable.");
break;
case 48:
if (ckt.isPositiveSequence()) {
DSS.appendGlobalResult("positive");
} else {
DSS.appendGlobalResult("multiphase");
}
break;
case 49:
DSS.appendGlobalResult(String.format("%g", ckt.getPriceSignal()));
break;
case 50:
DSS.appendGlobalResult(ckt.getPriceCurve());
break;
case 51:
DSS.appendGlobalResult(
String.format("%d", ckt.getActiveCktElement().getActiveTerminalIdx()));
break;
case 52:
DSS.appendGlobalResult(String.format("%g", ckt.getFundamental()));
break;
case 53:
if (ckt.getSolution().isDoAllHarmonics()) {
DSS.appendGlobalResult("ALL");
} else {
for (int i = 0; i < ckt.getSolution().getHarmonicListSize(); i++)
DSS.appendGlobalResult(String.format("%g", ckt.getSolution().getHarmonicList()[i]));
}
break;
case 54:
DSS.appendGlobalResult(String.valueOf(ckt.getSolution().getMaxControlIterations()));
break;
case 55:
DSS.appendGlobalResult(ckt.getBusList().get(ckt.getActiveBusIndex()));
break;
case 56:
DSS.appendGlobalResult(DSS.dataDirectory);
break;
case 57:
for (int i = 0; i < ckt.getNumBuses(); i++)
if (ckt.getBus(i).isKeep()) DSS.appendGlobalResult(ckt.getBusList().get(i));
break;
case 58:
DSS.appendGlobalResult(ckt.getReductionStrategyString());
break;
case 59:
if (DSS.energyMeterClass.isSaveDemandInterval()) {
DSS.appendGlobalResult("Yes");
} else {
DSS.appendGlobalResult("No");
}
break;
case 60:
DSS.appendGlobalResult(String.format("%-.g", ckt.getPctNormalFactor()));
break;
case 61:
if (DSS.energyMeterClass.isDI_Verbose()) {
DSS.appendGlobalResult("Yes");
} else {
DSS.appendGlobalResult("No");
}
break;
case 62:
DSS.appendGlobalResult(ckt.getCaseName());
break;
case 63:
DSS.appendGlobalResult(String.format("%d", ckt.getNodeMarkerCode()));
break;
case 64:
DSS.appendGlobalResult(String.format("%d", ckt.getNodeMarkerWidth()));
break;
case 65:
if (ckt.isLogEvents()) {
DSS.appendGlobalResult("Yes");
} else {
DSS.appendGlobalResult("No");
}
break;
case 66:
if (Executive.getInstance().isRecorderOn()) {
DSS.appendGlobalResult("Yes");
} else {
DSS.appendGlobalResult("No");
}
break;
case 67:
if (DSS.energyMeterClass.isDoOverloadReport()) {
DSS.appendGlobalResult("Yes");
} else {
DSS.appendGlobalResult("No");
}
break;
case 68:
if (DSS.energyMeterClass.isDoVoltageExceptionReport()) {
DSS.appendGlobalResult("Yes");
} else {
DSS.appendGlobalResult("No");
}
break;
case 69:
DSS.appendGlobalResult("Get function not applicable.");
break;
case 70:
if (DSS.autoShowExport) {
DSS.appendGlobalResult("Yes");
} else {
DSS.appendGlobalResult("No");
}
break;
case 71:
DSS.appendGlobalResult(String.format("%d", DSS.maxAllocationIterations));
break;
case 72:
DSS.appendGlobalResult(String.format("%d", DSS.defaultBaseFreq));
break;
case 73:
if (ckt.isMarkSwitches()) {
DSS.appendGlobalResult("Yes");
} else {
DSS.appendGlobalResult("No");
}
break;
case 74:
DSS.appendGlobalResult(String.format("%d", ckt.getSwitchMarkerCode()));
break;
case 75:
DSS.appendGlobalResult(String.format("%-.6g", DSS.daisySize));
break;
case 76:
if (ckt.isMarkTransformers()) {
DSS.appendGlobalResult("Yes");
} else {
DSS.appendGlobalResult("No");
}
break;
case 77:
DSS.appendGlobalResult(String.format("%d", ckt.getTransMarkerCode()));
break;
case 78:
DSS.appendGlobalResult(String.format("%d", ckt.getTransMarkerSize()));
break;
case 79:
DSS.appendGlobalResult(Util.getActiveLoadShapeClass());
break;
case 80:
DSS.appendGlobalResult(Util.getEarthModel(DSS.defaultEarthModel));
break;
case 81:
if (DSS.logQueries) {
DSS.appendGlobalResult("Yes");
} else {
DSS.appendGlobalResult("No");
}
default:
// ignore excess parameters
break;
}
paramName = Parser.getInstance().getNextParam();
param = Parser.getInstance().stringValue();
}
} catch (Exception e) {
DSS.appendGlobalResult("***Error***");
}
return 0;
}
/**
* Set DSS options.
*
* <p>Solve command is re-routed here first to set options before solving.
*/
public static int doSetCmd(int solveOption) {
LoadShapeObj testLoadShapeObj;
int[] numRegs;
Parser parser = Parser.getInstance();
Circuit ckt = DSS.activeCircuit;
int ret = 0;
// continue parsing command line
int paramPointer = -1;
String paramName = parser.getNextParam();
String param = parser.stringValue();
while (param.length() > 0) {
if (paramName.length() == 0) {
paramPointer += 1;
} else {
paramPointer = optionList.getCommand(paramName);
}
switch (paramPointer) {
case -1:
DSS.doSimpleMsg("Unknown parameter \"" + paramName + "\" for set command ", 130);
break;
case 0:
case 11:
DSSClassDefs.setObjectClass(param);
break;
case 1:
case 12:
DSS.setObject(param);
break;
case 2:
ckt.getSolution().setIntHour(parser.integerValue());
break;
case 3:
ckt.getSolution().getDynaVars().t = parser.doubleValue();
break;
case 4:
ckt.getSolution().setYear(parser.integerValue());
ckt.setDefaultGrowthFactor(
Math.pow(ckt.getDefaultGrowthRate(), ckt.getSolution().getYear() - 1));
break;
case 5:
ckt.getSolution().setFrequency(parser.doubleValue());
break;
case 6:
ckt.getSolution().getDynaVars().h = Util.interpretTimeStepSize(param);
break;
case 17:
ckt.getSolution().getDynaVars().h = Util.interpretTimeStepSize(param);
break;
case 7:
ckt.getSolution().setMode(Util.interpretSolveMode(param)); // see DSSGlobals
break;
case 8:
ckt.getSolution().setRandomType(Util.interpretRandom(param));
break;
case 9:
ckt.getSolution().setNumberOfTimes(parser.integerValue());
break;
case 10:
ExecHelper.setTime();
break;
case 13:
ExecHelper.setActiveCircuit(param);
break;
case 14:
DSS.defaultEditor = param; // 'Editor='
break;
case 15:
ckt.getSolution().setConvergenceTolerance(parser.doubleValue());
break;
case 16:
ckt.getSolution().setMaxIterations(parser.integerValue());
break;
case 18:
ckt.getSolution()
.setDefaultLoadModel(
Util.interpretLoadModel(param)); // for reverting to last on specified
ckt.getSolution().setLoadModel(ckt.getSolution().getDefaultLoadModel());
break;
case 19:
ckt.setLoadMultiplier(parser.doubleValue()); // set using loadMultiplier property
break;
case 20:
ckt.setNormalMinVolts(parser.doubleValue());
break;
case 21:
ckt.setNormalMaxVolts(parser.doubleValue());
break;
case 22:
ckt.setEmergMinVolts(parser.doubleValue());
break;
case 23:
ckt.setEmergMaxVolts(parser.doubleValue());
break;
case 24:
ckt.getDefaultDailyShapeObj().setMean(parser.doubleValue() / 100.0);
break;
case 25:
ckt.getDefaultDailyShapeObj().setStdDev(parser.doubleValue() / 100.0);
break;
case 26:
ckt.setLoadDurCurve(param);
ckt.setLoadDurCurveObj((LoadShapeObj) DSS.loadShapeClass.find(param));
if (ckt.getLoadDurCurveObj() == null)
DSS.doSimpleMsg("Load-duration curve not found.", 131);
break;
case 27:
ckt.setDefaultGrowthRate(1.0 + parser.doubleValue() / 100.0);
ckt.setDefaultGrowthFactor(
Math.pow(ckt.getDefaultGrowthRate(), ckt.getSolution().getYear() - 1));
break;
case 28:
ckt.getAutoAddObj().setGenKW(parser.doubleValue());
break;
case 29:
ckt.getAutoAddObj().setGenPF(parser.doubleValue());
break;
case 30:
ckt.getAutoAddObj().setCapKVAr(parser.doubleValue());
break;
case 31:
ckt.getAutoAddObj().setAddType(Util.interpretAddType(param));
break;
case 32:
ckt.setDuplicatesAllowed(Util.interpretYesNo(param));
break;
case 33:
ckt.setZonesLocked(Util.interpretYesNo(param));
break;
case 34:
ckt.setUEWeight(parser.doubleValue());
break;
case 35:
ckt.setLossWeight(parser.doubleValue());
break;
case 36:
numRegs = new int[1];
ckt.setUERegs(Util.parseIntArray(ckt.getUERegs(), numRegs, param));
ckt.setNumUERegs(numRegs[0]);
break;
case 37:
numRegs = new int[1];
ckt.setLossRegs(Util.parseIntArray(ckt.getLossRegs(), numRegs, param));
ckt.setNumLossRegs(numRegs[0]);
break;
case 38:
ExecHelper.doLegalVoltageBases();
break;
case 39:
ckt.getSolution().setAlgorithm(Util.interpretSolveAlg(param));
break;
case 40:
ckt.setTrapezoidalIntegration(Util.interpretYesNo(param));
break;
case 41:
ExecHelper.doAutoAddBusList(param);
break;
case 42:
ckt.getSolution().setControlMode(Util.interpretControlMode(param));
ckt.getSolution()
.setDefaultControlMode(
ckt.getSolution()
.getControlMode()); // always revert to last one specified in a script
break;
case 43:
ckt.getControlQueue().setTrace(Util.interpretYesNo(param));
break;
case 44:
ckt.setGenMultiplier(parser.doubleValue());
break;
case 45:
testLoadShapeObj = (LoadShapeObj) DSS.loadShapeClass.find(param);
if (testLoadShapeObj != null) ckt.setDefaultDailyShapeObj(testLoadShapeObj);
break;
case 46:
testLoadShapeObj = (LoadShapeObj) DSS.loadShapeClass.find(param);
if (testLoadShapeObj != null) ckt.setDefaultYearlyShapeObj(testLoadShapeObj);
break;
case 47:
ExecHelper.doSetAllocationFactors(parser.doubleValue());
break;
case 48:
ckt.setPositiveSequence(Util.interpretCktModel(param));
break;
case 49:
ckt.setPriceSignal(parser.doubleValue());
break;
case 50:
ckt.setPriceCurve(param);
ckt.setPriceCurveObj((PriceShapeObj) DSS.loadShapeClass.find(param));
if (ckt.getPriceCurveObj() == null)
DSS.doSimpleMsg("PriceShape: \"" + param + "\" not found.", 132);
break;
case 51:
if (ckt.getActiveCktElement() != null) {
CktElement elem = ckt.getActiveCktElement();
elem.setActiveTerminalIdx(parser.integerValue());
DSS.setActiveBus(
Util.stripExtension(
elem.getBus(elem.getActiveTerminalIdx()))); // bus connected to terminal
}
break;
case 52:
ckt.setFundamental(
parser.doubleValue()); // set base frequency for system (used henceforth)
ckt.getSolution().setFrequency(parser.doubleValue());
break;
case 53:
ExecHelper.doHarmonicsList(param);
break;
case 54:
ckt.getSolution().setMaxControlIterations(parser.integerValue());
break;
case 55:
ret = DSS.setActiveBus(param); // see DSS globals
break;
case 56:
DSS.setDataPath(param); // set a legal data path
break;
case 57:
ExecHelper.doKeeperBusList(param);
break;
case 58:
ExecHelper.doSetReduceStrategy(param);
break;
case 59:
DSS.energyMeterClass.setSaveDemandInterval(Util.interpretYesNo(param));
break;
case 60:
ckt.setPctNormalFactor(parser.doubleValue());
ExecHelper.doSetNormal(ckt.getPctNormalFactor());
break;
case 61:
DSS.energyMeterClass.setDIVerbose(Util.interpretYesNo(param));
break;
case 62:
ckt.setCaseName(parser.stringValue());
break;
case 63:
ckt.setNodeMarkerCode(parser.integerValue());
break;
case 64:
ckt.setNodeMarkerWidth(parser.integerValue());
break;
case 65:
ckt.setLogEvents(Util.interpretYesNo(param));
break;
case 66:
Executive.getInstance().setRecorderOn(Util.interpretYesNo(param));
break;
case 67:
DSS.energyMeterClass.setDoOverloadReport(Util.interpretYesNo(param));
break;
case 68:
DSS.energyMeterClass.setDoVoltageExceptionReport(Util.interpretYesNo(param));
break;
case 69:
ExecHelper.doSetCFactors(parser.doubleValue());
break;
case 70:
DSS.autoShowExport = Util.interpretYesNo(param);
break;
case 71:
DSS.maxAllocationIterations = parser.integerValue();
break;
case 72:
DSS.defaultBaseFreq = parser.doubleValue();
ckt.setFundamental(
parser.doubleValue()); // set base frequency for system (used henceforth)
ckt.getSolution().setFrequency(parser.doubleValue());
break;
case 73:
ckt.setMarkSwitches(Util.interpretYesNo(param));
break;
case 74:
ckt.setSwitchMarkerCode(parser.integerValue());
break;
case 75:
DSS.daisySize = parser.doubleValue();
break;
case 76:
ckt.setMarkTransformers(Util.interpretYesNo(param));
break;
case 77:
ckt.setTransMarkerCode(parser.integerValue());
break;
case 78:
ckt.setTransMarkerSize(parser.integerValue());
break;
case 79:
ckt.setActiveLoadShapeClass(Util.interpretLoadShapeClass(param));
break;
case 80:
DSS.defaultEarthModel = Util.interpretEarthModel(param);
break;
case 81:
DSS.logQueries = Util.interpretYesNo(param);
if (DSS.logQueries) DSS.resetQueryLogFile();
default:
// ignore excess parameters
break;
}
switch (paramPointer) {
case 3:
ckt.getSolution().updateDblHour();
break;
case 4:
ckt.getSolution().updateDblHour();
break;
}
paramName = parser.getNextParam();
param = parser.stringValue();
}
if (solveOption == 1) ExecHelper.doSolveCmd();
return ret;
}