AutoMovie API
    Preparing search index...

    Interface IAutoMovieServicePort

    One typed connection point on a node.

    Direction is stated relative to the node: in means the medium arrives from the network, out means the node puts it into the network. A tap has an in cold water port and a floor gully has an out waste port, so the same word means the same thing whether the medium is water, air, power or signal, and segments use that direction convention, also admitting explicitly bidirectional fitting ports.

    interface IAutoMovieServicePort {
        demand: number;
        direction: AutoMovieServicePortDirection;
        id: string;
        medium: AutoMovieServiceMedium;
        position: IAutoMovieVector3;
        section: number | null;
        system: string;
        unit: AutoMovieServiceUnit;
    }
    Index
    demand: number

    Finite nonnegative terminal flow, load or bandwidth in unit. A passing tee, valve, damper or switch declares zero to avoid counting the downstream terminal's demand twice.

    It is the port's own terminal that states it: a basin states what it draws on its in supply port and what it discharges on its out waste port, so a supply system and a drainage system are each loaded by the end that actually loads them.

    Which way the port faces, relative to the node that owns it.

    id: string

    Stable port identity, unique across the whole network.

    What the port carries. It must equal its system's medium.

    World position of the connection point, in metres.

    It stands inside the same logical space its node stands in. A run is anchored to this point at both ends, and a wall crossing is read between consecutive route points, so a port allowed to sit in another room would let a run terminate where its fitting is not and never appear to cross anything.

    section: number | null

    Internal cross-section in square metres a joining segment must match; a finite number greater than 0, or null when the port imposes none.

    system: string

    Id of the system this port belongs to.

    Unit demand is stated in. It must equal its system's unit.