Skip to content

Conversation

@dareumnam
Copy link
Collaborator

Pull request overview

  • Fixes CppCheck shadow variable errors

Description of the purpose of this PR

Pull Request Author

  • Title of PR should be user-synopsis style (clearly understandable in a standalone changelog context)
  • Label the PR with at least one of: Defect, Refactoring, NewFeature, Performance, and/or DoNoPublish
  • Pull requests that impact EnergyPlus code must also include unit tests to cover enhancement or defect repair
  • Author should provide a "walkthrough" of relevant code changes using a GitHub code review comment process
  • If any diffs are expected, author must demonstrate they are justified using plots and descriptions
  • If changes fix a defect, the fix should be demonstrated in plots and descriptions
  • If any defect files are updated to a more recent version, upload new versions here or on DevSupport
  • If IDD requires transition, transition source, rules, ExpandObjects, and IDFs must be updated, and add IDDChange label
  • If structural output changes, add to output rules file and add OutputChange label
  • If adding/removing any LaTeX docs or figures, update that document's CMakeLists file dependencies
  • If adding/removing any output files (e.g., eplustbl.*)
    • Update ..\scripts\Epl-run.bat
    • Update ..\scripts\RunEPlus.bat
    • Update ..\src\EPLaunch\ MainModule.bas, epl-ui.frm, and epl.vbp (VersionComments)
    • Update ...github\workflows\energyplus.py

Reviewer

  • Perform a Code Review on GitHub
  • If branch is behind develop, merge develop and build locally to check for side effects of the merge
  • 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
  • Check that performance is not impacted (CI Linux results include performance check)
  • Run Unit Test(s) locally
  • Check any new function arguments for performance impacts
  • Verify IDF naming conventions and styles, memos and notes and defaults
  • If new idf included, locally check the err file and other outputs

@dareumnam dareumnam added the DoNotPublish Includes changes that shouldn't be reported in the changelog label Jan 17, 2026
@dareumnam dareumnam marked this pull request as ready for review January 20, 2026 18:53
@dareumnam dareumnam marked this pull request as draft January 20, 2026 21:11
@dareumnam dareumnam marked this pull request as ready for review January 22, 2026 07:24
SetupWeekDaysByMonth(state, runPerInput1.startMonth, runPerInput1.startDay, runPerInput1.dayOfWeek, runPerInput1.monWeekDay);
}
} else if (nRunPeriods > 1 && state.dataSysVars->FullAnnualRun) {
nRunPeriods = 1;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I"m not saying this change is wrong but this comment says nRunPeriods was intended to be a reference argument.

    if (state.dataSysVars->FullAnnualRun) {
        // GetRunPeriodData may have reset the value of TotRunPers
        state.dataWeather->NumOfEnvrn = state.dataEnvrn->TotDesDays + state.dataWeather->TotRunPers + RPD1 + RPD2;
    }

Wondering when/if nRunPeriods should ever be changed back to 1 I see the FullAnnualSimulation environment variable which makes me wonder how that environment variable should affect the simulation.

    cEnvValue = std::getenv(FullAnnualSimulation);
    state.dataSysVars->FullAnnualRun = env_var_on(cEnvValue ? cEnvValue : ""); // Yes or True
    if (state.dataGlobal->AnnualSimulation) state.dataSysVars->FullAnnualRun = true;

    if (state.dataWeather->TotRunPers >= 1 || state.dataSysVars->FullAnnualRun) {
        GetRunPeriodData(state, state.dataWeather->TotRunPers, ErrorsFound);
    }

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @rraustad. I'm putting this back for now. I did a quick test where I put it back and made nRunPeriods a reference, but things broke pretty quickly, and it would need more effort to untangle.

@mitchute mitchute changed the title CppCheck Cleanup Continued CppCheck Cleanup Shadow Variables Jan 27, 2026
@mitchute
Copy link
Collaborator

All done here. Thanks @dareumnam and @rraustad.

@mitchute mitchute merged commit 67002ea into develop Jan 27, 2026
12 of 13 checks passed
@mitchute mitchute deleted the cppcheck_shadowVariable branch January 27, 2026 23:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

DoNotPublish Includes changes that shouldn't be reported in the changelog

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants