getMappedAttributesForToolType()

This API retrieves all the attributes for a given object mapping of the specified toolType, including attributes from both extended mappings and classification mappings.

The API traverses through all parent object mappings of the given toolType, as well as the classification mappings, to gather attributes. Since attributes from object mappings and classification mappings are structured differently, the function uses an AttributeInfo structure to standardize and store them. After collecting all the attributes, they are stored in an AttributeInfo list, which is then returned.

public List<AttributeInfo> getMappedAttributesForToolType(String toolType, String applicationName) throws ServiceException, BHMException, NotLoadedException, BHMCommonException, Exception

Input Parameters

• toolType — The tool type 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

List<AttributeInfo> — A list of AttributeInfo objects. Each AttributeInfo contains fields, such as direction, tcAttribute, toolAttribute, isInherited, and attributeType, to indicate the nature of the attribute.

The attributeType field specifies whether an attribute is a revisionAttribute, a generalAttribute, or an attribute from classAttribute.

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:

<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>
    <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>
    <OrganizationData/>
</ObjectMapping>

For the given use case, the output is a table where each row represents an AttributeInfo object:

#	TcAttribute	Direction	Tool attribute	IsInherited	Attribute type
1	object_name	null	name	FALSE	AttributeMapping
2	object_desc	null	description	FALSE	AttributeMapping
3	object_name	null	name	FALSE	RevisionAttributeMapping
4	object_desc	null	description	FALSE	RevisionAttributeMapping
5	Cif0ToolSpecificIntInfo::cif0ToolProperties	null	cifContainerIdentifier	FALSE	RevisionAttributeMapping
6	Cif0ToolSpecificIntInfo::cif0ToolProperties	null	cifContainerType	FALSE	RevisionAttributeMapping
7	Cif0ToolSpecificIntInfo::cif0ToolProperties	null	cifContainerIdentifier	TRUE	AttributeMapping
8	Cif0ToolSpecificIntInfo::cif0ToolProperties	null	cifContainerType	TRUE	AttributeMapping