epJSON helper functions to get field values #8738
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| epJSON helper functions to get field values | ||
| ================ | ||
|
|
||
| **M.J. Witte, GARD Analytics, Inc.** | ||
|
|
||
| - Original, May 17, 2021 | ||
| - Revision Date | ||
|
|
||
|
|
||
| ## Objective ## | ||
| From issue [#7632](https://github.com/NREL/EnergyPlus/issues/7632) | ||
|
|
||
| It would be useful to have an input processor function that | ||
|
|
||
| 1. Takes a field name, validates the field name, and returns the input value or it's default. | ||
| 2. To validate field name, will likely have to pass in cCurrentObjectItem (object class name) as an argument. | ||
| 3. If the field doesn't have a declared default, then numeric should return zero, and string should return blank. | ||
| 4. The EIRWWHP test for no default and no input is unusual, but for objects that want to test this for a given field, perhaps this function could return a status flag? (0 = user input, 1 = default, -1 = no user input or default) or ??? | ||
|
|
||
| For a field where you simply want to get the value or the default and move on, the goal would be something like: | ||
|
|
||
| `loc_m_HeatingCoilName = inputProcessor->getFieldValue("heating_coil_name", fields, cCurrentObjectItem, status);` | ||
|
|
||
| ## Design ## | ||
| Here's a prototype `getInput` function using 3 new functions: | ||
|
|
||
| getObjectSchemaProps(state, CurrentModuleObject) | ||
| getRealFieldValue(state, CurrentModuleObject, objectFields, objectSchemaProps, "field_name") | ||
| getAlphaFieldValue(state, CurrentModuleObject, objectFields, objectSchemaProps, "field_name") | ||
|
|
||
| // Get the schema properties for the current object type | ||
| InputProcessor::json objectSchemaProps; | ||
| CurrentModuleObject = "AirflowNetwork:MultiZone:Surface:Crack"; | ||
| objectSchemaProps = state.dataInputProcessing->inputProcessor->getObjectSchemaProps(state, CurrentModuleObject); | ||
|
|
||
| // Get all instances of this object type from the input file | ||
| auto instances = state.dataInputProcessing->inputProcessor->epJSON.find(CurrentModuleObject); | ||
|
|
||
| if (instances != state.dataInputProcessing->inputProcessor->epJSON.end()) { | ||
| auto &instancesValue = instances.value(); | ||
|
|
||
| for (auto instance = instancesValue.begin(); instance != instancesValue.end(); ++instance) { | ||
| auto const &objectFields = instance.value(); | ||
| auto const &thisObjectName = UtilityRoutines::MakeUPPERCase(instance.key()); | ||
| state.dataInputProcessing->inputProcessor->markObjectAsUsed(CurrentModuleObject, instance.key()); | ||
| // For incoming idf, maintain object order | ||
| ++instanceCounter; | ||
| itemNum = state.dataInputProcessing->inputProcessor->getIDFObjNum(state, state.dataHeatBalMgr->CurrentModuleObject, instanceCounter); | ||
|
|
||
| // Get simple input fields (if blank will return default or blank or zero) | ||
| Real64 crack(itemNum).coeff = state.dataInputProcessing->inputProcessor->getRealFieldValue( | ||
| state, CurrentModuleObject, objectFields, objectSchemaProps, "air_mass_flow_coefficient_at_reference_conditions"); | ||
|
|
||
| std::string crack(itemNum).referenceCrackConditionsName = state.dataInputProcessing->inputProcessor->getAlphaFieldValue( | ||
| state, CurrentModuleObject, objectFields, objectSchemaProps, "reference_crack_conditions"); | ||
|
|
||
| } | ||
| } | ||
|
|
||
| Here's a prototype section for retrieving extensible fields: | ||
| For this object, the extensible group is named "managers". | ||
| The extensible group name and field names can be found in the schema (Energy+.schema.epJSON). | ||
|
|
||
| auto extensibles = objectFields.find("managers"); | ||
| auto const &extensionSchemaProps = objectSchemaProps["managers"]["items"]["properties"]; | ||
| if (extensibles != objectFields.end()) { | ||
| auto extensiblesArray = extensibles.value(); | ||
| int numExtensibles = extensiblesArray.size(); | ||
|
|
||
| // Allocate and initialize object arrays that are sized by the number of extensible field groups | ||
| state.dataSystemAvailabilityManager->SysAvailMgrListData(Item).NumItems = numExtensibles; | ||
| state.dataSystemAvailabilityManager->SysAvailMgrListData(Item).AvailManagerName.allocate(numExtensibles); | ||
| state.dataSystemAvailabilityManager->SysAvailMgrListData(Item).cAvailManagerType.allocate(numExtensibles); | ||
| state.dataSystemAvailabilityManager->SysAvailMgrListData(Item).AvailManagerType.allocate(numExtensibles); | ||
| for (int extItem = 1; extItem <= numExtensibles; ++extItem) { | ||
| state.dataSystemAvailabilityManager->SysAvailMgrListData(Item).AvailManagerName = ""; | ||
| state.dataSystemAvailabilityManager->SysAvailMgrListData(Item).cAvailManagerType = ""; | ||
| state.dataSystemAvailabilityManager->SysAvailMgrListData(Item).AvailManagerType = 0; | ||
| } | ||
|
|
||
| // Loop through each extensible field group | ||
| int listItem = 0; | ||
| for (auto extensibleInstance : extensiblesArray) { | ||
| ++listItem; | ||
| state.dataSystemAvailabilityManager->SysAvailMgrListData(Item).AvailManagerName(listItem) = | ||
| state.dataInputProcessing->inputProcessor->getAlphaFieldValue( | ||
| state, cCurrentModuleObject, extensibleInstance, extensionSchemaProps, "availability_manager_name"); | ||
| std::string availManagerObjType = state.dataInputProcessing->inputProcessor->getAlphaFieldValue( | ||
| state, cCurrentModuleObject, extensibleInstance, extensionSchemaProps, "availability_manager_object_type"); | ||
| state.dataSystemAvailabilityManager->SysAvailMgrListData(Item).cAvailManagerType(listItem) = availManagerObjType; | ||
| state.dataSystemAvailabilityManager->SysAvailMgrListData(Item).AvailManagerType(listItem) = | ||
| ValidateAndSetSysAvailabilityManagerType(state, availManagerObjType); | ||
| } | ||
| } | ||
|
|
||
| ## Questions ## | ||
| 1. Do we want more functions to help with some of the setup shown here? |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -542,6 +542,117 @@ bool InputProcessor::getDefaultValue(EnergyPlusData &state, std::string const &o | |
| return defaultFound; | ||
| } | ||
|
|
||
| std::string InputProcessor::getAlphaFieldValue(json const &ep_object, json const &schema_obj_props, std::string const &fieldName) | ||
| { | ||
| // Return the value of fieldName in ep_object as a string. | ||
| // If the field is not present in ep_object then return its default if there is one, or return an empty string | ||
| auto const &schema_field_obj = schema_obj_props[fieldName]; | ||
| assert(!schema_field_obj.empty()); // Check that field name exists in the schema for this object type | ||
|
There was a problem hiding this comment. Why did you convert this to an There was a problem hiding this comment. I changed to There was a problem hiding this comment. @mjwitte can you give me an example of why schema_field_obj.empty() would ever be false? I get the misspelled field name issue but are there other instances? Inputs past min-fields? There was a problem hiding this comment. I see this is merged, but just for the record, this line is looking at the schema (not the user input) in |
||
| bool isDefaulted = false; | ||
| std::string value; | ||
| auto it = ep_object.find(fieldName); | ||
| if (it != ep_object.end()) { | ||
| auto const &field_value = it.value(); | ||
| if (field_value.is_string()) { | ||
| auto valuePair = getObjectItemValue(field_value.get<std::string>(), schema_field_obj); | ||
|
There was a problem hiding this comment. I don't see in here where uppercase is set. Is getObjectItemValue where a string gets pushed to uppercase? Can retain case be used here so developers don't make a mistake? There was a problem hiding this comment. Never mind. |
||
| value = valuePair.first; | ||
| isDefaulted = valuePair.second; | ||
| } else { | ||
| assert(false); // String value requested but field type is numeric | ||
| } | ||
| } else { | ||
| isDefaulted = findDefault(value, schema_field_obj); | ||
| if (!isDefaulted) { | ||
| value = ""; | ||
| } | ||
| } | ||
| return value; | ||
| } | ||
|
|
||
| Real64 InputProcessor::getRealFieldValue(json const &ep_object, json const &schema_obj_props, std::string const &fieldName) | ||
| { | ||
| // Return the value of fieldName in ep_object as a Real64. | ||
| // If the field value is a string, then assum autosize and return -99999. | ||
| // If the field is not present in ep_object then return its default if there is one, or return 0.0 | ||
| auto const &schema_field_obj = schema_obj_props[fieldName]; | ||
| assert(!schema_field_obj.empty()); // Check that field name exists in the schema for this object type | ||
|
There was a problem hiding this comment. Same question about change to |
||
| bool isDefaulted = false; | ||
| Real64 value = 0.0; | ||
| auto it = ep_object.find(fieldName); | ||
| if (it != ep_object.end()) { | ||
| auto const &field_value = it.value(); | ||
| if (field_value.is_number()) { | ||
| if (field_value.is_number_integer()) { | ||
| value = field_value.get<std::int64_t>(); | ||
| } else { | ||
| value = field_value.get<double>(); | ||
| } | ||
| } else { | ||
| bool is_empty = field_value.get<std::string>().empty(); | ||
| if (is_empty) { | ||
| isDefaulted = findDefault(value, schema_field_obj); | ||
|
There was a problem hiding this comment. Need to do something if There was a problem hiding this comment. Another good question. This block of code is borrowed from elsewhere (somewhere in the |
||
| } else { | ||
| value = -99999; // autosize and autocalculate | ||
|
There was a problem hiding this comment. I guess you assume here if !is_empty then the input is either blank or is set to Autosize. I explicitly tested for that but maybe with this method you don't have to test. Anything other than the word autosize would be caught by the inputprocessor. Do you need to check for? There was a problem hiding this comment. I'm not 100% certain about that. In |
||
| } | ||
| } | ||
| } else { | ||
| isDefaulted = findDefault(value, schema_field_obj); | ||
| if (!isDefaulted) { | ||
| value = 0.0; | ||
| } | ||
| } | ||
| return value; | ||
| } | ||
|
|
||
| int InputProcessor::getIntFieldValue(json const &ep_object, json const &schema_obj_props, std::string const &fieldName) | ||
| { | ||
| // Return the value of fieldName in ep_object as an integer (rounded to nearest integer if the input value is real). | ||
| // If the field value is a string, then assume autosize or autocalulate and return -99999. | ||
| // If the field is not present in ep_object then return its default if there is one, or return 0 | ||
|
|
||
| auto const &schema_field_obj = schema_obj_props[fieldName]; | ||
| assert(!schema_field_obj.empty()); // Check that field name exists in the schema for this object type | ||
| bool isDefaulted = false; | ||
| int value = 0; | ||
| Real64 defaultValue = 0.0; | ||
| auto it = ep_object.find(fieldName); | ||
| if (it != ep_object.end()) { | ||
| auto const &field_value = it.value(); | ||
| if (field_value.is_number()) { | ||
| if (field_value.is_number_integer()) { | ||
| value = field_value.get<std::int64_t>(); | ||
| } else { | ||
| value = nint(field_value.get<double>()); | ||
| } | ||
| } else { | ||
| bool is_empty = field_value.get<std::string>().empty(); | ||
| if (is_empty) { | ||
| isDefaulted = findDefault(defaultValue, schema_field_obj); | ||
| } else { | ||
| value = -99999; // autosize and autocalculate | ||
| } | ||
| } | ||
| } else { | ||
| isDefaulted = findDefault(defaultValue, schema_field_obj); | ||
| if (isDefaulted) { | ||
| value = nint(defaultValue); | ||
| } else { | ||
| value = 0.0; | ||
| } | ||
| } | ||
| return value; | ||
| } | ||
|
|
||
| const json &InputProcessor::getObjectSchemaProps(EnergyPlusData &state, std::string const &objectWord) | ||
| { | ||
| auto const &schema_properties = schema.at("properties"); | ||
|
There was a problem hiding this comment. Not sure how you would do this only once but this one line, auto const &schema_properties = schema.at("properties");, is applicable to all objects. Here it is set up again for each call. |
||
| const json &object_schema = schema_properties.at(objectWord); | ||
| assert(!object_schema.empty()); // If this fails, the object type does not exist in the schema | ||
|
There was a problem hiding this comment. Same question about change to |
||
|
|
||
| auto const &schema_obj_props = getPatternProperties(state, object_schema); | ||
| return schema_obj_props; | ||
| } | ||
|
|
||
| std::pair<std::string, bool> InputProcessor::getObjectItemValue(std::string const &field_value, json const &schema_field_obj) | ||
| { | ||
| std::pair<std::string, bool> output; | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just a stylistic thing, but defining
auto & Mat = state.dataMaterial->Material(MaterNum);andauto & ip = state.dataInputProcessing->inputProcessor;will make the rest of statements in this function into one liners.