Class EdbMulticore

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

Hierarchy (View Summary)

Accessors

id name otype parent shield type

Methods

attributes children GetAttr wires

Accessors

id

  • get id(): ObjectID

  • The unique EDB ID of the object.

    Returns ObjectID

name

  • get name(): undefined | string

  • The name of the object.

    Returns undefined | string

otype

  • get otype(): ObjectType

  • The object type of the object.

    Returns ObjectType

parent

  • 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

shield

  • get shield(): undefined | EdbWire

  • For shielded multicores, return the shield wire.

    Returns undefined | EdbWire

type

Methods

attributes

  • attributes(): Generator<[string, string | readonly string[]], void, any>

  • Iterate over the attributes of an object.

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

    Example

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

children

  • children(): Generator<EdbMulticore, void, any>

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

    Returns Generator<EdbMulticore, void, any>

    Example

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

GetAttr

  • GetAttr(name: string): undefined | string | string[]

  • 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.

wires

  • wires(recursive?: boolean): Generator<EdbWire, void, any>

  • Iterate over all wires in a bundle. This includes only the wires that are directly contained in this bundle, but not the ones that are part of nested bundles.

    Parameters

    • recursive: boolean = false

      if true also iterate over the wires of the nested multicores.

    Returns Generator<EdbWire, void, any>

Settings

Member Visibility

On This Page

Accessors
Methods