dragonfly_energy.gbxml.version module

Parameters for customizing the program information and schema version in gbXML files.

class dragonfly_energy.gbxml.version.GBXMLVersionFormat(program_name=None, program_version=None, gbxml_schema_version=None)[source]

Bases: object

Customize the program information and schema version in the gbXML.

Parameters:

  • program_name – Optional text to set the name of the software that will appear under the programId and ProductName tags of the DocumentHistory section. This can be set things like “Ladybug Tools” or “Pollination” or some other software in which this gbXML export capability is being run. If None, the “OpenStudio” will be used. (Default: None).

  • program_version – Optional text to set the version of the software that will appear under the DocumentHistory section. If None, and the program_name is also unspecified, only the version of OpenStudio will appear. Otherwise, this will default to “0.0.0” given that the version field is required. (Default: None).

  • gbxml_schema_version – Optional text to set the version of the gbXML schema that is specified in the XML header (eg. “5.00”). If None, this will default to the latest version. (Default: None).

Properties:

  • program_name

  • program_version

  • gbxml_schema_version

ToString()[source]

Overwrite .NET ToString.

duplicate()[source]

Get a copy of this object.

classmethod from_dict(data)[source]

Create a GBXMLNameFormat object from a dictionary.

Parameters:

data – A GBXMLVersionFormat dictionary in following the format below.

{
"type": "GBXMLVersionFormat",
"program_name": "Pollination Model Editor",
"program_version": "2.27.1.0",
"gbxml_schema_version": "8.01"
}
to_dict()[source]

GBXMLVersionFormat dictionary representation.

SCHEMA_VERSIONS = ('0.35', '0.36', '0.37', '5.00', '5.01', '5.10', '5.11', '5.12', '6.00', '6.01', '7.03', '8.01')
property gbxml_schema_version

Get or set text for the version of the gbXML schema to use.

property program_name

Get or set text to set the name of the exporting software.

property program_version

Get or set text to set the version of the exporting software.