The following tool map schema objects are used to define the mapping between the authoring tool and the SmartPlant schema:
-
Map class definitions (instances of SPMapClassDef)
-
Map property definitions (instances of SPMapPropertyDef)
-
Map relationship definitions (instances of SPMapRelDef)
-
Map enumerated list definitions (instances of SPMapEnumListDef)
-
Map enumerations (instances of SPMapEnumDef)
-
Map unit of measure list definitions (instances of SPMapUoMListDef)
-
Map units of measure definitions (instances of SPMapUoMDef)
-
Map software definition (maximum of one instance of SPMapSoftware)
-
Relationships between map objects and other map objects (map schema) and between map objects and SmartPlant objects (mapping)
Map Class Definitions
Map class definitions are used to represent both application classes and application interfaces. Therefore, all of the classes and interfaces from the simple class model, the class inheritance model, and the class/interface model are modeled using map class definitions (instances of SPMapClassDef). The following UML diagram represents the modeling of a class inheritance model using a tool map schema:
The following UML diagram represents the modeling of a class/interface model using a tool map schema:
Notice that inheritance in the class inheritance model uses MapClassMapClass relationships, but the relationships between the class and interface in the class/interface model are instances of the MapClassRealizesMapClass relationship definition.
Map Property Definitions
In representing a simple class model or a class inheritance model, all of the classes in the model can have (expose) properties. In a class/interface model, only the interfaces can have properties.
Application properties, when modeled using a tool (map) schema, are instances of map property definitions (SPMapPropertyDef). These map property definitions are tied to their map class definitions using instances of the MapClassMapProperties relationship definition. Therefore, if map class B has properties PA, PB, and PC, they would be modeled in the tool schema as shown in the following diagram:
Map Relationship Definitions
All but the simplest of applications have relationship definitions between their classes or interfaces that identify the types of relationships that can exist in the application's data. These relationship definitions are modeled using map relationship definitions (instances of SPMapRelDef).
Therefore, if instances of class B can be related to instances of class F, the relationship definition BRelatesToF would be modeled as:
OR
A map relationship definition (SPMapRelDef) has two different relationship definitions (FromClassForMapRelDef and ToClassForMapRelDef) to the map class definitions at its "from" and "to" ends.
Map Enumerated List and Map Enumeration Definitions
The following interface model shows how map enumerated lists and map unit of measure lists are modeled within the map schema.
A map unit of measure list is a specialization of a map enumerated list as indicated by the Implies relationship between IMapUoMListDef and IMapEnumListDef. Therefore, the same relationship types are used for both map enumerated lists and map unit of measure lists.
A map property that is scoped by a map enumerated list (or a map unit of measure list) should have a MapPropertyMapEnumList from the map property to the map enumerated list (or map unit of measure list).
Application enumerated lists are described using map enumerated lists (instances of SPMapEnumListDef) and map enumerations (instances of SPMapEnumDef). Using these objects, an application enumerated list for TrafficLightColors would be modeled as:
If an enumerated list contains more than one level, then it is modeled using a map enumerated list definition for each level. The map enumerated list definitions are related as are the individual map enumerations. For example, the enumerated list for ConstructionStatuses would look like the following:
Map Unit of Measure List and Map Unit of Measure Definitions
Application units of measure are modeled very similarly to enumerated lists with the exception that the list for the unit of measure is modeled as a unit of measure list (instance of SPMapUoMListDef) and the individual units of measure are modeled as instances of SPMapUoMDef. With this approach, a temperature unit of measure list would be modeled as:
The same relationship types (MapEnumListMapEnum) are used for unit of measure lists and enumerated lists.