NatLabRockies / NatLabRockies/OpenStudio

Modernize ControllerOutdoorAir API

Open
#4,416 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

APIChange component - Model Enhancement Request
Dominant language
C++
Stars
646
Forks
237
Avg merge
3d 11h
Merged PRs (30d)
10

Description

Enhancement Request

  • Most of the getters in ControllerOutdoorAir are still named "getXxxx()" inside of "xxxx()"
  • It uses optional for return types of the getters when there are defaults, and there isn't a isXXXdefaulted
  • It's missing static methods to find valid values for choice fields "EconomizerControlType" and "LockoutType" and "Minimum Limit Type" and "Heat Recovery Bypass Control Type"
Detailed description

example:

https://github.com/NREL/OpenStudio/blob/1b8f0d3549d67f5e461677439ee85c5d6f6cad0c/src/model/ControllerOutdoorAir.hpp#L126-L127

  A17, \field High Humidity Control
       \note Optional field to enable modified outdoor air flow rates based on zone relative humidity.
       \note Select Yes to modify outdoor air flow rate based on a zone humidistat.
       \note Select No to disable this feature.
       \note If the field Economizer Control Type = NoEconomizer, then this option is disabled.
       \type choice
       \default No
       \key Yes
       \key No

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with src/model/ControllerOutdoorAir.hpp, particularly the linked getter declarations and the four named choice fields. Review the requested getter naming, default handling, and valid-value methods, then identify the complete affected API surface. Done means ControllerOutdoorAir exposes the requested modernized getters, default indicators, and valid-value methods for all four choice fields.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
api
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
28/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.