Class InMultiPort<T>

StaticpathSeparator

_getFullyQualifiedName

• _getFullyQualifiedName(): string

• Return a string that identifies this component. The name is a path constructed as [App]/[..]/[Container]/[This].

  Returns string

_getName

• _getName(): string

• Return a string that identifies this component within its container. If no such string was found, return the name of the constructor.

  Returns string

_isContainedBy

• _isContainedBy(reactor): boolean

• Confirm whether or not this component is contained by the given reactor.

  Parameters

  • reactor: Reactor

    The presumptive container of this component.

  Returns boolean

_isContainedByContainerOf

• _isContainedByContainerOf(reactor): boolean

• Confirm whether or not this component is contained by the container of the given reactor.

  Parameters

  • reactor: Reactor

    The container presumptive container of the container of this component.

  Returns boolean

_isRegistered

• _isRegistered(): boolean

• Report whether this component has been registered with its container or not. In principle, all components should have a container, but at the time of their construction there is a brief period where they are not. This is the only moment that a component is allowed register with its container.

  Returns boolean

_receiveRuntimeObject

• _receiveRuntimeObject(runtime): void

• Unimplemented method (multiports require not access to the runtime object).

  Parameters

  • runtime: Runtime

  Returns void

asWritable

• asWritable(key): WritableMultiPort<T>

• Obtain a writable version of this port, provided that the caller holds the required key.

  Parameters

  • key: undefined | symbol

  Returns WritableMultiPort<T>

get

• get(index): undefined | T

• Parameters

  • index: number

    the index that identifies the channel to return the value of

  Returns undefined | T

  the value that corresponds to the identified channel

getContainer

• getContainer(): Reactor

• Returns Reactor

getManager

• getManager(key): TriggerManager

• Request the manager of this trigger. The request will only be honored if the correct key is given. Each component has a unique symbol (a key) that is handed to the owner upon instantiation of the component. If the wrong key is supplied, return undefined.

  Parameters

  • key: undefined | symbol

    The private key embedded in this trigger.

  Returns TriggerManager

isPresent

• isPresent(): boolean

• Return whether this multiport has any channels that are present.

  Returns boolean

  true if there are any present channels

toString

• toString(): string

• Returns a string representation of an object.

  Returns string

values

• values(): (undefined | T)[]

• Return an array of which the elements represent the current value of each channel, which may either be present or absent (i.e., undefined).

  Returns (undefined | T)[]

  an array of values

width

• width(): number

• Return the number of channels of this multiport.

  Returns number

  the number of channels

StatickeyOfMatchingBank

• keyOfMatchingBank(member, reactor): string

• Parameters

  • member: Component
  • reactor: Reactor

  Returns string

StatickeyOfMatchingEntry

• keyOfMatchingEntry(component, object): string

• Given a component and its container (the global object if the component is an App), return the key of the entry that matches the component.

  Parameters

  • component: Component

    a component of which the object is assumed to be its container
  • object: object

    the assumed container of the component

  Returns string

  the key of the entry that matches the component

StatickeyOfMatchingMultiport

• keyOfMatchingMultiport(port, reactor): string

• Given a port and its containing reactor, return the key of the entry that matches a multiport found in the reactor that matches the port.

  Parameters

  • port: Component

    a port that is assumed to be a constituent of a multiport declared on the given reactor
  • reactor: Reactor

    a reactor that is assumed to have a multiport of which one of the constituents is the given port

  Returns string

  an identifier for the port based on its location in a matching multiport

Staticvalues

• values<T>(ports): (undefined | T)[]

• Given an array of ports (channels), return an array holding the ports' current values.

  Type Parameters

  • T

  Parameters

  • ports: IOPort<T>[]

    the ports to return the values of

  Returns (undefined | T)[]

  the current values of the given ports