INet interface

The INet interface is associated with an existing net object of a design document. A net is a series of connections of net identifiers (electrically aware objects such as sheet entries, pins, wires and ports) with the same net name.

public interface INet : IDMObject

Namespace: EDP · Assembly: Altium.SDK.Interfaces

Inherits: IDMObject

Remarks

That is, all connections sharing the same net name is a net and can be connected on a sheet or between sheets in a project.

Methods

Method	Returns	Description
DM_AllNetItemCount	int	The method returns the number of net aware objects (that is inherited from the INetItem interface).
DM_AllNetItems	INetItem	The method returns an indexed net aware object.
DM_AutoNumber	int	The method returns the auto number value used for auto-numbering nets.
DM_BusIndex	int	The method returns the bus index.
DM_BusKind	TBusKind	The method returns the bus kind.
DM_BusPrefix	string	The method returns the bus prefix as used in this net.
DM_BusRange1	string	The method returns the first index of the Bus range.
DM_BusRange2	string	The method returns the last index of the Bus Range.
DM_BusRangeValue1	int	The method returns the value of the first index of the Bus range
DM_BusRangeValue2	int	The method returns the value of the second index of the Bus range.
DM_BusSectionParent	INet	This method returns an INet interface for the parent bus section.
DM_BusWidth	int	The method returns the bus width.
DM_CalculatedNetName	string	The method returns the bus width.
DM_CountOfElectricalType	int	The method returns the number of electrical types used by the current sheet or the project.
DM_CountOfNonPinItems	int	The method returns the number of non-pin objects used on the current sheet or the project.
DM_CrossSheetConnectorCount	int	The method returns the number of cross sheet connectors associated with this net.
DM_CrossSheetConnectors	ICrossSheet	The method returns an indexed cross sheet connector that is part of the current net.
DM_DirectiveCount	int	The method returns the number of directives associated with this net.
DM_Directives	INetItem	The method returns an indexed directive (which could be a PCB layout directive that contains PCB fules).
DM_DoCrossProbe	void
DM_Electric	TPinElectrical	The method returns the type of electrical property the pin is associated with.
DM_ElectricalString	string	The method returns the electrical property associated with this net.
DM_FullNetName	string	The method denotes the full net name (includes the bus index and so on).
DM_HarnessType	string
DM_HiddenNetName	string	The method denotes the hidden net name (like power nets).
DM_IsAutoGenerated	bool	The method denotes a boolean value whether this net has been system generated or not.
DM_IsBusElement	bool	The method returns a Boolean value whether this bus element exists or not for this INetItem interface.
DM_IsBusMember	bool	The method returns a Boolean value whether this bus member exists or not for this INetItem interface.
DM_IsBusSection	bool	The method returns a Boolean value whether the bus section exists or not for this INetItem interface.
DM_IsLocal	bool	The method denotes whether this net is a local net restricted to the document or not.
DM_LineCount	int	The method returns the number of lines associated with this net.
DM_Lines	ILine	The method returns an indexed line that is part of the current net.
DM_NetLabelCount	int	The method returns the number of net labels associated with this net.
DM_NetLabels	INetItem	The method returns an indexed net label that is part of the current net.
DM_NetName	string	The method denotes the net name of this net.
DM_NetNumber	string	The method denotes the net number of this net.
DM_PinCount	int	The method returns the number of pins associated with this net.
DM_Pins	INetItem	The method reurns an indexed pin that is part of the current net.
DM_PortCount	int	The method returns the number of ports associated with this net.
DM_Ports	INetItem	The method returns an indexed port that is part of the current net.
DM_PowerObjectCount	int	The method returns the number of power objects associated with this net.
DM_PowerObjects	INetItem	The method returns an indexed power object that is part of the current net.
DM_RangeDefinedByValue	bool	The method returns a boolean value whether the range has been defined by a two specific range values or not.
DM_RemovedHarnessEntries	INetItem
DM_RemovedHarnessEntryCount	int
DM_RemovedNetItemCount	int	The method returns the number of net items that have been removed from the nets.
DM_RemovedNetItems	INetItem	The method returns an indexed net item that has been removed from net of the schematic document.
DM_Scope	TNetScope	The funciton denotes the scope of this net as defined by the TNetScope type.
DM_SheetEntryCount	int	The method returns the number of sheet entries associated with this net.
DM_SheetEntrys	INetItem	The method returns an indexed sheet entry that is part of the current net.
DM_SignalType	string	The method returns the signal type property associated with this net.
DM_SubWireCount	int	The method returns the number of sub wires associated with this net.
DM_SubWires	INet	The method Returns an indexed sub wire (part of a bus object).
DM_SuppressERC	bool	The method returns a boolean value whether the ERC has been suppressed for this net or not.

DM_AllNetItemCount

The method returns the number of net aware objects (that is inherited from the INetItem interface).

int DM_AllNetItemCount();

Returns: int

DM_AllNetItems

The method returns an indexed net aware object. Use the DM_AllNetItemCount method for this method.

INetItem DM_AllNetItems(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: INetItem

Extension method of INetHelper (using EDP;).

See also: INet.DM_AllNetItemCount

DM_AutoNumber

The method returns the auto number value used for auto-numbering nets.

int DM_AutoNumber();

Returns: int

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 bus kind. which is one of the following enumerated values; eBusKindUndefined, eBusKindLowValueFirst, eBusKindHighValueFirst, eBusKindGeneric.

TBusKind DM_BusKind();

Returns: TBusKind

Extension method of INetHelper (using EDP;).

DM_BusPrefix

The method returns the bus prefix as used in this net.

string DM_BusPrefix();

Returns: string

DM_BusRange1

The method returns the first index of the Bus range. Eg. A1..6, the bus range1 is 1.

string DM_BusRange1();

Returns: string

DM_BusRange2

The method returns the last index of the Bus Range. Eg A0..4, the bus range 2 is 4.

string DM_BusRange2();

Returns: string

DM_BusRangeValue1

The method returns the value of the first index of the Bus range

int DM_BusRangeValue1();

Returns: int

DM_BusRangeValue2

The method returns the value of the second index of the Bus range.

int DM_BusRangeValue2();

Returns: int

DM_BusSectionParent

This method returns an INet interface for the parent bus section.

INet DM_BusSectionParent();

Returns: INet

Extension method of INetHelper (using EDP;).

DM_BusWidth

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

int DM_BusWidth();

Returns: int

DM_CalculatedNetName

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

string DM_CalculatedNetName();

Returns: string

DM_CountOfElectricalType

The method returns the number of electrical types used by the current sheet or the project.

int DM_CountOfElectricalType(TPinElectrical argElectric);
int DM_CountOfElectricalType(int argElectric);

Parameter	Type	Passing
argElectric	TPinElectrical	value

Returns: int

The first overload is an extension method of INetHelper (using EDP;) with typed parameters; the second is declared by the interface.

DM_CountOfNonPinItems

The method returns the number of non-pin objects used on the current sheet or the project.

int DM_CountOfNonPinItems();

Returns: int

DM_CrossSheetConnectorCount

The method returns the number of cross sheet connectors associated with this net.

int DM_CrossSheetConnectorCount();

Returns: int

DM_CrossSheetConnectors

The method returns an indexed cross sheet connector that is part of the current net. Use the DM_CrossSheetConnectorCount method.

ICrossSheet DM_CrossSheetConnectors(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: ICrossSheet

Extension method of INetHelper (using EDP;).

DM_DirectiveCount

The method returns the number of directives associated with this net.

int DM_DirectiveCount();

Returns: int

DM_Directives

The method returns an indexed directive (which could be a PCB layout directive that contains PCB fules). Use the DM_DirectiveCount method.

INetItem DM_Directives(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: INetItem

Extension method of INetHelper (using EDP;).

DM_DoCrossProbe

No description yet.

void DM_DoCrossProbe();

Returns: nothing (void)

DM_Electric

The method returns the type of electrical property the pin is associated with. Various values include :eElectricInput, eElectricIO, eElectricOutput, eElectricOpenCollector, eElectricPassive, eElectricHiZ, eElectricOpenEmitter, eElectricPower

TPinElectrical DM_Electric();

Returns: TPinElectrical

Extension method of INetHelper (using EDP;).

See also: TPinElectrical

DM_ElectricalString

The method returns the electrical property associated with this net.

string DM_ElectricalString();

Returns: string

DM_FullNetName

The method denotes the full net name (includes the bus index and so on).

string DM_FullNetName();

Returns: string

DM_HarnessType

No description yet.

string DM_HarnessType();

Returns: string

DM_HiddenNetName

The method denotes the hidden net name (like power nets).

string DM_HiddenNetName();

Returns: string

DM_IsAutoGenerated

The method denotes a boolean value whether this net has been system generated 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_IsLocal

The method denotes whether this net is a local net restricted to the document or not.

bool DM_IsLocal();

Returns: bool

DM_LineCount

The method returns the number of lines associated with this net.

int DM_LineCount();

Returns: int

DM_Lines

The method returns an indexed line that is part of the current net. use the DM_LineCount method.

ILine DM_Lines(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: ILine

Extension method of INetHelper (using EDP;).

DM_NetLabelCount

The method returns the number of net labels associated with this net.

int DM_NetLabelCount();

Returns: int

DM_NetLabels

The method returns an indexed net label that is part of the current net. Use DM_NetLabelCount method.

INetItem DM_NetLabels(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: INetItem

Extension method of INetHelper (using EDP;).

See also: INetItem

DM_NetName

The method denotes the net name of this net.

string DM_NetName();

Returns: string

DM_NetNumber

The method denotes the net number of this net.

string DM_NetNumber();

Returns: string

DM_PinCount

The method returns the number of pins associated with this net.

int DM_PinCount();

Returns: int

DM_Pins

The method reurns an indexed pin that is part of the current net. Use the DM_PinCount method.

INetItem DM_Pins(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: INetItem

Extension method of INetHelper (using EDP;).

DM_PortCount

The method returns the number of ports associated with this net.

int DM_PortCount();

Returns: int

DM_Ports

The method returns an indexed port that is part of the current net. Use the DM_PortCount method.

INetItem DM_Ports(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: INetItem

Extension method of INetHelper (using EDP;).

DM_PowerObjectCount

The method returns the number of power objects associated with this net.

int DM_PowerObjectCount();

Returns: int

DM_PowerObjects

The method returns an indexed power object that is part of the current net. Use the DM_PowerObjectCount method.

INetItem DM_PowerObjects(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: INetItem

Extension method of INetHelper (using EDP;).

DM_RangeDefinedByValue

The method returns a boolean value whether the range has been defined by a two specific range values or not.

bool DM_RangeDefinedByValue();

Returns: bool

DM_RemovedHarnessEntries

No description yet.

INetItem DM_RemovedHarnessEntries(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: INetItem

Extension method of INetHelper (using EDP;).

DM_RemovedHarnessEntryCount

No description yet.

int DM_RemovedHarnessEntryCount();

Returns: int

DM_RemovedNetItemCount

The method returns the number of net items that have been removed from the nets.

int DM_RemovedNetItemCount();

Returns: int

DM_RemovedNetItems

The method returns an indexed net item that has been removed from net of the schematic document.

INetItem DM_RemovedNetItems(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: INetItem

Extension method of INetHelper (using EDP;).

DM_Scope

The funciton denotes the scope of this net as defined by the TNetScope type.

TNetScope DM_Scope();

Returns: TNetScope

Extension method of INetHelper (using EDP;).

See also: TNetScope

DM_SheetEntryCount

The method returns the number of sheet entries associated with this net.

int DM_SheetEntryCount();

Returns: int

DM_SheetEntrys

The method returns an indexed sheet entry that is part of the current net. Use DM_SheetEntryCount method.

INetItem DM_SheetEntrys(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: INetItem

Extension method of INetHelper (using EDP;).

See also: INetItem, INet.DM_SheetEntryCount

DM_SignalType

The method returns the signal type property associated with this net.

string DM_SignalType();

Returns: string

DM_SubWireCount

The method returns the number of sub wires associated with this net.

int DM_SubWireCount();

Returns: int

DM_SubWires

The method Returns an indexed sub wire (part of a bus object). Use the DM_SubWireCount. A bus object conceptually carries multiple wires.

INet DM_SubWires(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: INet

Extension method of INetHelper (using EDP;).

DM_SuppressERC

The method returns a boolean value whether the ERC has been suppressed for this net or not.

bool DM_SuppressERC();

Returns: bool

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

IBus.DM_Sections, IBus.DM_Wires, IDifferentialPair.DM_NegativeNet, IDifferentialPair.DM_PositiveNet, IDocument.DM_HarnessNets, IDocument.DM_Nets, IHighlightedDocument.HL_GetHighlightedNet, INetItem.DM_OwnerNetLogical, INetItem.DM_OwnerNetPhysical, ISubNet.DM_Net

Accepted by

IHighlightedDocument.HL_Register_Net, IHighlightedDocument.HL_SetHighlightedNet, IInstrumentView.LiveUpdateNet