MBSE Integration Services for Integrating Modeling Tools
getMappedObjectMapForToolType()
This API returns the object mapping, along with all attributes inherited from its parent mappings.
The API first retrieves the object mapping for the specified toolType. Once the object mapping is found, the function iterates through its parent mappings, collecting attributes from each parent. After traversing all parent mappings and aggregating their attributes, the function returns the complete object mapping with the combined attributes.
public ObjectMappingType getMappedObjectMapForToolType(String toolType, String applicationName) throws ServiceException, BHMException, NotLoadedException, BHMCommonException, Exception
Input Parameters
- toolType — The tool type for which the object mapping is to be fetched.
- applicationName — The application name to identify the integrating tool, such as MATLAB, ECAD, or Amesim. This value is used to identify the mapping file of the tool.
Returns
ObjectMappingType — The object mapping, with attributes inherited from all its parent mappings.
Exceptions
- EXCEPTION_OBJECT_MAPPING_NOT_FOUND — Thrown if object mapping is not found for some tool type.
- EXCEPTION_CIRCULAR_INHERITANCE — Thrown if circular inheritance is found.
Example 1: Single-level inheritance
Consider the following object mappings, where PCA extends Design and the toolType is PCA:
<ObjectMapping type="PCA" behaviorType="MIXED" tctype="EDACCABase" extends="Design">
</ObjectMapping>
<ObjectMapping type="Design" tctype="EDACCABase">
<BHMElement type="RootModel" tctype="EDADesExpBrd">
<AttributeMappings>
<AttributeMapping name="name" tcattr="object_name" includeinduplicatecheck="false"/>
<AttributeMapping name="description" tcattr="object_desc" includeinduplicatecheck="false"/>
<AttributeMapping name="cifContainerIdentifier" tcattr="Cif0ToolSpecificIntInfo::cif0ToolProperties"/>
<AttributeMapping name="cifContainerType" tcattr="Cif0ToolSpecificIntInfo::cif0ToolProperties"/>
</AttributeMappings>
</BHMElement>
<FileMapping>
<FileMap fileExt="zip" tcNameReferencedType="ZIPFILE" />
</FileMapping>
</ObjectMapping>
The output in this case will be the following object mapping, where the attributes for the ObjectMapping PCA are updated because of the inheritance:
<ObjectMapping type="PCA" behaviorType="MIXED" tctype="EDACCABase" extends="Design">
<BHMElement type="RootModel" tctype="EDADesExpBrd">
<AttributeMappings>
<AttributeMapping name="name" tcattr="object_name" includeinduplicatecheck="false"/>
<AttributeMapping name="description" tcattr="object_desc" includeinduplicatecheck="false"/>
<AttributeMapping name="cifContainerIdentifier" tcattr="Cif0ToolSpecificIntInfo::cif0ToolProperties"/>
<AttributeMapping name="cifContainerType" tcattr="Cif0ToolSpecificIntInfo::cif0ToolProperties"/>
</AttributeMappings>
</BHMElement>
</ObjectMapping>
Example 2: Multi-level inheritance
Consider the following object mappings, where PCA extends Design, Design extends PCAComp, and the toolType is PCA:
<ObjectMapping type="PCA" behaviorType="MIXED" tctype="EDACCABase" extends="Design">
<BHMElement type="RootModel" tctype="EDACCABase">
<AttributeMappings>
<AttributeMapping name="name" tcattr="object_name" includeinduplicatecheck="false"/>
<AttributeMapping name="description" tcattr="object_desc" includeinduplicatecheck="false"/>
<RevisionAttributeMapping>
<AttributeMapping name="name" tcattr="object_name" includeinduplicatecheck="false"/>
<AttributeMapping name="description" tcattr="object_desc" includeinduplicatecheck="false"/>
<AttributeMapping name="cifContainerIdentifier" tcattr="Cif0ToolSpecificIntInfo::cif0ToolProperties"/>
<AttributeMapping name="cifContainerType" tcattr="Cif0ToolSpecificIntInfo::cif0ToolProperties"/>
</RevisionAttributeMapping>
</AttributeMappings>
</BHMElement>
<BHMElement type="Design" tctype="EDADesExpBrd" behaviorType="GRM" reltype="IMAN_specification" toolReltype="forExample" reftype ="Design">
<AttributeMappings>
<AttributeMapping name="name" tcattr="object_name" includeinduplicatecheck="false"/>
<RevisionAttributeMapping/>
</AttributeMappings>
</BHMElement>
<BHMElement type="Design" tctype="EDADesExpBrd" behaviorType="GRM" reltype="FND_tracelink" toolReltype="forExample2" reftype ="Design">
<AttributeMappings>
<AttributeMapping name="name" tcattr="object_name" includeinduplicatecheck="false"/>
<RevisionAttributeMapping/>
</AttributeMappings>
</BHMElement>
<BHMElement type="Design" tctype="EDADesExpBrd" behaviorType="BVR" reltype="" toolReltype="forExample3" reftype ="Design">
<AttributeMappings>
<AttributeMapping name="name" tcattr="object_name" includeinduplicatecheck="false"/>
<RevisionAttributeMapping/>
</AttributeMappings>
</BHMElement>
<BHMElement type="PCAComp" tctype="Item" behaviorType="GRM" reltype="FND_tracelink" toolReltype="forExample2" reftype ="PCAComp">
<AttributeMappings>
<RevisionAttributeMapping/>
</AttributeMappings>
</BHMElement>
<BHMElement type="PCAComp" tctype="Item" behaviorType="BVR" reltype="" reftype ="PCAComp">
<AttributeMappings>
<RevisionAttributeMapping/>
</AttributeMappings>
</BHMElement>
<BHMElement type="EDABOMComp" tctype="EDAComPart" behaviorType="BVR" reftype ="EDABOMComp">
</BHMElement>
</ObjectMapping>
<ObjectMapping type="Design" tctype="EDACCABase" extends="PCAComp">
<BHMElement type="RootModel" tctype="EDADesExpBrd">
<AttributeMappings>
<AttributeMapping name="name" tcattr="object_name" includeinduplicatecheck="false"/>
<AttributeMapping name="description" tcattr="object_desc" includeinduplicatecheck="false"/>
<AttributeMapping name="cifContainerIdentifier" tcattr="Cif0ToolSpecificIntInfo::cif0ToolProperties"/>
<AttributeMapping name="cifContainerType" tcattr="Cif0ToolSpecificIntInfo::cif0ToolProperties"/>
</AttributeMappings>
</BHMElement>
<BHMElement type="PCAComp" tctype="Item" behaviorType="GRM" reltype="FND_tracelink" toolReltype="forExample2" reftype ="PCAComp">
<AttributeMappings>
<AttributeMapping name="name" tcattr="object_name" includeinduplicatecheck="false"/>
<AttributeMapping name="description" tcattr="object_desc" includeinduplicatecheck="false"/>
<AttributeMapping name="cifContainerIdentifier" tcattr="Cif0ToolSpecificIntInfo::cif0ToolProperties"/>
<AttributeMapping name="cifContainerType" tcattr="Cif0ToolSpecificIntInfo::cif0ToolProperties"/>
</AttributeMappings>
</BHMElement>
<BHMElement type="EDABOMComp" tctype="EDAComPart" behaviorType="BVR" reftype ="EDABOMComp">
<AttributeMappings>
<AttributeMapping name="name" tcattr="object_name" includeinduplicatecheck="false"/>
<RevisionAttributeMapping/>
</AttributeMappings>
</BHMElement>
<FileMapping>
<FileMap fileExt="zip" tcNameReferencedType="ZIPFILE" />
</FileMapping>
</ObjectMapping>
<ObjectMapping type="PCAComp" behaviorType="MIXED" tctype="Item">
<BHMElement type="RootModel" tctype="Item">
<AttributeMappings>
<AttributeMapping name="name" tcattr="object_name" includeinduplicatecheck="false"/>
<AttributeMapping name="description" tcattr="object_desc" includeinduplicatecheck="false"/>
<RevisionAttributeMapping>
<AttributeMapping name="name" tcattr="object_name" includeinduplicatecheck="false"/>
<AttributeMapping name="description" tcattr="object_desc" includeinduplicatecheck="false"/>
<AttributeMapping name="cifContainerIdentifier" tcattr="Cif0ToolSpecificIntInfo::cif0ToolProperties"/>
<AttributeMapping name="cifContainerType" tcattr="Cif0ToolSpecificIntInfo::cif0ToolProperties"/>
</RevisionAttributeMapping>
</AttributeMappings>
</BHMElement>
<BHMElement type="EDABOMComp" tctype="EDAComPart" behaviorType="BVR" reftype ="EDABOMComp">
<AttributeMappings>
<AttributeMapping name="name" tcattr="object_name" includeinduplicatecheck="false"/>
<AttributeMapping name="description" tcattr="object_desc" includeinduplicatecheck="false"/>
<RevisionAttributeMapping>
<AttributeMapping name="name" tcattr="object_name" includeinduplicatecheck="false"/>
<AttributeMapping name="description" tcattr="object_desc" includeinduplicatecheck="false"/>
<AttributeMapping name="cifContainerIdentifier" tcattr="Cif0ToolSpecificIntInfo::cif0ToolProperties"/>
<AttributeMapping name="cifContainerType" tcattr="Cif0ToolSpecificIntInfo::cif0ToolProperties"/>
</RevisionAttributeMapping>
</AttributeMappings>
</BHMElement>
<OrganizationData/>
</ObjectMapping>
The output in this case will be the following object mapping, where the attributes for the BHMElement (PCAComp) of the object mapping PCA are updated because of the inheritance:
<ObjectMapping type="PCA" behaviorType="MIXED" tctype="EDACCABase" extends="Design">
<BHMElement type="RootModel" tctype="EDACCABase">
<AttributeMappings>
<AttributeMapping name="name" tcattr="object_name" includeinduplicatecheck="false"/>
<AttributeMapping name="description" tcattr="object_desc" includeinduplicatecheck="false"/>
<RevisionAttributeMapping>
<AttributeMapping name="name" tcattr="object_name" includeinduplicatecheck="false"/>
<AttributeMapping name="description" tcattr="object_desc" includeinduplicatecheck="false"/>
<AttributeMapping name="cifContainerIdentifier" tcattr="Cif0ToolSpecificIntInfo::cif0ToolProperties"/>
<AttributeMapping name="cifContainerType" tcattr="Cif0ToolSpecificIntInfo::cif0ToolProperties"/>
</RevisionAttributeMapping>
</AttributeMappings>
</BHMElement>
<BHMElement type="Design" tctype="EDADesExpBrd" behaviorType="GRM" reltype="IMAN_specification" toolReltype="forExample" reftype ="Design">
<AttributeMappings>
<AttributeMapping name="name" tcattr="object_name" includeinduplicatecheck="false"/>
<RevisionAttributeMapping/>
</AttributeMappings>
</BHMElement>
<BHMElement type="Design" tctype="EDADesExpBrd" behaviorType="GRM" reltype="FND_tracelink" toolReltype="forExample2" reftype ="Design">
<AttributeMappings>
<AttributeMapping name="name" tcattr="object_name" includeinduplicatecheck="false"/>
<RevisionAttributeMapping/>
</AttributeMappings>
</BHMElement>
<BHMElement type="Design" tctype="EDADesExpBrd" behaviorType="BVR" reltype="" toolReltype="forExample3" reftype ="Design">
<AttributeMappings>
<AttributeMapping name="name" tcattr="object_name" includeinduplicatecheck="false"/>
<RevisionAttributeMapping/>
</AttributeMappings>
</BHMElement>
<BHMElement type="PCAComp" tctype="Item" behaviorType="GRM" reltype="FND_tracelink" toolReltype="forExample2" reftype ="PCAComp">
<AttributeMappings>
<AttributeMapping name="name" tcattr="object_name" includeinduplicatecheck="false"/>
<AttributeMapping name="description" tcattr="object_desc" includeinduplicatecheck="false"/>
<AttributeMapping name="cifContainerIdentifier" tcattr="Cif0ToolSpecificIntInfo::cif0ToolProperties"/>
<AttributeMapping name="cifContainerType" tcattr="Cif0ToolSpecificIntInfo::cif0ToolProperties"/>
<RevisionAttributeMapping/>
</AttributeMappings>
</BHMElement>
<BHMElement type="PCAComp" tctype="Item" behaviorType="BVR" reltype="" reftype ="PCAComp">
<AttributeMappings>
<RevisionAttributeMapping/>
</AttributeMappings>
</BHMElement>
<BHMElement type="EDABOMComp" tctype="EDAComPart" behaviorType="BVR" reftype ="EDABOMComp">
</BHMElement>
</ObjectMapping>
Source: https://docs.sw.siemens.com/en-US/doc/282219420/PL20251212545240207.xid1913857/xid2307337 · retrieved Fri Jul 10 2026 00:00:00 GMT+0000 (Coordinated Universal Time)