dragonfly_energy.gbxml.parameters module

Parameters for customizing the translation to gbXML.

class dragonfly_energy.gbxml.parameters.GBXMLParameters(ip_units=False, geometry_format=None, name_format=None, energy_attribute_format=None, version_format=None)

Bases: object

Complete set of GBXML translation parameters.

Parameters:

ip_units – A boolean to note whether the geometry, space loads, and construction properties are reported in IP units (True) or SI units (False). (Default: False).

Properties:

• ip_units

• geometry_format

• name_format

• energy_attribute_format

• version_format

ToString()

Overwrite .NET ToString.

duplicate()

Get a copy of this object.

classmethod for_energy_pro()

Create default GBXMLParameters for export to EnergyPro.

classmethod for_energyplus()

Create default GBXMLParameters for export to EnergyPlus.

By extension, these parameters are also recommended when exporting gbXMLs for OpenStudio, DesignBuilder, or other interfaces built on top of EnergyPlus.

classmethod for_trace_3d_plus()

Create default GBXMLParameters for export to TRACE 3D Plus.

classmethod for_trace_700()

Create default GBXMLParameters for export to TRACE 700.

classmethod from_dict(data)

Create a GBXMLParameters object from a dictionary.

Parameters:

data – A GBXMLParameters dictionary in following the format below.

{
"type": "GBXMLParameters",
"ip_units": False,
"geometry_format": {}, # Dragonfly GBXMLGeometryFormat dictionary
"name_format": {}, # Dragonfly GBXMLNameFormat dictionary
"energy_attribute_format": {}, #GBXMLEnergyAttributeFormat dictionary
"version_format": {} # Dragonfly GBXMLVersionFormat dictionary
}

to_dict()

GBXMLParameters dictionary representation.

property energy_attribute_format

Get or set a GBXMLEnergyAttributeFormat object for the customizing the export.

property geometry_format

Get or set a GBXMLGeometryFormat object for the customizing the geometry export.

property ip_units

Get or set a boolean for whether the gbXML is exported in IP units.

property name_format

Get or set a GBXMLNameFormat object for the customizing the names in export.

property version_format

Get or set a GBXMLVersionFormat object for the customizing the names in export.