Class Timer

A timer is an attribute of a reactor which periodically (or just once) creates a timer event. A timer has an offset and a period. Upon initialization the timer will schedule an event at the given offset from starting wall clock time. Whenever this timer's event comes off the event queue, it will reschedule the event at the current logical time + period in the future. A 0 period indicates the timer's event is a one-off and should not be rescheduled.

Hierarchy (view full)

Implements

Constructors

constructor

Properties

_key manager offset period reactions runtime tag value pathSeparator

Methods

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

Constructors

constructor

  • new Timer(__container__, offset, period): Timer

  • Timer constructor.

    Parameters

    • __container__: Reactor

      The reactor this timer is attached to.

    • offset: 0 | TimeValue

      The interval between the start of execution and the first timer event. Cannot be negative.

    • period: 0 | TimeValue

      The interval between rescheduled timer events. If 0, will not reschedule. Cannot be negative.

    Returns Timer

Properties

Protected_key

_key: symbol = ...

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

Protectedmanager

manager: (Anonymous class)<Tag> = ...

offset

offset: TimeValue

period

period: TimeValue

Protectedreactions

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

Reactions to trigger.

Protectedruntime

runtime: Runtime

Protectedtag

tag: undefined | Tag

Protectedvalue

value: undefined | Tag = undefined

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

_receiveRuntimeObject

get

getContainer

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

  • Returns true if this action was scheduled for the current logical time. This result is not affected by whether it has a value.

    Returns boolean

toString

  • toString(): string

  • Returns a string representation of an object.

    Returns string

update

  • update(e): void

  • Update the current value of this timer in accordance with the given event, and trigger any reactions that list this timer as their trigger.

    Parameters

    Returns void

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