Source code for honeybee.radiance.staticscene

"""Radiance scene."""
from collections import namedtuple


class StaticScene(object):
    """Radiance base scene.

    Use this class to create a base for the radiance studies by using a number
    of radiance files. The main advantage of creating a scene is to avoid re-creating
    the geometries and writing the files in parametric studies.

    Args:
        files: List of radiance files. Valid files are *.rad, *.mat and *.oct.
        copy_local: Set to True to copy the files to the analysis folder (Default: True).
        overwrite: Set to True to overwrite the files if already exist.
    """

    def __init__(self, files, copy_local=True, overwrite=False):
        """Create scene."""
        self.files = files
        self.copy_local = copy_local
        self.overwrite = overwrite

    @property
    def file_count(self):
        """Number of total files in the scene."""
        return sum(len(f) for f in self.files)

    @property
    def files(self):
        """A named tuple of radiance files.

        keys are: (mat, oct, rad)
        """
        return self.__files

    @files.setter
    def files(self, fs):
        _f = namedtuple('Files', 'mat rad oct')
        if not fs:
            self.__files = _f((), (), ())
        else:
            self.__files = _f(
                tuple(f for f in fs if f.lower().endswith('.mat')),
                tuple(f for f in fs if f.lower().endswith('.rad')),
                tuple(f for f in fs if f.lower().endswith('.oct')))

    def to_rad_string(self):
        """Return list of files as single string."""
        return ''.join(fp for f in self.files for fp in f)

    def ToString(self):
        """Overwrite ToString .NET method."""
        return self.__repr__()

    def __repr__(self):
        """Scene."""
        return 'Radiance Scene%s:\n%s' % (
            ' (Files will be copied locally)' if self.copy_local else '',

            '\n'.join(fp for f in self.files for fp in f)
        )