Feature/parents lookup

archetypal/template/building_template.py

@@ -31,7 +31,6 @@ class BuildingTemplate(UmiBase):
 
     .. image:: ../images/template/buildingtemplate.png
     """
-    _CREATED_OBJECTS = []
 
     __slots__ = (
         "_partition_ratio",
@@ -116,7 +115,7 @@ def __init__(
         self.Version = Version
 
         # Only at the end append self to _CREATED_OBJECTS
-        self._CREATED_OBJECTS.append(self)
+        self.CREATED_OBJECTS.append(self)
 
     @property
     def Perimeter(self):
@@ -658,6 +657,13 @@ def __eq__(self, other):
                 ]
             )
 
+    @property
+    def ParentTemplates(self):
+        """Bails out of Parent Templates recursive call from UmiBase
+        And returns array of self for concatenation
+        """
+        return {self}
+
     @property
     def children(self):
         return self.Core, self.Perimeter, self.Structure, self.Windows

archetypal/template/conditioning.py

@@ -88,7 +88,8 @@ class ZoneConditioning(UmiBase):
 
     .. image:: ../images/template/zoninfo-conditioning.png
     """
-    _CREATED_OBJECTS = []
+
+    _POSSIBLE_PARENTS = [("ZoneDefinition", ["Conditioning"])]
 
     __slots__ = (
         "_cooling_setpoint",
@@ -287,7 +288,7 @@ def __init__(
         self.area = area
 
         # Only at the end append self to _CREATED_OBJECTS
-        self._CREATED_OBJECTS.append(self)
+        self.CREATED_OBJECTS.append(self)
 
     @property
     def area(self):

archetypal/template/constructions/opaque_construction.py

@@ -31,7 +31,10 @@ class OpaqueConstruction(LayeredConstruction):
         * solar_reflectance_index
     """
 
-    _CREATED_OBJECTS = []
+    _POSSIBLE_PARENTS = [
+        ("ZoneDefinition", ["InternalMassConstruction"]),
+        ("ZoneConstructionSet", ["Facade", "Slab", "Ground", "Partition", "Roof"]),
+    ]
 
     __slots__ = ("area",)
 
@@ -48,7 +51,7 @@ def __init__(self, Name, Layers, **kwargs):
         self.area = 1
 
         # Only at the end append self to _CREATED_OBJECTS
-        self._CREATED_OBJECTS.append(self)
+        self.CREATED_OBJECTS.append(self)
 
     @property
     def r_value(self):

archetypal/template/constructions/window_construction.py

@@ -63,8 +63,7 @@ class WindowConstruction(LayeredConstruction):
     .. image:: ../images/template/constructions-window.png
     """
 
-    _CREATED_OBJECTS = []
-
+    _POSSIBLE_PARENTS = [("WindowSetting", ["Construction"])]
     _CATEGORIES = ("single", "double", "triple", "quadruple")
 
     __slots__ = ("_category",)
@@ -88,7 +87,7 @@ def __init__(self, Name, Layers, Category="Double", **kwargs):
         self.Category = Category  # set here for validators
 
         # Only at the end append self to _CREATED_OBJECTS
-        self._CREATED_OBJECTS.append(self)
+        self.CREATED_OBJECTS.append(self)
 
     @property
     def Category(self):

archetypal/template/dhw.py

@@ -19,7 +19,8 @@ class DomesticHotWaterSetting(UmiBase):
 
     .. image:: ../images/template/zoneinfo-dhw.png
     """
-    _CREATED_OBJECTS = []
+
+    _POSSIBLE_PARENTS = [("ZoneDefinition", ["DomesticHotWater"])]
 
     __slots__ = (
         "_flow_rate_per_floor_area",
@@ -63,7 +64,7 @@ def __init__(
         self.area = area
 
         # Only at the end append self to _CREATED_OBJECTS
-        self._CREATED_OBJECTS.append(self)
+        self.CREATED_OBJECTS.append(self)
 
     @property
     def FlowRatePerFloorArea(self):

archetypal/template/load.py

@@ -42,7 +42,8 @@ class ZoneLoad(UmiBase):
 
     .. image:: ../images/template/zoneinfo-loads.png
     """
-    _CREATED_OBJECTS = []
+
+    _POSSIBLE_PARENTS = [("ZoneDefinition", ["Loads"])]
 
     __slots__ = (
         "_dimming_type",
@@ -133,7 +134,7 @@ def __init__(
         self.volume = volume
 
         # Only at the end append self to _CREATED_OBJECTS
-        self._CREATED_OBJECTS.append(self)
+        self.CREATED_OBJECTS.append(self)
 
     @property
     def DimmingType(self):

archetypal/template/materials/gas_material.py

@@ -14,7 +14,6 @@ class GasMaterial(MaterialBase):
 
     .. image:: ../images/template/materials-gas.png
     """
-    _CREATED_OBJECTS = []
 
     __slots__ = ("_type", "_conductivity", "_density")
 
@@ -41,7 +40,7 @@ def __init__(
         self.Density = Density
 
         # Only at the end append self to _CREATED_OBJECTS
-        self._CREATED_OBJECTS.append(self)
+        self.CREATED_OBJECTS.append(self)
 
     @property
     def Name(self):

archetypal/template/materials/glazing_material.py

@@ -17,7 +17,6 @@ class GlazingMaterial(MaterialBase):
     .. image:: ../images/template/materials-glazing.png
 
     """
-    _CREATED_OBJECTS = []
 
     __slots__ = (
         "_ir_emissivity_back",
@@ -106,7 +105,7 @@ def __init__(
         self.SolarTransmittance = SolarTransmittance
 
         # Only at the end append self to _CREATED_OBJECTS
-        self._CREATED_OBJECTS.append(self)
+        self.CREATED_OBJECTS.append(self)
 
     @property
     def Conductivity(self):

archetypal/template/materials/material_base.py

@@ -14,6 +14,27 @@ class MaterialBase(UmiBase):
     -cycle-impact
     """
 
+    _POSSIBLE_PARENTS = [
+        (
+            "WindowConstruction",
+            lambda parent: [
+                (i, layer.Material) for i, layer in enumerate(parent.Layers)
+            ],
+        ),
+        (
+            "OpaqueConstruction",
+            lambda parent: [
+                (i, layer.Material) for i, layer in enumerate(parent.Layers)
+            ],
+        ),
+        (
+            "StructureInformation",
+            lambda parent: [
+                (i, ratio.Material) for i, ratio in enumerate(parent.MassRatios)
+            ],
+        ),
+    ]
+
     __slots__ = (
         "_cost",
         "_embodied_carbon",

archetypal/template/materials/nomass_material.py

@@ -14,8 +14,6 @@
 class NoMassMaterial(MaterialBase):
     """Use this component to create a custom no mass material."""
 
-    _CREATED_OBJECTS = []
-
     _ROUGHNESS_TYPES = (
         "VeryRough",
         "Rough",
@@ -80,7 +78,7 @@ def __init__(
         self.MoistureDiffusionResistance = MoistureDiffusionResistance
 
         # Only at the end append self to _CREATED_OBJECTS
-        self._CREATED_OBJECTS.append(self)
+        self.CREATED_OBJECTS.append(self)
 
     @property
     def r_value(self):

archetypal/template/materials/opaque_material.py

@@ -16,8 +16,6 @@ class OpaqueMaterial(MaterialBase):
     .. image:: ../images/template/materials-opaque.png
     """
 
-    _CREATED_OBJECTS = []
-
     _ROUGHNESS_TYPES = (
         "VeryRough",
         "Rough",
@@ -124,7 +122,7 @@ def __init__(
         # TODO: replace when NoMass and AirGap when properly is supported
 
         # Only at the end append self to _CREATED_OBJECTS
-        self._CREATED_OBJECTS.append(self)
+        self.CREATED_OBJECTS.append(self)
 
     @property
     def Conductivity(self):

archetypal/template/schedule.py

@@ -17,7 +17,6 @@
 
 class UmiSchedule(Schedule, UmiBase):
     """Class that handles Schedules."""
-    _CREATED_OBJECTS = []
 
     __slots__ = ("_quantity",)
 
@@ -33,7 +32,7 @@ def __init__(self, Name, quantity=None, **kwargs):
         self.quantity = quantity
 
         # Only at the end append self to _CREATED_OBJECTS
-        self._CREATED_OBJECTS.append(self)
+        self.CREATED_OBJECTS.append(self)
 
     @property
     def quantity(self):
@@ -503,6 +502,10 @@ def __hash__(self):
 class DaySchedule(UmiSchedule):
     """Superclass of UmiSchedule that handles daily schedules."""
 
+    _POSSIBLE_PARENTS = [
+        ("WeekSchedule", lambda parent: [(i, day) for i, day in enumerate(parent.Days)])
+    ]
+
     __slots__ = ("_values",)
 
     def __init__(self, Name, Values, Category="Day", **kwargs):
@@ -517,6 +520,7 @@ def __init__(self, Name, Values, Category="Day", **kwargs):
         super(DaySchedule, self).__init__(
             Category=Category, Name=Name, Values=Values, **kwargs
         )
+        self.CREATED_OBJECTS.append(self)
 
     @property
     def all_values(self) -> np.ndarray:
@@ -719,6 +723,12 @@ def to_epbunch(self, idf):
 class WeekSchedule(UmiSchedule):
     """Superclass of UmiSchedule that handles weekly schedules."""
 
+    _POSSIBLE_PARENTS = [
+        (
+            "YearSchedule",
+            lambda parent: [(i, p.Schedule) for i, p in enumerate(parent.Parts)],
+        )
+    ]
     __slots__ = ("_days", "_values")
 
     def __init__(self, Name, Days=None, Category="Week", **kwargs):
@@ -730,6 +740,7 @@ def __init__(self, Name, Days=None, Category="Week", **kwargs):
         """
         super(WeekSchedule, self).__init__(Name, Category=Category, **kwargs)
         self.Days = Days
+        self.CREATED_OBJECTS.append(self)
 
     @property
     def Days(self):
@@ -912,6 +923,35 @@ def children(self):
 class YearSchedule(UmiSchedule):
     """Superclass of UmiSchedule that handles yearly schedules."""
 
+    _POSSIBLE_PARENTS = [
+        (
+            "WindowSetting",
+            [
+                "AfnWindowAvailability",
+                "ShadingSystemAvailabilitySchedule",
+                "ZoneMixingAvailabilitySchedule",
+            ],
+        ),
+        ("VentilationSetting", ["NatVentSchedule", "ScheduledVentilationSchedule"]),
+        (
+            "ZoneLoad",
+            [
+                "EquipmentAvailabilitySchedule",
+                "LightsAvailabilitySchedule",
+                "OccupancySchedule",
+            ],
+        ),
+        ("DomesticHotWaterSetting", ["WaterSchedule"]),
+        (
+            "ZoneConditioning",
+            [
+                "CoolingSchedule",
+                "HeatingSchedule",
+                "MechVentSchedule",
+            ],
+        ),
+    ]
+
     def __init__(self, Name, Type="Fraction", Parts=None, Category="Year", **kwargs):
         """Initialize a YearSchedule object with parameters.
 
@@ -930,6 +970,7 @@ def __init__(self, Name, Type="Fraction", Parts=None, Category="Year", **kwargs)
         super(YearSchedule, self).__init__(
             Name=Name, Type=Type, schType="Schedule:Year", Category=Category, **kwargs
         )
+        self.CREATED_OBJECTS.append(self)
 
     def __eq__(self, other):
         """Assert self is equivalent to other."""
@@ -1068,7 +1109,7 @@ def _get_parts(self, epbunch):
                     next(
                         (
                             x
-                            for x in self._CREATED_OBJECTS
+                            for x in self.CREATED_OBJECTS
                             if x.Name == week_day_schedule_name
                             and type(x).__name__ == "WeekSchedule"
                         )

archetypal/template/structure.py

@@ -139,7 +139,7 @@ class StructureInformation(ConstructionBase):
     .. image:: ../images/template/constructions-structure.png
     """
 
-    _CREATED_OBJECTS = []
+    _POSSIBLE_PARENTS = [("BuildingTemplate", ["Structure"])]
 
     __slots__ = ("_mass_ratios",)
 
@@ -154,7 +154,7 @@ def __init__(self, Name, MassRatios, **kwargs):
         self.MassRatios = MassRatios
 
         # Only at the end append self to _CREATED_OBJECTS
-        self._CREATED_OBJECTS.append(self)
+        self.CREATED_OBJECTS.append(self)
 
     @property
     def MassRatios(self):