honeybee-core 1.61.32__py2.py3-none-any.whl → 1.61.34__py2.py3-none-any.whl

honeybee/aperture.py

@@ -2,16 +2,18 @@
 """Honeybee Aperture."""
 from __future__ import division
 import math
+import re
 
-from ladybug_geometry.geometry2d.pointvector import Vector2D
-from ladybug_geometry.geometry3d.pointvector import Point3D
-from ladybug_geometry.geometry3d.face import Face3D
+from ladybug_geometry.geometry2d import Vector2D
+from ladybug_geometry.geometry3d import Point3D, Face3D
 from ladybug.color import Color
 
 from ._basewithshade import _BaseWithShade
 from .typing import clean_string
+from .search import get_attr_nested
 from .properties import ApertureProperties
 from .boundarycondition import boundary_conditions, Outdoors, Surface
+from .facetype import RoofCeiling
 from .shade import Shade
 import honeybee.writer.aperture as writer
 
@@ -276,6 +278,23 @@ class Aperture(_BaseWithShade):
         """
         return isinstance(self.boundary_condition, Outdoors)
 
+    @property
+    def gbxml_type(self):
+        """Get text for the type of object this is in gbXML schema.
+
+        This will always be one of the following.
+
+            * FixedWindow
+            * OperableWindow
+            * FixedSkylight
+            * OperableSkylight
+        """
+        base_type = 'Window'
+        if self.has_parent and isinstance(self.parent.type, RoofCeiling):
+            base_type = 'Skylight'
+        win_type = 'Fixed' if not self.is_operable else 'Operable'
+        return win_type + base_type
+
     @property
     def type_color(self):
         """Get a Color to be used in visualizations by type."""
@@ -298,16 +317,23 @@ class Aperture(_BaseWithShade):
         return math.degrees(
             north_vector.angle_clockwise(Vector2D(self.normal.x, self.normal.y)))
 
-    def cardinal_direction(self, north_vector=Vector2D(0, 1)):
+    def cardinal_direction(self, north_vector=Vector2D(0, 1), angle_tolerance=1):
         """Get text description for the cardinal direction that the aperture is pointing.
 
         Will be one of the following: ('North', 'NorthEast', 'East', 'SouthEast',
-        'South', 'SouthWest', 'West', 'NorthWest').
+        'South', 'SouthWest', 'West', 'NorthWest', 'Up', 'Down').
 
         Args:
             north_vector: A ladybug_geometry Vector2D for the north direction.
                 Default is the Y-axis (0, 1).
-        """
+            angle_tolerance: The angle tolerance in degrees used to determine if
+                the geometry is perfectly Up or Down. (Default: 1).
+        """
+        tilt = self.tilt
+        if tilt < angle_tolerance:
+            return 'Up'
+        elif tilt > 180 - angle_tolerance:
+            return 'Down'
         orient = self.horizontal_orientation(north_vector)
         orient_text = ('North', 'NorthEast', 'East', 'SouthEast', 'South',
                        'SouthWest', 'West', 'NorthWest')
@@ -317,6 +343,31 @@ class Aperture(_BaseWithShade):
                 return orient_text[i]
         return orient_text[0]
 
+    def cardinal_abbrev(self, north_vector=Vector2D(0, 1), angle_tolerance=1):
+        """Get text abbreviation for the cardinal direction that the aperture is pointing.
+
+        Will be one of the following: ('N', 'NE', 'E', 'SE', 'S', 'SW', 'W', 'NW',
+        'Up', 'Down').
+
+        Args:
+            north_vector: A ladybug_geometry Vector2D for the north direction.
+                Default is the Y-axis (0, 1).
+            angle_tolerance: The angle tolerance in degrees used to determine if
+                the aperture is perfectly Up or Down. (Default: 1).
+        """
+        tilt = self.tilt
+        if tilt < angle_tolerance:
+            return 'Up'
+        elif tilt > 180 - angle_tolerance:
+            return 'Down'
+        orient = self.horizontal_orientation(north_vector)
+        orient_text = ('N', 'NE', 'E', 'SE', 'S', 'SW', 'W', 'NW')
+        angles = (22.5, 67.5, 112.5, 157.5, 202.5, 247.5, 292.5, 337.5)
+        for i, ang in enumerate(angles):
+            if orient < ang:
+                return orient_text[i]
+        return orient_text[0]
+
     def add_prefix(self, prefix):
         """Change the identifier of this object and child objects by inserting a prefix.
 
@@ -340,6 +391,28 @@ class Aperture(_BaseWithShade):
                            in self._boundary_condition._boundary_condition_objects)
             self._boundary_condition = Surface(new_bc_objs, True)
 
+    def rename_by_attribute(
+        self,
+        format_str='{parent.parent.display_name} - {gbxml_type} - {cardinal_direction}'
+    ):
+        """Set the display name of this Aperture using a format string with attributes.
+
+        Args:
+            format_str: Text string for the pattern with which the Aperture will be
+                renamed. Any property on this 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.
+        """
+        matches = re.findall(r'{([^}]*)}', format_str)
+        attributes = [get_attr_nested(self, m, decimal_count=2) for m in matches]
+        for attr_name, attr_val in zip(matches, attributes):
+            format_str = format_str.replace('{{{}}}'.format(attr_name), attr_val)
+        self.display_name = format_str
+        return format_str
+
     def set_adjacency(self, other_aperture):
         """Set this aperture to be adjacent to another.
 

honeybee/door.py

@@ -2,14 +2,15 @@
 """Honeybee Door."""
 from __future__ import division
 import math
+import re
 
-from ladybug_geometry.geometry2d.pointvector import Vector2D
-from ladybug_geometry.geometry3d.pointvector import Point3D
-from ladybug_geometry.geometry3d.face import Face3D
+from ladybug_geometry.geometry2d import Vector2D
+from ladybug_geometry.geometry3d import Point3D, Face3D
 from ladybug.color import Color
 
 from ._basewithshade import _BaseWithShade
 from .typing import clean_string
+from .search import get_attr_nested
 from .properties import DoorProperties
 from .boundarycondition import boundary_conditions, Outdoors, Surface
 from .shade import Shade
@@ -278,6 +279,16 @@ class Door(_BaseWithShade):
         """
         return isinstance(self.boundary_condition, Outdoors)
 
+    @property
+    def gbxml_type(self):
+        """Get text for the type of object this is in gbXML schema."""
+        return 'NonSlidingDoor'
+
+    @property
+    def energyplus_type(self):
+        """Get text for the type of object this is in IDF schema."""
+        return 'GlassDoor' if self.is_glass else 'Door'
+
     @property
     def type_color(self):
         """Get a Color to be used in visualizations by type."""
@@ -300,16 +311,23 @@ class Door(_BaseWithShade):
         return math.degrees(
             north_vector.angle_clockwise(Vector2D(self.normal.x, self.normal.y)))
 
-    def cardinal_direction(self, north_vector=Vector2D(0, 1)):
+    def cardinal_direction(self, north_vector=Vector2D(0, 1), angle_tolerance=1):
         """Get text description for the cardinal direction that the door is pointing.
 
         Will be one of the following: ('North', 'NorthEast', 'East', 'SouthEast',
-        'South', 'SouthWest', 'West', 'NorthWest').
+        'South', 'SouthWest', 'West', 'NorthWest', 'Up', 'Down').
 
         Args:
             north_vector: A ladybug_geometry Vector2D for the north direction.
                 Default is the Y-axis (0, 1).
+            angle_tolerance: The angle tolerance in degrees used to determine if
+                the geometry is perfectly Up or Down. (Default: 1).
         """
+        tilt = self.tilt
+        if tilt < angle_tolerance:
+            return 'Up'
+        elif tilt > 180 - angle_tolerance:
+            return 'Down'
         orient = self.horizontal_orientation(north_vector)
         orient_text = ('North', 'NorthEast', 'East', 'SouthEast', 'South',
                        'SouthWest', 'West', 'NorthWest')
@@ -319,6 +337,31 @@ class Door(_BaseWithShade):
                 return orient_text[i]
         return orient_text[0]
 
+    def cardinal_abbrev(self, north_vector=Vector2D(0, 1), angle_tolerance=1):
+        """Get text abbreviation for the cardinal direction that the door is pointing.
+
+        Will be one of the following: ('N', 'NE', 'E', 'SE', 'S', 'SW', 'W', 'NW',
+        'Up', 'Down').
+
+        Args:
+            north_vector: A ladybug_geometry Vector2D for the north direction.
+                Default is the Y-axis (0, 1).
+            angle_tolerance: The angle tolerance in degrees used to determine if
+                the door is perfectly Up or Down. (Default: 1).
+        """
+        tilt = self.tilt
+        if tilt < angle_tolerance:
+            return 'Up'
+        elif tilt > 180 - angle_tolerance:
+            return 'Down'
+        orient = self.horizontal_orientation(north_vector)
+        orient_text = ('N', 'NE', 'E', 'SE', 'S', 'SW', 'W', 'NW')
+        angles = (22.5, 67.5, 112.5, 157.5, 202.5, 247.5, 292.5, 337.5)
+        for i, ang in enumerate(angles):
+            if orient < ang:
+                return orient_text[i]
+        return orient_text[0]
+
     def add_prefix(self, prefix):
         """Change the identifier of this object and child objects by inserting a prefix.
 
@@ -342,6 +385,28 @@ class Door(_BaseWithShade):
                            in self._boundary_condition._boundary_condition_objects)
             self._boundary_condition = Surface(new_bc_objs, True)
 
+    def rename_by_attribute(
+        self,
+        format_str='{parent.parent.display_name} - {energyplus_type} - {cardinal_direction}'
+    ):
+        """Set the display name of this Door using a format string with attributes.
+
+        Args:
+            format_str: Text string for the pattern with which the Door will be
+                renamed. Any property on this class may be used (eg. energyplus_type)
+                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.
+        """
+        matches = re.findall(r'{([^}]*)}', format_str)
+        attributes = [get_attr_nested(self, m, decimal_count=2) for m in matches]
+        for attr_name, attr_val in zip(matches, attributes):
+            format_str = format_str.replace('{{{}}}'.format(attr_name), attr_val)
+        self.display_name = format_str
+        return format_str
+
     def set_adjacency(self, other_door):
         """Set this door to be adjacent to another (and vice versa).
 

honeybee/face.py

@@ -2,6 +2,7 @@
 """Honeybee Face."""
 from __future__ import division
 import math
+import re
 
 from ladybug_geometry.geometry2d import Vector2D, Point2D, Polygon2D, Mesh2D
 from ladybug_geometry.geometry3d import Vector3D, Point3D, Plane, Face3D
@@ -9,8 +10,10 @@ from ladybug.color import Color
 
 from ._basewithshade import _BaseWithShade
 from .typing import clean_string, invalid_dict_error
+from .search import get_attr_nested
 from .properties import FaceProperties
-from .facetype import face_types, get_type_from_normal, AirBoundary, Floor, RoofCeiling
+from .facetype import face_types, get_type_from_normal, AirBoundary, Wall, \
+    Floor, RoofCeiling
 from .boundarycondition import boundary_conditions, get_bc_from_position, \
     _BoundaryCondition, Outdoors, Surface, Ground
 from .shade import Shade
@@ -398,6 +401,52 @@ class Face(_BaseWithShade):
         """
         return isinstance(self.boundary_condition, Outdoors)
 
+    @property
+    def gbxml_type(self):
+        """Get text for the type of object this is in gbXML schema.
+
+        This will always be one of the following.
+
+            * InteriorWall
+            * ExteriorWall
+            * UndergroundWall
+            * Roof
+            * Ceiling
+            * UndergroundCeiling
+            * InteriorFloor
+            * ExposedFloor
+            * UndergroundSlab
+            * SlabOnGrade
+            * Air
+        """
+        if isinstance(self.type, AirBoundary):
+            return 'Air'
+        elif isinstance(self.type, Wall):
+            bc_type = 'Interior'
+            if isinstance(self.boundary_condition, Outdoors):
+                bc_type = 'Exterior'
+            elif isinstance(self.boundary_condition, Ground):
+                bc_type = 'Underground'
+            return bc_type + 'Wall'
+        elif isinstance(self.type, Floor):
+            if isinstance(self.boundary_condition, Ground):
+                if self.has_parent:
+                    for f in self.parent.faces:
+                        if isinstance(f.type, Wall) and \
+                                isinstance(f.boundary_condition, Outdoors):
+                            return 'SlabOnGrade'
+                return 'UndergroundSlab'
+            elif isinstance(self.boundary_condition, Outdoors):
+                return 'ExposedFloor'
+            else:
+                return 'InteriorFloor'
+        else:
+            if isinstance(self.boundary_condition, Outdoors):
+                return 'Roof'
+            elif isinstance(self.boundary_condition, Ground):
+                return 'UndergroundCeiling'
+            return 'Ceiling'
+
     @property
     def type_color(self):
         """Get a Color to be used in visualizations by type."""
@@ -425,16 +474,23 @@ class Face(_BaseWithShade):
         return math.degrees(
             north_vector.angle_clockwise(Vector2D(self.normal.x, self.normal.y)))
 
-    def cardinal_direction(self, north_vector=Vector2D(0, 1)):
+    def cardinal_direction(self, north_vector=Vector2D(0, 1), angle_tolerance=1):
         """Get text description for the cardinal direction that the face is pointing.
 
         Will be one of the following: ('North', 'NorthEast', 'East', 'SouthEast',
-        'South', 'SouthWest', 'West', 'NorthWest').
+        'South', 'SouthWest', 'West', 'NorthWest', 'Up', 'Down').
 
         Args:
             north_vector: A ladybug_geometry Vector2D for the north direction.
                 Default is the Y-axis (0, 1).
+            angle_tolerance: The angle tolerance in degrees used to determine if
+                the Face is perfectly Up or Down. (Default: 1).
         """
+        tilt = self.tilt
+        if tilt < angle_tolerance:
+            return 'Up'
+        elif tilt > 180 - angle_tolerance:
+            return 'Down'
         orient = self.horizontal_orientation(north_vector)
         orient_text = ('North', 'NorthEast', 'East', 'SouthEast', 'South',
                        'SouthWest', 'West', 'NorthWest')
@@ -444,6 +500,31 @@ class Face(_BaseWithShade):
                 return orient_text[i]
         return orient_text[0]
 
+    def cardinal_abbrev(self, north_vector=Vector2D(0, 1), angle_tolerance=1):
+        """Get text abbreviation for the cardinal direction that the face is pointing.
+
+        Will be one of the following: ('N', 'NE', 'E', 'SE', 'S', 'SW', 'W', 'NW',
+        'Up', 'Down').
+
+        Args:
+            north_vector: A ladybug_geometry Vector2D for the north direction.
+                Default is the Y-axis (0, 1).
+            angle_tolerance: The angle tolerance in degrees used to determine if
+                the Face is perfectly Up or Down. (Default: 1).
+        """
+        tilt = self.tilt
+        if tilt < angle_tolerance:
+            return 'Up'
+        elif tilt > 180 - angle_tolerance:
+            return 'Down'
+        orient = self.horizontal_orientation(north_vector)
+        orient_text = ('N', 'NE', 'E', 'SE', 'S', 'SW', 'W', 'NW')
+        angles = (22.5, 67.5, 112.5, 157.5, 202.5, 247.5, 292.5, 337.5)
+        for i, ang in enumerate(angles):
+            if orient < ang:
+                return orient_text[i]
+        return orient_text[0]
+
     def add_prefix(self, prefix):
         """Change the identifier of this object and child objects by inserting a prefix.
 
@@ -471,6 +552,28 @@ class Face(_BaseWithShade):
                            in self._boundary_condition._boundary_condition_objects)
             self._boundary_condition = Surface(new_bc_objs, False)
 
+    def rename_by_attribute(
+        self,
+        format_str='{parent.display_name} - {gbxml_type} - {cardinal_direction}'
+    ):
+        """Set the display name of this Face using a format string with Face attributes.
+
+        Args:
+            format_str: Text string for the pattern with which the Face will be
+                renamed. Any property on this 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.
+        """
+        matches = re.findall(r'{([^}]*)}', format_str)
+        attributes = [get_attr_nested(self, m, decimal_count=2) for m in matches]
+        for attr_name, attr_val in zip(matches, attributes):
+            format_str = format_str.replace('{{{}}}'.format(attr_name), attr_val)
+        self.display_name = format_str
+        return format_str
+
     def remove_sub_faces(self):
         """Remove all apertures and doors from the face."""
         self.remove_apertures()

honeybee/room.py

@@ -2,6 +2,7 @@
 """Honeybee Room."""
 from __future__ import division
 import math
+import re
 import uuid
 
 from ladybug_geometry.geometry2d import Point2D, Vector2D, Polygon2D
@@ -11,8 +12,7 @@ from ladybug_geometry_polyskel.polysplit import perimeter_core_subpolygons
 
 import honeybee.writer.room as writer
 from ._basewithshade import _BaseWithShade
-from .typing import float_in_range, int_in_range, clean_string, \
-    invalid_dict_error
+from .typing import float_in_range, int_in_range, clean_string, invalid_dict_error
 from .properties import RoomProperties
 from .face import Face
 from .aperture import Aperture
@@ -605,6 +605,81 @@ class Room(_BaseWithShade):
             face.add_prefix(prefix)
         self._add_prefix_shades(prefix)
 
+    def rename_by_attribute(
+        self, format_str='{story} - {display_name}'
+    ):
+        """Set the display name of this Room using a format string with Room attributes.
+
+        Args:
+            format_str: Text string for the pattern with which the Room will be
+                renamed. Any property on this class may be used (eg. story)
+                and each property should be put in curly brackets. Nested
+                properties can be specified by using "." to denote nesting levels
+                (eg. properties.energy.program_type.display_name). Functions that
+                return string outputs can also be passed here as long as these
+                functions defaults specified for all arguments.
+        """
+        matches = re.findall(r'{([^}]*)}', format_str)
+        attributes = [get_attr_nested(self, m) for m in matches]
+        for attr_name, attr_val in zip(matches, attributes):
+            format_str = format_str.replace('{{{}}}'.format(attr_name), attr_val)
+        self.display_name = format_str
+        return format_str
+
+    def rename_faces_by_attribute(
+        self,
+        format_str='{parent.display_name} - {gbxml_type} - {cardinal_direction}'
+    ):
+        """Set the display name for all of this Room's faces using a format string.
+
+        Args:
+            format_str: Text string for the pattern with which the faces will be
+                renamed. Any property of the 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.
+        """
+        for face in self.faces:
+            face.rename_by_attribute(format_str)
+
+    def rename_apertures_by_attribute(
+        self,
+        format_str='{parent.parent.display_name} - {gbxml_type} - {cardinal_direction}'
+    ):
+        """Set the display name for all of this Room's apertures using a format string.
+
+        Args:
+            format_str: Text string for the pattern with which the apertures will be
+                renamed. Any property on the Aperture 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.
+        """
+        for ap in self.apertures:
+            ap.rename_by_attribute(format_str)
+
+    def rename_doors_by_attribute(
+        self,
+        format_str='{parent.parent.display_name} - {energyplus_type} - {cardinal_direction}'
+    ):
+        """Set the display name for all of this Room's doors using a format string.
+
+        Args:
+            format_str: Text string for the pattern with which the doors will be
+                renamed. Any property on the 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.
+        """
+        for dr in self.doors:
+            dr.rename_by_attribute(format_str)
+
     def horizontal_boundary(self, match_walls=False, tolerance=0.01):
         """Get a Face3D representing the horizontal boundary around the Room.
 
@@ -1662,6 +1737,44 @@ class Room(_BaseWithShade):
             msg, raise_exception, detailed, '000107',
             error_type='Degenerate Room Volume')
 
+    def remove_duplicate_faces(self, tolerance=0.01):
+        """Remove duplicate face geometries from the Room.
+
+        Such duplicate faces can sometimes happen as a result of performing many
+        coplanar splits.
+
+        Args:
+            tolerance: The minimum difference between the coordinate values of two
+                faces at which they can be considered adjacent. Default: 0.01,
+                suitable for objects in meters.
+
+        Returns:
+            A list containing only the duplicate Faces that were removed.
+        """
+        # first make a list of faces without any duplicate geometries
+        new_faces, removed_faces = [self._faces[0]], []
+        for face in self._faces[1:]:
+            for e_face in new_faces:
+                if face.geometry.is_centered_adjacent(e_face.geometry, tolerance):
+                    tol_area = math.sqrt(face.geometry.area) * tolerance
+                    if abs(face.geometry.area - e_face.area) < tol_area:
+                        removed_faces.append(face)
+                        break  # duplicate face found
+            else:  # the first face with this type of plane
+                new_faces.append(face)
+        if len(removed_faces) == 0:
+            return removed_faces  # nothing has been removed
+
+        # make a new polyface from the updated faces
+        room_polyface = Polyface3D.from_faces(
+            tuple(face.geometry for face in new_faces), tolerance)
+        if not room_polyface.is_solid:
+            room_polyface = room_polyface.merge_overlapping_edges(tolerance)
+        # reset the faces and geometry of the room with the new faces
+        self._faces = tuple(new_faces)
+        self._geometry = room_polyface
+        return removed_faces
+
     def merge_coplanar_faces(
             self, tolerance=0.01, angle_tolerance=1, orthogonal_only=False):
         """Merge coplanar Faces of this Room.
@@ -1941,6 +2054,7 @@ class Room(_BaseWithShade):
         for i, room in enumerate(rooms):
             other_rooms = room_geos[:i] + room_geos[i + 1:]
             room.coplanar_split(other_rooms, tolerance, angle_tolerance)
+            room.remove_duplicate_faces(tolerance)
 
     @staticmethod
     def solve_adjacency(rooms, tolerance=0.01, remove_mismatched_sub_faces=False):

honeybee/search.py

@@ -82,7 +82,10 @@ def get_attr_nested(obj_instance, attr_name, decimal_count=None, cast_to_str=Tru
                 else:
                     current_obj = getattr(current_obj, attribute)
             if isinstance(current_obj, float) and decimal_count:
-                return round(current_obj, decimal_count)
+                val = round(current_obj, decimal_count)
+                return str(val) if cast_to_str else val
+            elif callable(current_obj):
+                return str(current_obj()) if cast_to_str else current_obj()
             else:
                 return str(current_obj) if cast_to_str else current_obj
         except AttributeError as e:
@@ -94,7 +97,10 @@ def get_attr_nested(obj_instance, attr_name, decimal_count=None, cast_to_str=Tru
         try:
             current_obj = getattr(obj_instance, attr_name)
             if isinstance(current_obj, float) and decimal_count:
-                return round(current_obj, decimal_count)
+                val = round(current_obj, decimal_count)
+                return str(val) if cast_to_str else val
+            elif callable(current_obj):
+                return str(current_obj()) if cast_to_str else current_obj()
             else:
                 return str(current_obj) if cast_to_str else current_obj
         except AttributeError:

honeybee/shade.py

@@ -2,6 +2,7 @@
 """Honeybee Shade."""
 from __future__ import division
 import math
+import re
 
 from ladybug_geometry.geometry3d.pointvector import Point3D
 from ladybug_geometry.geometry3d.face import Face3D
@@ -9,6 +10,7 @@ from ladybug.color import Color
 
 from ._base import _Base
 from .typing import clean_string
+from .search import get_attr_nested
 from .properties import ShadeProperties
 import honeybee.writer.shade as writer
 
@@ -253,6 +255,11 @@ class Shade(_Base):
         """
         return math.degrees(self._geometry.azimuth)
 
+    @property
+    def gbxml_type(self):
+        """Get text for the type of object this is in gbXML schema."""
+        return 'Shade'
+
     @property
     def type_color(self):
         """Get a Color to be used in visualizations by type."""
@@ -280,6 +287,27 @@ class Shade(_Base):
         self.display_name = '{}_{}'.format(prefix, self.display_name)
         self.properties.add_prefix(prefix)
 
+    def rename_by_attribute(
+        self, format_str='{display_name} - {gbxml_type}'
+    ):
+        """Set the display name of this Shade using a format string with attributes.
+
+        Args:
+            format_str: Text string for the pattern with which the Shade will be
+                renamed. Any property on this class may be used (eg. energyplus_type)
+                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.
+        """
+        matches = re.findall(r'{([^}]*)}', format_str)
+        attributes = [get_attr_nested(self, m, decimal_count=2) for m in matches]
+        for attr_name, attr_val in zip(matches, attributes):
+            format_str = format_str.replace('{{{}}}'.format(attr_name), attr_val)
+        self.display_name = format_str
+        return format_str
+
     def move(self, moving_vec):
         """Move this Shade along a vector.
 

{honeybee_core-1.61.32.dist-info → honeybee_core-1.61.34.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: honeybee-core
-Version: 1.61.32
+Version: 1.61.34
 Summary: A library to create 3D building geometry for various types of environmental simulation.
 Home-page: https://github.com/ladybug-tools/honeybee-core
 Author: Ladybug Tools

{honeybee_core-1.61.32.dist-info → honeybee_core-1.61.34.dist-info}/RECORD

@@ -4,24 +4,24 @@ honeybee/_base.py,sha256=11TweR_0YJFv5ma1ttN2bs6FW_RlC3hNTjhhjvqXDB0,13181
 honeybee/_basewithshade.py,sha256=SXCWZ-4do6_Z-bZpVFidUINbylVyjwpkY2TIJE28Vuw,12943
 honeybee/_lockable.py,sha256=jmTVsXEWmYyEHpL3WsQZ_ItGOVVlJht1z3NFn07DIp0,3707
 honeybee/altnumber.py,sha256=nVXIvji9YDpy_I37oG41-rkPDx5QLplW9B2RYRCNeoA,1002
-honeybee/aperture.py,sha256=IHWU_-y1S2CEnIJnvBWU3WzwUqM3isn2JU_-3cXYPQQ,42425
+honeybee/aperture.py,sha256=Kegu9rPZtRhezwsJwqVz74jxepoTmGnzzLJ3D1xUfmc,45512
 honeybee/boundarycondition.py,sha256=ys3kgMqgeJDBMLpXwSgwNBwvKMRz-LbCtLiL9tiOXS0,13777
 honeybee/checkdup.py,sha256=8q5p4tD3S4dl69jcURQhppeajJ_pYXRBlA48zTOoAGI,8221
 honeybee/colorobj.py,sha256=jhJmTBcLayFKSniW5ASo2-XMKFsW-RBUJilc9v-33ik,13349
 honeybee/config.json,sha256=GAFduJOXTlNcPM4M0fMkSXom5Cb7XZAMYQis2WsNaq0,167
 honeybee/config.py,sha256=auH_ooOyqMKAeBZxUc2NGUehUcYg8SHya98b5hfNlvM,13836
 honeybee/dictutil.py,sha256=cOqkhgJSQ3MviIkqOPv8MRb-N-BeDv07cVcNg7w7nLY,1992
-honeybee/door.py,sha256=xbdefvnPPhwWzU66SpNL1C1A1YW5CNC8sLRabFZUf4E,28571
+honeybee/door.py,sha256=HiMBdT07_KjaGdasT2MvUdDl6XjOM7lhr-DxEy_0oZE,31406
 honeybee/extensionutil.py,sha256=DDQYhM7tFD3avRSCOjwTzLqX9ldUxl5GzY79V3_sATE,9644
-honeybee/face.py,sha256=RTd5NGqV-RXHqLEpKpANXp9Wi2HcDRp2AtEbPy2pqmc,108049
+honeybee/face.py,sha256=j8ud3d-8Z8RvDomeiyYTqalu5czgiCMb08Xue_tFRGo,112287
 honeybee/facetype.py,sha256=vCtWZKHp21RH-Yzs8zsHJHuFhJvczNh0yFl8wDe_RWY,4489
 honeybee/logutil.py,sha256=2gn-6RcWqFLvwdFzBHPqUwFqTj_R3iwHKALrl-2eL7M,2564
 honeybee/model.py,sha256=oGuhSSBimZ-MEJKyidh6_poi7twUgeEJKUzbr_j7qcQ,175868
 honeybee/orientation.py,sha256=GogGblASW9OU-fobfDaQ7w5yRbEAFdJJuHwg2fadhKI,5046
 honeybee/properties.py,sha256=fnlT71in22HpFQGD8ta5kXNnSZVXwXq5cNgvD-hrMRg,33462
-honeybee/room.py,sha256=5z6rSqsP231N3FYcRxSzntKfR8inEDIJJjJ-BaQcV3A,150943
-honeybee/search.py,sha256=OiXibGGVb1ff4gTn_768i-sehB-zAYG12c0o3B0RjKE,4718
-honeybee/shade.py,sha256=GSlceN2kpo8NOc_QkvvxEhKozRytOS8InZ1Ge0fPuko,19746
+honeybee/room.py,sha256=WrQuXHoomD_vbxF6Io8SIlUCpkXqh6j59N4yIR26mhM,156468
+honeybee/search.py,sha256=KOIeQjYdj0yhRWPmF5kiFiH8Ei0WbzuiU-capnwYVeM,5060
+honeybee/shade.py,sha256=HwLkOqvPpluLMXzicWXmKl4fMVJHmkqqehntT69e00Q,21026
 honeybee/shademesh.py,sha256=oldugnwhu-ibX9f0hfxpO-DvgM8U7S-dYwUjBSVzo4g,13273
 honeybee/typing.py,sha256=E8-HrCB9cSoqhFR6zcFXhrAlQRAFw_sxHGdobB8Lre8,20051
 honeybee/units.py,sha256=_qG_G5b9hdqjpyVOpGdIYCB6k8VKYjcxSJn1St-7Xjc,3204
@@ -40,9 +40,9 @@ honeybee/writer/model.py,sha256=N7F_jksf-5TrdVecuxTaFWxnPVFLmQs7k8g27TsdB7Q,177
 honeybee/writer/room.py,sha256=kFghgStTU1SEJSLigXB0VjOWhZtgs4uXuAqdwd4yRQo,174
 honeybee/writer/shade.py,sha256=EpgX-vMc-s21TnMvNWvWTKyT8iAnxu1nFVXzjY1oyF8,177
 honeybee/writer/shademesh.py,sha256=Y41bLogJ7dwpvMe5cAWVRDRVqJEwo9e5hFJQjlt6UX8,189
-honeybee_core-1.61.32.dist-info/LICENSE,sha256=hIahDEOTzuHCU5J2nd07LWwkLW7Hko4UFO__ffsvB-8,34523
-honeybee_core-1.61.32.dist-info/METADATA,sha256=e7FRoipS-OFp_ztDtU9j72So1mFM5JLwK64KeUczuIA,3317
-honeybee_core-1.61.32.dist-info/WHEEL,sha256=AHX6tWk3qWuce7vKLrj7lnulVHEdWoltgauo8bgCXgU,109
-honeybee_core-1.61.32.dist-info/entry_points.txt,sha256=r3YqOm40goBroH3ccUhpwQjvTwu10JWLd0HIRHI1J8E,47
-honeybee_core-1.61.32.dist-info/top_level.txt,sha256=8ve7puCRLUA9XDEGc1Mcs-UX9sFjpPV8MeTaIMwQ_Tg,9
-honeybee_core-1.61.32.dist-info/RECORD,,
+honeybee_core-1.61.34.dist-info/LICENSE,sha256=hIahDEOTzuHCU5J2nd07LWwkLW7Hko4UFO__ffsvB-8,34523
+honeybee_core-1.61.34.dist-info/METADATA,sha256=1n2sQVCaIqbaL5-S2niJsI8mo9QC3W6TimxVwIF5mJ8,3317
+honeybee_core-1.61.34.dist-info/WHEEL,sha256=AHX6tWk3qWuce7vKLrj7lnulVHEdWoltgauo8bgCXgU,109
+honeybee_core-1.61.34.dist-info/entry_points.txt,sha256=r3YqOm40goBroH3ccUhpwQjvTwu10JWLd0HIRHI1J8E,47
+honeybee_core-1.61.34.dist-info/top_level.txt,sha256=8ve7puCRLUA9XDEGc1Mcs-UX9sFjpPV8MeTaIMwQ_Tg,9
+honeybee_core-1.61.34.dist-info/RECORD,,