Class EdbWire

The representation of a wire.

Hierarchy (View Summary)

Accessors

group hierParent id name otype type

Methods

attributes GetAttr joined

Accessors

group

  • get group(): undefined | EdbMulticore

  • If the wire is part of a shielded and/or twisted wire bundle, return the corresponding EdbMulticore object.

    Returns undefined | EdbMulticore

    the wire bundle that contains the current wire if the wire is part of a bundle.

hierParent

  • get hierParent(): undefined | EdbComponent

  • If the wire is contained in a hierarchical component, this function returns the component that contains the wire.

    Returns undefined | EdbComponent

    the direct hierarchy parent component if the wire is contained in a hierarchy.

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

type

  • get type(): EdbWireType

  • The sub-type of the wire ("power", "ground", etc.).

    Returns EdbWireType

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

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.

joined

  • joined(): Generator<EdbCavity, void, any>

  • Iterate over all cavities the wire is connected to.

    Returns Generator<EdbCavity, void, any>

    Example

    for (const cav of wire.joined()) {
       const conn = cav.parent;
       const comp = conn.parent;
       console.log(`Wire ${wire.name} is connected to `
         + `${comp.name} :: ${conn.name} :: ${cav.name}.`);
    }

Settings

Member Visibility

On This Page

Accessors
Methods