Use the following procedure to define connector class properties for a new asset.
You can define custom connector classes for new asset types that require connection behavior beyond the product-supplied connector classes. These can then be used to control parameter propagation behavior among assets assigned to the class.
A connector class is defined by an XML file, using the extension .connectorclass. The elements of the connector class define the parameter mapping, and any conditional checks that are used to control the conditions in which the particular mappings are made.
The structure of a connector class XML file is straightforward. Here is an example of a simple connector class file. The element descriptions follow.
<connector>
<ConveyorWidth value_source="parameter">Width</ConveyorWidth> <ConveyorHeight family_type="normal"
value_source="parameter">Height</ConveyorHeight> <ConveyorHeight family_type="inclined" connector_name="Connector1"
value_source="Parameter">UpperHeight</ConveyorHeight> <ConveyorHeight family_type="inclined" connector_name="Connector2"
value_source="Parameter">LowerHeight</ConveyorHeight> <ConveyorHeight family_type="spiral" connector_name="UpperConnector"
value_source="Parameter">UpperHeight</ConveyorHeight> <ConveyorHeight family_type="spiral" connector_name="LowerConnector"
value_source="Parameter">LowerHeight</ConveyorHeight>
</connector>
Connector class files always use a root element named connector. This element contains a series of child elements that identify the parameters that are to be propagated between assets when they are connected and belong to the same connector class.
The child elements define mapping groups. They can have any name desired and are used according to the following rules:
The value of these elements usually identifies the parameter name to be mapped (e.g., "Width" above). Both assets must provide a parameter matching this name, or no mapping will be performed.
Attributes on these elements provide additional information to control the mapping operation. These attributes are described in the following table.
Attribute | Attribute Values | Notes |
value_source | Parameter (default) | This specifies that the value for the mapping is to be provided by the identified parameter in the source asset. |
Constant | This specifies that the value to be assigned will be a constant value, provided in the value attribute. | |
value | This attribute provides the value to be used for the parameter when value_source is set to Constant. | |
connector_name | This attribute is used to restrict the matching to a specific connector (by name). If the connector being used for the connection in the asset does not match this name, the mapping will be ignored. |
In addition to the above reserved attributes, additional attributes can be specified which define matching conditions. The attribute names (e.g., "family_type" in the above example) identify connector class properties. The values for these properties must be specified within the asset (using the Connector Class Properties dialog box) in order to facilitate matching. If the asset does not provide a matching connector class property, the mapping will be ignored.