Is there a way to get all the os objects and the public member function in some format of data structure? For example, based on the class reference here, https://openstudio-sdk-documentation....
BuildingStory:
.defaultConstructionSet
.defaultScheduleSet
.renderingColor
.resetDefaultConstructionSet
...
...
Rereading your question, you seem specifically interested in getting/generating a single structure/file with all OpenStudio nested classes/methods. I'm not sure if that exists in one file. Following a somewhat similar approach to what's described below, you could script your way to a solution by instantiating single instances of each upper class object, and recursively looping through each object method/member; then go through derived classes; and so on; e.g.
point3D = OpenStudio::Point3d.new(0, 0, 0)
puts point3D.public_methods(false)
or simply
puts OpenStudio::Point3d.instance_methods(false)
Some effort (!), but manageable.
--- original answer ---
By getting, I assume you mean via the OpenStudio API (e.g., a Ruby script). A bare-bones example of one way to do it (first make sure you can access the OpenStudio Ruby gem):
require "openstudio"
# Load in memory OpenStudio Model (a "warehouse" example):
translator = OpenStudio::OSVersion::VersionTranslator.new
file = "warehouse.osm"
path = OpenStudio::Path.new(File.dirname(__FILE__) + file)
model = translator.loadModel(path)
raise "Invalid OSM" if model.empty?
model = os_model.get
At this point, you should have access to a valid OSM, which you can probe with the API. You'll find many examples here at UnmetHours like this.
air_loops = model.getAirLoopHVACs
plant_loops = model.getPlantLoops
zones = model.getThermalZones
Note the pattern between the get prefix and the class name e.g. getThermalZones. You can then retrieve objects attributes e.g.
zones.each do |zone|
puts zone.nameString
puts zone.multiplier
end
Loops are neat/safe - the object may be empty (i.e. no zones in the OSM). Otherwise, one needs to pay attention to optional attributes (such as ThermalZone volume, which may not be initialized). Again, lots of examples on how to do this at UnmetHours, within OpenStudio Measures, etc.
You can also retrieve all model objects at once, then try to convert them into specific objects like the ones above.
I tried use .instance_methods(false) and noticed that what I got did not 100% match what's on the SDK website. For example, I applied it for ThermalZone, and instance_methods did not return addEquipment, which is listed here (https://openstudio-sdk-documentation....). Is there a reason for that?
Can you try:
puts OpenStudio::Model::ThermalZone.instance_methods(false).grep(/equipment/i)
or if you first instantiated a thermal "zone" object:
puts zone.public_methods(false).grep(/equipment/i)
... both should return a (long) list of methods that contain the regex "equipment", including addEquipment. You can narrow down the search by replacing "/equipment/i" with "/addEquipment/"
I tried and it returned a list of methods that contain "equipment", including "removeEquipment", but not "addEquipment". I double checked I'm using openstudio application v1.1.0 with core 3.1.0, and the SDK document I use if 3.1.0. I tried to use thermalZone.addEquipment and got error "undefined method". Anyways I'm just wondering why these two don't match and which one is right as I'm trying to get all methods for a certain class. Sounds like they should match right?
Huh! I am indeed able to reproduce your exact observations with API/SDK v3.2 (my previous response was based on v2.9.1). addEquipment remains a listed ThermalZone method in the online v3.2 SDK, yet if I:
zone.addEquipment(object)
... on a newly instantiated ThermalZone object, I get the same NoMethodError (undefined method). Sounds like the online SDK needs updating (?).
This function will get all the "setters" for a specific class, e.g. BuildingStory, without the need for instantiation. The same can be done for getters, resetters, autosizers, etc. and could be adapted to simply get all the instance_methods as @Denis Bourgeois suggested.
# return an array of all set methods for specific class_name string
def get_setters(class_name)
array = []
instance_methods = OpenStudio::Model.const_get(class_name).instance_methods
instance_methods.each do |instance_method|
array << instance_method if instance_method.to_s.start_with? 'set'
end
array.pop(12) # remove the last 12 elements, which are general setters
return array
end
Besides the getter and setters, is there a way to get the constructor for an object? For example, what's in the bracket: ExteriorLights (const ExteriorLightsDefinition &definition, bool useControlOptionAstronomicalClock=false), and ExteriorLights (const ExteriorLightsDefinition &definition, Schedule &schedule), so that I know what I need to provide when creating a new object (without looking at the SDK document)?
Asked: 2021-06-18 01:19:17 -0600
Seen: 395 times
Last updated: Jun 24 '21
You could use your preferred programming language to scrape the OpenStudio SDK website and compile the list of classes/methods.
This is a good suggestion I'll try that.