Difference between revisions of "MicroMVDs for exchange requirements/Project setup MicroMVD"

From Wiki.OSArch
Line 15: Line 15:
 
  * The IFC file "{file}" is exempt from being provided
 
  * The IFC file "{file}" is exempt from being provided
 
  * No further requirements are specified because {reason}
 
  * No further requirements are specified because {reason}
 +
 +
Scenario: Project metadata is organised and correct
 +
* The project name, code, or short identifier must be "{value}"
 +
* The project must have a longer form name of "{value}"
 +
* The project must be described as "{value}"
 +
* The project must be categorised under "{value}"
 +
* The project must contain information about the "{value}" phase
 +
 +
Scenario: Project geometry is stored
 +
* The project must contain 3D geometry representing the shape of objects
 +
* The project must contain 3D geometry representing clearance zones
 +
* The project must contain 3D geometry representing the center of gravity of objects
 +
* The project must contain 3D geometry representing the object bounding boxes
 
</pre>
 
</pre>
 +
 +
You can fill out the variables using the guide below.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 33: Line 48:
 
| we don't need it
 
| we don't need it
 
| You can write anything here to describe any reason.
 
| You can write anything here to describe any reason.
−
|}
 
−
 
−
{| class="wikitable"
 
−
! Test definition
 
−
! Justification
 
−
|-
 
−
| <code>Given the IFC file "{file}"</code>
 
−
| An IFC-SPF file is the expected format for a project.
 
−
|-
 
−
| <code>Then the file should be an {schema} file</code>
 
−
| Project data must conform to a client-nominated schema. The <code>{schema}</code> may be IFC2X3 or IFC4 in general.
 
−
|-
 
−
| <code>Then the project has a Name attribute with a value of "{value}"</code>
 
−
| A project must have a name given to it.
 
−
|-
 
−
| <code>Then the project has a LongName attribute with a value of "{value}"</code>
 
−
| A project generally also has a longer name associated with it.
 
−
|-
 
−
| <code>Then the project should have geolocation data</code>
 
−
| This checks for geolocation according to the buildingSMART recommendation in IFC2X3 and the native elements in IFC4.
 
−
|-
 
−
| <code>Given there is at least one IfcSite element</code>
 
−
| Most projects have a site.
 
−
|-
 
−
| <code>Then there is an IfcSite element with a Name attribute with a value of "{value}"</code>
 
−
| If a site exists, it typically has a name.
 
−
|-
 
−
| <code>Given there is at least one IfcBuilding element</code>
 
−
| Most projects have a building.
 
 
|-
 
|-
−
| <code>Then there is an IfcBuilding element with a Name attribute with a value of "{value}"</code>
+
| <code>{value}</code>
−
| If a building exists, it typically has a name.
+
| Foobar
 +
| Any text value you expect for a particular attribute or property.
 
|}
 
|}

Revision as of 22:06, 5 April 2020

The following MicroMVD vocabulary can be used to ensure basic project metadata is set, as a minimum requirement for all BIM projects. 

Feature: Project setup

In order to ensure quality of the digital built environment
As a responsible digital citizen
We expect compliant OpenBIM deliverables

Scenario: Receiving a file
 * The IFC file "{file}" must be provided
 * IFC data must use the {schema} schema

Scenario: Exempt files
 * The IFC file "{file}" is exempt from being provided
 * No further requirements are specified because {reason}

Scenario: Project metadata is organised and correct
 * The project name, code, or short identifier must be "{value}"
 * The project must have a longer form name of "{value}"
 * The project must be described as "{value}"
 * The project must be categorised under "{value}"
 * The project must contain information about the "{value}" phase

Scenario: Project geometry is stored
 * The project must contain 3D geometry representing the shape of objects
 * The project must contain 3D geometry representing clearance zones
 * The project must contain 3D geometry representing the center of gravity of objects
 * The project must contain 3D geometry representing the object bounding boxes

You can fill out the variables using the guide below.

Variable Example Description
{file} project.ifc The filename or path to any IFC file.
{schema} IFC4 The schema version. At the moment, these are likely to be either IFC4 or IFC2X3.
{reason} we don't need it You can write anything here to describe any reason.
{value} Foobar Any text value you expect for a particular attribute or property.
Retrieved from "https://wiki.osarch.org/index.php?title=MicroMVDs_for_exchange_requirements/Project_setup_MicroMVD&oldid=103"