IPCB_PrimitiveCounter interface
Counts the objects of a PCB document; IPCB_Board.GetPrimitiveCounter returns it.
public interface IPCB_PrimitiveCounter
Namespace: PCB · Assembly: Altium.SDK.Interfaces
Methods
| Method | Returns | Description |
|---|---|---|
| GetCount | uint | Counts the objects of a set of object types. |
| GetHoleCount | uint | Returns the number of holes of the given hole type on the board. |
| GetObjectCount | uint | Returns the number of objects of the given object type. |
| GetStringCount | uint | Returns the number of text strings on the board. |
GetCount
Counts the objects of a set of object types.
uint GetCount(TObjectSet argObjectSet);
uint GetCount(ITransportSet argObjectSet);
| Parameter | Type | Passing | Description |
|---|---|---|---|
argObjectSet | TObjectSet | value | The object types to count. |
Returns: uint
The first overload is an extension method of IPCB_PrimitiveCounterHelper (using PCB;) with typed parameters; the second is declared by the interface.
See also: TObjectSet
GetHoleCount
Returns the number of holes of the given hole type on the board.
uint GetHoleCount(TExtendedHoleType argHoleType);
uint GetHoleCount(int argHoleType);
| Parameter | Type | Passing | Description |
|---|---|---|---|
argHoleType | TExtendedHoleType | value | The hole shape to count. |
Returns: uint
The first overload is an extension method of IPCB_PrimitiveCounterHelper (using PCB;) with typed parameters; the second is declared by the interface.
GetObjectCount
Returns the number of objects of the given object type.
uint GetObjectCount(TObjectId argObjectId);
uint GetObjectCount(int argObjectId);
| Parameter | Type | Passing |
|---|---|---|
argObjectId | TObjectId | value |
Returns: uint
The first overload is an extension method of IPCB_PrimitiveCounterHelper (using PCB;) with typed parameters; the second is declared by the interface.
GetStringCount
Returns the number of text strings on the board.
uint GetStringCount();
Returns: uint
Text objects (TObjectId.eTextObject) are counted, except the designator and comment of each component.