Source code for dragonfly_radiance.properties.story

# coding=utf-8
"""Story Radiance Properties."""
from honeybee_radiance.modifierset import ModifierSet

from honeybee_radiance.lib.modifiersets import generic_modifier_set_visible




class StoryRadianceProperties(object):
    """Radiance Properties for Dragonfly Story.

    Args:
        host: A dragonfly_core Story object that hosts these properties.
        modifier_set: A honeybee ModifierSet object to specify all default modifiers
            for the Story geometry. If None, it will be the honeybee default modifier
            set, which is only representative of typical indoor conditions in
            the visible spectrum. (Default: None).

    Properties:
        * host
        * modifier_set
    """

    __slots__ = ('_host', '_modifier_set')

    def __init__(self, host, modifier_set=None):
        """Initialize Story radiance properties."""
        self._host = host
        self.modifier_set = modifier_set

    @property
    def host(self):
        """Get the Story object hosting these properties."""
        return self._host

    @property
    def modifier_set(self):
        """Get or set the Story ModifierSet object.

        If not set, it will be set by the parent Building or will be the Honeybee
        default generic ModifierSet.
        """
        if self._modifier_set is not None:  # set by the user
            return self._modifier_set
        elif self._host.has_parent:  # set by parent building
            return self._host.parent.properties.radiance.modifier_set
        else:
            return generic_modifier_set_visible

    @modifier_set.setter
    def modifier_set(self, value):
        if value is not None:
            assert isinstance(value, ModifierSet), \
                'Expected ModifierSet. Got {}'.format(type(value))
            value.lock()   # lock in case modifier set has multiple references
        self._modifier_set = value



    @classmethod
    def from_dict(cls, data, host):
        """Create StoryRadianceProperties from a dictionary.

        Note that the dictionary must be a non-abridged version for this
        classmethod to work.

        Args:
            data: A dictionary representation of StoryRadianceProperties.
            host: A Story object that hosts these properties.
        """
        assert data['type'] == 'StoryRadianceProperties', \
            'Expected StoryRadianceProperties. Got {}.'.format(data['type'])

        new_prop = cls(host)
        if 'modifier_set' in data and data['modifier_set'] is not None:
            new_prop.modifier_set = ModifierSet.from_dict(data['modifier_set'])

        return new_prop




    def apply_properties_from_dict(self, abridged_data, modifier_sets):
        """Apply properties from a StoryRadiancePropertiesAbridged dictionary.

        Args:
            abridged_data: A StoryRadiancePropertiesAbridged dictionary (typically
                coming from a Model).
            modifier_sets: A dictionary of ModifierSets with identifiers
                of the sets as keys, which will be used to re-assign modifier_sets.
        """
        if 'modifier_set' in abridged_data and abridged_data['modifier_set'] is not None:
            self.modifier_set = modifier_sets[abridged_data['modifier_set']]




    def to_dict(self, abridged=False):
        """Return Story Radiance properties as a dictionary.

        Args:
            abridged: Boolean for whether the full dictionary of the Story should
                be written (False) or just the identifier of the the individual
                properties (True). Default: False.
        """
        base = {'radiance': {}}
        base['radiance']['type'] = 'StoryRadianceProperties' if not \
            abridged else 'StoryRadiancePropertiesAbridged'

        # write the ModifierSet into the dictionary
        if self._modifier_set is not None:
            base['radiance']['modifier_set'] = \
                self._modifier_set.identifier if abridged else \
                self._modifier_set.to_dict()

        return base




    def duplicate(self, new_host=None):
        """Get a copy of this object.

        new_host: A new Story object that hosts these properties.
            If None, the properties will be duplicated with the same host.
        """
        _host = new_host or self._host
        return StoryRadianceProperties(_host, self._modifier_set)




    def ToString(self):
        return self.__repr__()


    def __repr__(self):
        return 'Story Radiance Properties: {}'.format(self.host.identifier)