Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Addresses #4469, method to Translate ScheduleYear/ScheduleWeek to ScheduleRuleset #4508

Merged
merged 19 commits into from Jan 28, 2022

Conversation

joseph-robertson
Copy link
Collaborator

@joseph-robertson joseph-robertson commented Dec 9, 2021

Pull request overview

Replace Schedule:Year to Schedule:Year RT with Schedule:Year to Schedule:Ruleset.

Issues:

  • Schedule:Week:Daily to Schedule:Week RT is performed directly from ReverseTranslator.cpp (i.e., independent of Schedule:Year to Schedule:Ruleset
  • Ctor for Schedule:Rule when passing in a daySchedule automatically clones and sets the daySchedule (why?)
  • Ctor for Schedule:Ruleset automatically creates a defaultDaySchedule; not sure how we'd parse defaultDaySchedule from the idf, but even if we could we'd have to transfer its values to ruleset's defaultDaySchedule as there is no setter for this object (should there be? or perhaps even a Schedule:Ruleset ctor that passes one in?)
  • The summer/winter design day, holiday, and custom day 1/2 schedules are specific to each Schedule:Ruleset whereas in the IDF they are defined for each Schedule:Week:Daily; what happens if these schedules vary between weeks? Create more ruleset objects? Only support non varying schedules and switch to Schedule:Year RT if they vary?
  • Setting summer/winter, holiday, and custom day 1/2 schedules clones the schedule passed in and sets the clone (why?)

Pull Request Author

  • Model API Changes / Additions
  • Any new or modified fields have been implemented in the EnergyPlus ForwardTranslator (and ReverseTranslator as appropriate)
  • Model API methods are tested (in src/model/test)
  • EnergyPlus ForwardTranslator Tests (in src/energyplus/Test)
  • If a new object or method, added a test in NREL/OpenStudio-resources: Add Link
  • If needed, added VersionTranslation rules for the objects (src/osversion/VersionTranslator.cpp)
  • Verified that C# bindings built fine on Windows, partial classes used as needed, etc.
  • All new and existing tests passes
  • If methods have been deprecated, update rest of code to use the new methods

Labels:

  • If change to an IDD file, add the label IDDChange
  • If breaking existing API, add the label APIChange
  • If deemed ready, add label Pull Request - Ready for CI so that CI builds your PR

Review Checklist

This will not be exhaustively relevant to every PR.

  • Perform a Code Review on GitHub
  • Code Style, strip trailing whitespace, etc.
  • All related changes have been implemented: model changes, model tests, FT changes, FT tests, VersionTranslation, OS App
  • Labeling is ok
  • If defect, verify by running develop branch and reproducing defect, then running PR and reproducing fix
  • If feature, test running new feature, try creative ways to break it
  • CI status: all green or justified

@joseph-robertson joseph-robertson self-assigned this Dec 9, 2021
@joseph-robertson joseph-robertson added component - IDF Translation Enhancement Request Pull Request - Ready for CI This pull request if finalized and is ready for continuous integration verification prior to merge. labels Dec 9, 2021
@jmarrec jmarrec merged commit 6729e3a into develop Jan 28, 2022
@jmarrec jmarrec deleted the issue-4469 branch January 28, 2022 16:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component - IDF Translation Enhancement Request Pull Request - Ready for CI This pull request if finalized and is ready for continuous integration verification prior to merge.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Method to Translate ScheduleYear/ScheduleWeek to ScheduleRuleset
3 participants