dragonfly_energy.gbxml.name module

Parameters for customizing the names and IDs of objects in gbXML files.

class dragonfly_energy.gbxml.name.GBXMLNameFormat(interior_face_type='InteriorFloor', ground_face_type='AutoAssign', face_rename_format=None, subface_rename_format=None, reset_geometry_ids=False, reset_resource_ids=False)[source]

Bases: object

Customize the names and IDs of objects in the gbXML.

Parameters:

  • interior_face_type –

    Text string for the type to be used for all interior floor/ceiling faces. (Default: InteriorFloor). Choose from the following.

    • InteriorFloor

    • Ceiling

  • ground_face_type –

    Text string for the type to be used for all ground-contact floor faces. If AutoAssign, the ground types will be SlabOnGrade for floors belonging to rooms with any above-ground walls and UndergroundSlab for floors in rooms with all underground walls. Choose from the following.

    • AutoAssign

    • UndergroundSlab

    • SlabOnGrade

    • RaisedFloor

  • face_rename_format – An optional text string for the pattern with which faces will be renamed. Any property on the honeybee Face class may be used (eg. gbxml_str) and each property should be put in curly brackets. Nested properties can be specified by using “.” to denote nesting levels (eg. properties.energy.construction.display_name). Functions that return string outputs can also be passed here as long as these functions defaults specified for all arguments.

  • subface_rename_format – An optional text string for the pattern with which apertures and doors will be renamed. Any property that exists on both the honeybee Aperture and honeybee Door class may be used (eg. gbxml_str) and each property should be put in curly brackets. Nested properties can be specified by using “.” to denote nesting levels (eg. properties.energy.construction.display_name). Functions that return string outputs can also be passed here as long as these functions defaults specified for all arguments.

  • reset_geometry_ids – Boolean to note whether a cleaned version of geometry display names should be used for the IDs that appear within the gbXML file. Using this flag will affect all Rooms, Faces, Apertures, Doors, and Shades. It will generally result in more read-able IDs in the gbXML file but this means that it will not be easy to map results back to the input Model. Cases of duplicate IDs resulting from non-unique names will be resolved by adding integers to the ends of the new IDs that are derived from the name. (Default: False).

  • reset_resource_ids – Boolean to note whether a cleaned version of all resource display names should be used for the IDs that appear within the gbXML file. Using this flag will affect all Materials, Constructions, ConstructionSets, Schedules, Loads, and ProgramTypes. It will generally result in more read-able names for the resources in the gbXML file. Cases of duplicate IDs resulting from non-unique names will be resolved by adding integers to the ends of the new IDs that are derived from the name. (Default: False).

Properties:

  • interior_face_type

  • ground_face_type

  • face_rename_format

  • subface_rename_format

  • reset_geometry_ids

  • reset_resource_ids

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 GBXMLNameFormat dictionary in following the format below.

{
"type": "GBXMLNameFormat",
"interior_face_type": "Ceiling",
"ground_face_type": "SlabOnGrade",
"face_rename_format": "{gbxml_type} - {cardinal_direction}",
"subface_rename_format: "{gbxml_type} - {cardinal_direction}",
"reset_geometry_ids": False,
"reset_resource_ids": False
}
to_dict()[source]

GBXMLGeometryFormat dictionary representation.

GROUND_TYPES = ('AutoAssign', 'UndergroundSlab', 'SlabOnGrade', 'RaisedFloor')
INTERIOR_TYPES = ('InteriorFloor', 'Ceiling')
property face_rename_format

Get or set a string for the pattern with which faces will be renamed.

property ground_face_type

Get or set text for the type to use for all ground-contact floor faces.

Choose from the options below:

  • AutoAssign

  • UndergroundSlab

  • SlabOnGrade

  • RaisedFloor

property interior_face_type

Get or set text for the type to use for interior floors/ceilings.

Choose from the options below:

  • InteriorFloor

  • Ceiling

property reset_geometry_ids

Get or set a boolean for whether the IDs of geometry are set from the names.

property reset_resource_ids

Get or set a boolean for whether the IDs of resources are set from the names.

property subface_rename_format

Get or set a string for the pattern with which sub-faces will be renamed.