Document linking

The COINS Building Information Model (CBIM) is of course object based. However, until the ultimate goal that all available information is object based we have to deal with document oriented information. CBIM has a Document class to link to external documents which enables any CBIM object to attach a document even Document objects itself.

UML Class diagram of the Document class and its subclasses.
UML Class diagram of the Document class and its subclasses.

The Document class may specify a file path or a file URI or both to address the indicated document. There is no prescribed precedence rule if both addressing methods are used.
If a document file URI is specified the user has to decide when the model is exported into a COINS Container if the document should be physically stored or only virtually as a hyperlink.
The Document class has several specializations:

Explicit 3D Representation

UML Class diagram of the Explicit 3D Representation class and its subclasses.
UML Class diagram of the Explicit 3D Representation class and its subclasses.

Explicit 3D representation objects are typically addressed by a subset of the CBIM classes:

To distinguish these specific shape related documents they are specified using the shape relation.

If the shape document contains object based information where objects have unique addressable ID's an Explicit 3D Representation object may use the documentUri attribute to deep link to an object inside the shape document using a fragment delimiter.

UML Instance diagram of an Explicit 3D Representation object deep linking a shape object within a shape document. If the shape document has a web address the deep link can be expressed using the document URI attribute only.
UML Instance diagram of an Explicit 3D Representation object deep linking a shape object within a shape document. If the shape document has a web address the deep link can be expressed using the document URI attribute only.

If a function fulfiller specifies states shape links can be discriminated to a certain state (e.g. early design, detail design, as-built, etc.). More generally a shape relation may address more than one Explicit 3D Representation. The recommended semantics is that in that case various representations of the same shape are intended. However, in case of deep linking in the same shape document the various shape objects are supposed to form one representation.

If the shape document/object publishes parameters that can be valued from outside an Explicit 3D Representation may specify parameter objects to specify specific values for specific parameters.

UML Class diagram of the Parameter class and its subclasses.
UML Class diagram of the Parameter class and its subclasses.
UML Instance diagram of an Explicit 3D representation object that specifies parameter values for a linked parametrized shape object. By convention the parameter object name is identical to the parameter name of the shape object.
UML Instance diagram of an Explicit 3D representation object that specifies parameter values for a linked parametrized shape object. By convention the parameter object name is identical to the parameter name of the shape object.

Visi Message

UML Class diagram of the VISI Message class and its subclasses.
UML Class diagram of the VISI Message class and its subclasses.

A Visi Message object is a document link that attaches a meta-data document to the object that specifies the link. In spite of the class name the referenced document could be any document and not necessarily a VISI message. The link is typically created during a merge operation of a COINS Container into a COINS Building Information System. New, updated or expired COINS objects will reference a meta-date object that clarifies the origin of their current state. In case of a VISI message the meta-data could contain:

  • the transaction involved
  • the executioner
  • the persons in role
  • message specific data

Library Reference

UML Class diagram of the Library Reference class and its subclasses.
UML Class diagram of the Library Reference class and its subclasses.

A Library Reference object is a document link that addresses a definition in an external object library. Typical examples are:

However, a library reference could also link to company or project object library.

Afkomstig van CoinsWiki NL, de Vrije Encyclopedie. "http://www.coinsweb.nl/wiki/index.php/Document_linking"
Personal tools