boost::optional<BCLMeasure> WorkflowJSON_Impl::addMeasure(const BCLMeasure& bclMeasure)
{
boost::optional<BCLMeasure> existingMeasure = getBCLMeasureByUUID(bclMeasure.uuid());
boost::optional<openstudio::path> existingMeasureDirName;
if (existingMeasure){
// TODO: check that measure type has not changed?
existingMeasureDirName = existingMeasure->directory();
boost::filesystem::remove_all(*existingMeasureDirName);
}
std::vector<openstudio::path> paths = absoluteMeasurePaths();
OS_ASSERT(!paths.empty());
// Get the name of the directory (=last level directory name), eg: /path/to/measure_folder => measure_folder
openstudio::path lastLevelDirectoryName = getLastLevelDirectoryName( bclMeasure.directory() );
if (!toUUID(toString(lastLevelDirectoryName)).isNull()){
// directory name is convertible to uuid, use the class name
lastLevelDirectoryName = toPath(bclMeasure.className());
}
int i = 1;
while (boost::filesystem::exists(paths[0] / lastLevelDirectoryName)){
std::stringstream ss;
ss << toString(lastLevelDirectoryName) << " " << i;
lastLevelDirectoryName = toPath(ss.str());
}
openstudio::path newMeasureDirName = paths[0] / lastLevelDirectoryName;
// If we have an existing measure
if( existingMeasureDirName) {
openstudio::path lastLevelExistingDirectoryName = getLastLevelDirectoryName(*existingMeasureDirName);
// And the previous directory name isn't the same as the new one
if( lastLevelExistingDirectoryName != lastLevelDirectoryName ) {
// update steps
for (auto& step : m_steps){
if (auto measureStep = step.optionalCast<MeasureStep>()){
if (measureStep->measureDirName() == toString(lastLevelExistingDirectoryName) ) {
measureStep->setMeasureDirName(toString(lastLevelDirectoryName));
}
}
}
}
}
onUpdate();
return bclMeasure.clone(newMeasureDirName);
}
TEST_F(ProjectFixture, RubyMeasureRecord_BCLMeasure) {
// Construct problem with RubyMeasure that points to BCLMeasure
Problem problem("Problem",VariableVector(),runmanager::Workflow());
MeasureGroup dvar("Variable",MeasureVector());
problem.push(dvar);
openstudio::path measuresPath = resourcesPath() / toPath("/utilities/BCL/Measures");
openstudio::path dir = measuresPath / toPath("SetWindowToWallRatioByFacade");
BCLMeasure measure = BCLMeasure::load(dir).get();
RubyMeasure rpert(measure);
dvar.push(rpert);
OSArgument arg = OSArgument::makeDoubleArgument("wwr");
arg.setValue(0.4);
rpert.setArgument(arg);
arg = OSArgument::makeIntegerArgument("typo_arg");
arg.setDefaultValue(1);
rpert.setArgument(arg);
// Serialize to database
{
ProjectDatabase database = getCleanDatabase("RubyMeasureRecord_BCLMeasure");
bool didStartTransaction = database.startTransaction();
EXPECT_TRUE(didStartTransaction);
// Problem Record
ProblemRecord problemRecord = ProblemRecord::factoryFromProblem(problem,database);
database.save();
if (didStartTransaction) {
EXPECT_TRUE(database.commitTransaction());
}
}
// Re-open database, de-serialize, verify that RubyMeasure is intact.
openstudio::path tempDir1 = measuresPath / toPath(toString(createUUID()));
{
ProjectDatabase database = getExistingDatabase("RubyMeasureRecord_BCLMeasure");
ASSERT_EQ(1u,ProblemRecord::getProblemRecords(database).size());
ASSERT_EQ(1u,MeasureGroupRecord::getMeasureGroupRecords(database).size());
EXPECT_EQ(1u,RubyMeasureRecord::getRubyMeasureRecords(database).size());
MeasureRecordVector dprs = MeasureGroupRecord::getMeasureGroupRecords(database)[0].measureRecords(false);
ASSERT_EQ(1u,dprs.size());
ASSERT_TRUE(dprs[0].optionalCast<RubyMeasureRecord>());
RubyMeasureRecord rpr = dprs[0].cast<RubyMeasureRecord>();
RubyMeasure rp = rpr.rubyMeasure();
EXPECT_TRUE(rp.usesBCLMeasure());
EXPECT_TRUE(rp.measure());
EXPECT_EQ(dir,rp.measureDirectory());
EXPECT_EQ(measure.uuid(),rp.measureUUID());
EXPECT_EQ(measure.versionUUID(),rp.measureVersionUUID());
EXPECT_ANY_THROW(rp.perturbationScript());
EXPECT_EQ(2u,rp.arguments().size());
EXPECT_FALSE(rp.hasIncompleteArguments());
// Update measure and save
BCLMeasure newVersion = measure.clone(tempDir1).get();
newVersion.setDescription("Window to wall ratio with sill height configurable.");
newVersion.save();
EXPECT_NE(measure.versionUUID(),newVersion.versionUUID());
OSArgumentVector args;
args.push_back(OSArgument::makeDoubleArgument("wwr"));
args.push_back(OSArgument::makeDoubleArgument("sillHeight"));
Problem problemCopy = ProblemRecord::getProblemRecords(database)[0].problem();
problemCopy.updateMeasure(newVersion,args,false);
bool didStartTransaction = database.startTransaction();
EXPECT_TRUE(didStartTransaction);
// Problem Record
ProblemRecord problemRecord = ProblemRecord::factoryFromProblem(problemCopy,database);
database.save();
if (didStartTransaction) {
EXPECT_TRUE(database.commitTransaction());
}
}
// Re-open database, check that old argument records are gone, check that de-serialized object ok
openstudio::path tempDir2 = measuresPath / toPath(toString(createUUID()));
{
ProjectDatabase database = getExistingDatabase("RubyMeasureRecord_BCLMeasure");
ASSERT_EQ(1u,ProblemRecord::getProblemRecords(database).size());
EXPECT_EQ(1u,MeasureGroupRecord::getMeasureGroupRecords(database).size());
EXPECT_EQ(1u,RubyMeasureRecord::getRubyMeasureRecords(database).size());
EXPECT_EQ(1u,FileReferenceRecord::getFileReferenceRecords(database).size());
EXPECT_EQ(2u,OSArgumentRecord::getOSArgumentRecords(database).size());
Problem problemCopy = ProblemRecord::getProblemRecords(database)[0].problem();
InputVariableVector vars = problemCopy.variables();
ASSERT_FALSE(vars.empty());
ASSERT_TRUE(vars[0].optionalCast<MeasureGroup>());
MeasureVector dps = vars[0].cast<MeasureGroup>().measures(false);
ASSERT_FALSE(dps.empty());
ASSERT_TRUE(dps[0].optionalCast<RubyMeasure>());
RubyMeasure rp = dps[0].cast<RubyMeasure>();
EXPECT_TRUE(rp.usesBCLMeasure());
EXPECT_TRUE(rp.measure());
EXPECT_EQ(tempDir1,rp.measureDirectory());
EXPECT_EQ(measure.uuid(),rp.measureUUID());
EXPECT_NE(measure.versionUUID(),rp.measureVersionUUID());
EXPECT_ANY_THROW(rp.perturbationScript());
ASSERT_EQ(2u,rp.arguments().size());
EXPECT_TRUE(rp.hasIncompleteArguments());
EXPECT_EQ("wwr",rp.arguments()[0].name());
ASSERT_EQ(1u,rp.incompleteArguments().size());
EXPECT_EQ("sillHeight",rp.incompleteArguments()[0].name());
// Set to different measure
BCLMeasure measure2 = measure.clone(tempDir2).get();
measure2.changeUID();
measure2.incrementVersionId();
measure2.save();
measure2 = BCLMeasure::load(tempDir2).get();
EXPECT_NE(measure.uuid(),measure2.uuid());
EXPECT_NE(measure.versionUUID(),measure2.versionUUID());
rp.setMeasure(measure2);
EXPECT_TRUE(rp.isDirty());
EXPECT_TRUE(problemCopy.isDirty());
bool didStartTransaction = database.startTransaction();
EXPECT_TRUE(didStartTransaction);
// Problem Record
ProblemRecord problemRecord = ProblemRecord::factoryFromProblem(problemCopy,database);
database.save();
if (didStartTransaction) {
EXPECT_TRUE(database.commitTransaction());
}
}
// Re-open database, check that old measure and all argument records are gone
{
ProjectDatabase database = getExistingDatabase("RubyMeasureRecord_BCLMeasure");
ASSERT_EQ(1u,ProblemRecord::getProblemRecords(database).size());
EXPECT_EQ(1u,MeasureGroupRecord::getMeasureGroupRecords(database).size());
EXPECT_EQ(1u,RubyMeasureRecord::getRubyMeasureRecords(database).size());
EXPECT_EQ(1u,FileReferenceRecord::getFileReferenceRecords(database).size());
EXPECT_EQ(0u,OSArgumentRecord::getOSArgumentRecords(database).size());
Problem problemCopy = ProblemRecord::getProblemRecords(database)[0].problem();
InputVariableVector vars = problemCopy.variables();
ASSERT_FALSE(vars.empty());
ASSERT_TRUE(vars[0].optionalCast<MeasureGroup>());
MeasureVector dps = vars[0].cast<MeasureGroup>().measures(false);
ASSERT_FALSE(dps.empty());
ASSERT_TRUE(dps[0].optionalCast<RubyMeasure>());
RubyMeasure rp = dps[0].cast<RubyMeasure>();
EXPECT_TRUE(rp.usesBCLMeasure());
EXPECT_TRUE(rp.measure());
EXPECT_EQ(tempDir2,rp.measureDirectory());
EXPECT_NE(measure.uuid(),rp.measureUUID());
EXPECT_NE(measure.versionUUID(),rp.measureVersionUUID());
EXPECT_ANY_THROW(rp.perturbationScript());
ASSERT_EQ(0u,rp.arguments().size());
EXPECT_FALSE(rp.hasIncompleteArguments());
}
boost::filesystem::remove_all(tempDir1);
boost::filesystem::remove_all(tempDir2);
}
TEST_F(AnalysisDriverFixture,SimpleProject_UpdateMeasure) {
// create a new project
SimpleProject project = getCleanSimpleProject("SimpleProject_UpdateMeasure");
Problem problem = project.analysis().problem();
// insert a measure into the project, extract and register its arguments
openstudio::path measuresDir = resourcesPath() / toPath("/utilities/BCL/Measures");
openstudio::path dir = measuresDir / toPath("SetWindowToWallRatioByFacade");
BCLMeasure measure = BCLMeasure::load(dir).get();
BCLMeasure projectMeasure = project.insertMeasure(measure);
OSArgumentVector args = argumentGetter->getArguments(projectMeasure,
project.seedModel(),
project.seedIdf());
project.registerArguments(projectMeasure,args);
EXPECT_EQ(1u,project.measures().size());
// use the measure to create a new variable/ruby measure
MeasureGroup dv("New Measure Group",MeasureVector());
EXPECT_TRUE(problem.push(dv));
RubyMeasure rp(projectMeasure);
rp.setArguments(args);
EXPECT_TRUE(dv.push(rp));
EXPECT_EQ(args.size(),rp.arguments().size());
EXPECT_TRUE(rp.hasIncompleteArguments());
BOOST_FOREACH(const OSArgument& arg,args) {
if (arg.name() == "wwr") {
OSArgument temp = arg.clone();
temp.setValue(0.6);
rp.setArgument(temp);
}
if (arg.name() == "sillHeight") {
OSArgument temp = arg.clone();
temp.setValue(1.0);
rp.setArgument(temp);
}
if (arg.name() == "facade") {
OSArgument temp = arg.clone();
temp.setValue("South");
rp.setArgument(temp);
}
}
EXPECT_FALSE(rp.hasIncompleteArguments());
openstudio::path tempDir = measuresDir / toPath(toString(createUUID()));
{
// create fake new version of the measure
BCLMeasure newVersion = measure.clone(tempDir).get();
newVersion.incrementVersionId();
newVersion.save();
OSArgumentVector newArgs = args;
newArgs.push_back(OSArgument::makeDoubleArgument("frame_width"));
// update the measure
project.updateMeasure(newVersion,newArgs);
// verify the final state of SimpleProject and RubyMeasure
EXPECT_EQ(1u,project.measures().size());
BCLMeasure retrievedMeasure = project.getMeasureByUUID(measure.uuid()).get();
EXPECT_NE(measure.versionUUID(),retrievedMeasure.versionUUID());
EXPECT_EQ(newVersion.versionUUID(),retrievedMeasure.versionUUID());
ASSERT_TRUE(project.hasStoredArguments(retrievedMeasure));
OSArgumentVector retrievedArgs = project.getStoredArguments(retrievedMeasure);
EXPECT_EQ(args.size() + 1u,retrievedArgs.size());
EXPECT_EQ(retrievedArgs.size(),rp.arguments().size());
EXPECT_TRUE(rp.hasIncompleteArguments());
}
boost::filesystem::remove_all(tempDir);
}
TEST_F(AnalysisFixture, RubyPerturbation_BCLMeasure) {
// construct
openstudio::path measuresPath = resourcesPath() / toPath("/utilities/BCL/Measures");
openstudio::path dir = measuresPath / toPath("SetWindowToWallRatioByFacade");
BCLMeasure measure = BCLMeasure::load(dir).get();
RubyPerturbation perturbation(measure);
EXPECT_TRUE(perturbation.usesBCLMeasure());
ASSERT_TRUE(perturbation.measure());
EXPECT_TRUE(perturbation.measure().get() == measure);
EXPECT_EQ(dir,perturbation.measureDirectory());
EXPECT_TRUE(measure.uuid() == perturbation.measureUUID());
EXPECT_TRUE(measure.versionUUID() == perturbation.measureVersionUUID());
EXPECT_ANY_THROW(perturbation.perturbationScript());
// isUserScript value is ignored in this case
EXPECT_TRUE(perturbation.arguments().empty());
EXPECT_FALSE(perturbation.hasIncompleteArguments());
// add arguments to fill in
OSArgumentVector args;
args.push_back(OSArgument::makeDoubleArgument("wwr"));
args.push_back(OSArgument::makeDoubleArgument("sillHeight"));
perturbation.setArguments(args);
// verify that arguments are incomplete
EXPECT_EQ(2u,perturbation.incompleteArguments().size());
// fill in argument values
OSArgument arg = OSArgument::makeDoubleArgument("wwr");
EXPECT_TRUE(arg.setValue(0.8));
perturbation.setArgument(arg);
EXPECT_EQ(2u,perturbation.arguments().size());
EXPECT_EQ(1u,perturbation.incompleteArguments().size());
EXPECT_TRUE(perturbation.hasIncompleteArguments());
arg = OSArgument::makeDoubleArgument("sillHeight");
arg.setValue("0.1");
perturbation.setArgument(arg);
EXPECT_EQ(2u,perturbation.arguments().size());
EXPECT_EQ(0u,perturbation.incompleteArguments().size());
EXPECT_FALSE(perturbation.hasIncompleteArguments());
// update measure
openstudio::path tempDir = measuresPath / toPath(toString(createUUID()));
{
BCLMeasure newVersion = measure.clone(tempDir).get();
newVersion.setDescription("Window to wall ratio by wwr and offset.");
newVersion.save();
EXPECT_TRUE(newVersion.uuid() == measure.uuid());
EXPECT_FALSE(newVersion.versionUUID() == measure.versionUUID());
args.pop_back();
args.push_back(OSArgument::makeDoubleArgument("offset"));
perturbation.updateMeasure(newVersion,args);
EXPECT_TRUE(perturbation.usesBCLMeasure());
ASSERT_TRUE(perturbation.measure());
EXPECT_TRUE(perturbation.measure().get() == newVersion);
EXPECT_EQ(tempDir,perturbation.measureDirectory());
EXPECT_TRUE(newVersion.uuid() == perturbation.measureUUID());
EXPECT_TRUE(newVersion.versionUUID() == perturbation.measureVersionUUID());
EXPECT_ANY_THROW(perturbation.perturbationScript());
// verify that arguments updated correctly, values retained
EXPECT_EQ(2u,perturbation.arguments().size());
ASSERT_EQ(1u,perturbation.incompleteArguments().size());
EXPECT_TRUE(perturbation.hasIncompleteArguments());
EXPECT_EQ("offset",perturbation.incompleteArguments()[0].name());
EXPECT_EQ("wwr",perturbation.arguments()[0].name());
EXPECT_EQ(0.8,perturbation.arguments()[0].valueAsDouble());
// set measure and verify that arguments cleared
perturbation.setMeasure(newVersion); // always goes through setting motions, even if same
EXPECT_TRUE(perturbation.usesBCLMeasure());
ASSERT_TRUE(perturbation.measure());
EXPECT_TRUE(perturbation.measure().get() == newVersion);
EXPECT_EQ(tempDir,perturbation.measureDirectory());
EXPECT_TRUE(newVersion.uuid() == perturbation.measureUUID());
EXPECT_TRUE(newVersion.versionUUID() == perturbation.measureVersionUUID());
EXPECT_ANY_THROW(perturbation.perturbationScript());
// isUserScript value is ignored in this case
EXPECT_TRUE(perturbation.arguments().empty());
EXPECT_FALSE(perturbation.hasIncompleteArguments());
}
boost::filesystem::remove_all(tempDir);
}