TEST_F(AnalysisDriverFixture,SimpleProject_InsertMeasure) {
// create a new project
SimpleProject project = getCleanSimpleProject("SimpleProject_InsertMeasure");
// open a measure
openstudio::path dir = resourcesPath() / toPath("/utilities/BCL/Measures/SetWindowToWallRatioByFacade");
BCLMeasure measure = BCLMeasure::load(dir).get();
// insert it into the project
BCLMeasure projectMeasure = project.insertMeasure(measure);
// verify that there is a project-specific copy
EXPECT_NE(toString(measure.directory()),toString(projectMeasure.directory()));
openstudio::path scriptsDir = project.projectDir() / toPath("scripts");
EXPECT_EQ(toString(completeAndNormalize(scriptsDir)),
toString(completeAndNormalize(projectMeasure.directory().parent_path())));
EXPECT_EQ(measure.uuid(),projectMeasure.uuid());
EXPECT_EQ(measure.versionUUID(),projectMeasure.versionUUID()); // DLM: should this be not equal?
// verify that it can be retrieved from the project, but its arguments cannot
ASSERT_TRUE(project.getMeasureByUUID(measure.uuid()));
BCLMeasure temp = project.getMeasureByUUID(measure.uuid()).get();
EXPECT_EQ(toString(projectMeasure.directory()),toString(temp.directory()));
EXPECT_EQ(projectMeasure.uuid(),temp.uuid());
EXPECT_EQ(projectMeasure.versionUUID(),temp.versionUUID());
EXPECT_EQ(1u,project.measures().size());
// use embedded Ruby to extract the arguments
// (see AnalysisDriverFixture.cpp for interpreter set-up)
OSArgumentVector args = argumentGetter->getArguments(projectMeasure,
project.seedModel(),
project.seedIdf());
EXPECT_FALSE(args.empty());
// register and subsequently retrieve those arguments
project.registerArguments(measure,args); // doesn't matter which copy of the measure we use
EXPECT_TRUE(project.hasStoredArguments(temp));
OSArgumentVector argsCopy = project.getStoredArguments(projectMeasure);
ASSERT_EQ(args.size(),argsCopy.size());
for (int i = 0, n = args.size(); i < n; ++i) {
EXPECT_EQ(args[i].name(),argsCopy[i].name());
EXPECT_EQ(args[i].type(),argsCopy[i].type());
}
// use this measure to create a new variable/ruby measure
// now it is important to use the copy in the project
MeasureGroup dv("New Measure Group",MeasureVector());
Problem problem = project.analysis().problem();
problem.push(dv);
// here, expect this test to pass.
// in pat, if it fails, let user know and call problem.erase(dv).
EXPECT_TRUE(problem.fileTypesAreCompatible(dv,
projectMeasure.inputFileType(),
projectMeasure.outputFileType()));
EXPECT_TRUE(dv.push(RubyMeasure(projectMeasure)));
}
bool RubyMeasure_Impl::setMeasure(const BCLMeasure& bclMeasure) {
FileReferenceType inputFileType = bclMeasure.inputFileType();
FileReferenceType outputFileType = bclMeasure.outputFileType();
if (!fileTypesAreCompatible(inputFileType,outputFileType)) {
return false;
}
m_bclMeasure = bclMeasure;
m_bclMeasureDirectory = bclMeasure.directory();
m_bclMeasureUUID = bclMeasure.uuid();
m_bclMeasureVersionUUID = bclMeasure.versionUUID();
m_perturbationScript.reset();
m_inputFileType = inputFileType;
m_outputFileType = outputFileType;
m_isUserScript = false;
clearArguments(); // emits onChange(AnalysisObject_Impl::InvalidatesResults)
return true;
}
TEST_F(AnalysisFixture, Problem_FileTypesAreCompatible_ExistingMeasureGroup) {
// expected behavior when discrete variable already contains measures
// test with BCLMeasure first. verify with RubyMeasure.
// create problem
VariableVector variables;
variables.push_back(
MeasureGroup("Model Variable 1",
MeasureVector(1u,RubyMeasure(toPath("modelUserScript.rb"),
FileReferenceType::OSM,
FileReferenceType::OSM,
true))));
variables.back().cast<MeasureGroup>().insert(0,NullMeasure());
// 2
variables.push_back(
MeasureGroup("Translation Variable 1",
MeasureVector(1u,RubyMeasure(toPath("translationUserScript.rb"),
FileReferenceType::OSM,
FileReferenceType::IDF,
true))));
// 3
variables.push_back(
MeasureGroup("Workspace Variable 1",
MeasureVector(1u,RubyMeasure(toPath("workspaceUserScript.rb"),
FileReferenceType::IDF,
FileReferenceType::IDF,
true))));
variables.back().cast<MeasureGroup>().insert(0,NullMeasure());
runmanager::Workflow workflow;
workflow.addJob(runmanager::JobType::EnergyPlus);
Problem problem("Problem",variables,workflow);
// create measure to be pushed onto a variable
openstudio::path dir = resourcesPath() / toPath("/utilities/BCL/Measures/v2/SetWindowToWallRatioByFacade");
BCLMeasure bclMeasure = BCLMeasure::load(dir).get();
EXPECT_EQ(FileReferenceType(FileReferenceType::OSM),bclMeasure.inputFileType());
EXPECT_EQ(FileReferenceType(FileReferenceType::OSM),bclMeasure.outputFileType());
RubyMeasure measure(bclMeasure);
ASSERT_EQ(3,problem.numVariables());
// can be added to variable 0 (OSM)
WorkflowStep step = problem.workflow()[0];
InputVariable var = step.inputVariable();
EXPECT_EQ(2u,var.cast<MeasureGroup>().numMeasures(false));
EXPECT_TRUE(problem.fileTypesAreCompatible(step,
measure.inputFileType(),
measure.outputFileType()));
EXPECT_TRUE(var.cast<MeasureGroup>().push(measure));
EXPECT_EQ(3u,var.cast<MeasureGroup>().numMeasures(false));
// cannot be added to variable 1 (translation)
step = problem.workflow()[1];
var = step.inputVariable();
EXPECT_EQ(1u,var.cast<MeasureGroup>().numMeasures(false));
EXPECT_FALSE(problem.fileTypesAreCompatible(step,
measure.inputFileType(),
measure.outputFileType()));
EXPECT_FALSE(var.cast<MeasureGroup>().push(measure));
EXPECT_EQ(1u,var.cast<MeasureGroup>().numMeasures(false));
// cannot be added to variable 2 (IDF)
step = problem.variables()[2];
var = step.inputVariable();
EXPECT_EQ(2u,var.cast<MeasureGroup>().numMeasures(false));
EXPECT_FALSE(problem.fileTypesAreCompatible(step,
measure.inputFileType(),
measure.outputFileType()));
EXPECT_FALSE(var.cast<MeasureGroup>().push(measure));
EXPECT_EQ(2u,var.cast<MeasureGroup>().numMeasures(false));
}
TEST_F(AnalysisFixture, Problem_FileTypesAreCompatible_NewMeasureGroup) {
// ok to insert null-only discrete variable anywhere in the chain
// (between null-model, model-model, idf-idf, idf-workflow)
VariableVector variables;
// 0
variables.push_back(
MeasureGroup("Null Variable 1",
MeasureVector(1u,NullMeasure())));
// 1
variables.push_back(
MeasureGroup("Model Variable 1",
MeasureVector(1u,RubyMeasure(toPath("modelUserScript.rb"),
FileReferenceType::OSM,
FileReferenceType::OSM,
true))));
// 2
variables.push_back(
MeasureGroup("Translation Variable 1",
MeasureVector(1u,RubyMeasure(toPath("translationUserScript.rb"),
FileReferenceType::OSM,
FileReferenceType::IDF,
true))));
// 3
variables.push_back(
MeasureGroup("Workspace Variable 1",
MeasureVector(1u,RubyMeasure(toPath("workspaceUserScript.rb"),
FileReferenceType::IDF,
FileReferenceType::IDF,
true))));
runmanager::Workflow workflow;
workflow.addJob(runmanager::JobType::EnergyPlus);
Problem problem("Problem 1",variables,workflow);
MeasureGroup newVar("New Discrete Variable",
MeasureVector(1u,NullMeasure()));
EXPECT_TRUE(problem.insert(4,newVar.clone().cast<InputVariable>()));
ASSERT_EQ(5,problem.numVariables());
EXPECT_EQ("New Discrete Variable",problem.variables()[4].name());
EXPECT_TRUE(problem.insert(3,newVar.clone().cast<InputVariable>()));
EXPECT_EQ(6,problem.numVariables());
ASSERT_GE(problem.numVariables(),5);
EXPECT_EQ("Translation Variable 1",problem.variables()[2].name());
EXPECT_EQ("New Discrete Variable",problem.variables()[3].name());
EXPECT_EQ("Workspace Variable 1",problem.variables()[4].name());
EXPECT_TRUE(problem.insert(2,newVar.clone().cast<InputVariable>()));
EXPECT_TRUE(problem.insert(1,newVar.clone().cast<InputVariable>()));
EXPECT_TRUE(problem.insert(0,newVar.clone().cast<InputVariable>()));
EXPECT_EQ(9,problem.numVariables());
variables = castVector<Variable>(problem.variables());
for (int i = 0, n = problem.numVariables(); i < n; ++i) {
if (i % 2 == 0) {
EXPECT_EQ("New Discrete Variable",variables[i].name());
}
else {
EXPECT_NE("New Discrete Variable",variables[i].name());
}
}
// (between null-idf, idf-idf, idf-workflow)
variables.clear();
// 0
variables.push_back(
MeasureGroup("Null Variable 1",
MeasureVector(1u,NullMeasure())));
// 1
variables.push_back(
MeasureGroup("Workspace Variable 1",
MeasureVector(1u,RubyMeasure(toPath("workspaceUserScript.rb"),
FileReferenceType::IDF,
FileReferenceType::IDF,
true))));
// 2
variables.push_back(
MeasureGroup("Workspace Variable 2",
MeasureVector(1u,RubyMeasure(toPath("workspaceUserScript.rb"),
FileReferenceType::IDF,
FileReferenceType::IDF,
true))));
problem = Problem("Problem 2",variables,workflow);
EXPECT_TRUE(problem.insert(3,newVar.clone().cast<InputVariable>()));
EXPECT_TRUE(problem.insert(2,newVar.clone().cast<InputVariable>()));
EXPECT_TRUE(problem.insert(1,newVar.clone().cast<InputVariable>()));
EXPECT_TRUE(problem.insert(0,newVar.clone().cast<InputVariable>()));
EXPECT_EQ(7,problem.numVariables());
variables = castVector<Variable>(problem.variables());
for (int i = 0, n = problem.numVariables(); i < n; ++i) {
if (i % 2 == 0) {
EXPECT_EQ("New Discrete Variable",variables[i].name());
}
else {
EXPECT_NE("New Discrete Variable",variables[i].name());
}
}
// expected behavior for then adding first measure
// test with BCLMeasure first. verify with RubyMeasure.
openstudio::path dir = resourcesPath() / toPath("/utilities/BCL/Measures/v2/SetWindowToWallRatioByFacade");
BCLMeasure bclMeasure = BCLMeasure::load(dir).get();
EXPECT_EQ(FileReferenceType(FileReferenceType::OSM),bclMeasure.inputFileType());
EXPECT_EQ(FileReferenceType(FileReferenceType::OSM),bclMeasure.outputFileType());
RubyMeasure measure(bclMeasure);
// have idf-only problem with two null variables at the top
// try to add measures to first variable
MeasureGroup firstVariable = problem.variables()[0].cast<MeasureGroup>();
ASSERT_TRUE(firstVariable.parent());
WorkflowStep step0 = problem.workflow()[0];
EXPECT_TRUE(firstVariable.parent().get() == step0);
EXPECT_EQ(1u,firstVariable.numMeasures(false));
EXPECT_FALSE(problem.fileTypesAreCompatible(firstVariable,
measure.inputFileType(),
measure.outputFileType()));
ASSERT_TRUE(firstVariable.parent());
EXPECT_TRUE(firstVariable.parent().get() == problem.workflow()[0]);
EXPECT_TRUE(problem.workflow()[0] == step0);
EXPECT_FALSE(firstVariable.push(measure));
EXPECT_EQ(1u,firstVariable.numMeasures(false));
// make second variable a translation variable
MeasureGroup secondVariable = problem.variables()[1].cast<MeasureGroup>();
EXPECT_FALSE(secondVariable.push(RubyMeasure(toPath("myTranslationScript.rb"),
FileReferenceType::OSM,
FileReferenceType::IDF)));
secondVariable.erase(secondVariable.measures(false)[0]);
EXPECT_TRUE(secondVariable.push(RubyMeasure(toPath("myTranslationScript.rb"),
FileReferenceType::OSM,
FileReferenceType::IDF)));
// now should be able to add OSM measure
EXPECT_TRUE(problem.fileTypesAreCompatible(firstVariable,
measure.inputFileType(),
measure.outputFileType()));
EXPECT_TRUE(firstVariable.push(measure));
EXPECT_EQ(2u,firstVariable.numMeasures(false));
}
bool RubyMeasure_Impl::updateMeasure(const BCLMeasure& newVersion,
std::vector<ruleset::OSArgument> newArguments)
{
if (!usesBCLMeasure() || (newVersion.uuid() != m_bclMeasureUUID.get())) {
return false;
}
FileReferenceType inputFileType = newVersion.inputFileType();
FileReferenceType outputFileType = newVersion.outputFileType();
if (!fileTypesAreCompatible(inputFileType,outputFileType)) {
return false;
}
m_bclMeasure = newVersion;
m_bclMeasureDirectory = newVersion.directory();
OS_ASSERT(m_bclMeasureUUID.get() == newVersion.uuid());
m_bclMeasureVersionUUID = newVersion.versionUUID();
m_inputFileType = inputFileType;
m_outputFileType = outputFileType;
m_isUserScript = false;
// preserve current argument values
// otherwise, prefer newArguments definitions and order
OSArgumentVector argsToSet;
OSArgumentVector currentArgs = arguments();
BOOST_FOREACH(const OSArgument& newArg,newArguments) {
OSArgument newArgClone = newArg.clone();
// look for current value
NameFinder<OSArgument> finder(newArgClone.name(),true);
ruleset::OSArgumentVector::iterator it = std::find_if(currentArgs.begin(),
currentArgs.end(),
finder);
if (it != currentArgs.end()) {
// already exists--try to preserve value
if (it->hasValue()) {
bool setResult(false);
switch(it->type().value()) {
case OSArgumentType::Boolean :
setResult = newArgClone.setValue(it->valueAsBool());
break;
case OSArgumentType::Double :
setResult = newArgClone.setValue(it->valueAsDouble());
break;
case OSArgumentType::Quantity :
setResult = newArgClone.setValue(it->valueAsQuantity());
break;
case OSArgumentType::Integer :
setResult = newArgClone.setValue(it->valueAsInteger());
break;
default :
break;
}
if (!setResult) {
// try string conversion by default or if failed
setResult = newArgClone.setValue(it->valueAsString());
if (!setResult) {
LOG(Info,"Unable to preserve argument value for " << *it
<< " during updateMeasure operation on RubyMeasure named " << name()
<< " with measure " << newVersion.name() << " and new argument " << newArgClone);
}
}
}
}
argsToSet.push_back(newArgClone);
}