Altair EEvision 2025.1 APIs
    Preparing search index...

    Class EdbModule

    Modules are essentially collections of arbitrary EDB objects. Modules can even contain other modules. The class EdbModule is the representation of the modules in an EDB.

    Hierarchy (View Summary)

    Index

    Accessors

    id name options otype type

    Methods

    attributes GetAttr members membersA membersP

    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 options(): undefined | readonly string[]

      Return the options set at the module. Currently, there is only one option available: "autocomplete". It is used to denote (function) modules that only consist of the cavities of devices that are relevant for the vehicle function. EEvision automatically adds all wires, inliners, splices, and eyelets that are needed to electrically connect these cavities.

      Returns undefined | readonly string[]

    • get otype(): ObjectType

      The object type of the object.

      Returns ObjectType

    • get type(): EdbModuleType

      The sub-type of the module. For instance, "function" or "config".

      Returns EdbModuleType

    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(", ")}]`);
          }
      }

    • 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 objects in a module. If the module contains other modules, this does not iterate over their contents.

      Returns Generator<EdbObject, void>

      console.log(`Module ${mod.name} contains the following objects:`);
      for (const obj of mod.members()) {
          console.log(`${obj.otype} ${obj.name}`);
      }

    • Iterate over all configurable attributes of the module. Such attributes are typically only available for config modules (i.e., modules of type "config").

      A configurable attribute is a triple [object, key, value].

      Returns Generator<[obj: EdbObject, key: string, value: string], void>

    • Iterate over all configurable object pairs of the module. Such pairs are typically only available for config modules (i.e., modules of type "config"). They represent configurable wire--cavity connections or configurable partner relations between connectors and cavities of inliner components.

      Returns Generator<[EdbObject, EdbObject], void>

    Settings

    Member Visibility

    On This Page

    Accessors
    Methods