I know this is very easy in an openstudio measure, but how do I delete an object from the idf file using an energyplus measure?
Also, is there any documentation for writing energyplus measures similar to the openstudio documentation?
Per Eric's comment below, the best way to do this is using the remove call of a Workspace Object.
API documentation for the Workspace object here. You can get an instance of an object in your Workspace with the getObjectByTypeAndName or related method call. Be careful about removing workspace objects - you may end up deleting an object needed by another object.
For a tutorial on writing EnergyPlus measures, see the EnergyPlus Measures section in the OpenStudio Measure Writer's Reference Guide provides an example.
@mdahlhausen I wasn't able to find the string getObjectByTypeAndName anywhere on that webpage by using Ctrl-f on the webpage. There only appears to be instructions on creating new objects and modifying fields on existing objects in an energyplus model.
Ctrl-f on getObject does result in 6 found places on that webpage though, but all 6 instances are the front of getObjectsByType on the webpage.
That's strange, it's right here.
Also WorkspaceObject has the method remove that works just fine.
@Eric Ringold Yes. Your "here" link leads to a webpage with documentation on the workspace class. The "EnergyPlus Measures section" link from @mdahlhausen led to a short tutorial on writing measures, one section of which is writing energyplus measures. This is absolutely everything I need. Thanks!
@mdahlhausen Please change your first sentence to reference @Eric Ringold's link, then I'll accept your answer.
For example, removing all EMS sensor objects:
ems_sensors = workspace.getObjectsByType("EnergyManagementSystem:Sensor".to_IddObjectType)
ems_sensors.each do |obj|
obj.remove
end
Additional methods for removing EMS objects:
model.getEnergyManagementSystemActuators(&:remove)
model.getEnergyManagementSystemConstructionIndexVariables(&:remove)
model.getEnergyManagementSystemCurveOrTableIndexVariables(&:remove)
model.getEnergyManagementSystemGlobalVariables(&:remove)
model.getEnergyManagementSystemInternalVariables(&:remove)
model.getEnergyManagementSystemMeteredOutputVariables(&:remove)
model.getEnergyManagementSystemOutputVariables(&:remove)
model.getEnergyManagementSystemPrograms(&:remove)
model.getEnergyManagementSystemProgramCallingManagers(&:remove)
model.getEnergyManagementSystemSensors(&:remove)
model.getEnergyManagementSystemSubroutines(&:remove)
model.getEnergyManagementSystemTrendVariables(&:remove)
Credit to @Scott Horowitz from NREL.
You could also extend the solution provided by @Eric Martin to multiple EMS objects.
# remove EMS objects model.getEnergyManagementSystemSensors.each do |ems_obj| ems_obj.remove end model.getEnergyManagementSystemActuators.each do |ems_obj| ems_obj.remove end model.getEnergyManagementSystemGlobalVariables.each do |ems_obj| ems_obj.remove end
etc... for other EMS objects
Comments