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

From Wiki.OSArch
Line 17: Line 17:
  
 
Scenario: Project metadata is organised and correct
 
Scenario: Project metadata is organised and correct
−
  * The project name, code, or short identifier must be "{value}"
+
  * The project name, code, or short identifier must be "{name}"
−
  * The project must have a longer form name of "{value}"
+
  * The project must have a longer form name of "{long_name}"
−
  * The project must be described as "{value}"
+
  * The project must be described as "{description}"
−
  * The project must be categorised under "{value}"
+
  * The project must be categorised under "{object_type}"
−
  * The project must contain information about the "{value}" phase
+
  * The project must contain information about the "{phase}" phase
  
 
Scenario: Project geometry is stored
 
Scenario: Project geometry is stored
Line 49: Line 49:
 
| You can write anything here to describe any reason.
 
| You can write anything here to describe any reason.
 
|-
 
|-
−
| <code>{value}</code>
+
| <code>{name}</code>
−
| Foobar
+
| 123FOO
−
| Any text value you expect for a particular attribute or property.
+
| A short project code or name used to uniquely identify the project, either specified by the client or the BIM author
 +
|-
 +
| <code>{long_name}</code>
 +
| 123 Foo Street, Tower B Redevelopment
 +
| The full project name used to uniquely identify the project, either specified by the client or the BIM author
 +
|-
 +
| <code>{description}</code>
 +
| Redesign of southwest atrium of Tower B to a two-storey space with new interior fitout
 +
| A description of what the project is about, to help clarify the project scope
 +
|-
 +
| <code>{object_type}</code>
 +
| Commercial
 +
| If the project is categorised as a particular arbitrary type, it may be described here. Example categories could be "Residential", "Retail", "Commercial", "Health" and "Defence". Alternatively, it could be categorised as "Civic", "Infrastructure".
 +
|-
 +
| <code>{phase}</code>
 +
| A
 +
| If the project is phased or staged, the phase or stage name may be placed here.
 
|}
 
|}

Revision as of 00:11, 10 August 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 "{name}"
 * The project must have a longer form name of "{long_name}"
 * The project must be described as "{description}"
 * The project must be categorised under "{object_type}"
 * The project must contain information about the "{phase}" 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.
{name} 123FOO A short project code or name used to uniquely identify the project, either specified by the client or the BIM author
{long_name} 123 Foo Street, Tower B Redevelopment The full project name used to uniquely identify the project, either specified by the client or the BIM author
{description} Redesign of southwest atrium of Tower B to a two-storey space with new interior fitout A description of what the project is about, to help clarify the project scope
{object_type} Commercial If the project is categorised as a particular arbitrary type, it may be described here. Example categories could be "Residential", "Retail", "Commercial", "Health" and "Defence". Alternatively, it could be categorised as "Civic", "Infrastructure".
{phase} A If the project is phased or staged, the phase or stage name may be placed here.
Retrieved from "https://wiki.osarch.org/index.php?title=MicroMVDs_for_exchange_requirements/Project_setup_MicroMVD&oldid=679"