next up previous contents index
Next: Physical Devices Up: Extraction Functions Previous: Terminals   Contents   Index

Physical Conductor Groups

(int) Group()
This function will run the grouping and device extraction algorithm on the current physical cell. The grouping algorithm identifies the wire nets. The returned value is the number of groups used, or 0 if an error occurs. The group index extends from 0 through the number returned minus one. Group 0 is the ground group, if a ground plane layer has been defined.

(int) GetNumberGroups()
This returns the number of conductor groups allocated by the extraction process in the physical part of the current cell. The group index passed to other functions should be less than this value.

(int) GetGroupBB(group, array)
This function returns the bounding box of the conductor group whose index is passed as the first argument. The coordinates, in microns relative the the current physical cell origin, are returned in the array, which must have size 4 or larger. If the function succeeds, 1 is returned, otherwise 0 is returned. The saved order is L, B, R, T.

(int) GetGroupNode(group)
This function returns the node number from the electrical database which corresponds to the physical group index passed as the argument. If the association failed, -1 is returned.

(string) GetGroupName(group)
This will return a string containing a name for the group whose number is passed as the argument. The name is the name of a formal terminal attached to the group, or the net name if no formal terminal. If the group has no name, a null string is returned.

(string) GetGroupNetName(group)
This will return a string containing the net name for the group whose number is passed as the argument. If the group has no net name, a null string is returned.

(real) GetGroupCapacitance(group)
This will return the capacitance assigned to the group whose index is passed as the argument. If no capacitance has been assigned. 0 is returned.

(object_handle) ListGroupObjects(group)
This function returns a handle to the list of objects in the current physical cell which constitute the group. The argument is the group index. The objects are copies, so can not be modified or selected. The objects returned have been processed by the ``Conductor Exclude'' directive, so may not precisely correspond to the ``real'' objects in the database. If an error occurs, 0 is returned.

(dev_contact_handle) ListGroupDevContacts(group)
This function returns a handle to the list of device contacts which are assigned to the conductor group whose index is passed as the argument. If an error occurs, 0 is returned.

(subc_contact_handle) ListGroupSubcContacts(group)
This function returns a handle to a list of subcircuit contacts associated with the group index passed as the argument. If an error occurs, 0 is returned.

(terminal_handle) ListGroupTerminals(group)
This will return a handle to a list of formal terminals associated with the group number passed as an argument. If an error occurs, 0 is returned. If the group contains no formal terminals, the list will be empty.

(stringlist_handle) ListGroupTerminalNames(group)
This function returns a list of names of the formal terminals assigned to the conductor group whose index is passed as the argument. If an error occurs, 0 is returned. If the group contains no formal terminals, the list will be empty.


next up previous contents index
Next: Physical Devices Up: Extraction Functions Previous: Terminals   Contents   Index
Stephen R. Whiteley 2006-10-23