UL_MODULEINST

Data members

   
angle real (0, 90, 180 and 270)
column string (see note)
mirror int
module UL_MODULE
modulevariant string (selected variantdef of module)
name string (INSTANCE_NAME_LENGTH)
offset int
row string (see note)
sheet int (sheet number)
smashed int (see note)
x, y int (origin point)

Loop members

   
texts() UL_TEXT (see note)
wires() UL_WIRE

See also UL_PORTREF, UL_VARIANTDEF

Constants

   
INSTANCE_NAME_LENGTH max. recommended length of an instance name (used in formatted output only)

Note

The texts() member loops through all texts of the module instance, no matter if smashed or not. The column and row members return the column and row location within the frame on the sheet on which this instance is invoked. If there is no frame on that sheet, or the instance is placed outside the frame, a '?' (question mark) is returned. These members can only be used in a sheet context.

The smashed member tells whether the instance is smashed. This function can also be used to find out whether there is a detached text parameter by giving the name of that parameter in square brackets, as in smashed["NAME"]. This is useful in case you want to select such a text with the MOVE command by doing MOVE MOD1>NAME.

Example

schematic(SCH) {
  SCH.sheets(SH) {
    SH.moduleinsts(MI) {
      printf("Module instance %s is located on sheet %d\n", MI.name, MI.sheet);
      }
    }
  }