IBus interface
The IBus interface represents a bus object on the schematic sheet. Buses are special graphical elements that represent a common pathway for multiple signals on a schematic document. Buses have no electrical properties, and they must be correctly identified by net labels and ports.
public interface IBus : IDMObject
Namespace: EDP · Assembly: Altium.SDK.Interfaces
Inherits: IDMObject
Remarks
When a schematic document is compiled, bus objects have inferred objects (wires with netlabels on them) in memory that aids the connectivity and navigation features within Altium Designer.
Methods
| Method | Returns | Description |
|---|---|---|
| DM_BusKind | TBusKind | The method returns the bus kind which is one of the following enumerated values; eBusKindUndefined, eBusKindLowValueFirst, eBusKindHighValueFirst, eBusKindGeneric. |
| DM_BusName | string | This method returns the full bus name of this bus interface. |
| DM_BusRange1 | string | This method returns the Bus range 1 value. |
| DM_BusRange2 | string | The method returns the Bus range 2 value. |
| DM_BusRangeValue1 | int | The method returns the Bus range 1 value. |
| DM_BusRangeValue2 | int | The method returns the Bus range 2 value. |
| DM_BusWidth | int | The method returns the bus width. |
| DM_Electric | TPinElectrical | The method returns the electrical property for this bus. |
| DM_FullBusName | string | The method returns the full bus name of this bus interface. |
| DM_IsLocal | bool | The method returns a Boolean value whether this bus is a local object or not. |
| DM_RangeDefinedByValue | bool | The method returns a Boolean value whether this range is defined by a two specific range values or not. |
| DM_Scope | TNetScope | The method denotes the net scope of this IBus interface. |
| DM_SectionCount | int | The method returns the number of sections for this IBus interface. |
| DM_Sections | INet | The method returns the indexed section of the bus. |
| DM_SignalType | string | The method returns the signal type string for this bus. |
| DM_WireCount | int | The method returns the number of wires for this IBus interface. |
| DM_Wires | INet | The method returns the indexed wire. |
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 IBusHelper (using EDP;).
DM_BusName
This method returns the full bus name of this bus interface.
string DM_BusName();
Returns: string
DM_BusRange1
This method returns the Bus range 1 value. Eg. A1..6, the bus range1 is 1.
string DM_BusRange1();
Returns: string
DM_BusRange2
The method returns the Bus range 2 value. Eg. A1..6, the bus range2 is 6.
string DM_BusRange2();
Returns: string
DM_BusRangeValue1
The method returns the Bus range 1 value.
int DM_BusRangeValue1();
Returns: int
DM_BusRangeValue2
The method returns the Bus range 2 value.
int DM_BusRangeValue2();
Returns: int
DM_BusWidth
The method returns the bus width.
int DM_BusWidth();
Returns: int
DM_Electric
The method returns the electrical property for this bus. Various values include :eElectricInput, eElectricIO, eElectricOutput, eElectricOpenCollector, eElectricPassive, eElectricHiZ, eElectricOpenEmitter, eElectricPower
TPinElectrical DM_Electric();
Returns: TPinElectrical
Extension method of IBusHelper (using EDP;).
See also: TPinElectrical
DM_FullBusName
The method returns the full bus name of this bus interface.
string DM_FullBusName();
Returns: string
DM_IsLocal
The method returns a Boolean value whether this bus is a local object or not.
bool DM_IsLocal();
Returns: bool
DM_RangeDefinedByValue
The method returns a Boolean value whether this range is defined by a two specific range values or not.
bool DM_RangeDefinedByValue();
Returns: bool
DM_Scope
The method denotes the net scope of this IBus interface.
TNetScope DM_Scope();
Returns: TNetScope
Extension method of IBusHelper (using EDP;).
See also: TNetScope
DM_SectionCount
The method returns the number of sections for this IBus interface. This is used for the DM_Sections method.
int DM_SectionCount();
Returns: int
DM_Sections
The method returns the indexed section of the bus. Used in conjunction with the DM_SectionCount method.
INet DM_Sections(int argIndex);
| Parameter | Type | Passing |
|---|---|---|
argIndex | int | value |
Returns: INet
Extension method of IBusHelper (using EDP;).
DM_SignalType
The method returns the signal type string for this bus.
string DM_SignalType();
Returns: string
DM_WireCount
The method returns the number of wires for this IBus interface. This is used for the DM_Wires method.
int DM_WireCount();
Returns: int
DM_Wires
The method returns the indexed wire. Used in conjunction with the DM_WireCount method.
INet DM_Wires(int argIndex);
| Parameter | Type | Passing |
|---|---|---|
argIndex | int | value |
Returns: INet
Extension method of IBusHelper (using EDP;).
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