Module Pin

class hal_py.ModulePin

Bases: hal_py.ModuleBasePin

The pin of a module. Each pin has a name, a direction, and a type and is associated with a net.

property direction

The direction of the pin.

Type

hal_py.PinDirection

get_direction(self: hal_py.ModuleBasePin) hal_py.PinDirection

Get the direction of the pin.

Returns

The direction of the pin.

Return type

hal_py.PinDirection

get_group(self: hal_py.ModuleBasePin) Tuple[hal::PinGroup<hal::ModulePin>, int]

Get the group of the pin as well as the index of the pin within the group.

Returns

The group and the index of the pin.

Return type

tuple(hal_py.ModulePinGroup,int)

get_id(self: hal_py.ModuleBasePin) int

Get the ID of the module pin. The ID is unique within a module.

Returns

The ID of the pin.

Return type

int

get_name(self: hal_py.ModuleBasePin) str

Get the name of the pin.

Returns

The name of the pin.

Return type

str

get_net(self: hal_py.ModulePin) hal::Net

Get the net passing through the pin.

Returns

The net of the pin.

Return type

hal_py.Net

get_type(self: hal_py.ModuleBasePin) hal_py.PinType

Get the type of the pin.

Returns

The type of the pin.

Return type

hal_py.PinType

property group

A tuple comprising the group of the pin as well as the index of the pin within the group.

Type

tuple(hal_py.ModulePinGroup,int)

property id

The ID of the module pin. The ID is unique within a module.

Type

int

property name

The name of the pin.

Type

str

property net

The net passing through the pin.

Type

hal_py.Net

property type

The type of the pin.

Type

hal_py.PinType