IComponent interface
The IChannelClass interface is a PCB Channel class object interface for an existing Channel Class on a PCB document. An existing Channel (room) class contains members of specific components.
public interface IComponent : IPart
Namespace: EDP · Assembly: Altium.SDK.Interfaces
Remarks
Each component within a Channel Class object can either be a member or not. The 'All Components' Channel Class exists in every PCB document by default, it includes all Components in the document.
It is not possible to change which components are members of that Channel class, but the user has full control over which components are members of any other Channel classes (which are created and named by the User)
Methods
| Method | Returns | Description |
|---|---|---|
| DM_DoCrossProbe | void | |
| DM_IncrementallyUpdatePhysicalDesignators | void | |
| DM_NexusDeviceId | string | |
| DM_PhysicalComponentCount | int | The method returns the number of physical components. |
| DM_PhysicalComponents | IComponent | The method returns the indexed physical component. |
| DM_PhysicalPath | string | The method returns the full physical path for this component. |
| DM_SubPartCount | int | The method returns the number of parts for this multi-part component. |
| DM_SubParts | IPart | The method returns the indexed sub-part of a multi-part component. |
| DM_UniqueId_1 | string | |
| DM_UniqueIdName_1 | string | |
| DM_UniqueIdPath_1 | string |
DM_DoCrossProbe
No description yet.
void DM_DoCrossProbe();
Returns: nothing (void)
DM_IncrementallyUpdatePhysicalDesignators
No description yet.
void DM_IncrementallyUpdatePhysicalDesignators(bool argNewHasDesignatorRecord, bool argNewDesignatorLocked, string argNewPhysicalDesignator);
| Parameter | Type | Passing |
|---|---|---|
argNewHasDesignatorRecord | bool | value |
argNewDesignatorLocked | bool | value |
argNewPhysicalDesignator | string | value |
Returns: nothing (void)
DM_NexusDeviceId
No description yet.
string DM_NexusDeviceId();
Returns: string
DM_PhysicalComponentCount
The method returns the number of physical components.
int DM_PhysicalComponentCount();
Returns: int
DM_PhysicalComponents
The method returns the indexed physical component. Use this in conjunction with the DM_PhysicalComponentCount method.
IComponent DM_PhysicalComponents(int argIndex);
| Parameter | Type | Passing |
|---|---|---|
argIndex | int | value |
Returns: IComponent
Extension method of IComponentHelper (using EDP;).
DM_PhysicalPath
The method returns the full physical path for this component. For example the string can consist of the schematic filename \ channel name and instance.
string DM_PhysicalPath();
Returns: string
DM_SubPartCount
The method returns the number of parts for this multi-part component. A standalone component returns 1 (only one part for a standalone component).
int DM_SubPartCount();
Returns: int
DM_SubParts
The method returns the indexed sub-part of a multi-part component. Use the DM_SubPartCount method.
IPart DM_SubParts(int argIndex);
| Parameter | Type | Passing |
|---|---|---|
argIndex | int | value |
Returns: IPart
Extension method of IComponentHelper (using EDP;).
DM_UniqueId_1
No description yet.
string DM_UniqueId_1();
Returns: string
DM_UniqueIdName_1
No description yet.
string DM_UniqueIdName_1();
Returns: string
DM_UniqueIdPath_1
No description yet.
string DM_UniqueIdPath_1();
Returns: string
Inherited members
- From IPart: DM_AddConfigurationParameters, DM_AssignedDesignator, DM_CalculatedDesignator, DM_CenterLocationX, DM_CenterLocationY, DM_ChannelOffset, DM_ChildProjectSheet, DM_ChildVHDLEntity, DM_Comment, DM_ComponentKind, DM_ConfigurationParameters, DM_ConfiguratorName, DM_CurrentImplementation, DM_Description, DM_DesignatorLocationX, DM_DesignatorLocationY, DM_DesignatorLocked, DM_DisplayMode, DM_FirstPinLocationX, DM_FirstPinLocationY, DM_Footprint, DM_FullLogicalDesignator, DM_FullLogicalDesignatorForDisplay, DM_FullPhysicalDesignator, DM_FullPhysicalDesignatorForDisplay, DM_Height, DM_ImplementationCount, DM_Implementations, DM_InstanceCount, DM_Layer, DM_LibraryReference, DM_LogicalDesignator, DM_LogicalOwnerDocument, DM_MaxPartCount, DM_NewDesignator, DM_NewPartId, DM_PartID, DM_PartIdLocked, DM_PartType, DM_PhysicalDesignator, DM_PinCount, DM_Pins, DM_ReferenceLocationX, DM_ReferenceLocationY, DM_Rotation, DM_SetExternalPartHandle, DM_SourceDesignator, DM_SourceHierarchicalPath, DM_SourceLibraryName, DM_SourceUniqueId, DM_SubProject, DM_UniqueId, DM_UniqueIdName, DM_UniqueIdPath
- 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
IComponentMappings.DM_MatchedSourceComponent, IComponentMappings.DM_MatchedTargetComponent, IComponentMappings.DM_UnmatchedSourceComponent, IComponentMappings.DM_UnmatchedTargetComponent, IDocument.DM_Components, IDocument.DM_UniqueComponents
Accepted by
IChangeManager.DM_CreateECO_SwapPin, IComponentVariation.DM_CalculatedAlternatePart, IHighlightedDocument.HL_Register_Component, IParameterVariation.DM_CalculatedValue, IProjectProperties.DM_DesignatorRecord_ECOChangeComponentDesignator
Examples
Used in the SDK examples: Extension_AddVariant, Extension_BOMManager, Extension_BOMManager, Extension_CreateVariantComponent, Extension_HierarchicalDesign.