Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

BC003 ALX1 - improving documentation #76

Open
wants to merge 11 commits into
base: main
Choose a base branch
from
Open

BC003 ALX1 - improving documentation #76

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
a9a765f
following #41, committing in the name of @joaoguilhermecorrea - BC003…
pjanck Jul 12, 2023
413841a
Adding test plan rationale
Jul 18, 2023
8504c49
Updating the instances diagram
Jul 18, 2023
1a60839
IDS file: indenting
Jul 20, 2023
41c6fe6
IDS file: removing out-of-scope rules wrt cardinality
Jul 20, 2023
b51beaf
Log requirements (RI-xxx) instead of their implementation (ALByyy)
Jul 20, 2023
f806720
Adding ALB004 to the 'Syntax & schema checks'
sylvainmarie Jul 24, 2023
455cb98
Typo
Jul 24, 2023
f6823d4
Updating the involved entities and adding the requirements
Aug 2, 2023
5248ec9
Merge remote-tracking branch 'upstream/main' into bc003-alx1
pjanck Aug 21, 2023
7f23605
minor manual fixes to the readme and ids
pjanck Aug 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified tests/BC003_ALX1/ALX01-diagram.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
164 changes: 14 additions & 150 deletions tests/BC003_ALX1/Dataset/BC003_ALX1.ids
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@
<ids:specifications>
<ids:specification ifcVersion="IFC4X3" name="IfcProject" minOccurs="1" maxOccurs="1"
identifier="01"
description="This test verifies the following requirement:&#xA;-There must be 1 instance of IfcProject and must be named BC003: Test plan 1&#xA;- It's GlobalID shall be &quot;3cyAkba2v5a9pVuthidcpX&quot;"
instructions="The IFCPROJECT's name and global id shall be set in the authoring tool">
description="This test verifies the following requirement:&#xA;-There must be 1 instance of IfcProject and must be named BC003: Test plan 1"
instructions="The IFCPROJECT's name shall be set in the authoring tool">
<ids:applicability>
<ids:entity>
<ids:name>
Expand All @@ -32,14 +32,6 @@
<ids:simpleValue>BC003: Test plan 1</ids:simpleValue>
</ids:value>
</ids:attribute>
<ids:attribute minOccurs="1" maxOccurs="1">
<ids:name>
<ids:simpleValue>GlobalId</ids:simpleValue>
</ids:name>
<ids:value>
<ids:simpleValue>3cyAkba2v5a9pVuthidcpX</ids:simpleValue>
</ids:value>
</ids:attribute>
</ids:requirements>
</ids:specification>
<ids:specification ifcVersion="IFC4X3" name="IfcSIUnit - Length unit" minOccurs="1"
Expand Down Expand Up @@ -132,7 +124,7 @@
</ids:attribute>
</ids:requirements>
</ids:specification>
<ids:specification ifcVersion="IFC4X3" name="IfcAlignment - naming 1" minOccurs="1"
<ids:specification ifcVersion="IFC4X3" name="IfcAlignment - naming" minOccurs="1"
maxOccurs="unbounded" identifier="05"
description="The name shall be the same as the one in the LandXML file"
instructions="Authoring tool must export the IFC file considering the naming convention defined by the user">
Expand All @@ -142,117 +134,24 @@
<ids:simpleValue>IFCALIGNMENT</ids:simpleValue>
</ids:name>
</ids:entity>
<ids:attribute>
<ids:name>
<ids:simpleValue>Name</ids:simpleValue>
</ids:name>
<ids:value>
<ids:simpleValue>SAN1_XD-B02</ids:simpleValue>
</ids:value>
</ids:attribute>
</ids:applicability>
<ids:requirements>
<ids:attribute minOccurs="1" maxOccurs="1">
<ids:name>
<ids:simpleValue>GlobalId </ids:simpleValue>
</ids:name>
<ids:value>
<ids:simpleValue>0irVCt7iH69Qln9fpXqYVb</ids:simpleValue>
</ids:value>
</ids:attribute>
</ids:requirements>
</ids:specification>
<ids:specification ifcVersion="IFC4X3" name="IfcAlignment - naming 2" minOccurs="1"
maxOccurs="unbounded" identifier="06"
description="The name shall be the same as the one in the LandXML file"
instructions="Authoring tool must export the IFC file considering the naming convention defined by the user">
<ids:applicability>
<ids:entity>
<ids:name>
<ids:simpleValue>IFCALIGNMENT</ids:simpleValue>
</ids:name>
</ids:entity>
<ids:attribute>
<ids:name>
<ids:simpleValue>Name</ids:simpleValue>
</ids:name>
<ids:value>
<ids:simpleValue>SAN1_XG-B02</ids:simpleValue>
</ids:value>
</ids:attribute>
</ids:applicability>
<ids:requirements>
<ids:attribute minOccurs="1" maxOccurs="1">
<ids:name>
<ids:simpleValue>GlobalId</ids:simpleValue>
</ids:name>
<ids:value>
<ids:simpleValue>202$CKGz56Q98WGfxCVA5m</ids:simpleValue>
</ids:value>
</ids:attribute>
</ids:requirements>
</ids:specification>
<ids:specification ifcVersion="IFC4X3" name="IfcAlignment - naming 3" minOccurs="1"
maxOccurs="unbounded" identifier="07"
description="The name shall be the same as the one in the LandXML file"
instructions="Authoring tool must export the IFC file considering the naming convention defined by the user">
<ids:applicability>
<ids:entity>
<ids:name>
<ids:simpleValue>IFCALIGNMENT</ids:simpleValue>
</ids:name>
</ids:entity>
<ids:attribute>
<ids:name>
<ids:simpleValue>Name</ids:simpleValue>
</ids:name>
<ids:value>
<ids:simpleValue>SAN1_COM</ids:simpleValue>
</ids:value>
</ids:attribute>
</ids:applicability>
<ids:requirements>
<ids:attribute minOccurs="1" maxOccurs="1">
<ids:name>
<ids:simpleValue>GlobalId</ids:simpleValue>
</ids:name>
<ids:value>
<ids:simpleValue>0V9ARKCu5F1O8wEweo6hYa</ids:simpleValue>
</ids:value>
</ids:attribute>
</ids:requirements>
</ids:specification>
<ids:specification ifcVersion="IFC4X3" name="IfcAlignment - naming 4" minOccurs="1"
maxOccurs="unbounded" identifier="08"
description="The name shall be the same as the one in the LandXML file"
instructions="Authoring tool must export the IFC file considering the naming convention defined by the user">
<ids:applicability>
<ids:entity>
<ids:name>
<ids:simpleValue>IFCALIGNMENT</ids:simpleValue>
</ids:name>
</ids:entity>
<ids:attribute>
<ids:name>
<ids:simpleValue>Name</ids:simpleValue>
</ids:name>
<ids:value>
<ids:simpleValue>SAN1_COM</ids:simpleValue>
</ids:value>
</ids:attribute>
</ids:applicability>
<ids:requirements>
<ids:attribute minOccurs="1" maxOccurs="1">
<ids:name>
<ids:simpleValue>GlobalId</ids:simpleValue>
</ids:name>
<ids:value>
<ids:simpleValue>06Ng1eKsn2MRkFhhU_YPPI</ids:simpleValue>
<xs:restriction base="xs:string">
<xs:enumeration value="SAN1_XD-B02" />
<xs:enumeration value="SAN1_COM" />
<xs:enumeration value="SAN1_XG-B02" />
<xs:enumeration value="SAN1_XG-3eme_Voie" />
</xs:restriction>
</ids:value>
</ids:attribute>
</ids:requirements>
</ids:specification>
<ids:specification ifcVersion="IFC4X3" name="IfcSign 01" minOccurs="1" maxOccurs="unbounded"
<ids:specification ifcVersion="IFC4X3" name="IfcSign Naming" minOccurs="1" maxOccurs="unbounded"
identifier="09"
description="• There must be a total of 2 objects classed as IfcSign;&#xA;"
instructions="Checking if all IfcSign were correctly imported">
Expand All @@ -269,45 +168,10 @@
<ids:simpleValue>Name</ids:simpleValue>
</ids:name>
<ids:value>
<ids:simpleValue>Traffic_Light01</ids:simpleValue>
</ids:value>
</ids:attribute>
<ids:attribute minOccurs="1" maxOccurs="1">
<ids:name>
<ids:simpleValue>GlobalId</ids:simpleValue>
</ids:name>
<ids:value>
<ids:simpleValue>2$7XSmOBLE88hi1ZsN1xBc</ids:simpleValue>
</ids:value>
</ids:attribute>
</ids:requirements>
</ids:specification>
<ids:specification ifcVersion="IFC4X3" name="IfcSign 02" minOccurs="1" maxOccurs="unbounded"
identifier="10"
description="• There must be a total of 2 objects classed as IfcSign;&#xA;"
instructions="Checking if all IfcSign were correctly imported">
<ids:applicability>
<ids:entity>
<ids:name>
<ids:simpleValue>IFCSIGN</ids:simpleValue>
</ids:name>
</ids:entity>
</ids:applicability>
<ids:requirements>
<ids:attribute minOccurs="1" maxOccurs="1">
<ids:name>
<ids:simpleValue>Name</ids:simpleValue>
</ids:name>
<ids:value>
<ids:simpleValue>Traffic_Light02</ids:simpleValue>
</ids:value>
</ids:attribute>
<ids:attribute minOccurs="1" maxOccurs="1">
<ids:name>
<ids:simpleValue>GlobalId</ids:simpleValue>
</ids:name>
<ids:value>
<ids:simpleValue>1M7eCDuXL21QPVVhnAbym8</ids:simpleValue>
<xs:restriction base="xs:string">
<xs:enumeration value="Traffic_Light01" />
<xs:enumeration value="Traffic_Light02" />
</xs:restriction>
</ids:value>
</ids:attribute>
</ids:requirements>
Expand Down
52 changes: 31 additions & 21 deletions tests/BC003_ALX1/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,53 +56,52 @@ In addition, the outcome of the previous tests shall be used as input of this te
When validated using the bSI Validation Service, the IFC must pass:

- Syntax & Schema check
- [ALB004](https://github.com/buildingSMART/ifc-gherkin-rules/pull/67) Each `IfcAlignment` must be aggregated directly under `IfcProject`.


#### Test case-specific checks

[IDS file BC003_ALX1.ids](./Dataset/BC003_ALX1.ids):

- There `IfcProject` must be named `BC003: Test plan 1` and its GUID must be `“3cyAkba2v5a9pVuthidcpX”`;
- Alignments must have the same Name, GUID and Length as those one found in the `BC003_AL01_Reference` file, which means:
- The `IfcProject` must be named `BC003: Test plan 1`;
- `IfcAlignment`s must have these Names and Lengths:

| Name | GUID | Length (m) |
|-------------------|------------------------|--------------|
| SAN1_XD-B02 | 0irVCt7iH69Qln9fpXqYVb | 1709.845 |
| SAN1_XG-B02 | 202$CKGz56Q98WGfxCVA5m | 1693.042 |
| SAN1_COM | 0V9ARKCu5F1O8wEweo6hYa | 40.179 |
| SAN1_XG-3eme_Voie | 06Ng1eKsn2MRkFhhU_YPPI | 104.421 |
| Name | Length (m) |
|-------------------|--------------|
| SAN1_XD-B02 | 1709.845 |
| SAN1_XG-B02 | 1693.042 |
| SAN1_COM | 40.179 |
| SAN1_XG-3eme_Voie | 104.421 |

- The table below presents the `IfcSignal` Names and GUID:
- There must be 2 `IfcSignal`s in the file with these Names:

| Name | GUID |
|-------------------|------------------------|
| Traffic_Light01 | 2$7XSmOBLE88hi1ZsN1xBc |
| Traffic_Light02 | 1M7eCDuXL21QPVVhnAbym8 |
| Name |
|-------------------|
| Traffic_Light01 |
| Traffic_Light02 |


#### Not covered by the IDS file (must be checked otherwise):

1. There must be 2 instances of `IfcSignal`.
1. There must be 2 instances of `IfcSign`.
1. Traffic lights are placed in the model using coordinates (XYZ). Once placed, **railway alignment station** is used to **locate** them for works and maintenance purposes. So, the authoring software shall **correlate their XYZ placement and a station in the railway alignment**. The table below represents for each traffic light, its referenced alignment, the referenced station and its placement coordinates of the base center point:

| Name | Ref. Alignment | Station | Coord. XYZ (top center point) |
|-------------------|-------------------|------------|----------------------------------------|
| Traffic_Light01 | SAN1_XD-B02 | 0+052.0866 | 1891995.6561, 3126679.5487, 4.1500 |
| Traffic_Light02 | SAN1_XG-3eme_Voie | 0+052.0002 | 1891982.5663, 3126673.6030, 4.1400 |
3. (RI-90) Each `IfcAlignment` must be aggregated directly under `IfcProject`;
1. (RI-300) Signal geometries are mapped (`IfcMappedItem`) to the `IfcSignalType` geometry;

1. (RI-300) Signal geometries are mapped (`IfcMappedItem`) to the `IfcSignType` geometry;
1. (RI-301) Signals are represented as 3D solids with a cylindrical shape (extruded along the Z axis, using `IfcSweptDiskSolid`);
1. (RI-302) Signals are defined by their `IfcSignalType`, which are declared in the `IfcProject`.
1. (RI-302) Signals are defined by their `IfcSignType`, which are declared in the `IfcProject`.

### Informal criteria

- Railway alignments presented in BC003_ALX1_Reference [BC003_ALX1_Reference](./Dataset/BC003_ALX1_Reference.ids) file shall be coincident with the ones presented in [BC003_AL01_Reference](https://github.com/bSI-RailwayRoom/IFC4.x-IF/blob/3ac4acd3e4e8aeca250a98d59297a125319743a4/tests/BC003_AL01/Dataset/BC003_AL01_Reference.ifc) file ;
- Railway alignments presented in [BC003_ALX1_Reference](./Dataset/BC003_ALX1_Reference.ifc) file shall be coincident with the ones presented in [BC003_AL01_Reference](../BC003_AL01/Dataset/BC003_AL01_Reference.ifc) file ;

### Open questions

- Shall every `IfcElement` instance be accessible through the software Spatial Decomposition Tree?
- `IfcSignal` instances are contained in the SpatialStructure, hence located according to its `IfcLocalPlacement`. This could contradict their own position through the `IfcLinearPlacement`?
- `IfcSign` instances are contained in the SpatialStructure, hence located according to its `IfcLocalPlacement`. This could contradict their own position through the `IfcLinearPlacement`?

### Expected geometry

Expand All @@ -123,6 +122,17 @@ After importing the reference file ([BC003_ALX1_Reference](./Dataset/BC003_ALX1_

## Link to requirements

:zap:
|ID (local) | Name | Description | Requirements for Appointed Party |
|-|-|-|-|
| RI 84 | Assemblies | | RA-75 | IfcElement that are aggregated in another IfcElement shall not be contained using IfcRelContainedInSpatialStructure. | NUL |
|RI 85 | Component placement | Parts of IfcElementAssembly (or other assembled IfcElement) shall be placed relative to the parent's placement. | NIM |
| RI 86 | Unique containment | "Each IfcElement shall be either: - contained in one and only one IfcSpatialStructureElement, or - contained in one and only one IfcLinearPositioningElement." | RA-75 |
|RI 300 | Signals reused geometries | Signal parts geometries shall be mapped (IfcMappedItem) to their matching type geometry | Every signal sharing the same type shall reuse shared geometry defined for the signal type|
|RI 301 | Signals as assemblies| Signals shall be modeled as an IfcElementAssembly with aggregated post, foundation, mast and signal port| Signal posts shall use parametric/lighweight geometry and avoid heavy tessalated or BRep geometry |
|RI 302 | Signals reused types| Signal parts shall be using IfcElementAssemblyType entities| Signals shall be defined by their type with their characteristics |
|RI 304 | Stationing address | IfcReferents (typed POSITION or STATION) linked to IfcAlignments need a IfcRelPositions relationship | A Linear address shall be known from the alignment it relates to |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is preventing the business requirement to be answered via the nesting relationship between an alignment and its referents?
Also, the current IFC documentation does not specify how and when to use IfcRelPositions between an alignment and referents.

Please clarify the requirement or put forward a proposal to modify the current IFC documentation.

|RI 306 | Trackside Signals geometries | Signal masts shall be modeled as IfcColumn with an extruded geometry along the Z axis of the profile (IfcExtrudedAreaSolid), using IfcSweptDiskSolid | A Signal shall be modeled with a column / 3D solids with some extruded shape |
| RI 314 | Project structure | The only "container" aggregated to the project shall be either IfcSite, IfcFacility, IfcAlignment. Other non-IfcProducts shall be connected to the project with IfcRelDeclares | NIL |
| RI 316 | ElementAssemblies stationing | IfcElementAssembly.SIGNAL shall be linked to IFcReferent.STATION by a IfcRelPositions relationship | A signal assembly should have its stationing defined |