DexpiModel¶

Overview¶

Class

An entire DEXPI model. A DexpiModel is the root of the composition hierarchy.

Attributes (data)

Name	Multiplicity	Type
ExportDateTime	1	NullableDateTime
OriginatingSystemName	1	NullableString
OriginatingSystemVendorName	1	NullableString
OriginatingSystemVersion	1	NullableString

Attributes (composition)

Name	Multiplicity	Type
ConceptualModel	0..1	ConceptualModel
Diagram	0..1	Diagram
ShapeCatalogues	*	ShapeCatalogue

Implementation in Proteus Schema

The class is implemented using the Proteus root element <PlantModel>, i.e., a DexpiModel corresponds to an entire Proteus XML document.

Note that Proteus Schema requires that the <PlantModel> element contains a <PlantInformation> element. The latter has several required attributes:

Application: fixed value Dexpi (optional in Proteus Schema, but required by DEXPI);
ApplicationVersion: fixed value 1.3 (optional in Proteus Schema, but required by DEXPI);
Date: see ExportDateTime;
Discipline: fixed value PID;
Is3D: fixed value no;
OriginatingSystem: see OriginatingSystemName;
SchemaVersion: fixed value 4.1;
Time: see ExportDateTime;

The <PlantInformation> element must contain a <UnitsOfMeasure> element. However, none of the attributes of <UnitsOfMeasure> is relevant for DEXPI.

Example

Implementation in Proteus Schema

The XML fragment below only shows the fixed XML attributes of the <PlantInformation> element. For the other required XML attributes Date, OriginatingSystem, Time, and Units, see the Proteus Schema implementations of the DEXPI attributes given above.

<PlantModel>
  <PlantInformation
      Discipline="PID"
      Is3D="no"
      SchemaVersion="4.1"
      ...>
    <UnitsOfMeasure/>
  </PlantInformation>
</PlantModel>

ConceptualModel¶

Attribute (composition)

The conceptual model of the DexpiModel.

Multiplicity: 0..1

Type: ConceptualModel

Opposite multiplicity: 0..1

Implementation in Proteus Schema

See Proteus Schema Implementation of ConceptualModel.

Example

Diagram¶

Attribute (composition)

The diagram of the DexpiModel.

Multiplicity: 0..1

Type: Diagram

Opposite multiplicity: 0..1

Implementation in Proteus Schema

The <Drawing> element that represents the Diagram is a child of the <PlantModel> element that represents the DexpiModel.

Example

Implementation in Proteus Schema

<PlantModel>
  <!-- dexpiModel1 -->
  ...
  <Drawing ...>
    <!-- diagram1 -->
    ...
  </Drawing>
  ...
<PlantModel>

ExportDateTime¶

Attribute (data)

The date time at which the DexpiModel was exported by the originating system (see OriginatingSystemName).

Multiplicity: 1

Type: NullableDateTime

Implementation in Proteus Schema

The attribute is implemented using the XML attributes Date and Time of the <PlantInformation> element in the <PlantModel> element that corresponds to the DexpiModel (see Proteus Schema implementation of DexpiModel):

The date part of the ExportDateTime is implemented as the XML attribute Date according to the rules for the lexical representation of the XML Schema datatype date as specified by the W3C Recommendation XML Schema Part 2: Datatypes Second Edition from October 28, 2004.
The time part of the ExportDateTime is implemented as the XML attribute Time according to the rules for the lexical representation of the XML Schema datatype time as specified by the W3C Recommendation XML Schema Part 2: Datatypes Second Edition from October 28, 2004.

Note that these two attribute are required by Proteus Schema, i.e., it is not possible to transfer the null value NULL_DATE_TIME. Also note that the DEXPI type DateTime does not allow timezone information. In consequence, the values of the XML attributes Date and Time must not contain timezone information.

Example

December 7, 2020, 15:32:42 (DateTime "2020-12-07T15:32:42")

Implementation in Proteus Schema

The XML fragment below only contains the Date and Time attributes of the <PlantInformation> element. This element has further required attributes (see Proteus Schema implementation of DexpiModel).

<PlantModel>
  <PlantInformation
      Date="2020-12-07"
      Time="15:32:42"
      ...>
    ...
  </PlantInformation>
</PlantModel>

OriginatingSystemName¶

Attribute (data)

The name of the system from which the DexpiModel originates, e.g., the name of a P&ID tool.

Multiplicity: 1

Type: NullableString

Implementation in Proteus Schema

The attribute is implemented as the XML attribute OriginatingSystem of the <PlantInformation> element in the <PlantModel> element that corresponds to the DexpiModel (see Proteus Schema implementation of DexpiModel). Note that this attribute is required by Proteus Schema, i.e., it is not possible to transfer the null value NULL_STRING.

Example

“PID Kit Professional” (String)

Implementation in Proteus Schema

The XML fragment below only contains the OriginatingSystem attribute of the <PlantInformation> element. This element has further required attributes (see Proteus Schema implementation of DexpiModel).

<PlantModel>
  <PlantInformation
      OriginatingSystem="PID Kit Professional"
      ...>
    ...
  </PlantInformation>
</PlantModel>

OriginatingSystemVendorName¶

Attribute (data)

The name of the vendor of the system from which the DexpiModel originates, e.g., the name of a software company.

Multiplicity: 1

Type: NullableString

Implementation in Proteus Schema

The attribute is implemented as the XML attribute OriginatingSystemVendor of the <PlantInformation> element in the <PlantModel> element that corresponds to the DexpiModel (see Proteus Schema implementation of DexpiModel).

Example

“Smart and Clever Systems, Inc.” (String)

Implementation in Proteus Schema

The XML fragment below only contains the OriginatingSystemVendor attribute of the <PlantInformation> element. This element has further required attributes (see Proteus Schema implementation of DexpiModel).

<PlantModel>
  <PlantInformation
      OriginatingSystemVendor="Smart and Clever Systems, Inc."
      ...>
    ...
  </PlantInformation>
</PlantModel>

OriginatingSystemVersion¶

Attribute (data)

The version of the the system from which the DexpiModel originates, e.g., the version number of a tool.

Multiplicity: 1

Type: NullableString

Implementation in Proteus Schema

The attribute is implemented as the XML attribute OriginatingSystemVersion of the <PlantInformation> element in the <PlantModel> element that corresponds to the DexpiModel (see Proteus Schema implementation of DexpiModel).

Example

“1.1” (String)

Implementation in Proteus Schema

The XML fragment below only contains the OriginatingSystemVersion attribute of the <PlantInformation> element. This element has further required attributes (see Proteus Schema implementation of DexpiModel).

<PlantModel>
  <PlantInformation
      OriginatingSystemVersion="1.1"
      ...>
    ...
  </PlantInformation>
</PlantModel>

ShapeCatalogues¶

Attribute (composition)

The shape catalogues of the DexpiModel.

Multiplicity: *

Type: ShapeCatalogue

Opposite multiplicity: 0..1

Implementation in Proteus Schema

The <ShapeCatalogue> element that represents the ShapeCatalogue is a child of the <PlantModel> element that represents the DexpiModel.

Example

Implementation in Proteus Schema

<PlantModel>
  <!-- dexpiModel1 -->
  ...
  <ShapeCatalogue ...>
    <!-- shapeCatalogue1 -->
    ...
   </ShapeCatalogue>
  ...
<PlantModel>