getMappedRelAttributesForToolNRelType()

This API retrieves all attributes associated with the specified toolRelType of the BHMElement mapped under the object mappings of the provided toolType from the integration definition file.

It collects the attributes for each BHMElement, storing them in a map where the key is the BHMElement type and the value is the list of attributes. This process continues recursively through the inheritance chain, from child to parent object mappings, ensuring that attributes from both child and parent mappings are included. Finally, the function returns the complete map of attributes.

public Map<String, List<AttributeMappingType>> getMappedRelAttributesForToolNRelType(String toolType, String toolRelType, String applicationName) throws ServiceException, BHMException, NotLoadedException, BHMCommonException, Exception

Input Parameters

• toolType — The tool type for which the object mappings are to be fetched.
• toolRelType — The toolRelType of the BHMElement for which the attributes are 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

Map<String, List<AttributeMappingType>> — A map where each key is a BHMElement type, and the corresponding value is a list of attributes for that element, covering both the child and parent object 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

Consider the following object mappings, where Design extends PCAComp and the toolRelType under consideration is forExample2:

<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="Design" tctype="EDADesExpBrd" behaviorType="GRM" reltype="FND_tracelink" toolReltype="forExample2" reftype ="Design">
        <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>
    <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="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"/>
            <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>

For the given use case, the output map will be as follows:

• Key: BHMElement type: Design — Value: Attributes:

  <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"/>
  

• Key: BHMElement type: PCAComp — Value: Attributes:

  <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"/>