IPart interface

www.kxcad.net Home > Electronic Index > Altium(Protel) Index


Your Ad Here

Overview

The IPart interface is the interface or the front end of an existing schematic part on a Schematic sheet. A part object is “part” of a component, that is, a multi-part component consists of part objects. For example a multiple gate integrated circuit has duplicate gates, and that a component represents the multi-part gate and a part represents the gate itself.

An equivalent component object representation is the ISch_Component class in Schematic API Reference. The ISch_Component interface represents a component that can contain links to different model implementations such as PCB, Signal Integrity and Simulation models. Only one model of a particular model type (PCB footprint, SIM, SI, EDIF Macro and VHDL) can be enabled as the currently linked model, at any one time.

Interface Methods

Method

Description

Function DM_Pins(Index : Integer) : INetItem;

Returns the INetItem interface for the specified indexed Pin of a Schematic Component.

Function DM_Implementations(Index : Integer) : IComponentImplementation;

Returns the particular IComponentImplementation for the specified indexed implementations of a Schematic component.

Function    DM_CurrentImplementation   (AType : WideSTring) : IComponentImplementation;

Returns the current implementation.

Function DM_PinCount : Integer;

Returns the number of pins for this schematic component.

Function DM_ImplementationCount : Integer;

Returns the number of implementations of this schematic component.

Function    DM_DesignatorLocationX        : Integer;

Returns the location X of the designator associated with this component.

Function    DM_DesignatorLocationY        : Integer;

Returns the location Y of the designator associated with this component.

Function    DM_ReferenceLocationX         : Integer;

Returns the reference location X of the designator associated with this component.

Function    DM_ReferenceLocationY         : Integer;

Returns the reference location Y of the designator associated with this component.

Function    DM_CenterLocationX            : Integer;                                   

Returns the central location X of the designator associated with this component.

Function    DM_CenterLocationY            : Integer;                                   

Returns the central location Y of the designator associated with this component.

Function    DM_FirstPinLocationX          : Integer;

Denotes the reference X location of the first pin of a part

Function    DM_FirstPinLocationY          : Integer;

Denotes the reference Y location of the first pin of a part

Function    DM_Layer                      : WideString;

Denotes which layer this part is on.

Function    DM_Rotation                   : Double;

Denotes the rotation property of a part.

Function    DM_Footprint : WideString;

Denotes the footprint string that this part is associated with.

Function    DM_Comment : WideString;

Denotes the comment string for this part.

Function    DM_SubProject : WideString;

Returns the sub project string of this part. A part can represent a schematic sheet, like a sheet symbol.

Function    DM_ChildVHDLEntity : WideString;

Returns the Child VHDL entity string

Function    DM_PhysicalDesignator         : WideString;

Denotes the physical designator of a part.

Function    DM_FullPhysicalDesignator     : WideString;

Denotes the full physical designator of a part (which includes the logical designator and the channel instance string).

Function    DM_FullLogicalDesignator      : WideString;

Denotes the full logical designator of a part.

Function    DM_ChildProjectSheet          : IDocument;

Denotes the IDocument interface representing the child project sheet associated with this part.

Function    DM_InstanceCount              : Integer;                                   

Returns the number of instances of this part.

Function    DM_LogicalDesignator          : WideString;

Denotes the logical designator of this part.

Function    DM_AssignedDesignator         : WideString;

Denotes the assigned designator for this part.

Function    DM_CalculatedDesignator       : WideString;

Denotes the system generated designator for this part.

Function    DM_UniqueId : WideString;

Denotes the Unique ID for this part. Unique IDs are used in Schematic – PCB documents synchronization so that Sch components and its corresponding PCB components are in sync.

Function    DM_UniqueIdName : WideString;

Denotes the Unique ID name of this part.

Function    DM_UniqueIdPath : WideString;

Denotes the Unique ID path of this part (includes the back slash).

Function    DM_PartType: WideString;

Denotes the part type for this part. (Footprint type).

Function    DM_LibraryReference : WideString;

Denotes the name of the component from the library

Function    DM_SourceLibraryName : WideString;

Denotes the name of the source library where the schematic component and its associated part come from.

Function    DM_SourceUniqueId : WideString;

Unique IDs (UIDs) are used to match each schematic component to the corresponding PCB component. When a schematic is transferred to a blank PCB using the Update command, the source reference links for each PCB footprint is populated with source library pathnames. The UID is a system generated value that uniquely identifies the source component.

Function DM_SourceHierarchicalPath     : WideString;

Denotes the source reference path to the PCB component. The path can be multi level depending on whether it is a multi channel or a bormal design. When a schematic is transferred to a blank PCB using the Update command, the source reference links for each PCB footprint is populated with source library path names.

Function DM_SourceDesignator : WideString;

Denotes the current designator of the source component from the corresponding schematic.

Function DM_Description : WideString;

Denotes the description of the reference link to a source component or as a device name.

Function DM_PartID : Integer;

Denotes the PartID for this part. A multi-part component references each part by its PartID, for example a four part component has four unique PartIDs.

Function DM_DisplayMode : TDisplayMode;

Denotes one of the 255 display modes. The mode 0 is the normal graphical display for this part object. The other 254 modes are alternative graphical displays of this same part object.

Function    DM_MaxPartCount : Integer;

Returns the maximum part count for this part object.

Function    DM_LogicalOwnerDocument       : IDocument;

Denotes the IDocument representing the logical owner document that this part is associated to a schematic component.

Function DM_ChannelOffset              : Integer;                                   

The offset represents which part is offset in relation to the reference channel and the associated channels are also affected.

Function DM_DesignatorLocked           : Boolean;                                   

Denotes whether or not the designator string is locked (unmoveable).

Function DM_PartIdLocked               : Boolean;

Denotes whether or not the part id string is locked (unmoveable).

Function DM_ComponentKind : TComponentKind;

Denotes the component kind that this part is represented as. in the BOM and are maintained during synchronization.

A component kind can be one of the following:

eComponentKind_Standard : These components possess standard electrical properties, are always synchronized and are the type most commonly used on a board.

eComponentKind_Mechanical: These components do not have electrical properties and will appear in the BOM. They are synchronized if the same components exist on both the Schematic and PCB documents. An example is a heatsink.

eComponentKind_Graphical: These components are not used during synchronization or checked for electrical errors. These components are used, for example, when adding company logos to documents.

eComponentKind_NetTie_BOM: These components short two or more different nets for routing and these components will appear.

eComponentKind_NetTie_NoBOM: These components short two

or more different nets for routing and these components will NOT

appear in the BOM and are maintained during synchronization.

Note the TComponentKind type is defined from RT_Workspace

unit.

Function    DM_NewDesignator : WideString;

Denotes the new designator for this part.

Function DM_NewPartId : Integer;

Denotes the new part id for this part.

Function DM_Height : Integer;

Denotes the height property of the part object. A part object is “part” of a multi-part component.

Procedure   DM_AddConfigurationParameters;

Add configuration parameters to this part.