track enrichment data sources

[veronikarichter]

Currently, racking the enrichment process within bim2sim requires manual checking of the resulting parameters. For practical applications we need information on the data that was obtained from the input IFC file and which parameters have been enriched from templates.

This information should be tracked for each instance and each parameter individually, as it is common that only partial information can be obtained from IFC. Maybe export the enrichment information as a dict with the exported models?

[veronikarichter]

@DaJansenGit currently, heating and cooling profiles are extrapolated from heating and cooling setpoints available in IFC. I did not find a proper way (or setting) to change this setting to template-based and it took me a while to figure out that it is not the template data that is used for heating_profile and cooling_profile.

[Cudok]

General idea to add information about the source of the parameters:

• Add a new feature named source for all parameters
• the source feature will collected while the data of the parameter is readed
  • practical: in the if loop not only the data for the parameter will written also their source
• general content of the source attribute depending on the source
  • attribute task
  • ifc > GlobalID
  • default value > default (+ hint regarding the general approach of the source of the default value)
  • enrichment task
  • enrichment > function name, which was used to calculate/generate the enrichment value
  • general questions:
  • where or how should the source feature available ?

ToDos:

1. [ ] implement the source feature to the attribute task
2. [ ] implement the source feature to the enrichment task
3. [ ] discuss solution
4. [ ] add/adapt a test

[Cudok]

• [ ] add print command into the function, where the enrichment happens
  • [ ] print the value of the later source feature, values like 'from TEASER/....'
• [ ] find the or all enrichment functions
• [ ] add the values to the playgroud.state
• [ ] questions:
  • [ ] is the enrichment part of the tasks?
  • bim2sim/tasks/bps/enrich_use_use_cond.py
  • bim2sim/tasks/bps/enrich_material.py
  • bim2sim/project.py
    • is @property function
    • [ ] find out, what this decorator is adding

[DaJansenGit]

Results of discussion with @Cudok on 03.01.2024

Ziel Struktur

• alle cached properties überführen in attributes mit nur function
• 2 Stufiger check
  • conditions nutzen um validität der Attribute bei Erstellung zu überprüfen -> attribut get_value() function am Ende -> Status auf invalid setzen
  • check functionen von request params um Nutzereingaben und Enrichment Werte zu überprüfen -> check()
• enrichment task überarbeiten
  1. "Checking teil" des Tasks EnrichUseConditions und den Inhalt von ValidateLayerMaterials komplett in conditions überführen
  2. "Enrichment Teil" des Tasks EnrichUseConditions und den Inhalt von EnrichLayersMaterials komplett in enrichment in attribute.py überführen
     3. • Attribute ergänzen um:
        • enrichment='teaser' oder enrichment='None'
        • mandatory
        • eine neue Methode enrichment() in attribute.py schreiben
        • attributmanager statt tuple aus value, status -> ifc_value, enriched_value, status erweitern
        • Evtl. statt status eines attributes status jedes values
        • in create_elements task decisions triggern für attribute, die mandatory sind um bspw. Baujahr sicher zu machen
        • evtl. mandatoryabfrage noch in CheckIFC und dann neuen Task der mandatory werte über decisions einholt (wenn <x werte, sonst abbruch)

Flowchart attribute system (aktueller Stand)

flowchart TB
gv["get_value()"]
ps{default_ps}
as{default_association}
fi{finder}
pt{patterns}
ft{functions}
de{default}
re[return value]

gv --> ps -->|Value not existing| as -->|Value not existing| fi -->|Value not existing| pt -->|Value not existing| ft -->|Value not existing| de 

ps -->|Value exists| re
as -->|Value exists| re
fi -->|Value exists| re
pt -->|Value exists| re
ft -->|Value exists| re
de --> re

request system (WIP)

flowchart TB
    re{"request()"}

    req_params["request_param()"] --> req[requested attributes]
    be -->|"get_pending_attribute_decisions(elements)"| decisions

    be[base_elements] --> re -->|available| no[None]
re --> |"Not avialable"| dec[Decision]

    ee["export_elements"] -->|"collect_params()"| pa["set value to export element parameter"]

[Cudok]

actual situation of using cached_properties

• base_elements.py: 4 times
  • class Elements: goes for position and orientation (2x cached_property)
• hvac_elements.py: 17 times
• bps_elements.py: 38 times
• hvac_aggregations.py: 9 times

[Cudok]

removed all cached_properties "orientation", because not needed anymore

[Cudok]

some structure figure were moved to issue " understanding the structure of bim2sim #640"

[Cudok]

Remove cached property

• see #639

[DaJansenGit]

a first implementation of the data_source information for attributes is done. We still need to figure out a clear guideline what information should be stored in which way:

• attribute system
• cached_property (or delete complelty?)
• property
• instance variable
• class variable