Altair EEvision 2025.1 APIs
    Preparing search index...

    Class Edb

    In-browser representation of the electrical cable harness database (EDB). An instance of Edb can be obtained using the EEvision API function EEvisionAPI.GetEdb().

    Index

    Methods

    attributes components GetAttr GetObj modules multicores wires

    Methods

    • Iterate over all root-level attributes of the EDB, i.e., all attributes that do not belong to an EDB object, but the EDB itself.

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

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

    • Iterate over all components in the EDB.

      Returns Generator<EdbComponent, void>

      for (const comp of edb.components()) {
          console.log(comp.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.

    • Given an object ID, return the corresponding EdbObject.

      Parameters

      Returns undefined | EdbObject

      • the corresponding EDB object (or undefined if no object with that ID exists).

    • Iterate over all modules in the EDB.

      Returns Generator<EdbModule, void>

      for (const mod of edb.modules()) {
          console.log(mod.name);
      }

    • Iterate over the multicores in the EDB.

      Parameters

      • recursive: boolean = false

        if false, only iterate over the outermost multicores; if true, iterate also over the nested ones.

      Returns Generator<EdbMulticore, void>

      for (const mc of edb.multicores()) {
          if (mc.parent) {
              console.log(`multicore ${mc.name} is a nested multicore.`);
          } else {
              console.log(`multicore ${mc.name} is an outermost multicore.`);
          }
      }

    • Iterate over all wires in the EDB.

      Returns Generator<EdbWire, void>

      for (const wire of edb.wires()) {
          console.log(wire.name);
      }

    Settings

    Member Visibility

    On This Page

    Methods