honeybee-radiance 1.66.190__py3-none-any.whl

honeybee_radiance/properties/door.py

@@ -0,0 +1,198 @@
+# coding=utf-8
+"""Door Radiance Properties."""
+from ._base import _DynamicRadianceProperties
+from ..modifier import Modifier
+from ..dynamic.state import RadianceSubFaceState
+from ..lib.modifiers import black
+from ..lib.modifiersets import generic_modifier_set_visible
+
+
+class DoorRadianceProperties(_DynamicRadianceProperties):
+    """Radiance Properties for Honeybee Door.
+
+
+    Args:
+        host: A honeybee_core Door object that hosts these properties.
+        modifier: A Honeybee Radiance Modifier object for the door. If None,
+            it will be set by the parent Room ModifierSet or the Honeybee
+            default generic ModifierSet.
+        modifier_blk: A Honeybee Radiance Modifier object to be used for this
+            door in direct solar simulations and in isolation studies (assessing
+            the contribution of individual Doors). If None, this will be
+            a completely black material.
+        dynamic_group_identifier: An optional string to note the dynamic group
+            to which the Door is a part of. Doors sharing the same
+            dynamic_group_identifier will have their states change in unison.
+            If None, the Door is assumed to be static.
+
+    Properties:
+        * host
+        * modifier
+        * modifier_blk
+        * dynamic_group_identifier
+        * states
+        * state_count
+        * is_opaque
+        * is_modifier_set_on_object
+        * is_blk_overridden
+    """
+
+    __slots__ = ()
+
+    def __init__(self, host, modifier=None, modifier_blk=None,
+                 dynamic_group_identifier=None):
+        """Initialize Door radiance properties."""
+        _DynamicRadianceProperties.__init__(
+            self, host, modifier, modifier_blk, dynamic_group_identifier)
+
+    @property
+    def modifier(self):
+        """Get or set the Door modifier.
+
+        If the modifier is not set on the door-level, then it will be assigned
+        based on the ModifierSet assigned to the parent Room.  If there is no
+        parent Room or the parent Room's ModifierSet has no modifier for
+        the Door type and boundary_condition, it will be assigned using the
+        honeybee default generic ModifierSet.
+        """
+        if self._modifier:  # set by user
+            return self._modifier
+        elif self._host.has_parent and self._host.parent.has_parent:  # set by room
+            constr_set = self._host.parent.parent.properties.radiance.modifier_set
+            return constr_set.get_door_modifier(
+                self._host.boundary_condition.name, self._host.is_glass,
+                self._host.parent.type.name)
+        elif self._host.has_parent:  # generic but influenced by parent door
+            return generic_modifier_set_visible.get_door_modifier(
+                self._host.boundary_condition.name, self._host.is_glass,
+                self._host.parent.type.name)
+        else:
+            return generic_modifier_set_visible.get_door_modifier(
+                self._host.boundary_condition.name, self._host.is_glass, 'Wall')
+
+    @modifier.setter
+    def modifier(self, value):
+        if value is not None:
+            assert isinstance(value, Modifier), \
+                'Expected Radiance Modifier for door. Got {}'.format(type(value))
+            value.lock()  # lock editing in case modifier has multiple references
+        self._modifier = value
+
+    @property
+    def modifier_blk(self):
+        """Get or set a modifier to be used in direct solar and in isolation studies.
+
+        If None, this will be a completely black material.
+        """
+        if self._modifier_blk:  # set by user
+            return self._modifier_blk
+        return black
+
+    @modifier_blk.setter
+    def modifier_blk(self, value):
+        if value is not None:
+            assert isinstance(value, Modifier), \
+                'Expected Radiance Modifier for door. Got {}'.format(type(value))
+            value.lock()  # lock editing in case modifier has multiple references
+        self._modifier_blk = value
+
+    @classmethod
+    def from_dict(cls, data, host):
+        """Create DoorRadianceProperties from a dictionary.
+
+        Note that the dictionary must be a non-abridged version for this
+        classmethod to work.
+
+        Args:
+            data: A dictionary representation of DoorRadianceProperties with the
+                format below.
+            host: A Door object that hosts these properties.
+
+        .. code-block:: python
+
+            {
+            'type': 'DoorRadianceProperties',
+            'modifier': {},  # A Honeybee Radiance Modifier dictionary
+            'modifier_blk': {},  # A Honeybee Radiance Modifier dictionary
+            'dynamic_group_identifier': str,  # An optional dynamic group identifier
+            'states': []  # An optional list of states
+            }
+        """
+        assert data['type'] == 'DoorRadianceProperties', \
+            'Expected DoorRadianceProperties. Got {}.'.format(data['type'])
+        new_prop = cls(host)
+        new_prop = cls._restore_modifiers_from_dict(new_prop, data)
+        return cls._restore_states_from_dict(new_prop, data)
+
+    def apply_properties_from_dict(self, abridged_data, modifiers):
+        """Apply properties from a DoorRadiancePropertiesAbridged dictionary.
+
+        Args:
+            abridged_data: A DoorRadiancePropertiesAbridged dictionary (typically
+                coming from a Model) with the format below.
+            modifiers: A dictionary of modifiers with modifier identifiers as keys,
+                which will be used to re-assign modifiers.
+
+        .. code-block:: python
+
+            {
+            'type': 'DoorRadiancePropertiesAbridged',
+            'modifier': str,  # A Honeybee Radiance Modifier identifier
+            'modifier_blk': str,  # A Honeybee Radiance Modifier identifier
+            'dynamic_group_identifier': str,  # An optional dynamic group identifier
+            'states': []  # An optional list of states
+            }
+        """
+        self._apply_modifiers_from_dict(abridged_data, modifiers)
+        self._apply_states_from_dict(abridged_data, modifiers)
+
+    def to_dict(self, abridged=False):
+        """Return radiance properties as a dictionary.
+
+        Args:
+            abridged: Boolean to note whether the full dictionary describing the
+                object should be returned (False) or just an abridged version (True).
+                Default: False.
+        """
+        base = {'radiance': {}}
+        base['radiance']['type'] = 'DoorRadianceProperties' if not \
+            abridged else 'DoorRadiancePropertiesAbridged'
+        self._add_modifiers_to_dict(base, abridged)
+        return self._add_states_to_dict(base, abridged)
+
+    def _check_state(self, obj):
+        assert isinstance(obj, RadianceSubFaceState), \
+            'Expected RadianceSubFaceState. Got {}.'.format(type(obj))
+        assert obj.parent is None, \
+            'RadianceSubFaceState cannot already have a parent object.'
+        obj._parent = self.host
+        return obj
+
+    def _apply_states_from_dict(self, abridged_data, modifiers):
+        """Apply statess from an Abridged dictionary.
+
+        Args:
+            abridged_data: An Abridged dictionary (typically coming from a Model).
+            modifiers: A dictionary of modifiers with modifier identifiers as keys,
+                which will be used to re-assign modifiers.
+        """
+        if 'dynamic_group_identifier' in abridged_data and \
+                abridged_data['dynamic_group_identifier'] is not None:
+            self.dynamic_group_identifier = abridged_data['dynamic_group_identifier']
+        if 'states' in abridged_data and abridged_data['states'] is not None:
+            self.states = [RadianceSubFaceState.from_dict_abridged(st, modifiers)
+                           for st in abridged_data['states']]
+
+    @staticmethod
+    def _restore_states_from_dict(new_prop, data):
+        """Restore states from a data dictionary to a new properties object."""
+        if 'dynamic_group_identifier' in data and \
+                data['dynamic_group_identifier'] is not None:
+            new_prop.dynamic_group_identifier = data['dynamic_group_identifier']
+        if 'states' in data and data['states'] is not None:
+            new_prop.states = [RadianceSubFaceState.from_dict(shd)
+                               for shd in data['states']]
+        return new_prop
+
+    def __repr__(self):
+        return 'Door Radiance Properties: [host: {}]'.format(self.host.display_name)

honeybee_radiance/properties/face.py

@@ -0,0 +1,123 @@
+# coding=utf-8
+"""Face Radiance Properties."""
+from ._base import _RadianceProperties
+from ..modifier import Modifier
+from ..lib.modifiersets import generic_modifier_set_visible
+
+
+class FaceRadianceProperties(_RadianceProperties):
+    """Radiance Properties for Honeybee Face.
+
+    Args:
+        host: A honeybee_core Face object that hosts these properties.
+        modifier: A Honeybee Radiance Modifier object for the face. If None,
+            it will be set by the parent Room ModifierSet or the Honeybee
+            default generic ModifierSet.
+        modifier_blk: A Honeybee Radiance Modifier object to be used for this
+            face in direct solar simulations and in isolation studies (assessing
+            the contribution of individual Apertures). If None, this will be
+            a completely black material if the Face's modifier is opaque and
+            will be equal to the modifier if the Face's modifier is non-opaque.
+
+    Properties:
+        * host
+        * modifier
+        * modifier_blk
+        * is_opaque
+        * is_modifier_set_on_object
+        * is_blk_overridden
+    """
+
+    __slots__ = ()
+
+    def __init__(self, host, modifier=None, modifier_blk=None):
+        """Initialize Face radiance properties."""
+        _RadianceProperties.__init__(self, host, modifier, modifier_blk)
+
+    @property
+    def modifier(self):
+        """Get or set the Face modifier.
+
+        If the modifier is not set on the face-level, then it will be assigned
+        based on the ModifierSet assigned to the parent Room.  If there is no
+        parent Room or the parent Room's ModifierSet has no modifier for
+        the Face type and boundary_condition, it will be assigned using the
+        honeybee default generic ModifierSet.
+        """
+        if self._modifier:  # set by user
+            return self._modifier
+        elif self._host.has_parent:  # set by parent room
+            modifier_set = self._host.parent.properties.radiance.modifier_set
+            return modifier_set.get_face_modifier(
+                self._host.type.name, self._host.boundary_condition.name)
+        else:
+            return generic_modifier_set_visible.get_face_modifier(
+                self._host.type.name, self._host.boundary_condition.name)
+
+    @modifier.setter
+    def modifier(self, value):
+        if value is not None:
+            assert isinstance(value, Modifier), \
+                'Expected Radiance Modifier for face. Got {}'.format(type(value))
+            value.lock()  # lock editing in case modifier has multiple references
+        self._modifier = value
+
+    @classmethod
+    def from_dict(cls, data, host):
+        """Create FaceRadianceProperties from a dictionary.
+
+        Note that the dictionary must be a non-abridged version for this
+        classmethod to work.
+
+        Args:
+            data: A dictionary representation of FaceRadianceProperties with the
+                format below.
+            host: A Face object that hosts these properties.
+
+        .. code-block:: python
+
+            {
+            'type': 'FaceRadianceProperties',
+            'modifier': {},  # A Honeybee Radiance Modifier dictionary
+            'modifier_blk': {}  # A Honeybee Radiance Modifier dictionary
+            }
+        """
+        assert data['type'] == 'FaceRadianceProperties', \
+            'Expected FaceRadianceProperties. Got {}.'.format(data['type'])
+        new_prop = cls(host)
+        return cls._restore_modifiers_from_dict(new_prop, data)
+
+    def apply_properties_from_dict(self, abridged_data, modifiers):
+        """Apply properties from a FaceRadiancePropertiesAbridged dictionary.
+
+        Args:
+            abridged_data: A FaceRadiancePropertiesAbridged dictionary (typically
+                coming from a Model) with the format below.
+            modifiers: A dictionary of modifiers with modifier identifiers as keys,
+                which will be used to re-assign modifiers.
+
+        .. code-block:: python
+
+            {
+            'type': 'FaceRadiancePropertiesAbridged',
+            'modifier': str,  # A Honeybee Radiance Modifier identifier
+            'modifier_blk': str  # A Honeybee Radiance Modifier identifier
+            }
+        """
+        self._apply_modifiers_from_dict(abridged_data, modifiers)
+
+    def to_dict(self, abridged=False):
+        """Return radiance properties as a dictionary.
+
+        Args:
+            abridged: Boolean to note whether the full dictionary describing the
+                object should be returned (False) or just an abridged version (True).
+                Default: False.
+        """
+        base = {'radiance': {}}
+        base['radiance']['type'] = 'FaceRadianceProperties' if not \
+            abridged else 'FaceRadiancePropertiesAbridged'
+        return self._add_modifiers_to_dict(base, abridged)
+
+    def __repr__(self):
+        return 'Face Radiance Properties: [host: {}]'.format(self.host.display_name)