Class TriggerAbstract

Abstract class for a trigger. A trigger may be an action, port, or timer.

Hierarchy (view full)

Constructors

constructor

Properties

_key reactions pathSeparator

Methods

_getContainer _getFullyQualifiedName _getName _isContainedBy _isContainedByContainerOf _isRegistered _linkToRuntimeObject _receiveRuntimeObject getContainer getManager isPresent keyOfMatchingBank keyOfMatchingEntry keyOfMatchingMultiport

Constructors

constructor

  • new Trigger(container): Trigger

  • Create a new component and register it with the given container.

    Parameters

    • container: null | Reactor

      The reactor that will contain the new component, null if this is an instance of App, in which case the component will be designated as its own container.

      Note that each subclass implementation needs to call the method _linkToRuntimeObject immediately after calling this super constructor in order to establish a link with the runtime object.

    Returns Trigger

Properties

Protected_key

_key: symbol = ...

A symbol that identifies this component, and it also used to selectively grant access to its privileged functions.

Protectedreactions

reactions: Set<Reaction<Variable[]>> = ...

Reactions to trigger.

StaticpathSeparator

pathSeparator: string = "."

Methods

Protected_getContainer

_getFullyQualifiedName

_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

Protected_linkToRuntimeObject

  • _linkToRuntimeObject(): void

  • Request the container to pass down its runtime object to this component. This function is to be called once and only once upon the construction of an object that subclasses Component. If it is called more than once a runtime error results.

    Returns void

Abstract_receiveRuntimeObject

getContainer

AbstractgetManager

  • 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

AbstractisPresent

  • isPresent(): boolean

  • Return whether or not this trigger is present.

    Returns boolean

StatickeyOfMatchingBank

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

Settings

Member Visibility

On This Page

Constructors
Properties
Methods