buildingSMART / buildingSMART/ifc-validation-data-model

Requests from TK

Open
#2 2 comments 0 reactions 1 assignee Claimed by @rw-bsi View on GitHub
Dominant language
Python
Stars
9
Forks
1
Avg merge
2d 11h
Merged PRs (30d)
2

Description

The following request/questions came from a quick interaction with the datamodel.

### 1. `IfcValidationOutcome.instance` points to model instead of instance

https://github.com/buildingSMART/ifc-validation-data-model/blob/d09fb3a4eefd8c96b88fd9655b05698aa88f6359/models.py#L705-L706

### 2. `IfcValidationOutcome.instance` should be optional. In not all cases we will have an instance to refer to

### 3. `IfcValidationOutcome.feature` and `code` are redundant. Delete code.

https://github.com/buildingSMART/ifc-validation-data-model/blob/d09fb3a4eefd8c96b88fd9655b05698aa88f6359/models.py#L725-L730

https://github.com/buildingSMART/ifc-validation-data-model/blob/d09fb3a4eefd8c96b88fd9655b05698aa88f6359/models.py#L739-L745

### 4. `IfcValidationOutcome.feature` and `feature_version` Should be optional as not everything is Gherkin-related.

### 5. My preference would be to remove the `Ifc-` prefix from all classes

### 6. `IfcModel` has no attribute `type`, suggest `file_name`. I didn't review all __repr__ functions, just came across this in my repl session.

https://github.com/buildingSMART/ifc-validation-data-model/blob/d09fb3a4eefd8c96b88fd9655b05698aa88f6359/models.py#L381

### 7. `IfcModel.Status`: Needed? Or retrieve as related IfcValidationTask.Status? We have it currently in the datamodel, but in my mind it is a bit redundant.

https://github.com/buildingSMART/ifc-validation-data-model/blob/d09fb3a4eefd8c96b88fd9655b05698aa88f6359/models.py#L185-L191

https://github.com/buildingSMART/ifc-validation-data-model/blob/d09fb3a4eefd8c96b88fd9655b05698aa88f6359/models.py#L280-L288

etc.

vs.

https://github.com/buildingSMART/ifc-validation-data-model/blob/d09fb3a4eefd8c96b88fd9655b05698aa88f6359/models.py#L554-L563

### 8. IfcValidationTask vs IfcValidationRequest. Why both?

https://github.com/buildingSMART/ifc-validation-data-model/blob/d09fb3a4eefd8c96b88fd9655b05698aa88f6359/models.py#L434

https://github.com/buildingSMART/ifc-validation-data-model/blob/d09fb3a4eefd8c96b88fd9655b05698aa88f6359/models.py#L535

### 9. IfcValidationTask/IfcValidationRequest. No foreign key to IfcModel

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.