Altair EEvision 2025.1 APIs
    Preparing search index...

    Class EdbMulticore

    Representation of a shielded/twisted wire bundle (a.k.a. multicore). Note that multicores can be nested arbitrarily deeply.

    Hierarchy (View Summary)

    Index

    Accessors

    id name otype parent shield type

    Methods

    attributes children GetAttr wires

    Accessors

    • get id(): ObjectID

      The unique EDB ID of the object.

      Returns ObjectID

    • get name(): undefined | string

      The name of the object.

      Returns undefined | string

    • get otype(): ObjectType

      The object type of the object.

      Returns ObjectType

    • get parent(): undefined | EdbMulticore

      For nested multicores, get the parent multicore; undefined is returned if the current multicore is an outermost bundle.

      Returns undefined | EdbMulticore

    • get shield(): undefined | EdbWire

      For shielded multicores, return the shield wire.

      Returns undefined | EdbWire

    Methods

    • Iterate over the attributes of an object.

      Returns Generator<[string, string | readonly string[]], void>

      for (const [name, value] of obj.attributes()) {
          if (typeof value === "string") {
              console.log(`${name} = ${value}`);
          } else {
              console.log(`${name} = [${value.join(", ")}]`);
          }
      }

    • Iterate over all multicores that are nested in the current bundle.

      Parameters

      • recursive: boolean = false

        if false, only iterate over the direct children; if true, iterate over all (arbitrarily deeply) nested multicores.

      Returns Generator<EdbMulticore, void>

      console.log(`Multicore ${mc.name} contains the following multicores:`);
      for (const sub_mc of mc.children()) {
          console.log(sub_mc.name);
      }

    • Get the value of an attribute.

      Parameters

      • name: string

        the name of the attribute.

      Returns undefined | string | string[]

      the value(s) of the attribute if it exists, or undefined if the object does not have an attribute with the given name. In case the object has multiple attributes with the same name, an array with the values is returned instead of a single string.

    • Iterate over all wires in a bundle. The wires of a multicore include the shield wire (if the multicore is shielded).

      Parameters

      • recursive: boolean = false

        if true also iterate over the wires of the nested multicores; if false, only iterate over the wires included in the current multicore.

      Returns Generator<EdbWire, void>

    Settings

    Member Visibility

    On This Page

    Accessors
    Methods