IComponentMappings interface
The IComponentMappings interface represents the mapping of source components and target components in schematic and PCB documents.
public interface IComponentMappings : IDMObject
Namespace: EDP · Assembly: Altium.SDK.Interfaces
Inherits: IDMObject
Methods
| Method | Returns | Description |
|---|---|---|
| DM_MatchedComponentCount | int | Returns the number of matched components. |
| DM_MatchedSourceComponent | IComponent | Returns the indexed matched source component (that has been matched with a target component). |
| DM_MatchedTargetComponent | IComponent | Returns the indexed matched source component (that has been matched with a target component). |
| DM_UnmatchedSourceComponent | IComponent | Returns the indexed unmatched source component, that is, a target component could not be found to map to this source component. |
| DM_UnmatchedSourceComponentCount | int | Returns the number of unmatched source components. |
| DM_UnmatchedTargetComponent | IComponent | Returns the indexed unmatched target component, that is, a source component could not be found to map to the target component. |
| DM_UnmatchedTargetComponentCount | int | Returns the number of unmatched target components. |
DM_MatchedComponentCount
Returns the number of matched components.
int DM_MatchedComponentCount();
Returns: int
DM_MatchedSourceComponent
Returns the indexed matched source component (that has been matched with a target component). Use the DM_MatchedSourceComponentCount method.
IComponent DM_MatchedSourceComponent(int argIndex);
| Parameter | Type | Passing |
|---|---|---|
argIndex | int | value |
Returns: IComponent
Extension method of IComponentMappingsHelper (using EDP;).
DM_MatchedTargetComponent
Returns the indexed matched source component (that has been matched with a target component). Use the DM_MatchedTargetComponentCount method.
IComponent DM_MatchedTargetComponent(int argIndex);
| Parameter | Type | Passing |
|---|---|---|
argIndex | int | value |
Returns: IComponent
Extension method of IComponentMappingsHelper (using EDP;).
DM_UnmatchedSourceComponent
Returns the indexed unmatched source component, that is, a target component could not be found to map to this source component. Use the DM_UnmatchedSourceComponentCount method.
IComponent DM_UnmatchedSourceComponent(int argIndex);
| Parameter | Type | Passing |
|---|---|---|
argIndex | int | value |
Returns: IComponent
Extension method of IComponentMappingsHelper (using EDP;).
DM_UnmatchedSourceComponentCount
Returns the number of unmatched source components.
int DM_UnmatchedSourceComponentCount();
Returns: int
DM_UnmatchedTargetComponent
Returns the indexed unmatched target component, that is, a source component could not be found to map to the target component. Use the DM_UnmatchedTargetComponentCount method.
IComponent DM_UnmatchedTargetComponent(int argIndex);
| Parameter | Type | Passing |
|---|---|---|
argIndex | int | value |
Returns: IComponent
Extension method of IComponentMappingsHelper (using EDP;).
DM_UnmatchedTargetComponentCount
Returns the number of unmatched target components.
int DM_UnmatchedTargetComponentCount();
Returns: int
Inherited members
- From IDMObject: DM_CalculateParameterValue, DM_CurrentSheetInstanceNumber, DM_FullCrossProbeString, DM_GeneralField, DM_GetVCSProject, DM_ImageIndex, DM_IsFormulaString, DM_IsInferredObject, DM_LocationString, DM_LocationX, DM_LocationY, DM_LongDescriptorString, DM_NetIndex_Flat, DM_NetIndex_Sheet, DM_NetIndex_SubNet, DM_ObjectKindString, DM_ObjectKindStringForCrossProbe, DM_OwnerDocument, DM_OwnerDocumentFullPath, DM_OwnerDocumentName, DM_ParameterCount, DM_Parameters, DM_PcbHandle, DM_PCBObjectHandle, DM_PCBObjectInterface, DM_PrimaryCrossProbeString, DM_SchHandle, DM_SCHObjectHandle, DM_SCHObjectInterface, DM_SecondaryCrossProbeString, DM_SetVCSProject, DM_SheetIndex_Logical, DM_SheetIndex_Physical, DM_ShortDescriptorString, DM_ValidForNavigation, DM_VHDLEntity
Returned by
IProject.DM_ComponentMappings, IProject.DM_ComponentMappings_1