Skip to main content
View as Markdown

INetItem interface

The INetItem interface represents the ancestor or parent interface for the following interfaces - IBus, ICrossSheetConnector, IPin, IPort, INetlabel, ISheetEntry and IPowerObject interfaces that have a Net property.

public interface INetItem : IDMObject

Namespace: EDP · Assembly: Altium.SDK.Interfaces

Inherits: IDMObject

Derived: ICrossSheet

Remarks​

These interface objects have a net property and thus these objects can be part of a net.

Methods​

MethodReturnsDescription
DM_BusIndexintThe method returns the bus index.
DM_BusKindTBusKindThe method returns the type of bus.
DM_BusPrefixstringThe method returns the bus prefix.
DM_BusRange1stringThis method returns the bus range 1 string.
DM_BusRange2stringThis method returns the bus range 1 string.
DM_BusRangeValue1intThis method returns value of the bus range 1.
DM_BusRangeValue2intThis method returns value of the bus range 1.
DM_BusWidthintThe method returns the bus width.
DM_CrossSheetTextstring
DM_DisplayModebyteThe method returns the display mode for this part object.
DM_ElectricTPinElectricalThis method denotes the electrical pin property for a net aware object.
DM_ElectricalTPinElectricalThe method returns the electrical pin property.
DM_ElectricalStringstringThe method returns the electrical property string.
DM_FlattenedNetNamestringThe method returns the net name of the flattened net where the net aware object is associated with.
DM_Footprintstring
DM_FullLogicalPartDesignatorstringThe method returns the logical part designator and the channel instance for this INetItem Interface.
DM_FullPhysicalPartDesignatorstringThe method returns the full logical part designator and the channel instance for this INetItem Interface.
DM_FullPinNamestringThe method returns the full Pin name and number that this INetItem interface is associated with.
DM_FullUniqueIdstringThe method returns the full Unique ID string for this INetItem interface.
DM_IdstringThe method returns the Id value for this net aware object.
DM_IsAutoGeneratedboolThe method returns a Boolean value whether this INetItem has been automatically generated by Atlium Designer or not.
DM_IsBusElementboolThe method returns a Boolean value whether this bus element exists or not for this INetItem interface.
DM_IsBusMemberboolThe method returns a Boolean value whether this bus member exists or not for this INetItem interface.
DM_IsBusSectionboolThe method returns a Boolean value whether the bus section exists or not for this INetItem interface.
DM_IsHiddenboolThe method returns whether this pin object is hidden or not.
DM_IsInferredFromHarnessbool
DM_LinkObjectINetItemThe method denotes the linked object to a sheet entry or port from a port or a sheet entry respectively.
DM_LogicalPartDesignatorstringThe method returns the logical part designator for this INetItem interface.
DM_NetLabelTextstring
DM_NetNamestringThe method returns the net name of the net where the net aware object is associated with.
DM_NetNumberstring
DM_OwnerNetLogicalINetThe method denotes whether this net aware object is associated with the net of a logical document.
DM_OwnerNetPhysicalINetThe method denotes whether this net aware object is associated with the net of a physical document.
DM_OwnerPartIDint
DM_PairSwapIdstring
DM_ParentIDstringThe method denotes the parent ID or the Sheet document name / Net Name property where this interface is associated with.
DM_ParentSheetSymbolNamestringThe method Returns the parent sheet symbol name associated with this INetItem interface (which is a SheetEntry object).
DM_ParentSheetSymbolSheetNamestringThe method returns the parent sheet symbol sheet name string associated with this INetItem interface (which is a sheet entry object).
DM_PartIPartThe method returns the IPart interface.
DM_PartIDint
DM_PartPinSwapIdstring
DM_PartSwapIdstringThe method returns the wide string for the part swap Id.
DM_PartTypestringThe method returns the part type for this INetItem associated with an IPart object.
DM_PartUniqueIdstringThe method returns the Unique ID for this part the NetItem is associated with.
DM_PhysicalPartDesignatorstringThe method returns the logical part designator and the channel instance for this INetItem Interface.
DM_PinNamestringThe method returns the Pin name that this INetItem interface is associated with.
DM_PinNameNoPartIdstringThe method returns the Pin Name Number and Part ID string for this INetItem associated with an Part object.
DM_PinNumberstringThe method returns the Pin Number that this INetItem interface is associated with.
DM_PinSwapIdstringThe method returns the wide string for the pin swap Id.
DM_PortNamestring
DM_PowerTextstring
DM_RangeDefinedByValueboolThe method returns a Boolean value whether the range is defined by a two specific range values or not.
DM_SheetNamestring
DM_SheetSymbolISheetSymbolThe method returns the ISheetSymbol interface where this INetItem (representing a ISheetEntry interface if it exists) is associated with.
DM_SignalTypestringThe method returns the signal type string.

DM_BusIndex​

The method returns the bus index. An IBus interface is inherited from a INetItem interface.

int DM_BusIndex();

Returns: int

DM_BusKind​

The method returns the type of bus. An IBus interface is inherited from a INetItem interface.

TBusKind DM_BusKind();

Returns: TBusKind

Extension method of INetItemHelper (using EDP;).

DM_BusPrefix​

The method returns the bus prefix. An example, a bus object could have this A0..7 net label, and the prefix is A. An IBus interface is inherited from a INetItem interface.

string DM_BusPrefix();

Returns: string

DM_BusRange1​

This method returns the bus range 1 string.

string DM_BusRange1();

Returns: string

DM_BusRange2​

This method returns the bus range 1 string.

string DM_BusRange2();

Returns: string

DM_BusRangeValue1​

This method returns value of the bus range 1.

int DM_BusRangeValue1();

Returns: int

DM_BusRangeValue2​

This method returns value of the bus range 1.

int DM_BusRangeValue2();

Returns: int

DM_BusWidth​

The method returns the bus width. An IBus interface is inherited from a INetItem interface.

int DM_BusWidth();

Returns: int

DM_CrossSheetText​

No description yet.

string DM_CrossSheetText();

Returns: string

DM_DisplayMode​

The method returns the display mode for this part object. A part object can have up to 254 alternative graphical displays along with the normal graphical display.

byte DM_DisplayMode();

Returns: byte

DM_Electric​

This method denotes the electrical pin property for a net aware object.

TPinElectrical DM_Electric();

Returns: TPinElectrical

Extension method of INetItemHelper (using EDP;).

See also: TPinElectrical

DM_Electrical​

The method returns the electrical pin property.

TPinElectrical DM_Electrical();

Returns: TPinElectrical

Extension method of INetItemHelper (using EDP;).

See also: TPinElectrical

DM_ElectricalString​

The method returns the electrical property string.

string DM_ElectricalString();

Returns: string

DM_FlattenedNetName​

The method returns the net name of the flattened net where the net aware object is associated with.

string DM_FlattenedNetName();

Returns: string

DM_Footprint​

No description yet.

string DM_Footprint();

Returns: string

DM_FullLogicalPartDesignator​

The method returns the logical part designator and the channel instance for this INetItem Interface.

string DM_FullLogicalPartDesignator();

Returns: string

DM_FullPhysicalPartDesignator​

The method returns the full logical part designator and the channel instance for this INetItem Interface.

string DM_FullPhysicalPartDesignator();

Returns: string

DM_FullPinName​

The method returns the full Pin name and number that this INetItem interface is associated with. An IPin interface is inherited from an INetItem interface.

string DM_FullPinName();

Returns: string

DM_FullUniqueId​

The method returns the full Unique ID string for this INetItem interface.

string DM_FullUniqueId();

Returns: string

DM_Id​

The method returns the Id value for this net aware object.

string DM_Id();

Returns: string

DM_IsAutoGenerated​

The method returns a Boolean value whether this INetItem has been automatically generated by Atlium Designer or not.

bool DM_IsAutoGenerated();

Returns: bool

DM_IsBusElement​

The method returns a Boolean value whether this bus element exists or not for this INetItem interface. An IBus interface is inherited from a INetItem interface.

bool DM_IsBusElement();

Returns: bool

DM_IsBusMember​

The method returns a Boolean value whether this bus member exists or not for this INetItem interface. An IBus interface is inherited from a INetItem interface.

bool DM_IsBusMember();

Returns: bool

DM_IsBusSection​

The method returns a Boolean value whether the bus section exists or not for this INetItem interface. An IBus interface is inherited from a INetItem interface.

bool DM_IsBusSection();

Returns: bool

DM_IsHidden​

The method returns whether this pin object is hidden or not. An IPin interface is inherited from an INetItem interface.

bool DM_IsHidden();

Returns: bool

DM_IsInferredFromHarness​

No description yet.

bool DM_IsInferredFromHarness();

Returns: bool

DM_LinkObject​

The method denotes the linked object to a sheet entry or port from a port or a sheet entry respectively. This method is for port objects that are connected from child schematic sheets to sheet entries of sheet symbols on a parent sheet.

INetItem DM_LinkObject();

Returns: INetItem

Extension method of INetItemHelper (using EDP;).

DM_LogicalPartDesignator​

The method returns the logical part designator for this INetItem interface.

string DM_LogicalPartDesignator();

Returns: string

DM_NetLabelText​

No description yet.

string DM_NetLabelText();

Returns: string

DM_NetName​

The method returns the net name of the net where the net aware object is associated with.

string DM_NetName();

Returns: string

DM_NetNumber​

No description yet.

string DM_NetNumber();

Returns: string

DM_OwnerNetLogical​

The method denotes whether this net aware object is associated with the net of a logical document.

INet DM_OwnerNetLogical();

Returns: INet

Extension method of INetItemHelper (using EDP;).

DM_OwnerNetPhysical​

The method denotes whether this net aware object is associated with the net of a physical document.

INet DM_OwnerNetPhysical();

Returns: INet

Extension method of INetItemHelper (using EDP;).

DM_OwnerPartID​

No description yet.

int DM_OwnerPartID();

Returns: int

DM_PairSwapId​

No description yet.

string DM_PairSwapId();

Returns: string

DM_ParentID​

The method denotes the parent ID or the Sheet document name / Net Name property where this interface is associated with. For example a sheet entry on a sheet symbol object's parent ID is the name of the schematic sheet where the port is.

string DM_ParentID();

Returns: string

DM_ParentSheetSymbolName​

The method Returns the parent sheet symbol name associated with this INetItem interface (which is a SheetEntry object).

string DM_ParentSheetSymbolName();

Returns: string

DM_ParentSheetSymbolSheetName​

The method returns the parent sheet symbol sheet name string associated with this INetItem interface (which is a sheet entry object).

string DM_ParentSheetSymbolSheetName();

Returns: string

DM_Part​

The method returns the IPart interface.

IPart DM_Part();

Returns: IPart

Extension method of INetItemHelper (using EDP;).

DM_PartID​

No description yet.

int DM_PartID();

Returns: int

DM_PartPinSwapId​

No description yet.

string DM_PartPinSwapId();

Returns: string

DM_PartSwapId​

The method returns the wide string for the part swap Id.

string DM_PartSwapId();

Returns: string

DM_PartType​

The method returns the part type for this INetItem associated with an IPart object.

string DM_PartType();

Returns: string

DM_PartUniqueId​

The method returns the Unique ID for this part the NetItem is associated with.

string DM_PartUniqueId();

Returns: string

DM_PhysicalPartDesignator​

The method returns the logical part designator and the channel instance for this INetItem Interface.

string DM_PhysicalPartDesignator();

Returns: string

DM_PinName​

The method returns the Pin name that this INetItem interface is associated with. Since an IPin interface is inherited from an INetItem interface.

string DM_PinName();

Returns: string

DM_PinNameNoPartId​

The method returns the Pin Name Number and Part ID string for this INetItem associated with an Part object. A pin is part of a part / component.

string DM_PinNameNoPartId();

Returns: string

DM_PinNumber​

The method returns the Pin Number that this INetItem interface is associated with. An IPin interface is inherited from an INetItem interface.

string DM_PinNumber();

Returns: string

DM_PinSwapId​

The method returns the wide string for the pin swap Id.

string DM_PinSwapId();

Returns: string

DM_PortName​

No description yet.

string DM_PortName();

Returns: string

Examples: Extension_TestPortHarnessDev

DM_PowerText​

No description yet.

string DM_PowerText();

Returns: string

DM_RangeDefinedByValue​

The method returns a Boolean value whether the range is defined by a two specific range values or not.

bool DM_RangeDefinedByValue();

Returns: bool

DM_SheetName​

No description yet.

string DM_SheetName();

Returns: string

DM_SheetSymbol​

The method returns the ISheetSymbol interface where this INetItem (representing a ISheetEntry interface if it exists) is associated with. If not, a nil value is returned.

ISheetSymbol DM_SheetSymbol();

Returns: ISheetSymbol

Extension method of INetItemHelper (using EDP;).

DM_SignalType​

The method returns the signal type string.

string DM_SignalType();

Returns: string

Inherited members​

Returned by​

IBlanket.DM_NetItems, IDocument.DM_FSMClockPort, IDocument.DM_FSMResetPort, IDocument.DM_Ports, INet.DM_AllNetItems, INet.DM_Directives, INet.DM_NetLabels, INet.DM_Pins, INet.DM_Ports, INet.DM_PowerObjects, INet.DM_RemovedHarnessEntries, INet.DM_RemovedNetItems, INet.DM_SheetEntrys, IPart.DM_Pins, ISheetSymbol.DM_SheetEntries, ISignalNode.DM_NetItem, ISimProbe.GetProbeSchProbe

Accepted by​

IChangeManager.DM_CreateECO_SwapPin, IHighlightedDocument.HL_Register_NetItem

Examples​

Used in the SDK examples: Extension_TestPortHarnessDev.