Class EdbCavity

Representation of a cavity at the connector of a component. Please see the EDB documentation for more information about the EDB object model; here every component contains a set of connectors, which in turn contain a set of cavities. This also holds for inline connectors (which in physical reality do not have a component) and splices/eyelets (which actually neither have connectors nor cavities).

Hierarchy (View Summary)

Accessors

id name otype parent partner type

Methods

attributes GetAttr joined

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

partner

  • get partner(): undefined | EdbCavity

  • Get the partner cavity (or undefined if the cavity has no partner). This function is only useful for cavities at inliner components where connectors and cavities typically appear in pairs.

    Returns undefined | EdbCavity

type

  • get type(): undefined | readonly EdbCavityType[]

  • The list of sub-types of the cavity (e.g., "halfdot" or "in").

    Returns undefined | readonly EdbCavityType[]

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<EdbWire, void, any>

  • Iterate over all wire that are connected to the cavity.

    Returns Generator<EdbWire, void, any>

    Example

    for (const wire of cav.joined()) {
       console.log(`Wire ${wire.name} is connected to this cavity.`);
    }

Settings

Member Visibility

On This Page

Accessors
Methods