Fix #3076 - make openstudio::Vector "Enumerable" in ruby

[jmarrec]

Pull request overview

• Fix OpenStudio::Vector when SWIG'ed into ruby is not enumerable #3076
• make openstudio::Vector "Enumerable" in ruby

NOTE: just because you can use the << to append to an openstudio::Vector doesn't mean you should in all cases, as it will resize the vector each time. It's much more efficient to do os_vec = OpenStudio::Vector.new(size) then fill it.

Demo:

[1] (main)> os_vec = OpenStudio::createVector([0,1,2,3,4,5,6,7,8,9])
=> #<OpenStudio::Vector:0x00005619d21645d0 @__swigtype__="_p_openstudio__Vector">
[2] (main)> os_vec << 11
=> nil
[3] (main)> os_vec.map{|x| x}
=> [0.0, 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 11.0]
[4] (main)> os_vec.size
=> 11
[5] (main)> os_vec.map!{|x| x**2}
=> #<OpenStudio::Vector:0x00005619d2223d18 @__swigtype__="_p_openstudio__Vector">
[6] (main)> os_vec.map{|x| x}
=> [0.0, 1.0, 4.0, 9.0, 16.0, 25.0, 36.0, 49.0, 64.0, 81.0, 121.0]
[7] (main)> os_vec = OpenStudio::createVector([0,1,2,3,4,5,6,7,8,9])
=> #<OpenStudio::Vector:0x00005619d2284af0 @__swigtype__="_p_openstudio__Vector">
[8] (main)> os_vec.map{|x| x}
=> [0.0, 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0]
[9] (main)> os_vec.map!{|x| x+2}
=> #<OpenStudio::Vector:0x00005619d22e8550 @__swigtype__="_p_openstudio__Vector">
[10] (main)> os_vec.size
=> 10
[11] (main)> os_vec << 0.5
=> nil
[12] (main)> os_vec.size
=> 11
[13] (main)> os_vec.map{|x| x}
=> [2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 0.5]
[14] (main)> os_vec.each do |x|
[14] (main)*   puts x
[14] (main)* end  
2.0
3.0
4.0
5.0
6.0
7.0
8.0
9.0
10.0
11.0
0.5
=> #<OpenStudio::Vector:0x00005619d2413d08 @__swigtype__="_p_openstudio__Vector">
[15] (main)> os_vec.each_with_index {|x, i| puts x+i}
2.0
4.0
6.0
8.0
10.0
12.0
14.0
16.0
18.0
20.0
10.5

Pull Request Author

Add to this list or remove from it as applicable. This is a simple templated set of guidelines.

• 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)
• Checked behavior in OpenStudioApplication, adjusted policies as needed (src/openstudio_lib/library/OpenStudioPolicy.xml)
• 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

[jmarrec]

Anyone to review.?

[ci-commercialbuildings]

CI Results for 3b2b953:

• Linux:
• Darwin:
• Windows:
  • OpenStudio-3.0.1-beta+3b2b953852-Windows.exe
  • OpenStudio-3.0.1-beta+3b2b953852-Windows.tar.gz

[tijcolem]

Looks good to me and CI is happy.