From 294793fefb53e09bf780e367bde384a76a440a1d Mon Sep 17 00:00:00 2001 From: lhstrh Date: Tue, 18 Jun 2024 17:56:30 +0000 Subject: [PATCH] lhstrh published a site update --- classes/Action.html | 34 ++--- classes/Alarm.html | 20 +-- classes/App.html | 166 ++++++++++----------- classes/Bank.html | 14 +- classes/CalleePort.html | 34 ++--- classes/CallerPort.html | 34 ++--- classes/Component.html | 28 ++-- classes/Dummy.html | 34 ++--- classes/FederatePortAction.html | 34 ++--- classes/FederatedApp.html | 180 +++++++++++------------ classes/IOPort.html | 42 +++--- classes/InMultiPort.html | 52 +++---- classes/InPort.html | 42 +++--- classes/MultiPort.html | 54 +++---- classes/Mutation.html | 26 ++-- classes/NetworkReceiver.html | 102 ++++++------- classes/NetworkSender.html | 92 ++++++------ classes/OutMultiPort.html | 52 +++---- classes/OutPort.html | 42 +++--- classes/Parameter.html | 4 +- classes/Port.html | 36 ++--- classes/PrecedenceGraph.html | 34 ++--- classes/PrioritySet.html | 16 +- classes/Procedure.html | 28 ++-- classes/Reaction.html | 40 ++--- classes/ReactionGraph.html | 38 ++--- classes/Reactor.html | 114 +++++++------- classes/RemoteFederatePort.html | 4 +- classes/SchedulableAction.html | 4 +- classes/ScheduledTrigger.html | 34 ++--- classes/Shutdown.html | 34 ++--- classes/SortablePrecedenceGraph.html | 38 ++--- classes/Startup.html | 34 ++--- classes/State.html | 10 +- classes/Tag.html | 30 ++-- classes/TaggedEvent.html | 18 +-- classes/TimeValue.html | 32 ++-- classes/Timer.html | 34 ++--- classes/Trigger.html | 32 ++-- classes/WritableMultiPort.html | 4 +- classes/WritablePort.html | 4 +- enums/Log.LogLevel.html | 4 +- enums/Origin.html | 4 +- enums/TimeUnit.html | 4 +- functions/Log.debug.html | 2 +- functions/Log.error.html | 2 +- functions/Log.fatal.html | 2 +- functions/Log.getInstance.html | 2 +- functions/Log.info.html | 2 +- functions/Log.log.html | 2 +- functions/Log.setLevel.html | 2 +- functions/Log.warn.html | 2 +- functions/booleanCLAType.html | 2 +- functions/dontIndent.html | 2 +- functions/getCurrentPhysicalTime.html | 2 +- functions/loggingCLAType.html | 2 +- functions/stringCLAType.html | 2 +- functions/unitBasedTimeValueCLAType.html | 2 +- interfaces/Call.html | 4 +- interfaces/FederateConfig.html | 4 +- interfaces/MultiRead.html | 6 +- interfaces/MultiWrite.html | 6 +- interfaces/MutationSandbox.html | 6 +- interfaces/PrioritySetElement.html | 10 +- interfaces/ProcessedCommandLineArgs.html | 4 +- interfaces/ReactionSandbox.html | 6 +- interfaces/Read.html | 4 +- interfaces/Runtime.html | 4 +- interfaces/Sched.html | 4 +- interfaces/Sortable.html | 4 +- interfaces/TriggerManager.html | 4 +- interfaces/Write.html | 4 +- modules/Log.html | 2 +- types/Absent.html | 2 +- types/ArgList.html | 2 +- types/CommandLineOptionSpec.html | 2 +- types/MultiReadWrite.html | 2 +- types/ParmList.html | 2 +- types/Priority.html | 2 +- types/ReactorClass.html | 2 +- types/ReadWrite.html | 2 +- types/Variable.html | 2 +- variables/BUFFER_SIZE.html | 2 +- variables/CONNECT_NUM_RETRIES.html | 2 +- variables/CONNECT_RETRY_INTERVAL.html | 2 +- variables/CommandLineOptionDefs.html | 2 +- variables/CommandLineUsageDefs.html | 2 +- variables/Log.globalLogger.html | 2 +- variables/Log.hr.html | 2 +- 89 files changed, 924 insertions(+), 924 deletions(-) diff --git a/classes/Action.html b/classes/Action.html index c6f3c307..4a4b4b7c 100644 --- a/classes/Action.html +++ b/classes/Action.html @@ -5,7 +5,7 @@ event or as a delayed response to some input event. The action can be scheduled by a reactor by invoking the schedule function in a reaction or in an asynchronous callback that has been set up in a reaction.

-

Type Parameters

Hierarchy (view full)

Implements

Constructors

constructor +

Type Parameters

  • T

Hierarchy (view full)

Implements

Constructors

constructor

Properties

_key manager minDelay @@ -44,51 +44,51 @@ any events resulting from scheduling this action.

  • minInterArrival: TimeValue = defaultMIT

    Optional. Defaults to 1 nsec. Specifies the minimum intrinsic delay between to occurrences of this action.

    -

    • Returns Action<T>

    Properties

    Protected _key

    _key: symbol = ...

    A symbol that identifies this component, and it also used to selectively +

    Returns Action<T>

    Properties

    Protected _key

    _key: symbol = ...

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

    -

    Protected manager

    manager: __class<T> = ...

    Readonly minDelay

    minDelay: TimeValue

    Readonly minInterArrival

    minInterArrival: TimeValue = defaultMIT

    Readonly origin

    origin: Origin

    Protected reactions

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

    Reactions to trigger.

    -

    Protected runtime

    runtime: Runtime

    Protected scheduler

    scheduler: __class<T, T> = ...

    Protected tag

    tag: undefined | Tag

    Protected value

    value: undefined | T = undefined

    Static pathSeparator

    pathSeparator: string = "."

    Methods

    Protected _getContainer

    _getFullyQualifiedName

    Protected manager

    manager: __class<T> = ...

    Readonly minDelay

    minDelay: TimeValue

    Readonly minInterArrival

    minInterArrival: TimeValue = defaultMIT

    Readonly origin

    origin: Origin

    Protected reactions

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

    Reactions to trigger.

    +

    Protected runtime

    runtime: Runtime

    Protected scheduler

    scheduler: __class<T, T> = ...

    Protected tag

    tag: undefined | Tag

    Protected value

    value: undefined | T = undefined

    Static pathSeparator

    pathSeparator: string = "."

    Methods

    Protected _getContainer

    _getFullyQualifiedName

    _getName

    _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

    _isContainedByContainerOf

    • _isContainedByContainerOf(reactor): boolean

    • Confirm whether or not this component is contained by the container of +

    Returns boolean

    _isContainedByContainerOf

    _isRegistered

    • _isRegistered(): boolean

    • Report whether this component has been registered with its container or not. +

    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

    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

    asSchedulable

    get

    getContainer

    getManager

    _receiveRuntimeObject

    asSchedulable

    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 +

    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

    update

    toString

    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

    Static keyOfMatchingBank

    Static keyOfMatchingEntry

    • keyOfMatchingEntry(component, object): string

    • Given a component and its container (the global object if the component +

    Returns void

    Static keyOfMatchingBank

    Static keyOfMatchingEntry

    • 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

      -

    Static keyOfMatchingMultiport

    Static keyOfMatchingMultiport

    • 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

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/Alarm.html b/classes/Alarm.html index e4125978..775e0852 100644 --- a/classes/Alarm.html +++ b/classes/Alarm.html @@ -1,7 +1,7 @@ Alarm | @lf-lang/reactor-ts

    Class Alarm

    Simple but accurate alarm that makes use of high-resolution timer. The algorithm is inspired by nanotimer, written by Kevin Briggs.

    Author

    Marten Lohstroh (marten@berkeley.edu)

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    active deferredRef hiResDelay @@ -12,20 +12,20 @@ try unset

    Constructors

    constructor

    Properties

    active

    active: boolean = false

    Indicates whether the alarm has been set or not.

    -

    deferredRef

    deferredRef: undefined | Timeout

    Handle for regular timeout, used for delays > 25 ms.

    -

    hiResDelay

    hiResDelay: [number, number] = ...

    The delay interval in high resolution; tuple of seconds and nanoseconds.

    -

    hiResStart

    hiResStart: [number, number] = ...

    Start of the delay interval; tuple of seconds and nanoseconds.

    -

    immediateRef

    immediateRef: undefined | Immediate

    Handle for immediate, used for polling once the remaining delay is < 25 +

    deferredRef

    deferredRef: undefined | Timeout

    Handle for regular timeout, used for delays > 25 ms.

    +

    hiResDelay

    hiResDelay: [number, number] = ...

    The delay interval in high resolution; tuple of seconds and nanoseconds.

    +

    hiResStart

    hiResStart: [number, number] = ...

    Start of the delay interval; tuple of seconds and nanoseconds.

    +

    immediateRef

    immediateRef: undefined | Immediate

    Handle for immediate, used for polling once the remaining delay is < 25 ms.

    -

    loResDelay

    loResDelay: number = 0

    Delay in terms of milliseconds, used when deferring to regular timeout.

    -

    Methods

    set

    loResDelay

    loResDelay: number = 0

    Delay in terms of milliseconds, used when deferring to regular timeout.

    +

    Methods

    set

    • set(task, delay, callback?): void

    • Set the alarm.

      Parameters

      • task: (() => void)

        The task to be performed.

          • (): void

          • Returns void

      • delay: TimeValue

        The time has to elapse before the task can be performed.

      • Optional callback: ((waitTime) => void)

        Optional callback used to report the wait time.

        -
          • (waitTime): void

          • Parameters

            Returns void

      Returns void

    Private try

    • try(task, callback?): void

    • Once the alarm has been initialized, see if the task can be performed or +

        • (waitTime): void

        • Parameters

          Returns void

    Returns void

    Private try

    • try(task, callback?): void

    • Once the alarm has been initialized, see if the task can be performed or a longer wait is necessary.

      Parameters

      • task: (() => void)

        The task to perform.

          • (): void

          • Returns void

      • Optional callback: ((waitTime) => void)

        Optional callback used to report the wait time.

        -
          • (waitTime): void

          • Parameters

            Returns void

      Returns void

    unset

    • unset(): void

    • Disable any scheduled timeouts or immediate events, and set the timer to +

        • (waitTime): void

        • Parameters

          Returns void

    Returns void

    unset

    • unset(): void

    • Disable any scheduled timeouts or immediate events, and set the timer to inactive.

      -

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/App.html b/classes/App.html index 7a34041c..107699f5 100644 --- a/classes/App.html +++ b/classes/App.html @@ -3,7 +3,7 @@ other reactor. Its reactions can consist of altering its own state, sending messages to other reactors, or affecting the environment through some kind of actuation or side effect.

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    __dummy __runtime _active @@ -113,69 +113,69 @@
  • fast: boolean = false

    Optional parameter, if true does not wait for physical time to catch up to logical time.

  • success: (() => void) = ...

    Optional callback to be used to indicate a successful execution.

      • (): void

      • Returns void

  • failure: (() => void) = ...

    Optional callback to be used to indicate a failed execution.

    -
      • (): void

      • Returns void

    • Returns App

    Properties

    Readonly __dummy

    __dummy: Dummy

    This reactor's dummy action.

    -

    Private Readonly __runtime

    __runtime: Runtime = ...

    Inner class that provides access to the Runtime object.

    -

    Protected _active

    _active: boolean = false

    Indicates whether this reactor is active (meaning it has reacted to a +

      • (): void

      • Returns void

    Returns App

    Properties

    Readonly __dummy

    __dummy: Dummy

    This reactor's dummy action.

    +

    Private Readonly __runtime

    __runtime: Runtime = ...

    Inner class that provides access to the Runtime object.

    +

    Protected _active

    _active: boolean = false

    Indicates whether this reactor is active (meaning it has reacted to a startup action), or not (in which case it either never started up or has reacted to a shutdown action).

    -

    Private _advanceMessageInterval

    _advanceMessageInterval: TimeValue = ...

    Interval for snoozing and waking up.

    -

    Readonly _alarm

    _alarm: Alarm = ...

    Private _currentTag

    _currentTag: Tag

    The current time, made available so actions may be scheduled relative to it.

    -

    Protected _dependencyGraph

    _dependencyGraph: PrecedenceGraph<Reaction<Variable[]> | Port<unknown>> = ...

    This graph has in it all the dependencies implied by this container's +

    Private _advanceMessageInterval

    _advanceMessageInterval: TimeValue = ...

    Interval for snoozing and waking up.

    +

    Readonly _alarm

    _alarm: Alarm = ...

    Private _currentTag

    _currentTag: Tag

    The current time, made available so actions may be scheduled relative to it.

    +

    Protected _dependencyGraph

    _dependencyGraph: PrecedenceGraph<Reaction<Variable[]> | Port<unknown>> = ...

    This graph has in it all the dependencies implied by this container's ports, reactions, and connections.

    -

    Private _done

    _done: boolean = false

    Indicates if _finish() was already called. +

    Private _done

    _done: boolean = false

    Indicates if _finish() was already called. This prevents _finish() from being called recursively.

    -

    Private _endOfExecution

    _endOfExecution: undefined | Tag

    The time at which normal execution should terminate. When this time is +

    Private _endOfExecution

    _endOfExecution: undefined | Tag

    The time at which normal execution should terminate. When this time is defined, we can assume that a shutdown event associated with this time has been scheduled.

    -

    Protected Optional _errorMessage

    _errorMessage?: string

    Protected _errored

    _errored: boolean = false

    Private Readonly _eventQ

    _eventQ: EventQueue = ...

    Priority set that keeps track of scheduled events.

    -

    Private Readonly _executionTimeout

    _executionTimeout: undefined | TimeValue

    If not null, finish execution with success, this time interval after the +

    Protected Optional _errorMessage

    _errorMessage?: string

    Protected _errored

    _errored: boolean = false

    Private Readonly _eventQ

    _eventQ: EventQueue = ...

    Priority set that keeps track of scheduled events.

    +

    Private Readonly _executionTimeout

    _executionTimeout: undefined | TimeValue

    If not null, finish execution with success, this time interval after the start of execution.

    -

    Private Readonly _fast

    _fast: boolean

    If false, execute with normal delays to allow physical time to catch up +

    Private Readonly _fast

    _fast: boolean

    If false, execute with normal delays to allow physical time to catch up to logical time. If true, don't wait for physical time to match logical time.

    -

    Protected _immediateRef

    _immediateRef: undefined | Immediate

    Reference to "immediate" invocation of next.

    -

    Private _isDone

    _isDone: boolean = false

    Stores whether the current tag's reactions queue is empty. +

    Protected _immediateRef

    _immediateRef: undefined | Immediate

    Reference to "immediate" invocation of next.

    +

    Private _isDone

    _isDone: boolean = false

    Stores whether the current tag's reactions queue is empty. This will be false when a federate waits for network inputs. Note that this should be initialized with false to handle startup reactions of each federate.

    -

    Protected _isLastTAGProvisional

    _isLastTAGProvisional: boolean = false

    Stores whether the last received TAG (Tag Advance Grant) was provisional. +

    Protected _isLastTAGProvisional

    _isLastTAGProvisional: boolean = false

    Stores whether the last received TAG (Tag Advance Grant) was provisional. Every federate starts out assuming that it has been granted a PTAG at the start time, or if it has no upstream federates, a TAG.

    -

    Protected _keepAlive

    _keepAlive: boolean = false

    Indicates whether the program should continue running once the event +

    Protected _keepAlive

    _keepAlive: boolean = false

    Indicates whether the program should continue running once the event queue is empty.

    -

    Protected _key

    _key: symbol = ...

    A symbol that identifies this component, and it also used to selectively +

    Protected _key

    _key: symbol = ...

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

    -

    Readonly _name

    _name: string

    Protected Readonly _reactionQ

    _reactionQ: ReactionQueue = ...

    Priority set that keeps track of reactions at the current Logical time.

    -

    Private Readonly _reactionsAtStartup

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

    Set of reactions to stage when this app starts executing.

    -

    Private Readonly _reactorsToRemove

    _reactorsToRemove: Reactor[] = ...

    Set of reactors that gets populated during each execution step, +

    Readonly _name

    _name: string

    Protected Readonly _reactionQ

    _reactionQ: ReactionQueue = ...

    Priority set that keeps track of reactions at the current Logical time.

    +

    Private Readonly _reactionsAtStartup

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

    Set of reactions to stage when this app starts executing.

    +

    Private Readonly _reactorsToRemove

    _reactorsToRemove: Reactor[] = ...

    Set of reactors that gets populated during each execution step, identifying all the terminated reactors that are to be removed at the end of that execution step.

    -

    Private _startOfExecution

    _startOfExecution: TimeValue

    The physical time when execution began relative to January 1, 1970 00:00:00 UTC. +

    Private _startOfExecution

    _startOfExecution: TimeValue

    The physical time when execution began relative to January 1, 1970 00:00:00 UTC. Initialized in start().

    -

    Private Readonly _timersToSchedule

    _timersToSchedule: Set<Timer> = ...

    Set of timers to schedule when this app starts executing.

    -

    Readonly _uuid

    _uuid: string = ...

    failure

    failure: (() => void) = ...

    Optional callback to be used to indicate a failed execution.

    +

    Private Readonly _timersToSchedule

    _timersToSchedule: Set<Timer> = ...

    Set of timers to schedule when this app starts executing.

    +

    Readonly _uuid

    _uuid: string = ...

    failure

    failure: (() => void) = ...

    Optional callback to be used to indicate a failed execution.

    Type declaration

      • (): void

      • Optional callback to be used to indicate a failed execution.

        -

        Returns void

    Readonly shutdown

    shutdown: Shutdown

    This reactor's shutdown action.

    -

    Private Readonly snooze

    snooze: Action<Tag>

    Readonly startup

    startup: Startup

    This reactor's startup action.

    -

    success

    success: (() => void) = ...

    Optional callback to be used to indicate a successful execution.

    +

    Returns void

    Readonly shutdown

    shutdown: Shutdown

    This reactor's shutdown action.

    +

    Private Readonly snooze

    snooze: Action<Tag>

    Readonly startup

    startup: Startup

    This reactor's startup action.

    +

    success

    success: (() => void) = ...

    Optional callback to be used to indicate a successful execution.

    Type declaration

      • (): void

      • Optional callback to be used to indicate a successful execution.

        -

        Returns void

    Protected util

    util: UtilityFunctions = ...

    Inner class that provides access to utilities that are safe to expose to +

    Returns void

    Protected util

    util: UtilityFunctions = ...

    Inner class that provides access to utilities that are safe to expose to reaction code.

    -

    Static pathSeparator

    pathSeparator: string = "."

    Methods

    Protected _addDummyEvent

    Static pathSeparator

    pathSeparator: string = "."

    Methods

    Protected _addDummyEvent

    • _addDummyEvent(tag): void

    • Add a dummy event to the event queue. Currently, the sole usage of this is to ensure LET to be sent to the RTI when there is any physical action triggering output port(s) in federated execution.

      Parameters

      • tag: Tag

        The tag at which this dummy event occurs.

        -

      Returns void

    Protected _advanceTime

    • _advanceTime(nextTag): void

    • Set the current tag to be the next tag.

      -

      Parameters

      Returns void

    Protected _analyzeDependencies

    • _analyzeDependencies(): void

    • Analyze the dependencies between reactions in this app.

      +

    Returns void

    Protected _advanceTime

    • _advanceTime(nextTag): void

    • Set the current tag to be the next tag.

      +

      Parameters

      Returns void

    Protected _analyzeDependencies

    • _analyzeDependencies(): void

    • Analyze the dependencies between reactions in this app.

      Assign priorities that encode the precedence relations between reactions. If there exist circular dependencies, throw an exception. This method should only be invoked prior to the start of execution, never during execution.

      -

      Returns void

    Protected _canProceed

    • _canProceed(event): boolean

    • Check whether the next event can be handled or not.

      +

      Returns void

    Protected _canProceed

    • _canProceed(event): boolean

    • Check whether the next event can be handled or not.

      In a non-federated context this method always returns true.

      Parameters

      • event: TaggedEvent<unknown>

        The next event to be processed.

        -

      Returns boolean

    Protected _cancelNext

    • _cancelNext(): void

    • Disable the alarm and clear possible immediate next.

      -

      Returns void

    Protected _connect

    • _connect<R, S>(src, dst): void

    • Connect a source port to a downstream destination port. If a source is a +

    Returns boolean

    Protected _cancelNext

    • _cancelNext(): void

    • Disable the alarm and clear possible immediate next.

      +

      Returns void

    Protected _connect

    • _connect<R, S>(src, dst): void

    • Connect a source port to a downstream destination port. If a source is a regular port, then the type variable of the source has to be a subtype of the type variable of the destination. If the source is a caller port, then the destination has to be a callee port that is effectively a @@ -185,9 +185,9 @@ the caller's.

      Type Parameters

      • R

      • S

      Parameters

      • src: IOPort<S>

        The source port to connect.

      • dst: IOPort<R>

        The destination port to connect.

        -

      Returns void

    Protected _connectCall

    Protected _connectMulti

    _deregister

    • _deregister(reactor, key): void

    • Remove the given reactor and its connections from this container if +

    Returns void

    Protected _connectCall

    Protected _connectMulti

    _deregister

    • _deregister(reactor, key): void

    • Remove the given reactor and its connections from this container if the key matches.

      -

      Parameters

      Returns void

    Protected _determineStartAndEndOfExecution

    • _determineStartAndEndOfExecution(startTime): void

    • Set the logical start time of the execution according to the given time +

      Parameters

      Returns void

    Protected _determineStartAndEndOfExecution

    • _determineStartAndEndOfExecution(startTime): void

    • Set the logical start time of the execution according to the given time value. If an execution timeout is defined, also determine the end of execution is as the start time plus the execution timeout. This method also marks the app as "active" and initializes any timers that may have @@ -195,18 +195,18 @@

      Parameters

      • startTime: TimeValue

        The beginning of this app's execution. The end of execution is determined relative to this TimeValue is a timeout has been set.

        -

      Returns void

    Protected _disconnect

    • _disconnect<R, S>(src, dst?): void

    • Delete the connection between the source and destination nodes. +

    Returns void

    Protected _disconnect

    • _disconnect<R, S>(src, dst?): void

    • Delete the connection between the source and destination nodes. If the destination node is not specified, all connections from the source node to any other node are deleted.

      Type Parameters

      • R

      • S

      Parameters

      • src: IOPort<S>

        Source port of connection to be disconnected.

      • Optional dst: IOPort<R>

        Destination port of connection to be disconnected. If undefined, disconnect all connections from the source port.

        -

      Returns void

    Protected _finish

    • _finish(): void

    • Wrap up execution by logging information and reporting errors if applicable.

      -

      Returns void

    Protected _getCausalityInterface

    • _getCausalityInterface(): PrecedenceGraph<Port<unknown>>

    • Return a dependency graph consisting of only this reactor's own ports +

    Returns void

    Protected _finish

    • _finish(): void

    • Wrap up execution by logging information and reporting errors if applicable.

      +

      Returns void

    Protected _getCausalityInterface

    Protected _getContainer

    Protected _getEndOfExecution

    • _getEndOfExecution(): undefined | Tag

    • Getter for _endOfExecution to be used used by the subclass, FederatedApp.

      -

      Returns undefined | Tag

    Protected _getFirstReactionOrMutation

    _getFullyQualifiedName

    Protected _getContainer

    Protected _getEndOfExecution

    • _getEndOfExecution(): undefined | Tag

    • Getter for _endOfExecution to be used used by the subclass, FederatedApp.

      +

      Returns undefined | Tag

    Protected _getFirstReactionOrMutation

    _getFullyQualifiedName

    _getKey

    _getKey

    • _getKey(component, key?): undefined | symbol

    • If the given component is owned by this reactor, look up its key and return it. Otherwise, if a key has been provided, and it matches the key of this reactor, also look up the component's key and return it. Otherwise, if the component is owned by a reactor that is owned by @@ -216,15 +216,15 @@

      Parameters

      • component: Trigger

        The component to look up the key for.

      • Optional key: symbol

        The key that verifies the containment relation between this reactor and the component, with at most one level of indirection.

        -

      Returns undefined | symbol

    Protected _getLastMutation

    • _getLastMutation(): undefined | Mutation<Variable[]>

    • Return the last mutation of this reactor. All contained reactors +

    Returns undefined | symbol

    Protected _getLastMutation

    Protected _getLastReactionOrMutation

    Protected _getMutations

    Protected _getLastReactionOrMutation

    Protected _getMutations

    _getName

    _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

    Protected _getPrecedenceGraph

    Protected _getPrecedenceGraph

    • _getPrecedenceGraph(depth?): PrecedenceGraph<Reaction<Variable[]> | Port<unknown>>

    • Recursively collect the local dependency graph of each contained reactor and merge them all in one graph.

      The recursion depth can be limited via the depth parameter. A depth of 0 will only return the local dependency graph of this reactor, a depth @@ -238,31 +238,31 @@

    • RPCs occur in a deterministic order.

    Parameters

    • depth: number = -1

      The depth of recursion.

      -

    Returns PrecedenceGraph<Reaction<Variable[]> | Port<unknown>>

    _getReactionIndex

    • _getReactionIndex(reaction): number

    • Return the index of the reaction given as an argument.

      +

    Returns PrecedenceGraph<Reaction<Variable[]> | Port<unknown>>

    _getReactionIndex

    Protected _getReactions

    Protected _getReactionsAndMutations

    Protected _initializeMutationScope

    Protected _initializeReactionScope

    _isContainedBy

    • _isContainedBy(reactor): boolean

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

      +

    Returns number

    Protected _getReactions

    Protected _getReactionsAndMutations

    Protected _initializeMutationScope

    Protected _initializeReactionScope

    _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 +

    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

    _isDownstream

    • _isDownstream(port): boolean

    • Report whether the given port is downstream of this reactor. If so, the +

    Returns boolean

    _isDownstream

    • _isDownstream(port): boolean

    • Report whether the given port is downstream of this reactor. If so, the given port can be connected to with an output port of this reactor.

      -

      Parameters

      Returns boolean

    _isRegistered

    _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

    _isUpstream

    _isUpstream

    • _isUpstream(port): boolean

    • Report whether the given port is upstream of this reactor. If so, the given port can be connected to an input port of this reactor.

      -

      Parameters

      Returns boolean

    Protected _iterationComplete

    Protected _linkToRuntimeObject

    • _linkToRuntimeObject(): void

    • Request the container to pass down its runtime object to this component. +

      Parameters

      Returns boolean

    Protected _iterationComplete

    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

    Protected _loadStartupReactions

    Protected _loadStartupReactions

    • _loadStartupReactions(): void

    • Load all reactions that were staged for immediate execution during this app's instantiation onto the reaction queue.

      -

      Returns void

    Private _next

    Private _next

    • _next(): void

    • Handle the next events on the event queue.

      Wait until physical time matches or exceeds the time of the least tag on the event queue. After this wait, load the reactions triggered by all events with the least tag onto the reaction queue and start executing reactions in topological order. Each reaction may produce outputs, which, @@ -276,43 +276,43 @@ computation has caught up, full control is given back to the JS event loop. This prevents the system from being overwhelmed with external stimuli.

      -

      Returns void

    Private _popEvents

    • _popEvents(): void

    • Pop all events from event_q with timestamp equal to current tag, +

      Returns void

    Private _popEvents

    • _popEvents(): void

    • Pop all events from event_q with timestamp equal to current tag, extract all the reactions triggered by these events, and stick them into the reaction queue.

      -

      Returns void

    Protected _react

    • _react(): boolean

    • Iterate over all reactions in the reaction queue and execute them.

      +

      Returns void

    Protected _react

    • _react(): boolean

    • Iterate over all reactions in the reaction queue and execute them.

      Returns boolean

      Whether every reactions at this tag are executed. This can be false in the federated exection.

      -

    _receiveRuntimeObject

    • _receiveRuntimeObject(runtime): void

    • Receive the runtime object from the container of this reactor. +

    _receiveRuntimeObject

    • _receiveRuntimeObject(runtime): void

    • Receive the runtime object from the container of this reactor. Invoking this method in any user-written code will result in a runtime error.

      Parameters

      • runtime: Runtime

        The runtime object handed down from the container.

        -

      Returns void

    _register

    • _register(component, key): void

    • Add a component to this container.

      +

    Returns void

    _register

    • _register(component, key): void

    • Add a component to this container.

      A component that is created as part of this reactor invokes this method upon creation.

      Parameters

      • component: Component

        The component to register.

      • key: symbol

        The component's key.

        -

      Returns void

    Protected _requestImmediateInvocationOfNext

    • _requestImmediateInvocationOfNext(): void

    • Request an immediate invocation of this._next().

      -

      Returns void

    _requestRuntimeObject

    Protected _setAlarmOrYield

    Protected _setEndOfExecution

    • _setEndOfExecution(stopTag): void

    • Setter for _endOfExecution to be used used by the subclass, FederatedApp.

      -

      Parameters

      Returns void

    Protected _shutdown

    • _shutdown(): void

    • Schedule a shutdown event at the current time if no such action has been taken yet. +

    Returns void

    Protected _requestImmediateInvocationOfNext

    • _requestImmediateInvocationOfNext(): void

    • Request an immediate invocation of this._next().

      +

      Returns void

    _requestRuntimeObject

    Protected _setAlarmOrYield

    Protected _setEndOfExecution

    • _setEndOfExecution(stopTag): void

    • Setter for _endOfExecution to be used used by the subclass, FederatedApp.

      +

      Parameters

      Returns void

    Protected _shutdown

    • _shutdown(): void

    • Schedule a shutdown event at the current time if no such action has been taken yet. Clear the alarm, and set the end of execution to be the current tag.

      -

      Returns void

    _start

    Protected _startExecuting

    Protected _startTimeStep

    • _startTimeStep(): void

    • Do the steps needed for the new logical tag. +

      Returns void

    _start

    Protected _startExecuting

    Protected _startTimeStep

    • _startTimeStep(): void

    • Do the steps needed for the new logical tag. This function is overriden by federation.ts.

      -

      Returns void

    Protected _unplug

    • _unplug(): void

    • Remove this reactor from its container and sever any connections it may +

      Returns void

    Protected _unplug

    • _unplug(): void

    • Remove this reactor from its container and sever any connections it may still have. This reactor will become defunct and is ready for garbage collection.

      -

      Returns void

    Protected _unsetTimer

    Protected _unsetTimer

    Protected _unsetTimers

    Protected addMutation

    Protected addReaction

    • addReaction<T>(trigs, args, react, deadline?, late?): void

    • Add a reaction to this reactor. Each newly added reaction will acquire a +

    Returns void

    Protected _unsetTimers

    Protected addMutation

    Protected addReaction

    • addReaction<T>(trigs, args, react, deadline?, late?): void

    • Add a reaction to this reactor. Each newly added reaction will acquire a dependency either on the previously added reaction, or on the last added mutation (in case no reactions had been added prior to this one). A reaction is specified by a list of triggers, a list of arguments, a react function, an optional deadline, and an optional late function (which represents the reaction body of the deadline). All triggers a reaction needs access must be included in the arguments.

      -

      Type Parameters

      Parameters

      Returns void

    allWritable

    canConnect

    allWritable

    canConnect

    • canConnect<R, S>(src, dst): boolean

    • Returns true if a given source port can be connected to the given destination port, false otherwise. Valid connections must: (1) adhere to the scoping rules and connectivity constraints @@ -327,39 +327,39 @@

    Type Parameters

    • R

    • S

    Parameters

    • src: IOPort<S>

      The start point of a new connection.

    • dst: IOPort<R>

      The end point of a new connection.

      -

    Returns boolean

    canConnectCall

    getBankIndex

    • getBankIndex(): number

    • Return the location of the reactor instance in a bank, +

    Returns boolean

    canConnectCall

    getBankIndex

    • getBankIndex(): number

    • Return the location of the reactor instance in a bank, if it is a member of one; return -1 otherwise.

      -

      Returns number

    Protected nextReaction

    Protected nextReaction

    Protected prevReaction

    • prevReaction(reaction): undefined | Reaction<Variable[]>

    • Given a reaction, return the reaction within this reactor that directly +

    Returns undefined | Reaction<Variable[]>

    Protected prevReaction

    Protected schedulable

    Protected sendRTIMessage

    • sendRTIMessage<T>(data, destFederateID, destPortID): void

    • Send an (untimed) message to the designated federate port through the RTI. +

    Returns undefined | Reaction<Variable[]>

    Protected schedulable

    Protected sendRTIMessage

    • sendRTIMessage<T>(data, destFederateID, destPortID): void

    • Send an (untimed) message to the designated federate port through the RTI. This function throws an error if it isn't called on a FederatedApp.

      Type Parameters

      • T

      Parameters

      • data: T

        The data that contain the body of the message.

      • destFederateID: number

        The federate ID that is the destination of this message.

      • destPortID: number

        The port ID that is the destination of this message.

        -

      Returns void

    Protected sendRTIPortAbsent

    • sendRTIPortAbsent(destFederateID, destPortID, additionalDelay): void

    • Send a port absent message to the destination port. +

    Returns void

    Protected sendRTIPortAbsent

    • sendRTIPortAbsent(destFederateID, destPortID, additionalDelay): void

    • Send a port absent message to the destination port. This function throws an error if it isn't called on a FederatedApp.

      Parameters

      • destFederateID: number
      • destPortID: number

        The ID of the receiving port.

        -
      • additionalDelay: undefined | TimeValue

      Returns void

    Protected sendRTITimedMessage

    • sendRTITimedMessage<T>(data, destFederateID, destPortID, time): void

    • Send a (timed) message to the designated federate port through the RTI. +

    • additionalDelay: undefined | TimeValue

    Returns void

    Protected sendRTITimedMessage

    • sendRTITimedMessage<T>(data, destFederateID, destPortID, time): void

    • Send a (timed) message to the designated federate port through the RTI. This function throws an error if it isn't called on a FederatedApp.

      Type Parameters

      • T

      Parameters

      • data: T

        The data that contain the body of the message.

      • destFederateID: number

        The federate ID that is the destination of this message.

      • destPortID: number

        The port ID that is the destination of this message.

        -
      • time: undefined | TimeValue

      Returns void

    setAdvanceMessageInterval

    toString

    writable

    Static keyOfMatchingBank

    Static keyOfMatchingEntry

    • keyOfMatchingEntry(component, object): string

    • Given a component and its container (the global object if the component +

    • time: undefined | TimeValue

    Returns void

    setAdvanceMessageInterval

    toString

    writable

    Static keyOfMatchingBank

    Static keyOfMatchingEntry

    • 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

      -

    Static keyOfMatchingMultiport

    Static keyOfMatchingMultiport

    • 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

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/Bank.html b/classes/Bank.html index 787fe85a..3e59ffdf 100644 --- a/classes/Bank.html +++ b/classes/Bank.html @@ -1,5 +1,5 @@ Bank | @lf-lang/reactor-ts

    Class Bank<T, S>

    A bank of reactor instances.

    -

    Type Parameters

    Constructors

    constructor +

    Type Parameters

    Constructors

    constructor

    Properties

    members initializationMap

    Methods

    all @@ -12,15 +12,15 @@

    Type Parameters

    Parameters

    • container: Reactor
    • width: number

      the width of the bank

    • cls: ReactorClass<T, S>

      the class to construct reactor instances of that will populate the bank

    • Rest ...parameters: ParmList<S>

      the arguments to pass into the constructor of the given reactor class

      -

    Returns Bank<T, S>

    Properties

    Private Readonly members

    members: T[] = ...

    Array of reactor instances that constitute the bank.

    -

    Static Readonly initializationMap

    initializationMap: Map<Reactor, number> = ...

    A mapping from containing reactors to indices corresponding to the member +

    Returns Bank<T, S>

    Properties

    Private Readonly members

    members: T[] = ...

    Array of reactor instances that constitute the bank.

    +

    Static Readonly initializationMap

    initializationMap: Map<Reactor, number> = ...

    A mapping from containing reactors to indices corresponding to the member of a contained bank that is currently being initialized (if there is one).

    -

    Methods

    all

    • all(): T[]

    • Return all reactor instances in this bank.

      +

    Methods

    all

    • all(): T[]

    • Return all reactor instances in this bank.

      Returns T[]

      all reactor instances in this bank

      -

    allWritable

    get

    • get(index): T

    • Return the reactor instance that corresponds to the given index.

      +

    allWritable

    get

    • get(index): T

    • Return the reactor instance that corresponds to the given index.

      Parameters

      • index: number

        index of the reactor instance inside this bank

      Returns T

      the reactor instances that corresponds to the given index

      -

    port

    • port<P>(selector): P[]

    • Return a list of ports selected across all bank members by the given lambda.

      +

    port

    • port<P>(selector): P[]

    • Return a list of ports selected across all bank members by the given lambda.

      Type Parameters

      Parameters

      • selector: ((reactor) => P)

        lambda function that takes a reactor of type T and return a port of type P

          • (reactor): P

          • Parameters

            • reactor: T

            Returns P

      Returns P[]

      a list of ports selected across all bank members by the given lambda

      -

    toString

    writable

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    toString

    writable

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/CalleePort.html b/classes/CalleePort.html index abbd72eb..099ff3b1 100644 --- a/classes/CalleePort.html +++ b/classes/CalleePort.html @@ -1,5 +1,5 @@ CalleePort | @lf-lang/reactor-ts

    Class CalleePort<A, R>

    A callee port receives arguments of type A and send a response of type R.

    -

    Type Parameters

    • A

    • R

    Hierarchy (view full)

    Implements

    Constructors

    constructor +

    Type Parameters

    • A

    • R

    Hierarchy (view full)

    Implements

    Constructors

    constructor

    Properties

    _key argValue lastCaller @@ -31,43 +31,43 @@ keyOfMatchingBank keyOfMatchingEntry keyOfMatchingMultiport -

    Constructors

    constructor

    Properties

    Protected _key

    _key: symbol = ...

    A symbol that identifies this component, and it also used to selectively +

    Constructors

    constructor

    Properties

    Protected _key

    _key: symbol = ...

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

    -

    argValue

    argValue: undefined | A

    Protected lastCaller

    lastCaller: undefined | Reaction<Variable[]>

    Protected manager

    manager: CalleeManager = ...

    Protected procedure

    procedure: undefined | Procedure<Variable[]>

    Protected reactions

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

    Reactions to trigger.

    -

    Protected receivers

    receivers: Set<WritablePort<A>> = ...

    retValue

    retValue: undefined | R

    Protected runtime

    runtime: Runtime

    Protected tag

    tag: undefined | Tag

    The tag associated with this port's value, or undefined is there is none.

    -

    Protected value

    value: undefined | A

    The current value associated with this port.

    -

    Static pathSeparator

    pathSeparator: string = "."

    Methods

    Protected _getContainer

    _getFullyQualifiedName

    argValue

    argValue: undefined | A

    Protected lastCaller

    lastCaller: undefined | Reaction<Variable[]>

    Protected manager

    manager: CalleeManager = ...

    Protected procedure

    procedure: undefined | Procedure<Variable[]>

    Protected reactions

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

    Reactions to trigger.

    +

    Protected receivers

    receivers: Set<WritablePort<A>> = ...

    retValue

    retValue: undefined | R

    Protected runtime

    runtime: Runtime

    Protected tag

    tag: undefined | Tag

    The tag associated with this port's value, or undefined is there is none.

    +

    Protected value

    value: undefined | A

    The current value associated with this port.

    +

    Static pathSeparator

    pathSeparator: string = "."

    Methods

    Protected _getContainer

    _getFullyQualifiedName

    _getName

    _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.

      +

      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 +

    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. +

    Returns boolean

    _isRegistered

    Protected _linkToRuntimeObject

    Protected _linkToRuntimeObject

    _receiveRuntimeObject

    get

    getContainer

    getManager

    invoke

    isPresent

    return

    set

    toString

    Static keyOfMatchingBank

    Static keyOfMatchingEntry

    _receiveRuntimeObject

    get

    getContainer

    getManager

    invoke

    isPresent

    return

    set

    toString

    Static keyOfMatchingBank

    Static keyOfMatchingEntry

    Static keyOfMatchingMultiport

    Static keyOfMatchingMultiport

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/CallerPort.html b/classes/CallerPort.html index febccb46..38fa1fcb 100644 --- a/classes/CallerPort.html +++ b/classes/CallerPort.html @@ -1,5 +1,5 @@ CallerPort | @lf-lang/reactor-ts

    Class CallerPort<A, R>

    A caller port sends arguments of type T and receives a response of type R.

    -

    Type Parameters

    • A

    • R

    Hierarchy (view full)

    Implements

    Constructors

    constructor +

    Type Parameters

    • A

    • R

    Hierarchy (view full)

    Implements

    Constructors

    constructor

    Properties

    _key manager reactions @@ -27,43 +27,43 @@ keyOfMatchingBank keyOfMatchingEntry keyOfMatchingMultiport -

    Constructors

    constructor

    Properties

    Protected _key

    _key: symbol = ...

    A symbol that identifies this component, and it also used to selectively +

    Constructors

    constructor

    Properties

    Protected _key

    _key: symbol = ...

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

    -

    Protected manager

    manager: TriggerManager = ...

    Protected reactions

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

    Reactions to trigger.

    -

    Protected receivers

    receivers: Set<WritablePort<R>> = ...

    remotePort

    remotePort: undefined | CalleePort<A, R>

    Protected runtime

    runtime: Runtime

    Protected tag

    tag: undefined | Tag

    The tag associated with this port's value, or undefined is there is none.

    -

    Protected value

    value: undefined | R

    The current value associated with this port.

    -

    Static pathSeparator

    pathSeparator: string = "."

    Methods

    Protected _getContainer

    _getFullyQualifiedName

    Protected manager

    manager: TriggerManager = ...

    Protected reactions

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

    Reactions to trigger.

    +

    Protected receivers

    receivers: Set<WritablePort<R>> = ...

    remotePort

    remotePort: undefined | CalleePort<A, R>

    Protected runtime

    runtime: Runtime

    Protected tag

    tag: undefined | Tag

    The tag associated with this port's value, or undefined is there is none.

    +

    Protected value

    value: undefined | R

    The current value associated with this port.

    +

    Static pathSeparator

    pathSeparator: string = "."

    Methods

    Protected _getContainer

    _getFullyQualifiedName

    _getName

    _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.

      +

      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 +

    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. +

    Returns boolean

    _isRegistered

    Protected _linkToRuntimeObject

    Protected _linkToRuntimeObject

    _receiveRuntimeObject

    get

    getContainer

    getManager

    invoke

    isPresent

    set

    toString

    Static keyOfMatchingBank

    Static keyOfMatchingEntry

    _receiveRuntimeObject

    get

    getContainer

    getManager

    invoke

    isPresent

    set

    toString

    Static keyOfMatchingBank

    Static keyOfMatchingEntry

    Static keyOfMatchingMultiport

    Static keyOfMatchingMultiport

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/Component.html b/classes/Component.html index 15c4aea3..589328fa 100644 --- a/classes/Component.html +++ b/classes/Component.html @@ -4,7 +4,7 @@ ports, actions, timers, or reactor instances that may be part of the interface of a Reactor, which extends this class.

    Author

    Marten Lohstroh (marten@berkeley.edu)

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    _container _key pathSeparator @@ -26,42 +26,42 @@

    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 Component

    Properties

    Private Readonly _container

    _container: Reactor

    The container of this component. Each component is contained by a +

    Returns Component

    Properties

    Private Readonly _container

    _container: Reactor

    The container of this component. Each component is contained by a reactor. Only instances of App, which denote top-level reactors, are self-contained.

    -

    Protected _key

    _key: symbol = ...

    A symbol that identifies this component, and it also used to selectively +

    Protected _key

    _key: symbol = ...

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

    -

    Static pathSeparator

    pathSeparator: string = "."

    Methods

    Protected _getContainer

    _getFullyQualifiedName

    • _getFullyQualifiedName(): string

    • Return a string that identifies this component. +

    Static pathSeparator

    pathSeparator: string = "."

    Methods

    Protected _getContainer

    _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. +

      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.

      +

      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 +

    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. +

    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. +

      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

    • _receiveRuntimeObject(runtime): void

    • Store a reference to the given runtime object as a private class member.

      -

      Parameters

      Returns void

    Static keyOfMatchingBank

    Static keyOfMatchingEntry

    • keyOfMatchingEntry(component, object): string

    • Given a component and its container (the global object if the component +

      Returns void

    Abstract _receiveRuntimeObject

    • _receiveRuntimeObject(runtime): void

    • Store a reference to the given runtime object as a private class member.

      +

      Parameters

      Returns void

    Static keyOfMatchingBank

    Static keyOfMatchingEntry

    • 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

      -

    Static keyOfMatchingMultiport

    • keyOfMatchingMultiport(port, reactor): string

    • Given a port and its containing reactor, return the key of the entry that matches +

    Static keyOfMatchingMultiport

    • 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

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/Dummy.html b/classes/Dummy.html index 61b5f92b..5828e8cc 100644 --- a/classes/Dummy.html +++ b/classes/Dummy.html @@ -5,7 +5,7 @@ event or as a delayed response to some input event. The action can be scheduled by a reactor by invoking the schedule function in a reaction or in an asynchronous callback that has been set up in a reaction.

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    _key manager minDelay @@ -35,51 +35,51 @@ keyOfMatchingBank keyOfMatchingEntry keyOfMatchingMultiport -

    Constructors

    constructor

    Properties

    Protected _key

    _key: symbol = ...

    A symbol that identifies this component, and it also used to selectively +

    Constructors

    constructor

    Properties

    Protected _key

    _key: symbol = ...

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

    -

    Protected manager

    manager: __class<unknown> = ...

    Readonly minDelay

    minDelay: TimeValue

    Readonly minInterArrival

    minInterArrival: TimeValue = defaultMIT

    Readonly origin

    origin: Origin

    Protected reactions

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

    Reactions to trigger.

    -

    Protected runtime

    runtime: Runtime

    Protected scheduler

    scheduler: __class<unknown, unknown> = ...

    Protected tag

    tag: undefined | Tag

    Protected value

    value: unknown = undefined

    Static pathSeparator

    pathSeparator: string = "."

    Methods

    Protected _getContainer

    _getFullyQualifiedName

    Protected manager

    manager: __class<unknown> = ...

    Readonly minDelay

    minDelay: TimeValue

    Readonly minInterArrival

    minInterArrival: TimeValue = defaultMIT

    Readonly origin

    origin: Origin

    Protected reactions

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

    Reactions to trigger.

    +

    Protected runtime

    runtime: Runtime

    Protected scheduler

    scheduler: __class<unknown, unknown> = ...

    Protected tag

    tag: undefined | Tag

    Protected value

    value: unknown = undefined

    Static pathSeparator

    pathSeparator: string = "."

    Methods

    Protected _getContainer

    _getFullyQualifiedName

    _getName

    _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.

      +

      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 +

    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. +

    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

    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

    asSchedulable

    get

    getContainer

    getManager

    _receiveRuntimeObject

    asSchedulable

    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 +

    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

    update

    toString

    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

    Static keyOfMatchingBank

    Static keyOfMatchingEntry

    • keyOfMatchingEntry(component, object): string

    • Given a component and its container (the global object if the component +

    Returns void

    Static keyOfMatchingBank

    Static keyOfMatchingEntry

    • 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

      -

    Static keyOfMatchingMultiport

    Static keyOfMatchingMultiport

    • 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

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/FederatePortAction.html b/classes/FederatePortAction.html index 9779b75f..4a7e1599 100644 --- a/classes/FederatePortAction.html +++ b/classes/FederatePortAction.html @@ -5,7 +5,7 @@ event or as a delayed response to some input event. The action can be scheduled by a reactor by invoking the schedule function in a reaction or in an asynchronous callback that has been set up in a reaction.

    -

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor +

    Type Parameters

    • T

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    _key manager minDelay @@ -35,51 +35,51 @@ keyOfMatchingBank keyOfMatchingEntry keyOfMatchingMultiport -

    Constructors

    constructor

    Properties

    Protected _key

    _key: symbol = ...

    A symbol that identifies this component, and it also used to selectively +

    Constructors

    constructor

    Properties

    Protected _key

    _key: symbol = ...

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

    -

    Protected manager

    manager: __class<T> = ...

    Readonly minDelay

    minDelay: TimeValue

    Readonly minInterArrival

    minInterArrival: TimeValue = defaultMIT

    Readonly origin

    origin: Origin

    Protected reactions

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

    Reactions to trigger.

    -

    Protected runtime

    runtime: Runtime

    Protected scheduler

    scheduler: __class<T, T> = ...

    Protected tag

    tag: undefined | Tag

    Protected value

    value: undefined | T = undefined

    Static pathSeparator

    pathSeparator: string = "."

    Methods

    Protected _getContainer

    _getFullyQualifiedName

    Protected manager

    manager: __class<T> = ...

    Readonly minDelay

    minDelay: TimeValue

    Readonly minInterArrival

    minInterArrival: TimeValue = defaultMIT

    Readonly origin

    origin: Origin

    Protected reactions

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

    Reactions to trigger.

    +

    Protected runtime

    runtime: Runtime

    Protected scheduler

    scheduler: __class<T, T> = ...

    Protected tag

    tag: undefined | Tag

    Protected value

    value: undefined | T = undefined

    Static pathSeparator

    pathSeparator: string = "."

    Methods

    Protected _getContainer

    _getFullyQualifiedName

    _getName

    _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.

      +

      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 +

    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. +

    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

    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

    asSchedulable

    get

    getContainer

    getManager

    _receiveRuntimeObject

    asSchedulable

    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 +

    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

    update

    toString

    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

    Static keyOfMatchingBank

    Static keyOfMatchingEntry

    • keyOfMatchingEntry(component, object): string

    • Given a component and its container (the global object if the component +

    Returns void

    Static keyOfMatchingBank

    Static keyOfMatchingEntry

    • 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

      -

    Static keyOfMatchingMultiport

    Static keyOfMatchingMultiport

    • 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

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/FederatedApp.html b/classes/FederatedApp.html index b1ee9f20..73145f33 100644 --- a/classes/FederatedApp.html +++ b/classes/FederatedApp.html @@ -8,7 +8,7 @@ advancing time, and exchanging messages with other federates.

    Note: There is no special class for a federate. A federate is the name for a top level reactor of a federated app.

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    • App
      • FederatedApp

    Constructors

    constructor

    Properties

    __dummy _active _alarm @@ -130,66 +130,66 @@ is the federateID and the rtiPort.

    Parameters

    • config: FederateConfig
    • Optional success: (() => void)

      Optional argument. Called when the FederatedApp exits with success.

        • (): void

        • Returns void

    • Optional failure: (() => void)

      Optional argument. Called when the FederatedApp exits with failure.

      -
        • (): void

        • Returns void

    Returns FederatedApp

    Properties

    Readonly __dummy

    __dummy: Dummy

    This reactor's dummy action.

    -

    Protected _active

    _active: boolean = false

    Indicates whether this reactor is active (meaning it has reacted to a +

      • (): void

      • Returns void

    Returns FederatedApp

    Properties

    Readonly __dummy

    __dummy: Dummy

    This reactor's dummy action.

    +

    Protected _active

    _active: boolean = false

    Indicates whether this reactor is active (meaning it has reacted to a startup action), or not (in which case it either never started up or has reacted to a shutdown action).

    -

    Readonly _alarm

    _alarm: Alarm = ...

    Protected _dependencyGraph

    _dependencyGraph: PrecedenceGraph<Reaction<Variable[]> | Port<unknown>> = ...

    This graph has in it all the dependencies implied by this container's +

    Readonly _alarm

    _alarm: Alarm = ...

    Protected _dependencyGraph

    _dependencyGraph: PrecedenceGraph<Reaction<Variable[]> | Port<unknown>> = ...

    This graph has in it all the dependencies implied by this container's ports, reactions, and connections.

    -

    Protected Optional _errorMessage

    _errorMessage?: string

    Protected _errored

    _errored: boolean = false

    Protected _immediateRef

    _immediateRef: undefined | Immediate

    Reference to "immediate" invocation of next.

    -

    Protected _isLastTAGProvisional

    _isLastTAGProvisional: boolean = false

    Stores whether the last received TAG (Tag Advance Grant) was provisional. +

    Protected Optional _errorMessage

    _errorMessage?: string

    Protected _errored

    _errored: boolean = false

    Protected _immediateRef

    _immediateRef: undefined | Immediate

    Reference to "immediate" invocation of next.

    +

    Protected _isLastTAGProvisional

    _isLastTAGProvisional: boolean = false

    Stores whether the last received TAG (Tag Advance Grant) was provisional. Every federate starts out assuming that it has been granted a PTAG at the start time, or if it has no upstream federates, a TAG.

    -

    Protected _keepAlive

    _keepAlive: boolean = false

    Indicates whether the program should continue running once the event +

    Protected _keepAlive

    _keepAlive: boolean = false

    Indicates whether the program should continue running once the event queue is empty.

    -

    Protected _key

    _key: symbol = ...

    A symbol that identifies this component, and it also used to selectively +

    Protected _key

    _key: symbol = ...

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

    -

    Readonly _name

    _name: string

    Protected Readonly _reactionQ

    _reactionQ: ReactionQueue = ...

    Priority set that keeps track of reactions at the current Logical time.

    -

    Readonly _uuid

    _uuid: string = ...

    Private Readonly downstreamFedIDs

    downstreamFedIDs: number[] = []

    failure

    failure: (() => void) = ...

    Optional callback to be used to indicate a failed execution.

    +

    Readonly _name

    _name: string

    Protected Readonly _reactionQ

    _reactionQ: ReactionQueue = ...

    Priority set that keeps track of reactions at the current Logical time.

    +

    Readonly _uuid

    _uuid: string = ...

    Private Readonly downstreamFedIDs

    downstreamFedIDs: number[] = []

    failure

    failure: (() => void) = ...

    Optional callback to be used to indicate a failed execution.

    Type declaration

      • (): void

      • Optional callback to be used to indicate a failed execution.

        -

        Returns void

    Private greatestTimeAdvanceGrant

    greatestTimeAdvanceGrant: Tag = ...

    The largest time advance grant received so far from the RTI, +

    Returns void

    Private greatestTimeAdvanceGrant

    greatestTimeAdvanceGrant: Tag = ...

    The largest time advance grant received so far from the RTI, or NEVER if no time advance grant has been received yet. An RTI synchronized Federate cannot advance its logical time beyond this value.

    -

    Private maxLevelAllowedToAdvance

    maxLevelAllowedToAdvance: number = 0

    Variable to track how far in the reaction queue we can go until we need to wait for more network port statuses to be known.

    -

    Private minDelayFromPhysicalActionToFederateOutput

    minDelayFromPhysicalActionToFederateOutput: null | TimeValue = null

    The default value, null, indicates there is no output depending on a physical action.

    -

    Private Readonly networkReceivers

    networkReceivers: Map<number, NetworkReceiver<unknown>> = ...

    An array of network receivers

    -

    Private Readonly networkSenders

    networkSenders: NetworkSender[] = []

    An array of network senders

    -

    Private Readonly portAbsentReactions

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

    An array of port absent reactions

    -

    Private Readonly rtiClient

    rtiClient: RTIClient

    A federate's rtiClient establishes the federate's connection to +

    Private maxLevelAllowedToAdvance

    maxLevelAllowedToAdvance: number = 0

    Variable to track how far in the reaction queue we can go until we need to wait for more network port statuses to be known.

    +

    Private minDelayFromPhysicalActionToFederateOutput

    minDelayFromPhysicalActionToFederateOutput: null | TimeValue = null

    The default value, null, indicates there is no output depending on a physical action.

    +

    Private Readonly networkReceivers

    networkReceivers: Map<number, NetworkReceiver<unknown>> = ...

    An array of network receivers

    +

    Private Readonly networkSenders

    networkSenders: NetworkSender[] = []

    An array of network senders

    +

    Private Readonly portAbsentReactions

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

    An array of port absent reactions

    +

    Private Readonly rtiClient

    rtiClient: RTIClient

    A federate's rtiClient establishes the federate's connection to the RTI (Run Time Infrastructure). When socket events occur, the rtiClient processes socket-level data into events it emits at the Federate's level of abstraction.

    -

    rtiHost

    rtiHost: string

    rtiPort

    rtiPort: number

    Readonly shutdown

    shutdown: Shutdown

    This reactor's shutdown action.

    -

    Readonly startup

    startup: Startup

    This reactor's startup action.

    -

    Private stopRequestInfo

    stopRequestInfo: StopRequestInfo = ...

    Stop request-related information +

    rtiHost

    rtiHost: string

    rtiPort

    rtiPort: number

    Readonly shutdown

    shutdown: Shutdown

    This reactor's shutdown action.

    +

    Readonly startup

    startup: Startup

    This reactor's startup action.

    +

    Private stopRequestInfo

    stopRequestInfo: StopRequestInfo = ...

    Stop request-related information including the current state and the tag associated with the stop requested or stop granted.

    -

    success

    success: (() => void) = ...

    Optional callback to be used to indicate a successful execution.

    +

    success

    success: (() => void) = ...

    Optional callback to be used to indicate a successful execution.

    Type declaration

      • (): void

      • Optional callback to be used to indicate a successful execution.

        -

        Returns void

    Private Readonly upstreamFedDelays

    upstreamFedDelays: TimeValue[] = []

    Private Readonly upstreamFedIDs

    upstreamFedIDs: number[] = []

    Protected util

    util: UtilityFunctions = ...

    Inner class that provides access to utilities that are safe to expose to +

    Returns void

    Private Readonly upstreamFedDelays

    upstreamFedDelays: TimeValue[] = []

    Private Readonly upstreamFedIDs

    upstreamFedIDs: number[] = []

    Protected util

    util: UtilityFunctions = ...

    Inner class that provides access to utilities that are safe to expose to reaction code.

    -

    Static pathSeparator

    pathSeparator: string = "."

    Methods

    Protected _addDummyEvent

    Static pathSeparator

    pathSeparator: string = "."

    Methods

    Protected _addDummyEvent

    • _addDummyEvent(tag): void

    • Add a dummy event to the event queue. Currently, the sole usage of this is to ensure LET to be sent to the RTI when there is any physical action triggering output port(s) in federated execution.

      Parameters

      • tag: Tag

        The tag at which this dummy event occurs.

        -

      Returns void

    _addEdgesForTpoLevels

    • _addEdgesForTpoLevels(): void

    • Add edges between reactions of network sender and receiver reactors.

      +

    Returns void

    _addEdgesForTpoLevels

    • _addEdgesForTpoLevels(): void

    • Add edges between reactions of network sender and receiver reactors.

      Returns void

      Note

      Network reactors from a connection with a delay do not have a TPO leve and are ignored in this operation.

      -

    Protected _advanceTime

    Protected _analyzeDependencies

    • _analyzeDependencies(): void

    • Analyze the dependencies between reactions in this app.

      +

    Protected _advanceTime

    Protected _analyzeDependencies

    • _analyzeDependencies(): void

    • Analyze the dependencies between reactions in this app.

      Assign priorities that encode the precedence relations between reactions. If there exist circular dependencies, throw an exception. This method should only be invoked prior to the start of execution, never during execution.

      -

      Returns void

    Protected _canProceed

    Protected _canProceed

    • _canProceed(nextEvent): boolean

    • Return whether the next event can be handled, or handling the next event has to be postponed to a later time.

      If this federated app has not received a sufficiently large time advance grant (TAG) from the RTI for the next event, send it a Next Event Time (NET) message and return. _next() will be called when a new greatest TAG is received. The NET message is not sent if the connection to the RTI is closed. FIXME: what happens in that case? Will next be called?

      -

      Parameters

      Returns boolean

    Protected _cancelNext

    Protected _connect

    Protected _cancelNext

    Protected _connect

    • _connect<R, S>(src, dst): void

    • Connect a source port to a downstream destination port. If a source is a regular port, then the type variable of the source has to be a subtype of the type variable of the destination. If the source is a caller port, then the destination has to be a callee port that is effectively a @@ -199,9 +199,9 @@ the caller's.

      Type Parameters

      • R

      • S

      Parameters

      • src: IOPort<S>

        The source port to connect.

      • dst: IOPort<R>

        The destination port to connect.

        -

      Returns void

    Protected _connectCall

    Protected _connectMulti

    _deregister

    • _deregister(reactor, key): void

    • Remove the given reactor and its connections from this container if +

    Returns void

    Protected _connectCall

    Protected _connectMulti

    _deregister

    • _deregister(reactor, key): void

    • Remove the given reactor and its connections from this container if the key matches.

      -

      Parameters

      Returns void

    Protected _determineStartAndEndOfExecution

    • _determineStartAndEndOfExecution(startTime): void

    • Set the logical start time of the execution according to the given time +

      Parameters

      Returns void

    Protected _determineStartAndEndOfExecution

    • _determineStartAndEndOfExecution(startTime): void

    • Set the logical start time of the execution according to the given time value. If an execution timeout is defined, also determine the end of execution is as the start time plus the execution timeout. This method also marks the app as "active" and initializes any timers that may have @@ -209,21 +209,21 @@

      Parameters

      • startTime: TimeValue

        The beginning of this app's execution. The end of execution is determined relative to this TimeValue is a timeout has been set.

        -

      Returns void

    Protected _disconnect

    • _disconnect<R, S>(src, dst?): void

    • Delete the connection between the source and destination nodes. +

    Returns void

    Protected _disconnect

    • _disconnect<R, S>(src, dst?): void

    • Delete the connection between the source and destination nodes. If the destination node is not specified, all connections from the source node to any other node are deleted.

      Type Parameters

      • R

      • S

      Parameters

      • src: IOPort<S>

        Source port of connection to be disconnected.

      • Optional dst: IOPort<R>

        Destination port of connection to be disconnected. If undefined, disconnect all connections from the source port.

        -

      Returns void

    Private _enqueuePortAbsentReactions

    • _enqueuePortAbsentReactions(): void

    • Enqueue network port absent reactions that will send a MSG_TYPE_PORT_ABSENT +

    Returns void

    Private _enqueuePortAbsentReactions

    • _enqueuePortAbsentReactions(): void

    • Enqueue network port absent reactions that will send a MSG_TYPE_PORT_ABSENT message to downstream federates if a given network output port is not present.

      -

      Returns void

    Protected _finish

    Protected _getCausalityInterface

    Protected _finish

    Protected _getCausalityInterface

    Protected _getContainer

    Protected _getEndOfExecution

    Protected _getFirstReactionOrMutation

    _getFullyQualifiedName

    Protected _getContainer

    Protected _getEndOfExecution

    Protected _getFirstReactionOrMutation

    _getFullyQualifiedName

    • _getFullyQualifiedName(): string

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

      -

      Returns string

    _getGreatestTimeAdvanceGrant

    _getKey

    _getGreatestTimeAdvanceGrant

    _getKey

    • _getKey(component, key?): undefined | symbol

    • If the given component is owned by this reactor, look up its key and return it. Otherwise, if a key has been provided, and it matches the key of this reactor, also look up the component's key and return it. Otherwise, if the component is owned by a reactor that is owned by @@ -233,15 +233,15 @@

      Parameters

      • component: Trigger

        The component to look up the key for.

      • Optional key: symbol

        The key that verifies the containment relation between this reactor and the component, with at most one level of indirection.

        -

      Returns undefined | symbol

    Protected _getLastMutation

    • _getLastMutation(): undefined | Mutation<Variable[]>

    • Return the last mutation of this reactor. All contained reactors +

    Returns undefined | symbol

    Protected _getLastMutation

    Protected _getLastReactionOrMutation

    Protected _getMutations

    Protected _getLastReactionOrMutation

    Protected _getMutations

    _getName

    _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

    Protected _getPrecedenceGraph

    Protected _getPrecedenceGraph

    • _getPrecedenceGraph(depth?): PrecedenceGraph<Reaction<Variable[]> | Port<unknown>>

    • Recursively collect the local dependency graph of each contained reactor and merge them all in one graph.

      The recursion depth can be limited via the depth parameter. A depth of 0 will only return the local dependency graph of this reactor, a depth @@ -255,82 +255,82 @@

    • RPCs occur in a deterministic order.

    Parameters

    • depth: number = -1

      The depth of recursion.

      -

    Returns PrecedenceGraph<Reaction<Variable[]> | Port<unknown>>

    _getReactionIndex

    • _getReactionIndex(reaction): number

    • Return the index of the reaction given as an argument.

      +

    Returns PrecedenceGraph<Reaction<Variable[]> | Port<unknown>>

    _getReactionIndex

    Protected _getReactions

    Protected _getReactionsAndMutations

    Protected _initializeMutationScope

    Protected _initializeReactionScope

    _isContainedBy

    • _isContainedBy(reactor): boolean

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

      +

    Returns number

    Protected _getReactions

    Protected _getReactionsAndMutations

    Protected _initializeMutationScope

    Protected _initializeReactionScope

    _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 +

    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

    _isDownstream

    • _isDownstream(port): boolean

    • Report whether the given port is downstream of this reactor. If so, the +

    Returns boolean

    _isDownstream

    • _isDownstream(port): boolean

    • Report whether the given port is downstream of this reactor. If so, the given port can be connected to with an output port of this reactor.

      -

      Parameters

      Returns boolean

    _isRegistered

    • _isRegistered(): boolean

    • Report whether this component has been registered with its container or not. +

      Parameters

      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

    _isUpstream

    _isUpstream

    • _isUpstream(port): boolean

    • Report whether the given port is upstream of this reactor. If so, the given port can be connected to an input port of this reactor.

      -

      Parameters

      Returns boolean

    Protected _iterationComplete

    Protected _linkToRuntimeObject

    • _linkToRuntimeObject(): void

    • Request the container to pass down its runtime object to this component. +

      Parameters

      Returns boolean

    Protected _iterationComplete

    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

    Protected _loadStartupReactions

    Protected _loadStartupReactions

    • _loadStartupReactions(): void

    • Load all reactions that were staged for immediate execution during this app's instantiation onto the reaction queue.

      -

      Returns void

    Protected _react

    Protected _react

    • _react(): boolean

    • Iterate over all reactions in the reaction queue and execute them. If a reaction's priority is less than MLAA, stop executing and return.

      Returns boolean

      Whether every reactions at this tag are executed.

      -

    _receiveRuntimeObject

    _receiveRuntimeObject

    • _receiveRuntimeObject(runtime): void

    • Receive the runtime object from the container of this reactor. Invoking this method in any user-written code will result in a runtime error.

      Parameters

      • runtime: Runtime

        The runtime object handed down from the container.

        -

      Returns void

    _register

    • _register(component, key): void

    • Add a component to this container.

      +

    Returns void

    _register

    • _register(component, key): void

    • Add a component to this container.

      A component that is created as part of this reactor invokes this method upon creation.

      Parameters

      • component: Component

        The component to register.

      • key: symbol

        The component's key.

        -

      Returns void

    Protected _requestImmediateInvocationOfNext

    _requestRuntimeObject

    Protected _setAlarmOrYield

    Protected _setEndOfExecution

    Protected _shutdown

    • _shutdown(): void

    • Send RTI the MSG_STOP_REQUEST +

    Returns void

    Protected _requestImmediateInvocationOfNext

    _requestRuntimeObject

    Protected _setAlarmOrYield

    Protected _setEndOfExecution

    Protected _shutdown

    • _shutdown(): void

    • Send RTI the MSG_STOP_REQUEST Setting greatest time advance grant needs to modify or remove

      -

      Returns void

    _start

    _start

    • _start(): void

    • Register this federated app with the RTI and request a start time. This function registers handlers for the events produced by the federated app's rtiClient and connects to the RTI. The federated app cannot schedule the start of the runtime until the rtiClient has received a start time message from the RTI.

      -

      Returns void

    Protected _startExecuting

    Protected _startTimeStep

    Protected _startExecuting

    Protected _startTimeStep

    • _startTimeStep(): void

    • Do the steps needed for the new logical tag. Enqueue network port absent reactions and update max level for the new tag.

      -

      Returns void

    Protected _unplug

    Protected _unplug

    • _unplug(): void

    • Remove this reactor from its container and sever any connections it may still have. This reactor will become defunct and is ready for garbage collection.

      -

      Returns void

    Protected _unsetTimer

    • _unsetTimer(timer): void

    • Report a timer to the app so that it gets unscheduled.

      +

      Returns void

    Protected _unsetTimer

    • _unsetTimer(timer): void

    • Report a timer to the app so that it gets unscheduled.

      Parameters

      • timer: Timer

        The timer to report to the app.

        -

      Returns void

    Protected _unsetTimers

    Private _updateLastKnownStatusOnInputPort

    • _updateLastKnownStatusOnInputPort(tag, portID): void

    • Update the last known status tag of a network input port +

    Returns void

    Protected _unsetTimers

    Private _updateLastKnownStatusOnInputPort

    • _updateLastKnownStatusOnInputPort(tag, portID): void

    • Update the last known status tag of a network input port to the value of "tag". This is the largest tag at which the status (present or absent) of the port was known.

      Parameters

      • tag: Tag

        The tag on which the latest status of network input ports is known.

      • portID: number

        The port ID

        -

      Returns void

    Private _updateLastKnownStatusOnInputPorts

    • _updateLastKnownStatusOnInputPorts(tag): void

    • Update the last known status tag of all network input ports +

    Returns void

    Private _updateLastKnownStatusOnInputPorts

    • _updateLastKnownStatusOnInputPorts(tag): void

    • Update the last known status tag of all network input ports to the value of "tag", unless that the provided tag is less than the last_known_status_tag of the port. This is called when this federated receives a TAG.

      Parameters

      • tag: Tag

        The received TAG

        -

      Returns void

    Private _updateMaxLevel

    • _updateMaxLevel(): void

    • Update the max level allowed to advance (MLAA) for the current logical timestep. +

    Returns void

    Private _updateMaxLevel

    • _updateMaxLevel(): void

    • Update the max level allowed to advance (MLAA) for the current logical timestep. If it's safe to complete the current tag by the last TAG, set the MLAA to the infinity. Else, check the network port's status and update the MLAA.

      -

      Returns void

    addDownstreamFederate

    Protected addMutation

    Protected addReaction

    • addReaction<T>(trigs, args, react, deadline?, late?): void

    • Add a reaction to this reactor. Each newly added reaction will acquire a +

      Returns void

    addDownstreamFederate

    Protected addMutation

    Protected addReaction

    • addReaction<T>(trigs, args, react, deadline?, late?): void

    • Add a reaction to this reactor. Each newly added reaction will acquire a dependency either on the previously added reaction, or on the last added mutation (in case no reactions had been added prior to this one). A reaction is specified by a list of triggers, a list of arguments, a react function, an optional deadline, and an optional late function (which represents the reaction body of the deadline). All triggers a reaction needs access must be included in the arguments.

      -

      Type Parameters

      Parameters

      Returns void

    addUpstreamFederate

    allWritable

    canConnect

    addUpstreamFederate

    allWritable

    canConnect

    • canConnect<R, S>(src, dst): boolean

    • Returns true if a given source port can be connected to the given destination port, false otherwise. Valid connections must: (1) adhere to the scoping rules and connectivity constraints @@ -345,37 +345,37 @@

    Type Parameters

    • R

    • S

    Parameters

    • src: IOPort<S>

      The start point of a new connection.

    • dst: IOPort<R>

      The end point of a new connection.

      -

    Returns boolean

    canConnectCall

    getBankIndex

    • getBankIndex(): number

    • Return the location of the reactor instance in a bank, +

    Returns boolean

    canConnectCall

    getBankIndex

    • getBankIndex(): number

    • Return the location of the reactor instance in a bank, if it is a member of one; return -1 otherwise.

      -

      Returns number

    Protected nextReaction

    Protected nextReaction

    Protected prevReaction

    • prevReaction(reaction): undefined | Reaction<Variable[]>

    • Given a reaction, return the reaction within this reactor that directly +

    Returns undefined | Reaction<Variable[]>

    Protected prevReaction

    registerNetworkReceiver

    • registerNetworkReceiver(portID, networkReceiver): void

    • Register a network receiver reactors. It must be registered so it is known by this +

    Returns undefined | Reaction<Variable[]>

    registerNetworkReceiver

    • registerNetworkReceiver(portID, networkReceiver): void

    • Register a network receiver reactors. It must be registered so it is known by this FederatedApp and used when add edges for TPO levels and may be used when a message for the associated port has been received via the RTI.

      Unfortunately, the data type of the action has to be unknown, meaning that the type checker cannot check whether uses of the action are type safe. In an alternative design, type information might be preserved. TODO(marten): Look into this.

      Parameters

      • portID: number
      • networkReceiver: NetworkReceiver<unknown>

        The designated network receiver reactor.

        -

      Returns void

    registerNetworkSender

    • registerNetworkSender(networkSender): void

    • Register a network sender reactors. It must be registered so it is known by this +

    Returns void

    registerNetworkSender

    • registerNetworkSender(networkSender): void

    • Register a network sender reactors. It must be registered so it is known by this FederatedApp to be used when register portAbsentReaction and add edges for TPO levels.

      Parameters

      • networkSender: NetworkSender

        The designated network sender reactor

        -

      Returns void

    Protected schedulable

    sendRTILogicalTimeComplete

    • sendRTILogicalTimeComplete(completeTag): void

    • Send a logical time complete message to the RTI. This should be called whenever +

    Returns void

    Protected schedulable

    sendRTILogicalTimeComplete

    • sendRTILogicalTimeComplete(completeTag): void

    • Send a logical time complete message to the RTI. This should be called whenever this federate is ready to advance beyond the given logical time.

      -

      Parameters

      • completeTag: Tag

      Returns void

    sendRTIMessage

    • sendRTIMessage<T>(msg, destFederateID, destPortID): void

    • Send a message to a potentially remote federate's port via the RTI. This message +

      Parameters

      • completeTag: Tag

      Returns void

    sendRTIMessage

    • sendRTIMessage<T>(msg, destFederateID, destPortID): void

    • Send a message to a potentially remote federate's port via the RTI. This message is untimed, and will be timestamped by the destination federate when it is received.

      Type Parameters

      • T

      Parameters

      • msg: T

        The message encoded as a Buffer.

      • destFederateID: number

        The ID of the federate intended to receive the message.

      • destPortID: number

        The ID of the federate's port intended to receive the message.

        -

      Returns void

    sendRTINextEventTag

    • sendRTINextEventTag(nextTag): void

    • Send a next event time message to the RTI. This should be called +

    Returns void

    sendRTINextEventTag

    • sendRTINextEventTag(nextTag): void

    • Send a next event time message to the RTI. This should be called when this federated app is unable to advance logical time beause it has not yet received a sufficiently large time advance grant.

      Parameters

      • nextTag: Tag

        The time to which this federate would like to advance logical time.

        -

      Returns void

    sendRTIPortAbsent

    • sendRTIPortAbsent(destFederateID, destPortID, additionalDelay): void

    • Send a port absent message to the destination port, informing the +

    Returns void

    sendRTIPortAbsent

    • sendRTIPortAbsent(destFederateID, destPortID, additionalDelay): void

    • Send a port absent message to the destination port, informing the remote federate that the current federate will not produce an event on this network port at the current logical time.

      Parameters

      • destFederateID: number
      • destPortID: number

        The ID of the receiving port.

        @@ -383,31 +383,31 @@ using after. The additional delay will be greater or equal to zero if an after is used on the connection. If no after is given in the program, NEVER is passed.

        -

      Returns void

    sendRTIResign

    • sendRTIResign(): void

    • Send a resign message to the RTI. This message indicates this federated +

    Returns void

    sendRTIResign

    • sendRTIResign(): void

    • Send a resign message to the RTI. This message indicates this federated app is shutting down, and should not be directed any new messages.

      -

      Returns void

    sendRTIStopRequest

    • sendRTIStopRequest(stopTag): void

    • Send the RTI a stop request message.

      -

      Parameters

      Returns void

    sendRTIStopRequestReply

    • sendRTIStopRequestReply(stopTag): void

    • Send the RTI a stop request reply message.

      -

      Parameters

      Returns void

    sendRTITimedMessage

    • sendRTITimedMessage<T>(msg, destFederateID, destPortID, time): void

    • Send a timed message to a potentially remote FederateInPort via the RTI. +

      Returns void

    sendRTIStopRequest

    • sendRTIStopRequest(stopTag): void

    • Send the RTI a stop request message.

      +

      Parameters

      Returns void

    sendRTIStopRequestReply

    • sendRTIStopRequestReply(stopTag): void

    • Send the RTI a stop request reply message.

      +

      Parameters

      Returns void

    sendRTITimedMessage

    • sendRTITimedMessage<T>(msg, destFederateID, destPortID, time): void

    • Send a timed message to a potentially remote FederateInPort via the RTI. This message is timed, meaning it carries the logical timestamp of this federate when this function is called.

      Type Parameters

      • T

      Parameters

      • msg: T

        The message encoded as a Buffer.

      • destFederateID: number

        The ID of the Federate intended to receive the message.

      • destPortID: number

        The ID of the FederateInPort intended to receive the message.

      • time: undefined | TimeValue

        The offset from the current time that the message should have.

        -

      Returns void

    setAdvanceMessageInterval

    setMinDelayFromPhysicalActionToFederateOutput

    shutdownRTIClient

    • shutdownRTIClient(): void

    • Shutdown the RTI Client by closing its socket connection to +

    Returns void

    setAdvanceMessageInterval

    setMinDelayFromPhysicalActionToFederateOutput

    shutdownRTIClient

    • shutdownRTIClient(): void

    • Shutdown the RTI Client by closing its socket connection to the RTI.

      -

      Returns void

    toString

    writable

    Static keyOfMatchingBank

    Static keyOfMatchingEntry

    • keyOfMatchingEntry(component, object): string

    • Given a component and its container (the global object if the component +

      Returns void

    toString

    writable

    Static keyOfMatchingBank

    Static keyOfMatchingEntry

    • 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

      -

    Static keyOfMatchingMultiport

    Static keyOfMatchingMultiport

    • 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

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/IOPort.html b/classes/IOPort.html index 1bff5ad8..c5166f29 100644 --- a/classes/IOPort.html +++ b/classes/IOPort.html @@ -1,5 +1,5 @@ IOPort | @lf-lang/reactor-ts

    Class IOPort<T>Abstract

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

    -

    Type Parameters

    • T

    Hierarchy (view full)

    Constructors

    constructor +

    Type Parameters

    • T

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    _key manager reactions @@ -26,48 +26,48 @@ keyOfMatchingBank keyOfMatchingEntry keyOfMatchingMultiport -

    Constructors

    constructor

    Properties

    Protected _key

    _key: symbol = ...

    A symbol that identifies this component, and it also used to selectively +

    Constructors

    constructor

    Properties

    Protected _key

    _key: symbol = ...

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

    -

    Protected manager

    manager: IOPortManager<T> = ...

    Inner class instance to let the container configure this port.

    -

    Protected reactions

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

    Reactions to trigger.

    -

    Protected receivers

    receivers: Set<WritablePort<T>> = ...

    Protected runtime

    runtime: Runtime

    Protected tag

    tag: undefined | Tag

    The tag associated with this port's value, or undefined is there is none.

    -

    Protected value

    value: undefined | T

    The current value associated with this port.

    -

    Protected writer

    writer: __class<T> = ...

    Inner class instance to gain access to Write interface.

    -

    Static pathSeparator

    pathSeparator: string = "."

    Methods

    Protected _getContainer

    _getFullyQualifiedName

    Protected manager

    manager: IOPortManager<T> = ...

    Inner class instance to let the container configure this port.

    +

    Protected reactions

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

    Reactions to trigger.

    +

    Protected receivers

    receivers: Set<WritablePort<T>> = ...

    Protected runtime

    runtime: Runtime

    Protected tag

    tag: undefined | Tag

    The tag associated with this port's value, or undefined is there is none.

    +

    Protected value

    value: undefined | T

    The current value associated with this port.

    +

    Protected writer

    writer: __class<T> = ...

    Inner class instance to gain access to Write interface.

    +

    Static pathSeparator

    pathSeparator: string = "."

    Methods

    Protected _getContainer

    _getFullyQualifiedName

    _getName

    _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.

      +

      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 +

    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. +

    Returns boolean

    _isRegistered

    Protected _linkToRuntimeObject

    Protected _linkToRuntimeObject

    _receiveRuntimeObject

    asWritable

    get

    _receiveRuntimeObject

    asWritable

    get

    getContainer

    getManager

    isPresent

    toString

    Static keyOfMatchingBank

    Static keyOfMatchingEntry

    getContainer

    getManager

    isPresent

    toString

    Static keyOfMatchingBank

    Static keyOfMatchingEntry

    Static keyOfMatchingMultiport

    Static keyOfMatchingMultiport

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/InMultiPort.html b/classes/InMultiPort.html index a9219d5f..6dc27459 100644 --- a/classes/InMultiPort.html +++ b/classes/InMultiPort.html @@ -1,7 +1,7 @@ InMultiPort | @lf-lang/reactor-ts

    Class InMultiPort<T>

    A trigger that represents an input port that is also multiport.

    Author

    Marten Lohstroh marten@berkeley.edu

    Author

    Hokeun Kim hokeun@berkeley.edu

    -

    Type Parameters

    • T

    Hierarchy (view full)

    Constructors

    constructor +

    Type Parameters

    • T

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    _channels _key manager @@ -30,67 +30,67 @@

    Author

    Hokeun Kim hokeun@berkele keyOfMatchingEntry keyOfMatchingMultiport values -

    Constructors

    constructor

    Properties

    Protected _channels

    _channels: IOPort<T>[]

    The channels of this multiport.

    -

    Protected _key

    _key: symbol = ...

    A symbol that identifies this component, and it also used to selectively +

    Constructors

    constructor

    Properties

    Protected _channels

    _channels: IOPort<T>[]

    The channels of this multiport.

    +

    Protected _key

    _key: symbol = ...

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

    -

    Protected manager

    manager: __class<T> = ...

    Inner class instance to let the container configure this port.

    -

    Protected reactions

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

    Reactions to trigger.

    -

    Protected writer

    writer: __class<T> = ...

    Inner class instance to gain access to MultiWrite interface.

    -

    Static pathSeparator

    pathSeparator: string = "."

    Methods

    Protected _getContainer

    _getFullyQualifiedName

    Protected manager

    manager: __class<T> = ...

    Inner class instance to let the container configure this port.

    +

    Protected reactions

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

    Reactions to trigger.

    +

    Protected writer

    writer: __class<T> = ...

    Inner class instance to gain access to MultiWrite interface.

    +

    Static pathSeparator

    pathSeparator: string = "."

    Methods

    Protected _getContainer

    _getFullyQualifiedName

    _getName

    _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

    • _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 +

    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. +

    Returns boolean

    _isRegistered

    Protected _linkToRuntimeObject

    Protected _linkToRuntimeObject

    _receiveRuntimeObject

    asWritable

    channel

    _receiveRuntimeObject

    asWritable

    channel

    channels

    get

    Returns InPort<T>

    channels

    get

    getContainer

    getManager

    getContainer

    getManager

    isPresent

    Returns TriggerManager

    isPresent

    toString

    values

    toString

    values

    width

    width

    Static keyOfMatchingBank

    Static keyOfMatchingEntry

    Static keyOfMatchingBank

    Static keyOfMatchingEntry

    Static keyOfMatchingMultiport

    Static keyOfMatchingMultiport

    Static values

    Static values

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/InPort.html b/classes/InPort.html index 69db65a8..b58c5867 100644 --- a/classes/InPort.html +++ b/classes/InPort.html @@ -1,5 +1,5 @@ InPort | @lf-lang/reactor-ts

    Class InPort<T>

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

    -

    Type Parameters

    • T

    Hierarchy (view full)

    Constructors

    constructor +

    Type Parameters

    • T

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    _key manager reactions @@ -26,48 +26,48 @@ keyOfMatchingBank keyOfMatchingEntry keyOfMatchingMultiport -

    Constructors

    constructor

    Properties

    Protected _key

    _key: symbol = ...

    A symbol that identifies this component, and it also used to selectively +

    Constructors

    constructor

    Properties

    Protected _key

    _key: symbol = ...

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

    -

    Protected manager

    manager: IOPortManager<T> = ...

    Inner class instance to let the container configure this port.

    -

    Protected reactions

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

    Reactions to trigger.

    -

    Protected receivers

    receivers: Set<WritablePort<T>> = ...

    Protected runtime

    runtime: Runtime

    Protected tag

    tag: undefined | Tag

    The tag associated with this port's value, or undefined is there is none.

    -

    Protected value

    value: undefined | T

    The current value associated with this port.

    -

    Protected writer

    writer: __class<T> = ...

    Inner class instance to gain access to Write interface.

    -

    Static pathSeparator

    pathSeparator: string = "."

    Methods

    Protected _getContainer

    _getFullyQualifiedName

    Protected manager

    manager: IOPortManager<T> = ...

    Inner class instance to let the container configure this port.

    +

    Protected reactions

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

    Reactions to trigger.

    +

    Protected receivers

    receivers: Set<WritablePort<T>> = ...

    Protected runtime

    runtime: Runtime

    Protected tag

    tag: undefined | Tag

    The tag associated with this port's value, or undefined is there is none.

    +

    Protected value

    value: undefined | T

    The current value associated with this port.

    +

    Protected writer

    writer: __class<T> = ...

    Inner class instance to gain access to Write interface.

    +

    Static pathSeparator

    pathSeparator: string = "."

    Methods

    Protected _getContainer

    _getFullyQualifiedName

    _getName

    _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.

      +

      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 +

    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. +

    Returns boolean

    _isRegistered

    Protected _linkToRuntimeObject

    Protected _linkToRuntimeObject

    _receiveRuntimeObject

    asWritable

    get

    _receiveRuntimeObject

    asWritable

    get

    getContainer

    getManager

    isPresent

    toString

    Static keyOfMatchingBank

    Static keyOfMatchingEntry

    getContainer

    getManager

    isPresent

    toString

    Static keyOfMatchingBank

    Static keyOfMatchingEntry

    Static keyOfMatchingMultiport

    Static keyOfMatchingMultiport

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/MultiPort.html b/classes/MultiPort.html index 7bea3d8c..5cd76e87 100644 --- a/classes/MultiPort.html +++ b/classes/MultiPort.html @@ -2,7 +2,7 @@ To obtain a writable version, see @link{Reactor.allWritable()}.

    Author

    Marten Lohstroh marten@berkeley.edu

    Author

    Hokeun Kim hokeun@berkeley.edu

    -

    Type Parameters

    Hierarchy (view full)

    Implements

    Constructors

    constructor +

    Type Parameters

    • T

    Hierarchy (view full)

    Implements

    Constructors

    constructor

    Properties

    _channels _key _width @@ -36,68 +36,68 @@

    Author

    Hokeun Kim hokeun@berkele

    Constructors

    constructor

    Properties

    Protected _channels

    _channels: IOPort<T>[]

    The channels of this multiport.

    -

    Protected _key

    _key: symbol = ...

    A symbol that identifies this component, and it also used to selectively +

    Returns MultiPort<T>

    Properties

    Protected _channels

    _channels: IOPort<T>[]

    The channels of this multiport.

    +

    Protected _key

    _key: symbol = ...

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

    -

    Private Readonly _width

    _width: number

    Inherit Doc

    Private Readonly container

    container: Reactor

    the reactor that will contain the new instance

    -

    Protected manager

    manager: __class<T> = ...

    Inner class instance to let the container configure this port.

    -

    Protected reactions

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

    Reactions to trigger.

    -

    Protected writer

    writer: __class<T> = ...

    Inner class instance to gain access to MultiWrite interface.

    -

    Static pathSeparator

    pathSeparator: string = "."

    Methods

    Protected _getContainer

    _getFullyQualifiedName

    Private Readonly _width

    _width: number

    Inherit Doc

    Private Readonly container

    container: Reactor

    the reactor that will contain the new instance

    +

    Protected manager

    manager: __class<T> = ...

    Inner class instance to let the container configure this port.

    +

    Protected reactions

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

    Reactions to trigger.

    +

    Protected writer

    writer: __class<T> = ...

    Inner class instance to gain access to MultiWrite interface.

    +

    Static pathSeparator

    pathSeparator: string = "."

    Methods

    Protected _getContainer

    _getFullyQualifiedName

    _getName

    _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.

      +

      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 +

    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. +

    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

    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

    asWritable

    Abstract channel

    _receiveRuntimeObject

    asWritable

    Abstract channel

    • channel(index): IOPort<T>

    • Return the channel identified by the given index.

      Parameters

      • index: number

        the index of the requested channel

        -

      Returns IOPort<T>

    Abstract channels

    get

    • get(index): undefined | T

    • Given an index that identifies a particular channel, return the current +

    Returns IOPort<T>

    Abstract channels

    get

    • get(index): undefined | T

    • Given an index that identifies a particular channel, return the current value of the identified channel.

      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

    getManager

    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

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

      +

    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

    values

    toString

    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

    Static keyOfMatchingBank

    Static keyOfMatchingEntry

    • keyOfMatchingEntry(component, object): string

    • Given a component and its container (the global object if the component +

    Static keyOfMatchingBank

    Static keyOfMatchingEntry

    • 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

      -

    Static keyOfMatchingMultiport

    Static keyOfMatchingMultiport

    • 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

      -

    Static values

    Static values

    • 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

      -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/Mutation.html b/classes/Mutation.html index 55f453bd..a033c274 100644 --- a/classes/Mutation.html +++ b/classes/Mutation.html @@ -2,7 +2,7 @@ the argument list of the react function that that is applied to when this reaction gets triggered.

    Author

    Marten Lohstroh marten@berkeley.edu

    -

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor +

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    active args next @@ -16,32 +16,32 @@ setPriority toString updateIfDuplicateOf -

    Constructors

    constructor

    Properties

    active

    active: boolean = false

    Indicates whether or not this reaction is active. A reaction become +

    Constructors

    constructor

    Properties

    active

    active: boolean = false

    Indicates whether or not this reaction is active. A reaction become active when its container starts up, inactive when its container shuts down.

    -

    Readonly args

    args: [...ArgList<T>[]]

    The arguments to be passed to react and late.

    -

    next

    next: undefined | PrioritySetElement<number>

    Pointer to the next reaction, used by the runtime when this reaction is staged +

    Readonly args

    args: [...ArgList<T>[]]

    The arguments to be passed to react and late.

    +

    next

    next: undefined | PrioritySetElement<number>

    Pointer to the next reaction, used by the runtime when this reaction is staged for execution at the current logical time.

    -

    Readonly parent

    parent: Reactor

    Readonly trigs

    trigs: Variable[]

    The ports, actions, or timers, which, when they receive +

    Readonly parent

    parent: Reactor

    Readonly trigs

    trigs: Variable[]

    The ports, actions, or timers, which, when they receive values, will trigger this reaction.

    -

    Methods

    doReact

    Methods

    doReact

    • doReact(): void

    • Invoke the react function in the appropriate sandbox and with the argument list that was specified upon the construction of this reaction object.

      -

      Returns void

    getPriority

    getPriority

    • getPriority(): number

    • Return the priority of this reaction. It determines the execution order among reactions staged for execution at the same logical time.

      -

      Returns number

    hasPriorityOver

    hasPriorityOver

    isTriggeredImmediately

    • isTriggeredImmediately(): boolean

    • Return true if this reaction is triggered immediately (by startup or a +

    Returns boolean

    isTriggeredImmediately

    setDeadline

    setDeadline

    • setDeadline(deadline): this

    • Set a deadline for this reaction. The given time value denotes the maximum allowable amount by which logical time may lag behind physical time at the point that this reaction is ready to execute. If this maximum lag is exceeded, the late function is executed instead of the react function.

      Parameters

      • deadline: TimeValue

        The deadline to set to this reaction.

        -

      Returns this

    setPriority

    • setPriority(priority): void

    • Set for reaction priority, to be used only by the runtime environment. +

    Returns this

    setPriority

    • setPriority(priority): void

    • Set for reaction priority, to be used only by the runtime environment. The priority of each reaction is determined on the basis of its dependencies on other reactions.

      Parameters

      • priority: number

        The priority for this reaction.

        -

      Returns void

    toString

    updateIfDuplicateOf

    • updateIfDuplicateOf(node): boolean

    • Return whether another, newly staged reaction is equal to this one. +

    Returns void

    toString

    updateIfDuplicateOf

    • updateIfDuplicateOf(node): boolean

    • Return whether another, newly staged reaction is equal to this one. Because reactions are just object references, no updating is necessary. Returning true just signals that the scheduler shouldn't stage it twice.

      -

      Parameters

      Returns boolean

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns boolean

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/NetworkReceiver.html b/classes/NetworkReceiver.html index f647c72f..7bf770d1 100644 --- a/classes/NetworkReceiver.html +++ b/classes/NetworkReceiver.html @@ -1,5 +1,5 @@ NetworkReceiver | @lf-lang/reactor-ts

    Class NetworkReceiver<T>

    A network receiver is a reactor handling a network input.

    -

    Type Parameters

    • T

    Hierarchy

    • NetworkReactor
      • NetworkReceiver

    Constructors

    constructor +

    Type Parameters

    • T

    Hierarchy

    • NetworkReactor
      • NetworkReceiver

    Constructors

    constructor

    Properties

    __dummy _active _dependencyGraph @@ -64,22 +64,22 @@ keyOfMatchingBank keyOfMatchingEntry keyOfMatchingMultiport -

    Constructors

    constructor

    Properties

    Readonly __dummy

    __dummy: Dummy

    This reactor's dummy action.

    -

    Protected _active

    _active: boolean = false

    Indicates whether this reactor is active (meaning it has reacted to a +

    Constructors

    constructor

    Properties

    Readonly __dummy

    __dummy: Dummy

    This reactor's dummy action.

    +

    Protected _active

    _active: boolean = false

    Indicates whether this reactor is active (meaning it has reacted to a startup action), or not (in which case it either never started up or has reacted to a shutdown action).

    -

    Protected _dependencyGraph

    _dependencyGraph: PrecedenceGraph<Reaction<Variable[]> | Port<unknown>> = ...

    This graph has in it all the dependencies implied by this container's +

    Protected _dependencyGraph

    _dependencyGraph: PrecedenceGraph<Reaction<Variable[]> | Port<unknown>> = ...

    This graph has in it all the dependencies implied by this container's ports, reactions, and connections.

    -

    Protected _key

    _key: symbol = ...

    A symbol that identifies this component, and it also used to selectively +

    Protected _key

    _key: symbol = ...

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

    -

    lastKnownStatusTag

    lastKnownStatusTag: Tag

    Last known status of the port, either via a timed message, a port absent, +

    lastKnownStatusTag

    lastKnownStatusTag: Tag

    Last known status of the port, either via a timed message, a port absent, or a TAG from the RTI.

    -

    Private networkInputActionOrigin

    networkInputActionOrigin: undefined | Origin

    The information of origin of this NetworkReceiver's network input action.

    -

    Private networkInputSchedAction

    networkInputSchedAction: undefined | SchedulableAction<T>

    A schedulable action of this NetworkReceiver's network input.

    -

    Readonly shutdown

    shutdown: Shutdown

    This reactor's shutdown action.

    -

    Readonly startup

    startup: Startup

    This reactor's startup action.

    -

    Protected Optional Readonly tpoLevel

    tpoLevel?: number

    Protected util

    util: UtilityFunctions

    Collection of utility functions for this reactor and its subclasses.

    -

    Static pathSeparator

    pathSeparator: string = "."

    Methods

    Protected _connect

    • _connect<R, S>(src, dst): void

    • Connect a source port to a downstream destination port. If a source is a +

    Private networkInputActionOrigin

    networkInputActionOrigin: undefined | Origin

    The information of origin of this NetworkReceiver's network input action.

    +

    Private networkInputSchedAction

    networkInputSchedAction: undefined | SchedulableAction<T>

    A schedulable action of this NetworkReceiver's network input.

    +

    Readonly shutdown

    shutdown: Shutdown

    This reactor's shutdown action.

    +

    Readonly startup

    startup: Startup

    This reactor's startup action.

    +

    Protected Optional Readonly tpoLevel

    tpoLevel?: number

    Protected util

    util: UtilityFunctions

    Collection of utility functions for this reactor and its subclasses.

    +

    Static pathSeparator

    pathSeparator: string = "."

    Methods

    Protected _connect

    • _connect<R, S>(src, dst): void

    • Connect a source port to a downstream destination port. If a source is a regular port, then the type variable of the source has to be a subtype of the type variable of the destination. If the source is a caller port, then the destination has to be a callee port that is effectively a @@ -89,18 +89,18 @@ the caller's.

      Type Parameters

      • R

      • S

      Parameters

      • src: IOPort<S>

        The source port to connect.

      • dst: IOPort<R>

        The destination port to connect.

        -

      Returns void

    Protected _connectCall

    Protected _connectMulti

    _deregister

    • _deregister(reactor, key): void

    • Remove the given reactor and its connections from this container if +

    Returns void

    Protected _connectCall

    Protected _connectMulti

    _deregister

    • _deregister(reactor, key): void

    • Remove the given reactor and its connections from this container if the key matches.

      -

      Parameters

      Returns void

    Protected _disconnect

    • _disconnect<R, S>(src, dst?): void

    • Delete the connection between the source and destination nodes. +

      Parameters

      Returns void

    Protected _disconnect

    • _disconnect<R, S>(src, dst?): void

    • Delete the connection between the source and destination nodes. If the destination node is not specified, all connections from the source node to any other node are deleted.

      Type Parameters

      • R

      • S

      Parameters

      • src: IOPort<S>

        Source port of connection to be disconnected.

      • Optional dst: IOPort<R>

        Destination port of connection to be disconnected. If undefined, disconnect all connections from the source port.

        -

      Returns void

    Protected _getCausalityInterface

    • _getCausalityInterface(): PrecedenceGraph<Port<unknown>>

    • Return a dependency graph consisting of only this reactor's own ports +

    Returns void

    Protected _getCausalityInterface

    Protected _getContainer

    Protected _getFirstReactionOrMutation

    _getFullyQualifiedName

    Protected _getContainer

    Protected _getFirstReactionOrMutation

    _getFullyQualifiedName

    _getKey

    _getKey

    Protected _getLastMutation

    Returns undefined | symbol

    Protected _getLastMutation

    Protected _getLastReactionOrMutation

    Protected _getMutations

    Protected _getLastReactionOrMutation

    Protected _getMutations

    _getName

    _getName

    Protected _getPrecedenceGraph

    Protected _getPrecedenceGraph

    Parameters

    • depth: number = -1

      The depth of recursion.

      -

    Returns PrecedenceGraph<Reaction<Variable[]> | Port<unknown>>

    _getReactionIndex

    Returns PrecedenceGraph<Reaction<Variable[]> | Port<unknown>>

    _getReactionIndex

    Protected _getReactions

    Protected _getReactionsAndMutations

    Protected _initializeMutationScope

    Protected _initializeReactionScope

    _isContainedBy

    Returns number

    Protected _getReactions

    Protected _getReactionsAndMutations

    Protected _initializeMutationScope

    Protected _initializeReactionScope

    _isContainedBy

    _isContainedByContainerOf

    Returns boolean

    _isContainedByContainerOf

    _isDownstream

    Returns boolean

    _isDownstream

    _isRegistered

    _isRegistered

    _isUpstream

    _isUpstream

    Protected _linkToRuntimeObject

    Protected _linkToRuntimeObject

    _receiveRuntimeObject

    _receiveRuntimeObject

    _register

    Returns void

    _register

    _requestRuntimeObject

    Protected _unplug

    Returns void

    _requestRuntimeObject

    Protected _unplug

    Protected _unsetTimer

    Protected _unsetTimer

    Protected _unsetTimers

    Protected addMutation

    Protected addReaction

    Returns void

    Protected _unsetTimers

    Protected addMutation

    Protected addReaction

    allWritable

    canConnect

    allWritable

    canConnect

    Type Parameters

    • R

    • S

    Parameters

    • src: IOPort<S>

      The start point of a new connection.

    • dst: IOPort<R>

      The end point of a new connection.

      -

    Returns boolean

    canConnectCall

    getBankIndex

    Returns boolean

    canConnectCall

    getBankIndex

    getNetworkInputActionOrigin

    getReactions

    getNetworkInputActionOrigin

    getReactions

    getTpoLevel

    handleMessage

    getTpoLevel

    handleMessage

    handleTimedMessage

    Returns void

    handleTimedMessage

    Protected nextReaction

    Returns void

    Protected nextReaction

    Protected prevReaction

    Returns undefined | Reaction<Variable[]>

    Protected prevReaction

    registerNetworkInputAction

    Returns undefined | Reaction<Variable[]>

    registerNetworkInputAction

    Protected schedulable

    toString

    writable

    Static keyOfMatchingBank

    Static keyOfMatchingEntry

    Returns void

    Protected schedulable

    toString

    writable

    Static keyOfMatchingBank

    Static keyOfMatchingEntry

    Static keyOfMatchingMultiport

    Static keyOfMatchingMultiport

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/NetworkSender.html b/classes/NetworkSender.html index 66e13475..5acd933d 100644 --- a/classes/NetworkSender.html +++ b/classes/NetworkSender.html @@ -1,5 +1,5 @@ NetworkSender | @lf-lang/reactor-ts

    Class NetworkSender

    A network sender is a reactor containing a portAbsentReaction.

    -

    Hierarchy

    • NetworkReactor
      • NetworkSender

    Constructors

    constructor +

    Hierarchy

    • NetworkReactor
      • NetworkSender

    Constructors

    constructor

    Properties

    __dummy _active _dependencyGraph @@ -58,18 +58,18 @@ keyOfMatchingBank keyOfMatchingEntry keyOfMatchingMultiport -

    Constructors

    constructor

    Properties

    Readonly __dummy

    __dummy: Dummy

    This reactor's dummy action.

    -

    Protected _active

    _active: boolean = false

    Indicates whether this reactor is active (meaning it has reacted to a +

    Constructors

    constructor

    Properties

    Readonly __dummy

    __dummy: Dummy

    This reactor's dummy action.

    +

    Protected _active

    _active: boolean = false

    Indicates whether this reactor is active (meaning it has reacted to a startup action), or not (in which case it either never started up or has reacted to a shutdown action).

    -

    Protected _dependencyGraph

    _dependencyGraph: PrecedenceGraph<Reaction<Variable[]> | Port<unknown>> = ...

    This graph has in it all the dependencies implied by this container's +

    Protected _dependencyGraph

    _dependencyGraph: PrecedenceGraph<Reaction<Variable[]> | Port<unknown>> = ...

    This graph has in it all the dependencies implied by this container's ports, reactions, and connections.

    -

    Protected _key

    _key: symbol = ...

    A symbol that identifies this component, and it also used to selectively +

    Protected _key

    _key: symbol = ...

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

    -

    Readonly shutdown

    shutdown: Shutdown

    This reactor's shutdown action.

    -

    Readonly startup

    startup: Startup

    This reactor's startup action.

    -

    Protected Optional Readonly tpoLevel

    tpoLevel?: number

    Protected util

    util: UtilityFunctions

    Collection of utility functions for this reactor and its subclasses.

    -

    Static pathSeparator

    pathSeparator: string = "."

    Methods

    Protected _connect

    • _connect<R, S>(src, dst): void

    • Connect a source port to a downstream destination port. If a source is a +

    Readonly shutdown

    shutdown: Shutdown

    This reactor's shutdown action.

    +

    Readonly startup

    startup: Startup

    This reactor's startup action.

    +

    Protected Optional Readonly tpoLevel

    tpoLevel?: number

    Protected util

    util: UtilityFunctions

    Collection of utility functions for this reactor and its subclasses.

    +

    Static pathSeparator

    pathSeparator: string = "."

    Methods

    Protected _connect

    • _connect<R, S>(src, dst): void

    • Connect a source port to a downstream destination port. If a source is a regular port, then the type variable of the source has to be a subtype of the type variable of the destination. If the source is a caller port, then the destination has to be a callee port that is effectively a @@ -79,18 +79,18 @@ the caller's.

      Type Parameters

      • R

      • S

      Parameters

      • src: IOPort<S>

        The source port to connect.

      • dst: IOPort<R>

        The destination port to connect.

        -

      Returns void

    Protected _connectCall

    Protected _connectMulti

    _deregister

    • _deregister(reactor, key): void

    • Remove the given reactor and its connections from this container if +

    Returns void

    Protected _connectCall

    Protected _connectMulti

    _deregister

    • _deregister(reactor, key): void

    • Remove the given reactor and its connections from this container if the key matches.

      -

      Parameters

      Returns void

    Protected _disconnect

    • _disconnect<R, S>(src, dst?): void

    • Delete the connection between the source and destination nodes. +

      Parameters

      Returns void

    Protected _disconnect

    • _disconnect<R, S>(src, dst?): void

    • Delete the connection between the source and destination nodes. If the destination node is not specified, all connections from the source node to any other node are deleted.

      Type Parameters

      • R

      • S

      Parameters

      • src: IOPort<S>

        Source port of connection to be disconnected.

      • Optional dst: IOPort<R>

        Destination port of connection to be disconnected. If undefined, disconnect all connections from the source port.

        -

      Returns void

    Protected _getCausalityInterface

    • _getCausalityInterface(): PrecedenceGraph<Port<unknown>>

    • Return a dependency graph consisting of only this reactor's own ports +

    Returns void

    Protected _getCausalityInterface

    Protected _getContainer

    Protected _getFirstReactionOrMutation

    _getFullyQualifiedName

    Protected _getContainer

    Protected _getFirstReactionOrMutation

    _getFullyQualifiedName

    _getKey

    _getKey

    Protected _getLastMutation

    Returns undefined | symbol

    Protected _getLastMutation

    Protected _getLastReactionOrMutation

    Protected _getMutations

    Protected _getLastReactionOrMutation

    Protected _getMutations

    _getName

    _getName

    Protected _getPrecedenceGraph

    Protected _getPrecedenceGraph

    Parameters

    • depth: number = -1

      The depth of recursion.

      -

    Returns PrecedenceGraph<Reaction<Variable[]> | Port<unknown>>

    _getReactionIndex

    Returns PrecedenceGraph<Reaction<Variable[]> | Port<unknown>>

    _getReactionIndex

    Protected _getReactions

    Protected _getReactionsAndMutations

    Protected _initializeMutationScope

    Protected _initializeReactionScope

    _isContainedBy

    Returns number

    Protected _getReactions

    Protected _getReactionsAndMutations

    Protected _initializeMutationScope

    Protected _initializeReactionScope

    _isContainedBy

    _isContainedByContainerOf

    Returns boolean

    _isContainedByContainerOf

    _isDownstream

    Returns boolean

    _isDownstream

    _isRegistered

    _isRegistered

    _isUpstream

    _isUpstream

    Protected _linkToRuntimeObject

    Protected _linkToRuntimeObject

    _receiveRuntimeObject

    _receiveRuntimeObject

    _register

    Returns void

    _register

    _requestRuntimeObject

    Protected _unplug

    Returns void

    _requestRuntimeObject

    Protected _unplug

    Protected _unsetTimer

    Protected _unsetTimer

    Protected _unsetTimers

    Protected addMutation

    Protected addReaction

    Returns void

    Protected _unsetTimers

    Protected addMutation

    Protected addReaction

    allWritable

    canConnect

    allWritable

    canConnect

    Type Parameters

    • R

    • S

    Parameters

    • src: IOPort<S>

      The start point of a new connection.

    • dst: IOPort<R>

      The end point of a new connection.

      -

    Returns boolean

    canConnectCall

    getBankIndex

    Returns boolean

    canConnectCall

    getBankIndex

    getPortAbsentReaction

    getPortAbsentReaction

    getReactions

    getReactions

    getTpoLevel

    Protected nextReaction

    getTpoLevel

    Protected nextReaction

    Protected prevReaction

    Returns undefined | Reaction<Variable[]>

    Protected prevReaction

    Protected schedulable

    toString

    writable

    Static keyOfMatchingBank

    Static keyOfMatchingEntry

    Returns undefined | Reaction<Variable[]>

    Protected schedulable

    toString

    writable

    Static keyOfMatchingBank

    Static keyOfMatchingEntry

    Static keyOfMatchingMultiport

    Static keyOfMatchingMultiport

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/OutMultiPort.html b/classes/OutMultiPort.html index a36af2c1..6b9a544b 100644 --- a/classes/OutMultiPort.html +++ b/classes/OutMultiPort.html @@ -1,7 +1,7 @@ OutMultiPort | @lf-lang/reactor-ts

    Class OutMultiPort<T>

    A trigger that represents an output port that is also multiport.

    Author

    Marten Lohstroh marten@berkeley.edu

    Author

    Hokeun Kim hokeun@berkeley.edu

    -

    Type Parameters

    • T

    Hierarchy (view full)

    Constructors

    constructor +

    Type Parameters

    • T

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    _channels _key manager @@ -30,67 +30,67 @@

    Author

    Hokeun Kim hokeun@berkele keyOfMatchingEntry keyOfMatchingMultiport values -

    Constructors

    constructor

    Properties

    Protected _channels

    _channels: IOPort<T>[]

    The channels of this multiport.

    -

    Protected _key

    _key: symbol = ...

    A symbol that identifies this component, and it also used to selectively +

    Constructors

    constructor

    Properties

    Protected _channels

    _channels: IOPort<T>[]

    The channels of this multiport.

    +

    Protected _key

    _key: symbol = ...

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

    -

    Protected manager

    manager: __class<T> = ...

    Inner class instance to let the container configure this port.

    -

    Protected reactions

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

    Reactions to trigger.

    -

    Protected writer

    writer: __class<T> = ...

    Inner class instance to gain access to MultiWrite interface.

    -

    Static pathSeparator

    pathSeparator: string = "."

    Methods

    Protected _getContainer

    _getFullyQualifiedName

    Protected manager

    manager: __class<T> = ...

    Inner class instance to let the container configure this port.

    +

    Protected reactions

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

    Reactions to trigger.

    +

    Protected writer

    writer: __class<T> = ...

    Inner class instance to gain access to MultiWrite interface.

    +

    Static pathSeparator

    pathSeparator: string = "."

    Methods

    Protected _getContainer

    _getFullyQualifiedName

    _getName

    _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

    • _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 +

    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. +

    Returns boolean

    _isRegistered

    Protected _linkToRuntimeObject

    Protected _linkToRuntimeObject

    _receiveRuntimeObject

    asWritable

    channel

    _receiveRuntimeObject

    asWritable

    channel

    channels

    get

    Returns OutPort<T>

    channels

    get

    getContainer

    getManager

    getContainer

    getManager

    isPresent

    Returns TriggerManager

    isPresent

    toString

    values

    toString

    values

    width

    width

    Static keyOfMatchingBank

    Static keyOfMatchingEntry

    Static keyOfMatchingBank

    Static keyOfMatchingEntry

    Static keyOfMatchingMultiport

    Static keyOfMatchingMultiport

    Static values

    Static values

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/OutPort.html b/classes/OutPort.html index e41ea268..de10eae5 100644 --- a/classes/OutPort.html +++ b/classes/OutPort.html @@ -1,5 +1,5 @@ OutPort | @lf-lang/reactor-ts

    Class OutPort<T>

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

    -

    Type Parameters

    • T

    Hierarchy (view full)

    Constructors

    constructor +

    Type Parameters

    • T

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    _key manager reactions @@ -26,48 +26,48 @@ keyOfMatchingBank keyOfMatchingEntry keyOfMatchingMultiport -

    Constructors

    constructor

    Properties

    Protected _key

    _key: symbol = ...

    A symbol that identifies this component, and it also used to selectively +

    Constructors

    constructor

    Properties

    Protected _key

    _key: symbol = ...

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

    -

    Protected manager

    manager: IOPortManager<T> = ...

    Inner class instance to let the container configure this port.

    -

    Protected reactions

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

    Reactions to trigger.

    -

    Protected receivers

    receivers: Set<WritablePort<T>> = ...

    Protected runtime

    runtime: Runtime

    Protected tag

    tag: undefined | Tag

    The tag associated with this port's value, or undefined is there is none.

    -

    Protected value

    value: undefined | T

    The current value associated with this port.

    -

    Protected writer

    writer: __class<T> = ...

    Inner class instance to gain access to Write interface.

    -

    Static pathSeparator

    pathSeparator: string = "."

    Methods

    Protected _getContainer

    _getFullyQualifiedName

    Protected manager

    manager: IOPortManager<T> = ...

    Inner class instance to let the container configure this port.

    +

    Protected reactions

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

    Reactions to trigger.

    +

    Protected receivers

    receivers: Set<WritablePort<T>> = ...

    Protected runtime

    runtime: Runtime

    Protected tag

    tag: undefined | Tag

    The tag associated with this port's value, or undefined is there is none.

    +

    Protected value

    value: undefined | T

    The current value associated with this port.

    +

    Protected writer

    writer: __class<T> = ...

    Inner class instance to gain access to Write interface.

    +

    Static pathSeparator

    pathSeparator: string = "."

    Methods

    Protected _getContainer

    _getFullyQualifiedName

    _getName

    _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.

      +

      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 +

    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. +

    Returns boolean

    _isRegistered

    Protected _linkToRuntimeObject

    Protected _linkToRuntimeObject

    _receiveRuntimeObject

    asWritable

    get

    _receiveRuntimeObject

    asWritable

    get

    getContainer

    getManager

    isPresent

    toString

    Static keyOfMatchingBank

    Static keyOfMatchingEntry

    getContainer

    getManager

    isPresent

    toString

    Static keyOfMatchingBank

    Static keyOfMatchingEntry

    Static keyOfMatchingMultiport

    Static keyOfMatchingMultiport

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/Parameter.html b/classes/Parameter.html index 21ba2d4f..da8a3c04 100644 --- a/classes/Parameter.html +++ b/classes/Parameter.html @@ -1,7 +1,7 @@ Parameter | @lf-lang/reactor-ts

    Class Parameter<T>

    Abstract class for a schedulable action. It is intended as a wrapper for a regular action. In addition to a get method, it also has a schedule method that allows for the action to be scheduled.

    -

    Type Parameters

    • T

    Implements

    Constructors

    constructor +

    Type Parameters

    • T

    Implements

    Constructors

    constructor

    Properties

    value

    Methods

    get -

    Constructors

    constructor

    Properties

    Private Readonly value

    value: T

    Methods

    get

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Private Readonly value

    value: T

    Methods

    get

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/Port.html b/classes/Port.html index acc66822..8d01db0d 100644 --- a/classes/Port.html +++ b/classes/Port.html @@ -1,5 +1,5 @@ Port | @lf-lang/reactor-ts

    Class Port<T>Abstract

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

    -

    Type Parameters

    • T

    Hierarchy (view full)

    Constructors

    constructor +

    Type Parameters

    • T

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    _key reactions receivers @@ -21,48 +21,48 @@ keyOfMatchingBank keyOfMatchingEntry keyOfMatchingMultiport -

    Constructors

    constructor

    Properties

    Protected _key

    _key: symbol = ...

    A symbol that identifies this component, and it also used to selectively +

    Constructors

    constructor

    Properties

    Protected _key

    _key: symbol = ...

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

    -

    Protected reactions

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

    Reactions to trigger.

    -

    Protected receivers

    receivers: Set<WritablePort<T>> = ...

    Protected runtime

    runtime: Runtime

    Protected tag

    tag: undefined | Tag

    The tag associated with this port's value, or undefined is there is none.

    -

    Protected value

    value: undefined | T

    The current value associated with this port.

    -

    Static pathSeparator

    pathSeparator: string = "."

    Methods

    Protected _getContainer

    _getFullyQualifiedName

    Protected reactions

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

    Reactions to trigger.

    +

    Protected receivers

    receivers: Set<WritablePort<T>> = ...

    Protected runtime

    runtime: Runtime

    Protected tag

    tag: undefined | Tag

    The tag associated with this port's value, or undefined is there is none.

    +

    Protected value

    value: undefined | T

    The current value associated with this port.

    +

    Static pathSeparator

    pathSeparator: string = "."

    Methods

    Protected _getContainer

    _getFullyQualifiedName

    _getName

    _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.

      +

      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 +

    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. +

    Returns boolean

    _isRegistered

    Protected _linkToRuntimeObject

    Protected _linkToRuntimeObject

    _receiveRuntimeObject

    getContainer

    Abstract getManager

    _receiveRuntimeObject

    getContainer

    Abstract getManager

    isPresent

    Static keyOfMatchingBank

    Static keyOfMatchingEntry

    Returns TriggerManager

    isPresent

    Static keyOfMatchingBank

    Static keyOfMatchingEntry

    Static keyOfMatchingMultiport

    Static keyOfMatchingMultiport

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/PrecedenceGraph.html b/classes/PrecedenceGraph.html index 0bffa200..2d036fa9 100644 --- a/classes/PrecedenceGraph.html +++ b/classes/PrecedenceGraph.html @@ -1,5 +1,5 @@ PrecedenceGraph | @lf-lang/reactor-ts

    Class PrecedenceGraph<T>

    A generic precedence graph.

    -

    Type Parameters

    • T

    Hierarchy (view full)

    Constructors

    constructor +

    Type Parameters

    • T

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    adjacencyMap numberOfEdges toString @@ -18,29 +18,29 @@ toDotString toMermaidString

    Constructors

    constructor

    Properties

    Protected adjacencyMap

    adjacencyMap: Map<T, Set<T>> = ...

    A map from nodes to the set of their upstream neighbors.

    -

    Protected numberOfEdges

    numberOfEdges: number = 0

    The total number of edges in the graph.

    -

    toString

    toString: (() => string) = ...

    Type declaration

      • (): string

      • Returns string

    Methods

    addAll

    • addAll(pg): void

    • Add all the nodes and edges from the given precedence graph to this one.

      +

    Protected numberOfEdges

    numberOfEdges: number = 0

    The total number of edges in the graph.

    +

    toString

    toString: (() => string) = ...

    Type declaration

      • (): string

      • Returns string

    Methods

    addAll

    • addAll(pg): void

    • Add all the nodes and edges from the given precedence graph to this one.

      Parameters

      • pg: this

        A precedence graph

        -

      Returns void

    addEdge

    • addEdge(upstream, downstream): void

    • Add an edge from an upstream node to a downstream one.

      +

    Returns void

    addEdge

    • addEdge(upstream, downstream): void

    • Add an edge from an upstream node to a downstream one.

      Parameters

      • upstream: T

        The node at which the directed edge starts.

      • downstream: T

        The node at which the directed edge ends.

        -

      Returns void

    addNode

    • addNode(node): void

    • Add the given node to this graph.

      -

      Parameters

      • node: T

      Returns void

    getDownstreamNeighbors

    • getDownstreamNeighbors(node): Set<T>

    • Return the set of all downstream neighbors of the given node.

      +

    Returns void

    addNode

    • addNode(node): void

    • Add the given node to this graph.

      +

      Parameters

      • node: T

      Returns void

    getDownstreamNeighbors

    • getDownstreamNeighbors(node): Set<T>

    • Return the set of all downstream neighbors of the given node.

      Parameters

      • node: T

        The node to retrieve the outgoing nodes of.

        -

      Returns Set<T>

    getNodes

    • getNodes(): IterableIterator<T>

    • Return an iterator over the nodes in the graph.

      -

      Returns IterableIterator<T>

    getSinkNodes

    • getSinkNodes(): Set<T>

    • Return the nodes in the graph that have no downstream neighbors.

      -

      Returns Set<T>

    getSourceNodes

    • getSourceNodes(): Set<T>

    • Return the nodes in the graph that have no upstream neighbors.

      -

      Returns Set<T>

    getUpstreamNeighbors

    • getUpstreamNeighbors(node): Set<T>

    • Return the set of all upstream neighbors of the given node.

      +

    Returns Set<T>

    getNodes

    getSinkNodes

    getSourceNodes

    getUpstreamNeighbors

    hasCycle

    removeEdge

    Returns Set<T>

    hasCycle

    removeEdge

    removeNode

    Returns void

    removeNode

    size

    toDotString

    toMermaidString

    Returns void

    size

    toDotString

    toMermaidString

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/PrioritySet.html b/classes/PrioritySet.html index 73d23f55..a948e7e8 100644 --- a/classes/PrioritySet.html +++ b/classes/PrioritySet.html @@ -1,6 +1,6 @@ PrioritySet | @lf-lang/reactor-ts

    Class PrioritySet<P>

    A deduplicating priority queue that overwrites duplicate entries, based on a singly-linked list.

    -

    Type Parameters

    • P

    Constructors

    constructor +

    Type Parameters

    • P

    Constructors

    constructor

    Properties

    count head

    Methods

    empty @@ -9,12 +9,12 @@ push size

    Constructors

    constructor

    Properties

    Private count

    count: number = 0

    The number of elements in the queue.

    -

    Private head

    head: undefined | PrioritySetElement<P>

    The first-in-line element in the queue.

    -

    Methods

    empty

    peek

    pop

    push

    • push(element): void

    • Insert a new element into the queue based on its priority. +

    Private head

    head: undefined | PrioritySetElement<P>

    The first-in-line element in the queue.

    +

    Methods

    empty

    peek

    pop

    push

    • push(element): void

    • Insert a new element into the queue based on its priority. If a duplicate entry already exists, abort the insertion.

      Parameters

      Returns void

    size

    • size(): number

    • Return the number of elements in the queue.

      -

      Returns number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    size

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/Procedure.html b/classes/Procedure.html index e34606f1..a7fb4e29 100644 --- a/classes/Procedure.html +++ b/classes/Procedure.html @@ -2,7 +2,7 @@ the argument list of the react function that that is applied to when this reaction gets triggered.

    Author

    Marten Lohstroh marten@berkeley.edu

    -

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor +

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    active args next @@ -31,33 +31,33 @@
      • (...args): void

      • Parameters

        Returns void

  • Optional deadline: TimeValue

    The maximum amount by which logical time may lag behind physical time when react has been triggered and is ready to execute.

  • late: ((...args) => void) = ...

    Function that gets execute when triggered and "late."

    -
      • (...args): void

      • Parameters

        Returns void

    • Returns Procedure<T>

    Properties

    active

    active: boolean = false

    Indicates whether or not this reaction is active. A reaction become +

      • (...args): void

      • Parameters

        Returns void

    Returns Procedure<T>

    Properties

    active

    active: boolean = false

    Indicates whether or not this reaction is active. A reaction become active when its container starts up, inactive when its container shuts down.

    -

    Readonly args

    args: [...ArgList<T>[]]

    The arguments to be passed to react and late.

    -

    next

    next: undefined | PrioritySetElement<number>

    Pointer to the next reaction, used by the runtime when this reaction is staged +

    Readonly args

    args: [...ArgList<T>[]]

    The arguments to be passed to react and late.

    +

    next

    next: undefined | PrioritySetElement<number>

    Pointer to the next reaction, used by the runtime when this reaction is staged for execution at the current logical time.

    -

    Readonly trigs

    trigs: Variable[]

    The ports, actions, or timers, which, when they receive +

    Readonly trigs

    trigs: Variable[]

    The ports, actions, or timers, which, when they receive values, will trigger this reaction.

    -

    Methods

    doReact

    Methods

    doReact

    • doReact(): void

    • Invoke the react function in the appropriate sandbox and with the argument list that was specified upon the construction of this reaction object.

      -

      Returns void

    getPriority

    getPriority

    • getPriority(): number

    • Return the priority of this reaction. It determines the execution order among reactions staged for execution at the same logical time.

      -

      Returns number

    hasPriorityOver

    hasPriorityOver

    isTriggeredImmediately

    • isTriggeredImmediately(): boolean

    • Return true if this reaction is triggered immediately (by startup or a +

    Returns boolean

    isTriggeredImmediately

    setDeadline

    setDeadline

    • setDeadline(deadline): this

    • Set a deadline for this reaction. The given time value denotes the maximum allowable amount by which logical time may lag behind physical time at the point that this reaction is ready to execute. If this maximum lag is exceeded, the late function is executed instead of the react function.

      Parameters

      • deadline: TimeValue

        The deadline to set to this reaction.

        -

      Returns this

    setPriority

    • setPriority(priority): void

    • Set for reaction priority, to be used only by the runtime environment. +

    Returns this

    setPriority

    • setPriority(priority): void

    • Set for reaction priority, to be used only by the runtime environment. The priority of each reaction is determined on the basis of its dependencies on other reactions.

      Parameters

      • priority: number

        The priority for this reaction.

        -

      Returns void

    toString

    updateIfDuplicateOf

    • updateIfDuplicateOf(node): boolean

    • Return whether another, newly staged reaction is equal to this one. +

    Returns void

    toString

    updateIfDuplicateOf

    • updateIfDuplicateOf(node): boolean

    • Return whether another, newly staged reaction is equal to this one. Because reactions are just object references, no updating is necessary. Returning true just signals that the scheduler shouldn't stage it twice.

      -

      Parameters

      Returns boolean

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns boolean

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/Reaction.html b/classes/Reaction.html index 9f437b8a..36a34431 100644 --- a/classes/Reaction.html +++ b/classes/Reaction.html @@ -2,7 +2,7 @@ the argument list of the react function that that is applied to when this reaction gets triggered.

    Author

    Marten Lohstroh marten@berkeley.edu

    -

    Type Parameters

    Hierarchy (view full)

    Implements

    Constructors

    constructor +

    Type Parameters

    Hierarchy (view full)

    Implements

    Constructors

    constructor

    Properties

    active args deadline? @@ -37,44 +37,44 @@
      • (...args): void

      • Parameters

        Returns void

  • Optional deadline: TimeValue

    The maximum amount by which logical time may lag behind physical time when react has been triggered and is ready to execute.

  • late: ((...args) => void) = ...

    Function that gets execute when triggered and "late."

    -
      • (...args): void

      • Parameters

        Returns void

    • Returns Reaction<T>

    Properties

    active

    active: boolean = false

    Indicates whether or not this reaction is active. A reaction become +

      • (...args): void

      • Parameters

        Returns void

    Returns Reaction<T>

    Properties

    active

    active: boolean = false

    Indicates whether or not this reaction is active. A reaction become active when its container starts up, inactive when its container shuts down.

    -

    Readonly args

    args: [...ArgList<T>[]]

    The arguments to be passed to react and late.

    -

    Private Optional deadline

    deadline?: TimeValue

    The maximum amount by which logical time may lag behind +

    Readonly args

    args: [...ArgList<T>[]]

    The arguments to be passed to react and late.

    +

    Private Optional deadline

    deadline?: TimeValue

    The maximum amount by which logical time may lag behind physical time when react has been triggered and is ready to execute.

    -

    Private Readonly late

    late: ((...args) => void) = ...

    Function that gets execute when triggered and "late."

    +

    Private Readonly late

    late: ((...args) => void) = ...

    Function that gets execute when triggered and "late."

    Type declaration

      • (...args): void

      • Function that gets execute when triggered and "late."

        -

        Parameters

        Returns void

    next

    next: undefined | PrioritySetElement<number>

    Pointer to the next reaction, used by the runtime when this reaction is staged +

    Parameters

    Returns void

    next

    next: undefined | PrioritySetElement<number>

    Pointer to the next reaction, used by the runtime when this reaction is staged for execution at the current logical time.

    -

    Private priority

    priority: number = 0

    Priority derived from this reaction's location in the dependency graph +

    Private priority

    priority: number = 0

    Priority derived from this reaction's location in the dependency graph that spans the entire hierarchy of components inside the top-level reactor that this reaction is also embedded in.

    -

    Private Readonly react

    react: ((...args) => void)

    Function that gets execute when triggered and "on time."

    +

    Private Readonly react

    react: ((...args) => void)

    Function that gets execute when triggered and "on time."

    Type declaration

      • (...args): void

      • Function that gets execute when triggered and "on time."

        -

        Parameters

        Returns void

    Private Readonly reactor

    reactor: Reactor

    The owner of this reaction.

    -

    Private Readonly sandbox

    sandbox: ReactionSandbox

    The this object for react and late.

    -

    Readonly trigs

    trigs: Variable[]

    The ports, actions, or timers, which, when they receive +

    Parameters

    Returns void

    Private Readonly reactor

    reactor: Reactor

    The owner of this reaction.

    +

    Private Readonly sandbox

    sandbox: ReactionSandbox

    The this object for react and late.

    +

    Readonly trigs

    trigs: Variable[]

    The ports, actions, or timers, which, when they receive values, will trigger this reaction.

    -

    Methods

    doReact

    • doReact(): void

    • Invoke the react function in the appropriate sandbox and with the argument +

    Methods

    doReact

    • doReact(): void

    • Invoke the react function in the appropriate sandbox and with the argument list that was specified upon the construction of this reaction object.

      -

      Returns void

    getPriority

    • getPriority(): number

    • Return the priority of this reaction. It determines the execution order among +

      Returns void

    getPriority

    • getPriority(): number

    • Return the priority of this reaction. It determines the execution order among reactions staged for execution at the same logical time.

      -

      Returns number

    hasPriorityOver

    hasPriorityOver

    isTriggeredImmediately

    • isTriggeredImmediately(): boolean

    • Return true if this reaction is triggered immediately (by startup or a +

    Returns boolean

    isTriggeredImmediately

    • isTriggeredImmediately(): boolean

    • Return true if this reaction is triggered immediately (by startup or a timer with zero offset).

      -

      Returns boolean

    setDeadline

    • setDeadline(deadline): this

    • Set a deadline for this reaction. The given time value denotes the maximum +

      Returns boolean

    setDeadline

    • setDeadline(deadline): this

    • Set a deadline for this reaction. The given time value denotes the maximum allowable amount by which logical time may lag behind physical time at the point that this reaction is ready to execute. If this maximum lag is exceeded, the late function is executed instead of the react function.

      Parameters

      • deadline: TimeValue

        The deadline to set to this reaction.

        -

      Returns this

    setPriority

    • setPriority(priority): void

    • Set for reaction priority, to be used only by the runtime environment. +

    Returns this

    setPriority

    • setPriority(priority): void

    • Set for reaction priority, to be used only by the runtime environment. The priority of each reaction is determined on the basis of its dependencies on other reactions.

      Parameters

      • priority: number

        The priority for this reaction.

        -

      Returns void

    toString

    • toString(): string

    • Return string representation of the reaction.

      -

      Returns string

    updateIfDuplicateOf

    • updateIfDuplicateOf(node): boolean

    • Return whether another, newly staged reaction is equal to this one. +

    Returns void

    toString

    • toString(): string

    • Return string representation of the reaction.

      +

      Returns string

    updateIfDuplicateOf

    • updateIfDuplicateOf(node): boolean

    • Return whether another, newly staged reaction is equal to this one. Because reactions are just object references, no updating is necessary. Returning true just signals that the scheduler shouldn't stage it twice.

      -

      Parameters

      Returns boolean

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns boolean

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/ReactionGraph.html b/classes/ReactionGraph.html index 51b2f579..e1497706 100644 --- a/classes/ReactionGraph.html +++ b/classes/ReactionGraph.html @@ -1,5 +1,5 @@ ReactionGraph | @lf-lang/reactor-ts

    Class ReactionGraph

    A sortable precedence graph for reactions.

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    adjacencyMap numberOfEdges toString @@ -18,33 +18,33 @@ toDotString toMermaidString updatePriorities -

    Constructors

    constructor

    Properties

    Protected adjacencyMap

    adjacencyMap: Map<Reaction<Variable[]>, Set<Reaction<Variable[]>>> = ...

    A map from nodes to the set of their upstream neighbors.

    -

    Protected numberOfEdges

    numberOfEdges: number = 0

    The total number of edges in the graph.

    -

    toString

    toString: (() => string) = ...

    Type declaration

      • (): string

      • Returns string

    Methods

    addAll

    • addAll(pg): void

    • Add all the nodes and edges from the given precedence graph to this one.

      +

    Constructors

    constructor

    Properties

    Protected adjacencyMap

    adjacencyMap: Map<Reaction<Variable[]>, Set<Reaction<Variable[]>>> = ...

    A map from nodes to the set of their upstream neighbors.

    +

    Protected numberOfEdges

    numberOfEdges: number = 0

    The total number of edges in the graph.

    +

    toString

    toString: (() => string) = ...

    Type declaration

      • (): string

      • Returns string

    Methods

    addAll

    addEdge

    • addEdge(upstream, downstream): void

    • Add an edge from an upstream node to a downstream one.

      +

    Returns void

    addEdge

    addNode

    getDownstreamNeighbors

    • getDownstreamNeighbors(node): Set<Reaction<Variable[]>>

    • Return the set of all downstream neighbors of the given node.

      +

    Returns void

    addNode

    getDownstreamNeighbors

    getNodes

    getSinkNodes

    getSourceNodes

    getUpstreamNeighbors

    Returns Set<Reaction<Variable[]>>

    getNodes

    getSinkNodes

    getSourceNodes

    getUpstreamNeighbors

    hasCycle

    removeEdge

    Returns Set<Reaction<Variable[]>>

    hasCycle

    removeEdge

    removeNode

    Returns void

    removeNode

    size

    toDotString

    toMermaidString

    Returns void

    size

    toDotString

    toMermaidString

    updatePriorities

    Returns string

    updatePriorities

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/Reactor.html b/classes/Reactor.html index d464c857..12a0c657 100644 --- a/classes/Reactor.html +++ b/classes/Reactor.html @@ -3,7 +3,7 @@ other reactor. Its reactions can consist of altering its own state, sending messages to other reactors, or affecting the environment through some kind of actuation or side effect.

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    __dummy _active _bankIndex @@ -86,13 +86,13 @@ keyOfMatchingMultiport

    Constructors

    constructor

    Properties

    Readonly __dummy

    __dummy: Dummy

    This reactor's dummy action.

    -

    Protected _active

    _active: boolean = false

    Indicates whether this reactor is active (meaning it has reacted to a +

    Returns Reactor

    Properties

    Readonly __dummy

    __dummy: Dummy

    This reactor's dummy action.

    +

    Protected _active

    _active: boolean = false

    Indicates whether this reactor is active (meaning it has reacted to a startup action), or not (in which case it either never started up or has reacted to a shutdown action).

    -

    Private Readonly _bankIndex

    _bankIndex: number

    Index that specifies the location of the reactor instance in a bank, +

    Private Readonly _bankIndex

    _bankIndex: number

    Index that specifies the location of the reactor instance in a bank, if it is a member of one.

    -

    Private Readonly _causalityGraph

    _causalityGraph: PrecedenceGraph<Port<unknown>> = ...

    This graph has some overlap with the reactors dependency graph, but is +

    Private Readonly _causalityGraph

    _causalityGraph: PrecedenceGraph<Port<unknown>> = ...

    This graph has some overlap with the reactors dependency graph, but is different in two respects:

    • transitive dependencies between ports have been collapsed; and
      • @@ -101,26 +101,26 @@ connection at runtime could result in a cyclic dependency, without having to consult other reactors.
    -

    Protected _dependencyGraph

    _dependencyGraph: PrecedenceGraph<Reaction<Variable[]> | Port<unknown>> = ...

    This graph has in it all the dependencies implied by this container's +

    Protected _dependencyGraph

    _dependencyGraph: PrecedenceGraph<Reaction<Variable[]> | Port<unknown>> = ...

    This graph has in it all the dependencies implied by this container's ports, reactions, and connections.

    -

    Protected _key

    _key: symbol = ...

    A symbol that identifies this component, and it also used to selectively +

    Protected _key

    _key: symbol = ...

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

    -

    Private Readonly _keyChain

    _keyChain: Map<Component, symbol> = ...

    Data structure to keep track of registered components. +

    Private Readonly _keyChain

    _keyChain: Map<Component, symbol> = ...

    Data structure to keep track of registered components. Note: declare this class member before any other ones as they may attempt to access it.

    -

    Private Readonly _mutationSandbox

    _mutationSandbox: typeof __class = ...

    Inner class intended to provide access to methods that should be +

    Private Readonly _mutationSandbox

    _mutationSandbox: typeof __class = ...

    Inner class intended to provide access to methods that should be accessible to mutations, not to reactions.

    -

    Private _mutationScope

    _mutationScope: MutationSandbox

    Sandbox for the execution of mutations.

    -

    Private Readonly _mutations

    _mutations: Mutation<Variable[]>[] = []

    The list of mutations this reactor has.

    -

    Private Readonly _reactionSandbox

    _reactionSandbox: typeof __class = ...

    Inner class that furnishes an execution environment for reactions.

    -

    Private _reactionScope

    _reactionScope: ReactionSandbox

    Sandbox for the execution of reactions.

    -

    Private Readonly _reactions

    _reactions: Reaction<Variable[]>[] = []

    The list of reactions this reactor has.

    -

    Private _runtime

    _runtime: Runtime

    The runtime object, which has a collection of privileged functions that are passed down from the +

    Private _mutationScope

    _mutationScope: MutationSandbox

    Sandbox for the execution of mutations.

    +

    Private Readonly _mutations

    _mutations: Mutation<Variable[]>[] = []

    The list of mutations this reactor has.

    +

    Private Readonly _reactionSandbox

    _reactionSandbox: typeof __class = ...

    Inner class that furnishes an execution environment for reactions.

    +

    Private _reactionScope

    _reactionScope: ReactionSandbox

    Sandbox for the execution of reactions.

    +

    Private Readonly _reactions

    _reactions: Reaction<Variable[]>[] = []

    The list of reactions this reactor has.

    +

    Private _runtime

    _runtime: Runtime

    The runtime object, which has a collection of privileged functions that are passed down from the container.

    -

    Readonly shutdown

    shutdown: Shutdown

    This reactor's shutdown action.

    -

    Readonly startup

    startup: Startup

    This reactor's startup action.

    -

    Protected util

    util: UtilityFunctions

    Collection of utility functions for this reactor and its subclasses.

    -

    Static pathSeparator

    pathSeparator: string = "."

    Methods

    Private _addHierarchicalDependencies

    Private _addRPCDependencies

    Protected _connect

    • _connect<R, S>(src, dst): void

    • Connect a source port to a downstream destination port. If a source is a +

    Readonly shutdown

    shutdown: Shutdown

    This reactor's shutdown action.

    +

    Readonly startup

    startup: Startup

    This reactor's startup action.

    +

    Protected util

    util: UtilityFunctions

    Collection of utility functions for this reactor and its subclasses.

    +

    Static pathSeparator

    pathSeparator: string = "."

    Methods

    Private _addHierarchicalDependencies

    Private _addRPCDependencies

    Protected _connect

    • _connect<R, S>(src, dst): void

    • Connect a source port to a downstream destination port. If a source is a regular port, then the type variable of the source has to be a subtype of the type variable of the destination. If the source is a caller port, then the destination has to be a callee port that is effectively a @@ -130,22 +130,22 @@ the caller's.

      Type Parameters

      • R

      • S

      Parameters

      • src: IOPort<S>

        The source port to connect.

      • dst: IOPort<R>

        The destination port to connect.

        -

      Returns void

    Protected _connectCall

    Protected _connectMulti

    Private _delete

    • _delete(): void

    • Mark this reactor for deletion, trigger all of its shutdown reactions +

    Returns void

    Protected _connectCall

    Protected _connectMulti

    Private _delete

    • _delete(): void

    • Mark this reactor for deletion, trigger all of its shutdown reactions and mutations, and also delete all of the reactors that this reactor contains.

      -

      Returns void

    Private _deleteConnections

    • _deleteConnections(reactor): void

    • Remove all the connections associated with a given reactor.

      -

      Parameters

      Returns void

    _deregister

    • _deregister(reactor, key): void

    • Remove the given reactor and its connections from this container if +

      Returns void

    Private _deleteConnections

    • _deleteConnections(reactor): void

    • Remove all the connections associated with a given reactor.

      +

      Parameters

      Returns void

    _deregister

    • _deregister(reactor, key): void

    • Remove the given reactor and its connections from this container if the key matches.

      -

      Parameters

      Returns void

    Protected _disconnect

    • _disconnect<R, S>(src, dst?): void

    • Delete the connection between the source and destination nodes. +

      Parameters

      Returns void

    Protected _disconnect

    • _disconnect<R, S>(src, dst?): void

    • Delete the connection between the source and destination nodes. If the destination node is not specified, all connections from the source node to any other node are deleted.

      Type Parameters

      • R

      • S

      Parameters

      • src: IOPort<S>

        Source port of connection to be disconnected.

      • Optional dst: IOPort<R>

        Destination port of connection to be disconnected. If undefined, disconnect all connections from the source port.

        -

      Returns void

    Private _findOwnCalleePorts

    Private _findOwnInputs

    Private _findOwnOutputs

    Private _findOwnPorts

    Private _findOwnReactors

    Protected _getCausalityInterface

    • _getCausalityInterface(): PrecedenceGraph<Port<unknown>>

    • Return a dependency graph consisting of only this reactor's own ports +

    Returns void

    Private _findOwnCalleePorts

    Private _findOwnInputs

    Private _findOwnOutputs

    Private _findOwnPorts

    Private _findOwnReactors

    Protected _getCausalityInterface

    Protected _getContainer

    Private _getFirst

    Protected _getFirstReactionOrMutation

    _getFullyQualifiedName

    Protected _getContainer

    Private _getFirst

    Protected _getFirstReactionOrMutation

    _getFullyQualifiedName

    _getKey

    _getKey

    • _getKey(component, key?): undefined | symbol

    • If the given component is owned by this reactor, look up its key and return it. Otherwise, if a key has been provided, and it matches the key of this reactor, also look up the component's key and return it. Otherwise, if the component is owned by a reactor that is owned by @@ -155,16 +155,16 @@

      Parameters

      • component: Trigger

        The component to look up the key for.

      • Optional key: symbol

        The key that verifies the containment relation between this reactor and the component, with at most one level of indirection.

        -

      Returns undefined | symbol

    Private _getLast

    Protected _getLastMutation

    • _getLastMutation(): undefined | Mutation<Variable[]>

    • Return the last mutation of this reactor. All contained reactors +

    Returns undefined | symbol

    Private _getLast

    Protected _getLastMutation

    Protected _getLastReactionOrMutation

    Protected _getMutations

    Protected _getLastReactionOrMutation

    Protected _getMutations

    • _getMutations(): Reaction<Variable[]>[]

    • Return a list of reactions owned by this reactor.

      The returned list is a copy of the list kept inside of the reactor, so changing it will not affect this reactor.

      -

      Returns Reaction<Variable[]>[]

    _getName

    _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

    Private _getOwnReactors

    Protected _getPrecedenceGraph

    Private _getOwnReactors

    Protected _getPrecedenceGraph

    • _getPrecedenceGraph(depth?): PrecedenceGraph<Reaction<Variable[]> | Port<unknown>>

    • Recursively collect the local dependency graph of each contained reactor and merge them all in one graph.

      The recursion depth can be limited via the depth parameter. A depth of 0 will only return the local dependency graph of this reactor, a depth @@ -178,55 +178,55 @@

    • RPCs occur in a deterministic order.

    Parameters

    • depth: number = -1

      The depth of recursion.

      -

    Returns PrecedenceGraph<Reaction<Variable[]> | Port<unknown>>

    _getReactionIndex

    • _getReactionIndex(reaction): number

    • Return the index of the reaction given as an argument.

      +

    Returns PrecedenceGraph<Reaction<Variable[]> | Port<unknown>>

    _getReactionIndex

    • _getReactionIndex(reaction): number

    • Return the index of the reaction given as an argument.

      Parameters

      Returns number

    Protected _getReactions

    Protected _getReactionsAndMutations

    Protected _initializeMutationScope

    Protected _initializeReactionScope

    _isContainedBy

    • _isContainedBy(reactor): boolean

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

      +

    Returns number

    Protected _getReactions

    Protected _getReactionsAndMutations

    Protected _initializeMutationScope

    Protected _initializeReactionScope

    _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 +

    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

    _isDownstream

    • _isDownstream(port): boolean

    • Report whether the given port is downstream of this reactor. If so, the +

    Returns boolean

    _isDownstream

    • _isDownstream(port): boolean

    • Report whether the given port is downstream of this reactor. If so, the given port can be connected to with an output port of this reactor.

      -

      Parameters

      Returns boolean

    Private _isInScope

    _isRegistered

    • _isRegistered(): boolean

    • Report whether this component has been registered with its container or not. +

      Parameters

      Returns boolean

    Private _isInScope

    _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

    _isUpstream

    _isUpstream

    • _isUpstream(port): boolean

    • Report whether the given port is upstream of this reactor. If so, the given port can be connected to an input port of this reactor.

      -

      Parameters

      Returns boolean

    Protected _linkToRuntimeObject

    • _linkToRuntimeObject(): void

    • Request the container to pass down its runtime object to this component. +

      Parameters

      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

    _receiveRuntimeObject

    • _receiveRuntimeObject(runtime): void

    • Receive the runtime object from the container of this reactor. Invoking this method in any user-written code will result in a runtime error.

      Parameters

      • runtime: Runtime

        The runtime object handed down from the container.

        -

      Returns void

    Private _recordDeps

    _register

    • _register(component, key): void

    • Add a component to this container.

      +

    Returns void

    Private _recordDeps

    _register

    • _register(component, key): void

    • Add a component to this container.

      A component that is created as part of this reactor invokes this method upon creation.

      Parameters

      • component: Component

        The component to register.

      • key: symbol

        The component's key.

        -

      Returns void

    _requestRuntimeObject

    Private _uncheckedConnect

    • _uncheckedConnect<R, S>(src, dst): void

    • Connect a source port to a downstream destination port without canConnect() check. +

    Returns void

    _requestRuntimeObject

    Private _uncheckedConnect

    • _uncheckedConnect<R, S>(src, dst): void

    • Connect a source port to a downstream destination port without canConnect() check. This must be used with caution after checking canConnect for the given ports.

      Type Parameters

      • R

      • S

      Parameters

      • src: IOPort<S>

        The source port to connect.

      • dst: IOPort<R>

        The destination port to connect.

        -

      Returns void

    Private _uncheckedDisconnect

    Protected _unplug

    • _unplug(): void

    • Remove this reactor from its container and sever any connections it may +

    Returns void

    Private _uncheckedDisconnect

    Protected _unplug

    • _unplug(): void

    • Remove this reactor from its container and sever any connections it may still have. This reactor will become defunct and is ready for garbage collection.

      -

      Returns void

    Protected _unsetTimer

    • _unsetTimer(timer): void

    • Report a timer to the app so that it gets unscheduled.

      +

      Returns void

    Protected _unsetTimer

    • _unsetTimer(timer): void

    • Report a timer to the app so that it gets unscheduled.

      Parameters

      • timer: Timer

        The timer to report to the app.

        -

      Returns void

    Protected _unsetTimers

    • _unsetTimers(): void

    • Unset all the timers of this reactor.

      -

      Returns void

    Protected addMutation

    Protected addReaction

    • addReaction<T>(trigs, args, react, deadline?, late?): void

    • Add a reaction to this reactor. Each newly added reaction will acquire a +

    Returns void

    Protected _unsetTimers

    • _unsetTimers(): void

    • Unset all the timers of this reactor.

      +

      Returns void

    Protected addMutation

    Protected addReaction

    • addReaction<T>(trigs, args, react, deadline?, late?): void

    • Add a reaction to this reactor. Each newly added reaction will acquire a dependency either on the previously added reaction, or on the last added mutation (in case no reactions had been added prior to this one). A reaction is specified by a list of triggers, a list of arguments, a react function, an optional deadline, and an optional late function (which represents the reaction body of the deadline). All triggers a reaction needs access must be included in the arguments.

      -

      Type Parameters

      Parameters

      Returns void

    allWritable

    canConnect

    allWritable

    canConnect

    • canConnect<R, S>(src, dst): boolean

    • Returns true if a given source port can be connected to the given destination port, false otherwise. Valid connections must: (1) adhere to the scoping rules and connectivity constraints @@ -241,26 +241,26 @@

    Type Parameters

    • R

    • S

    Parameters

    • src: IOPort<S>

      The start point of a new connection.

    • dst: IOPort<R>

      The end point of a new connection.

      -

    Returns boolean

    canConnectCall

    getBankIndex

    • getBankIndex(): number

    • Return the location of the reactor instance in a bank, +

    Returns boolean

    canConnectCall

    getBankIndex

    • getBankIndex(): number

    • Return the location of the reactor instance in a bank, if it is a member of one; return -1 otherwise.

      -

      Returns number

    Protected nextReaction

    Protected nextReaction

    Protected prevReaction

    • prevReaction(reaction): undefined | Reaction<Variable[]>

    • Given a reaction, return the reaction within this reactor that directly +

    Returns undefined | Reaction<Variable[]>

    Protected prevReaction

    Protected schedulable

    toString

    • toString(): string

    • Return the fully qualified name of this reactor.

      -

      Returns string

    writable

    Static keyOfMatchingBank

    Static keyOfMatchingEntry

    • keyOfMatchingEntry(component, object): string

    • Given a component and its container (the global object if the component +

    Returns undefined | Reaction<Variable[]>

    Protected schedulable

    toString

    • toString(): string

    • Return the fully qualified name of this reactor.

      +

      Returns string

    writable

    Static keyOfMatchingBank

    Static keyOfMatchingEntry

    • 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

      -

    Static keyOfMatchingMultiport

    Static keyOfMatchingMultiport

    • 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

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/RemoteFederatePort.html b/classes/RemoteFederatePort.html index b295aa95..fe47c129 100644 --- a/classes/RemoteFederatePort.html +++ b/classes/RemoteFederatePort.html @@ -1,7 +1,7 @@ RemoteFederatePort | @lf-lang/reactor-ts

    Class RemoteFederatePort

    A RemoteFederatePort represents a FederateInPort in another federate. It contains the information needed to address RTI messages to the remote port.

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    federateID portID -

    Constructors

    constructor

    Properties

    federateID

    federateID: number

    portID

    portID: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    federateID

    federateID: number

    portID

    portID: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/SchedulableAction.html b/classes/SchedulableAction.html index a7bfef3f..465505d7 100644 --- a/classes/SchedulableAction.html +++ b/classes/SchedulableAction.html @@ -1,5 +1,5 @@ SchedulableAction | @lf-lang/reactor-ts

    Class SchedulableAction<T>Abstract

    Interface for schedulable actions.

    -

    Type Parameters

    • T

    Implements

    Constructors

    constructor +

    Type Parameters

    • T

    Implements

    Constructors

    constructor

    Methods

    get schedule -

    Constructors

    constructor

    Methods

    Abstract get

    Abstract schedule

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Methods

    Abstract get

    Abstract schedule

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/ScheduledTrigger.html b/classes/ScheduledTrigger.html index a8e9d28d..caae1bc0 100644 --- a/classes/ScheduledTrigger.html +++ b/classes/ScheduledTrigger.html @@ -1,4 +1,4 @@ -ScheduledTrigger | @lf-lang/reactor-ts

    Class ScheduledTrigger<T>Abstract

    Type Parameters

    • T

    Hierarchy (view full)

    Constructors

    constructor +ScheduledTrigger | @lf-lang/reactor-ts

    Class ScheduledTrigger<T>Abstract

    Type Parameters

    • T

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    _key manager reactions @@ -21,51 +21,51 @@ keyOfMatchingBank keyOfMatchingEntry keyOfMatchingMultiport -

    Constructors

    constructor

    Properties

    Protected _key

    _key: symbol = ...

    A symbol that identifies this component, and it also used to selectively +

    Constructors

    constructor

    Properties

    Protected _key

    _key: symbol = ...

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

    -

    Protected manager

    manager: __class<T> = ...

    Protected reactions

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

    Reactions to trigger.

    -

    Protected runtime

    runtime: Runtime

    Protected tag

    tag: undefined | Tag

    Protected value

    value: undefined | T = undefined

    Static pathSeparator

    pathSeparator: string = "."

    Methods

    Protected _getContainer

    _getFullyQualifiedName

    Protected manager

    manager: __class<T> = ...

    Protected reactions

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

    Reactions to trigger.

    +

    Protected runtime

    runtime: Runtime

    Protected tag

    tag: undefined | Tag

    Protected value

    value: undefined | T = undefined

    Static pathSeparator

    pathSeparator: string = "."

    Methods

    Protected _getContainer

    _getFullyQualifiedName

    _getName

    _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.

      +

      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 +

    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. +

    Returns boolean

    _isRegistered

    Protected _linkToRuntimeObject

    Protected _linkToRuntimeObject

    _receiveRuntimeObject

    getContainer

    getManager

    _receiveRuntimeObject

    getContainer

    getManager

    isPresent

    Returns TriggerManager

    isPresent

    update

    update

    Static keyOfMatchingBank

    Static keyOfMatchingEntry

    Returns void

    Static keyOfMatchingBank

    Static keyOfMatchingEntry

    Static keyOfMatchingMultiport

    Static keyOfMatchingMultiport

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/Shutdown.html b/classes/Shutdown.html index 13e30506..f891760d 100644 --- a/classes/Shutdown.html +++ b/classes/Shutdown.html @@ -5,7 +5,7 @@ event or as a delayed response to some input event. The action can be scheduled by a reactor by invoking the schedule function in a reaction or in an asynchronous callback that has been set up in a reaction.

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    _key manager minDelay @@ -35,51 +35,51 @@ keyOfMatchingBank keyOfMatchingEntry keyOfMatchingMultiport -

    Constructors

    constructor

    Properties

    Protected _key

    _key: symbol = ...

    A symbol that identifies this component, and it also used to selectively +

    Constructors

    constructor

    Properties

    Protected _key

    _key: symbol = ...

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

    -

    Protected manager

    manager: __class<unknown> = ...

    Readonly minDelay

    minDelay: TimeValue

    Readonly minInterArrival

    minInterArrival: TimeValue = defaultMIT

    Readonly origin

    origin: Origin

    Protected reactions

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

    Reactions to trigger.

    -

    Protected runtime

    runtime: Runtime

    Protected scheduler

    scheduler: __class<unknown, unknown> = ...

    Protected tag

    tag: undefined | Tag

    Protected value

    value: unknown = undefined

    Static pathSeparator

    pathSeparator: string = "."

    Methods

    Protected _getContainer

    _getFullyQualifiedName

    Protected manager

    manager: __class<unknown> = ...

    Readonly minDelay

    minDelay: TimeValue

    Readonly minInterArrival

    minInterArrival: TimeValue = defaultMIT

    Readonly origin

    origin: Origin

    Protected reactions

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

    Reactions to trigger.

    +

    Protected runtime

    runtime: Runtime

    Protected scheduler

    scheduler: __class<unknown, unknown> = ...

    Protected tag

    tag: undefined | Tag

    Protected value

    value: unknown = undefined

    Static pathSeparator

    pathSeparator: string = "."

    Methods

    Protected _getContainer

    _getFullyQualifiedName

    _getName

    _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.

      +

      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 +

    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. +

    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

    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

    asSchedulable

    get

    getContainer

    getManager

    _receiveRuntimeObject

    asSchedulable

    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 +

    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

    update

    toString

    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

    Static keyOfMatchingBank

    Static keyOfMatchingEntry

    • keyOfMatchingEntry(component, object): string

    • Given a component and its container (the global object if the component +

    Returns void

    Static keyOfMatchingBank

    Static keyOfMatchingEntry

    • 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

      -

    Static keyOfMatchingMultiport

    Static keyOfMatchingMultiport

    • 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

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/SortablePrecedenceGraph.html b/classes/SortablePrecedenceGraph.html index fc6027cb..8be39ee2 100644 --- a/classes/SortablePrecedenceGraph.html +++ b/classes/SortablePrecedenceGraph.html @@ -1,5 +1,5 @@ SortablePrecedenceGraph | @lf-lang/reactor-ts

    Class SortablePrecedenceGraph<T>

    A precedence graph with nodes that are sortable by assigning a numeric priority.

    -

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor +

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    adjacencyMap numberOfEdges toString @@ -23,33 +23,33 @@ the original lineage.

    Type Parameters

    Parameters

    • Optional type: (new (...args) => T)

      A type that extends T.

        • new (...args): T

        • Parameters

          • Rest ...args: never[]

          Returns T

    • Optional pg: PrecedenceGraph<unknown>

      A precedence graph.

      -

    Returns SortablePrecedenceGraph<T>

    Properties

    Protected adjacencyMap

    adjacencyMap: Map<T, Set<T>> = ...

    A map from nodes to the set of their upstream neighbors.

    -

    Protected numberOfEdges

    numberOfEdges: number = 0

    The total number of edges in the graph.

    -

    toString

    toString: (() => string) = ...

    Type declaration

      • (): string

      • Returns string

    Methods

    addAll

    • addAll(pg): void

    • Add all the nodes and edges from the given precedence graph to this one.

      +

    Returns SortablePrecedenceGraph<T>

    Properties

    Protected adjacencyMap

    adjacencyMap: Map<T, Set<T>> = ...

    A map from nodes to the set of their upstream neighbors.

    +

    Protected numberOfEdges

    numberOfEdges: number = 0

    The total number of edges in the graph.

    +

    toString

    toString: (() => string) = ...

    Type declaration

      • (): string

      • Returns string

    Methods

    addAll

    • addAll(pg): void

    • Add all the nodes and edges from the given precedence graph to this one.

      Parameters

      • pg: this

        A precedence graph

        -

      Returns void

    addEdge

    • addEdge(upstream, downstream): void

    • Add an edge from an upstream node to a downstream one.

      +

    Returns void

    addEdge

    • addEdge(upstream, downstream): void

    • Add an edge from an upstream node to a downstream one.

      Parameters

      • upstream: T

        The node at which the directed edge starts.

      • downstream: T

        The node at which the directed edge ends.

        -

      Returns void

    addNode

    getDownstreamNeighbors

    • getDownstreamNeighbors(node): Set<T>

    • Return the set of all downstream neighbors of the given node.

      +

    Returns void

    addNode

    getDownstreamNeighbors

    getNodes

    getSinkNodes

    getSourceNodes

    getUpstreamNeighbors

    Returns Set<T>

    getNodes

    getSinkNodes

    getSourceNodes

    getUpstreamNeighbors

    hasCycle

    removeEdge

    Returns Set<T>

    hasCycle

    removeEdge

    removeNode

    Returns void

    removeNode

    size

    toDotString

    toMermaidString

    Returns void

    size

    toDotString

    toMermaidString

    updatePriorities

    Returns string

    updatePriorities

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/Startup.html b/classes/Startup.html index d97d4bff..e295a477 100644 --- a/classes/Startup.html +++ b/classes/Startup.html @@ -5,7 +5,7 @@ event or as a delayed response to some input event. The action can be scheduled by a reactor by invoking the schedule function in a reaction or in an asynchronous callback that has been set up in a reaction.

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    _key manager minDelay @@ -35,51 +35,51 @@ keyOfMatchingBank keyOfMatchingEntry keyOfMatchingMultiport -

    Constructors

    constructor

    Properties

    Protected _key

    _key: symbol = ...

    A symbol that identifies this component, and it also used to selectively +

    Constructors

    constructor

    Properties

    Protected _key

    _key: symbol = ...

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

    -

    Protected manager

    manager: __class<unknown> = ...

    Readonly minDelay

    minDelay: TimeValue

    Readonly minInterArrival

    minInterArrival: TimeValue = defaultMIT

    Readonly origin

    origin: Origin

    Protected reactions

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

    Reactions to trigger.

    -

    Protected runtime

    runtime: Runtime

    Protected scheduler

    scheduler: __class<unknown, unknown> = ...

    Protected tag

    tag: undefined | Tag

    Protected value

    value: unknown = undefined

    Static pathSeparator

    pathSeparator: string = "."

    Methods

    Protected _getContainer

    _getFullyQualifiedName

    Protected manager

    manager: __class<unknown> = ...

    Readonly minDelay

    minDelay: TimeValue

    Readonly minInterArrival

    minInterArrival: TimeValue = defaultMIT

    Readonly origin

    origin: Origin

    Protected reactions

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

    Reactions to trigger.

    +

    Protected runtime

    runtime: Runtime

    Protected scheduler

    scheduler: __class<unknown, unknown> = ...

    Protected tag

    tag: undefined | Tag

    Protected value

    value: unknown = undefined

    Static pathSeparator

    pathSeparator: string = "."

    Methods

    Protected _getContainer

    _getFullyQualifiedName

    _getName

    _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.

      +

      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 +

    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. +

    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

    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

    asSchedulable

    get

    getContainer

    getManager

    _receiveRuntimeObject

    asSchedulable

    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 +

    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

    update

    toString

    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

    Static keyOfMatchingBank

    Static keyOfMatchingEntry

    • keyOfMatchingEntry(component, object): string

    • Given a component and its container (the global object if the component +

    Returns void

    Static keyOfMatchingBank

    Static keyOfMatchingEntry

    • 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

      -

    Static keyOfMatchingMultiport

    Static keyOfMatchingMultiport

    • 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

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/State.html b/classes/State.html index e86a0618..9fd4a0bd 100644 --- a/classes/State.html +++ b/classes/State.html @@ -1,13 +1,13 @@ State | @lf-lang/reactor-ts

    Class State<T>

    A state variable. This class refines the Read interface by letting get return T rather than T | Absent. If the state should be nullable or uninitialized, this has to be reflected explicitly in T.

    -

    Type Parameters

    • T

    Implements

    Constructors

    constructor +

    Type Parameters

    • T

    Implements

    Constructors

    constructor

    Properties

    value

    Methods

    get set

    Constructors

    constructor

    • new State<T>(value): State<T>

    • Create a new state variable and assign it an initial value.

      Type Parameters

      • T

      Parameters

      • value: T

        The initial value to assign to this state variable.

        -

      Returns State<T>

    Properties

    Private value

    value: T

    The initial value to assign to this state variable.

    -

    Methods

    get

    set

    • set(value): void

    • Set the current value of this state variable.

      -

      Parameters

      • value: T

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns State<T>

    Properties

    Private value

    value: T

    The initial value to assign to this state variable.

    +

    Methods

    get

    set

    • set(value): void

    • Set the current value of this state variable.

      +

      Parameters

      • value: T

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/Tag.html b/classes/Tag.html index 238c3f42..735c04bd 100644 --- a/classes/Tag.html +++ b/classes/Tag.html @@ -2,7 +2,7 @@ time elapsed since Epoch) paired with a microstep index to keep track of iterations in superdense time. For each such iteration, time remains the same, but microstep is incremented.

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    microstep time

    Methods

    getLaterTag @@ -19,37 +19,37 @@

    Constructors

    constructor

    • new Tag(timeSinceEpoch, microstep?): Tag

    • Create a new tag using a time value and a microstep.

      Parameters

      • timeSinceEpoch: TimeValue

        Time elapsed since Epoch.

      • microstep: number = 0

        Superdense time index.

        -

      Returns Tag

    Properties

    Readonly microstep

    microstep: number = 0

    Superdense time index.

    -

    Readonly time

    time: TimeValue

    Time elapsed since Epoch.

    -

    Methods

    getLaterTag

    • getLaterTag(delay): Tag

    • Get a new time instant that represents this time instant plus +

    Returns Tag

    Properties

    Readonly microstep

    microstep: number = 0

    Superdense time index.

    +

    Readonly time

    time: TimeValue

    Time elapsed since Epoch.

    +

    Methods

    getLaterTag

    • getLaterTag(delay): Tag

    • Get a new time instant that represents this time instant plus the given delay. The microstep of this time instant is ignored; the returned time instant has a microstep of zero if the delay is greater than zero. If the delay equals zero or is undefined, the tag is returned unchanged with its current microstep.

      Parameters

      • delay: undefined | TimeValue

        The time interval to add to this time instant.

        -

      Returns Tag

    getMicroStepsLater

    • getMicroStepsLater(n): Tag

    • Get a new time instant that has the same time but n microsteps later.

      -

      Parameters

      • n: number

      Returns Tag

    getTimeDifference

    • getTimeDifference(other): TimeValue

    • Obtain a time interval that represents the absolute (i.e., positive) time +

    Returns Tag

    getMicroStepsLater

    • getMicroStepsLater(n): Tag

    • Get a new time instant that has the same time but n microsteps later.

      +

      Parameters

      • n: number

      Returns Tag

    getTimeDifference

    • getTimeDifference(other): TimeValue

    • Obtain a time interval that represents the absolute (i.e., positive) time difference between this time interval and the tag given as a parameter.

      Parameters

      • other: Tag

        The time instant for which to compute the absolute difference with this time instant.

        -

      Returns TimeValue

    isGreaterThan

    • isGreaterThan(other): boolean

    • Return true if the tag is greater than the tag given as a parameter.

      +

    Returns TimeValue

    isGreaterThan

    • isGreaterThan(other): boolean

    • Return true if the tag is greater than the tag given as a parameter.

      Parameters

      • other: Tag

        The time instant to compare against this one.

        -

      Returns boolean

    isGreaterThanOrEqualTo

    • isGreaterThanOrEqualTo(other): boolean

    • Return true if the tag is greater than or equal to the tag given as a parameter.

      +

    Returns boolean

    isGreaterThanOrEqualTo

    • isGreaterThanOrEqualTo(other): boolean

    • Return true if the tag is greater than or equal to the tag given as a parameter.

      Parameters

      • other: Tag

        The time instant to compare against this one.

        -

      Returns boolean

    isSimultaneousWith

    • isSimultaneousWith(other): boolean

    • Return true if this tag is simultaneous with the tag given as +

    Returns boolean

    isSimultaneousWith

    • isSimultaneousWith(other): boolean

    • Return true if this tag is simultaneous with the tag given as a parameter, false otherwise. Both time and microstep must be equal for two tags to be simultaneous.

      Parameters

      • other: Tag

        The time instant to compare against this one.

        -

      Returns boolean

    isSmallerThan

    • isSmallerThan(other): boolean

    • Return true if this time instant is earlier than the tag given as a +

    Returns boolean

    isSmallerThan

    • isSmallerThan(other): boolean

    • Return true if this time instant is earlier than the tag given as a parameter, false otherwise. For two tags with an equal time, one instant is earlier than the other if its microstep is less than the microstep of the other.

      Parameters

      • other: Tag

        The time instant to compare against this one.

        -

      Returns boolean

    isSmallerThanOrEqualTo

    • isSmallerThanOrEqualTo(other): boolean

    • Return true if the tag is smaller than or equal to the tag given as a parameter.

      +

    Returns boolean

    isSmallerThanOrEqualTo

    • isSmallerThanOrEqualTo(other): boolean

    • Return true if the tag is smaller than or equal to the tag given as a parameter.

      Parameters

      • other: Tag

        The time instant to compare against this one.

        -

      Returns boolean

    toBinary

    • toBinary(): Buffer

    • Get a 12-byte buffer for the tag. +

    Returns boolean

    toBinary

    • toBinary(): Buffer

    • Get a 12-byte buffer for the tag. Used by federates.

      -

      Returns Buffer

    toString

    • toString(): string

    • Return a human-readable string presentation of this time instant.

      -

      Returns string

    Static fromBinary

    • fromBinary(buffer): Tag

    • Create a Tag from 8-byte TimeValue and 4-byte microstep in a buffer.

      +

      Returns Buffer

    toString

    • toString(): string

    • Return a human-readable string presentation of this time instant.

      +

      Returns string

    Static fromBinary

    • fromBinary(buffer): Tag

    • Create a Tag from 8-byte TimeValue and 4-byte microstep in a buffer.

      Parameters

      • buffer: Buffer

        A buffer of TimeValue and microstep.

        -

      Returns Tag

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Tag

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/TaggedEvent.html b/classes/TaggedEvent.html index 804d76bb..36c3a783 100644 --- a/classes/TaggedEvent.html +++ b/classes/TaggedEvent.html @@ -2,7 +2,7 @@ with a time instant and may carry a value of arbitrary type. The tag will determine the event's position with respect to other events in the event queue.

    -

    Type Parameters

    Implements

    Constructors

    constructor +

    Type Parameters

    • T

    Implements

    Constructors

    constructor

    Properties

    next tag trigger @@ -14,16 +14,16 @@

    Type Parameters

    • T

    Parameters

    • trigger: ScheduledTrigger<T>

      The trigger of this event.

    • tag: Tag

      The tag at which this event occurs.

    • value: T

      The value associated with this event.

      -

    Returns TaggedEvent<T>

    Properties

    next

    next: undefined | PrioritySetElement<Tag>

    Pointer to the next element of the priority set that this event might +

    Returns TaggedEvent<T>

    Properties

    next

    next: undefined | PrioritySetElement<Tag>

    Pointer to the next element of the priority set that this event might be hooked into.

    -

    tag

    tag: Tag

    The tag at which this event occurs.

    -

    trigger

    trigger: ScheduledTrigger<T>

    The trigger of this event.

    -

    value

    value: T

    The value associated with this event.

    -

    Methods

    getPriority

    hasPriorityOver

    tag

    tag: Tag

    The tag at which this event occurs.

    +

    trigger

    trigger: ScheduledTrigger<T>

    The trigger of this event.

    +

    value

    value: T

    The value associated with this event.

    +

    Methods

    getPriority

    hasPriorityOver

    updateIfDuplicateOf

    • updateIfDuplicateOf(node): boolean

    • Determine whether the given event is a duplicate of this one. If so, assign the +

    Returns boolean

    updateIfDuplicateOf

    • updateIfDuplicateOf(node): boolean

    • Determine whether the given event is a duplicate of this one. If so, assign the value this event to the given one. Otherwise, return false.

      Parameters

      • node: undefined | PrioritySetElement<Tag>

        The event adopt the value from if it is a duplicate of this one.

        -

      Returns boolean

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns boolean

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/TimeValue.html b/classes/TimeValue.html index 195004f5..c0d1c983 100644 --- a/classes/TimeValue.html +++ b/classes/TimeValue.html @@ -10,7 +10,7 @@
  • TimeUnit
  • UnitBasedTimeValue
    • -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    nanoseconds seconds

    Methods

    add @@ -45,43 +45,43 @@ an error will be thrown otherwise. The second parameter is optional.

    Parameters

    • seconds: number

      Number of seconds in the interval.

    • nanoseconds: number = 0

      Remaining number of nanoseconds (defaults to zero).

      -

    Returns TimeValue

    Properties

    Protected nanoseconds

    nanoseconds: number = 0

    Remaining number of nanoseconds (defaults to zero).

    -

    Protected seconds

    seconds: number

    Number of seconds in the interval.

    -

    Methods

    add

    • add(other): TimeValue

    • Return a new time value that denotes the duration of the time interval +

    Returns TimeValue

    Properties

    Protected nanoseconds

    nanoseconds: number = 0

    Remaining number of nanoseconds (defaults to zero).

    +

    Protected seconds

    seconds: number

    Number of seconds in the interval.

    +

    Methods

    add

    • add(other): TimeValue

    • Return a new time value that denotes the duration of the time interval encoded by this time value plus the time interval encoded by the time value given as a parameter.

      Parameters

      • other: TimeValue

        The time value to add to this one.

        -

      Returns TimeValue

    difference

    isEarlierThan

    • isEarlierThan(other): boolean

    • Return true if this time value denotes a time interval of smaller length +

    Returns TimeValue

    difference

    isEarlierThan

    isEqualTo

    • isEqualTo(other): boolean

    • Return true if this time value denotes a time interval of equal length as +

    isEqualTo

    • isEqualTo(other): boolean

    • Return true if this time value denotes a time interval of equal length as the interval encoded by the time value given as a parameter.

      Parameters

      • other: TimeValue

        The time value to compare to this one.

        -

      Returns boolean

    isForever

    isLaterThan

    • isLaterThan(other): boolean

    • Return true if this time value is later than the time given as a parameter.

      +

    Returns boolean

    isForever

    isLaterThan

    • isLaterThan(other): boolean

    • Return true if this time value is later than the time given as a parameter.

      Parameters

      • other: TimeValue

        The time value to compare to this one.

        -

      Returns boolean

    isNever

    isZero

    • isZero(): boolean

    • Return true if this denotes a time interval of length zero.

      -

      Returns boolean

    multiply

    subtract

    • subtract(other): TimeValue

    • Return a new time value that denotes the duration of the time interval +

    Returns boolean

    isNever

    isZero

    • isZero(): boolean

    • Return true if this denotes a time interval of length zero.

      +

      Returns boolean

    multiply

    subtract

    • subtract(other): TimeValue

    • Return a new time value that denotes the duration of the time interval encoded by this time value minus the time interval encoded by the time value given as a parameter.

      Parameters

      • other: TimeValue

        The time value to subtract from this one.

        -

      Returns TimeValue

    toBinary

    • toBinary(): Buffer

    • Get a 64 bit binary, little endian representation of this TimeValue. +

    Returns TimeValue

    toBinary

    • toBinary(): Buffer

    • Get a 64 bit binary, little endian representation of this TimeValue. Used by federates.

      -

      Returns Buffer

    toMilliseconds

    • toMilliseconds(): number

    • Return a millisecond representation of this time value.

      -

      Returns number

    toString

    • toString(): string

    • Print the number of seconds and nanoseconds in the time interval encoded +

      Returns Buffer

    toMilliseconds

    • toMilliseconds(): number

    • Return a millisecond representation of this time value.

      +

      Returns number

    toString

    • toString(): string

    • Print the number of seconds and nanoseconds in the time interval encoded by this time value.

      -

      Returns string

    toTimeTuple

    • toTimeTuple(): [number, number]

    • Return a tuple that holds the seconds and remaining nanoseconds that +

      Returns string

    toTimeTuple

    • toTimeTuple(): [number, number]

    • Return a tuple that holds the seconds and remaining nanoseconds that jointly represent this time value.

      -

      Returns [number, number]

    Static forever

    Static fromBinary

    • fromBinary(buffer): TimeValue

    • Create a TimeValue from a 64bit little endian unsigned integer in a buffer.

      +

      Returns [number, number]

    Static forever

    Static fromBinary

    • fromBinary(buffer): TimeValue

    • Create a TimeValue from a 64bit little endian unsigned integer in a buffer.

      Parameters

      • buffer: Buffer

        A 64 bit unsigned integer. Little endian.

        -

      Returns TimeValue

    Static msec

    Static msecs

    Static never

    Static nsec

    Static nsecs

    Static sec

    Static secs

    Static secsAndNs

    Static usec

    Static usecs

    Static withUnits

    • withUnits(value, unit): TimeValue

    • Give a value and time unit, return a new time value.

      +

    Returns TimeValue

    Static msec

    Static msecs

    Static never

    Static nsec

    Static nsecs

    Static sec

    Static secs

    Static secsAndNs

    Static usec

    Static usecs

    Static withUnits

    • withUnits(value, unit): TimeValue

    • Give a value and time unit, return a new time value.

      The value is a number that is required to be a positive integer. The time unit must be a member of the TimeUnit enum.

      Parameters

      • value: number

        A number (which must be a positive integer) that denotes the length of the specified time interval, expressed as a multiple of the given time unit.

      • unit: TimeUnit

        The unit of measurement that applies to the given value.

        -

      Returns TimeValue

    Static zero

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns TimeValue

    Static zero

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/Timer.html b/classes/Timer.html index 4a05370d..4447cb02 100644 --- a/classes/Timer.html +++ b/classes/Timer.html @@ -4,7 +4,7 @@ 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 +

    Hierarchy (view full)

    Implements

    Constructors

    constructor

    Properties

    _key manager offset @@ -37,51 +37,51 @@ 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 +

    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.

    -

    Protected manager

    manager: __class<Tag> = ...

    offset

    offset: TimeValue

    period

    period: TimeValue

    Protected reactions

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

    Reactions to trigger.

    -

    Protected runtime

    runtime: Runtime

    Protected tag

    tag: undefined | Tag

    Protected value

    value: undefined | Tag = undefined

    Static pathSeparator

    pathSeparator: string = "."

    Methods

    Protected _getContainer

    _getFullyQualifiedName

    Protected manager

    manager: __class<Tag> = ...

    offset

    offset: TimeValue

    period

    period: TimeValue

    Protected reactions

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

    Reactions to trigger.

    +

    Protected runtime

    runtime: Runtime

    Protected tag

    tag: undefined | Tag

    Protected value

    value: undefined | Tag = undefined

    Static pathSeparator

    pathSeparator: string = "."

    Methods

    Protected _getContainer

    _getFullyQualifiedName

    _getName

    _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

    _isContainedByContainerOf

    • _isContainedByContainerOf(reactor): boolean

    • Confirm whether or not this component is contained by the container of +

    Returns boolean

    _isContainedByContainerOf

    _isRegistered

    • _isRegistered(): boolean

    • Report whether this component has been registered with its container or not. +

    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

    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

    _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 +

    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

    update

    toString

    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

    Static keyOfMatchingBank

    Static keyOfMatchingEntry

    • keyOfMatchingEntry(component, object): string

    • Given a component and its container (the global object if the component +

    Returns void

    Static keyOfMatchingBank

    Static keyOfMatchingEntry

    • 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

      -

    Static keyOfMatchingMultiport

    Static keyOfMatchingMultiport

    • 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

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/Trigger.html b/classes/Trigger.html index 1b1a40af..1ec2345a 100644 --- a/classes/Trigger.html +++ b/classes/Trigger.html @@ -1,5 +1,5 @@ Trigger | @lf-lang/reactor-ts

    Class TriggerAbstract

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

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    _key reactions pathSeparator @@ -24,46 +24,46 @@

    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 +

    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.

    -

    Protected reactions

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

    Reactions to trigger.

    -

    Static pathSeparator

    pathSeparator: string = "."

    Methods

    Protected _getContainer

    _getFullyQualifiedName

    Protected reactions

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

    Reactions to trigger.

    +

    Static pathSeparator

    pathSeparator: string = "."

    Methods

    Protected _getContainer

    _getFullyQualifiedName

    _getName

    _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

    • _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 +

    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. +

    Returns boolean

    _isRegistered

    Protected _linkToRuntimeObject

    Protected _linkToRuntimeObject

    Abstract _receiveRuntimeObject

    getContainer

    Abstract getManager

    Abstract _receiveRuntimeObject

    getContainer

    Abstract getManager

    Abstract isPresent

    Static keyOfMatchingBank

    Static keyOfMatchingEntry

    Returns TriggerManager

    Abstract isPresent

    Static keyOfMatchingBank

    Static keyOfMatchingEntry

    Static keyOfMatchingMultiport

    Static keyOfMatchingMultiport

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/WritableMultiPort.html b/classes/WritableMultiPort.html index 4b191535..eda4789d 100644 --- a/classes/WritableMultiPort.html +++ b/classes/WritableMultiPort.html @@ -1,7 +1,7 @@ -WritableMultiPort | @lf-lang/reactor-ts

    Class WritableMultiPort<T>Abstract

    Type Parameters

    • T

    Implements

    Constructors

    constructor +WritableMultiPort | @lf-lang/reactor-ts

    Class WritableMultiPort<T>Abstract

    Type Parameters

    • T

    Implements

    Constructors

    constructor

    Methods

    get getPorts set values width -

    Constructors

    constructor

    Methods

    Abstract get

    • get(index): undefined | T

    • Parameters

      • index: number

      Returns undefined | T

    Abstract getPorts

    Abstract set

    • set(index, value): void

    • Parameters

      • index: number
      • value: T

      Returns void

    Abstract values

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

    • Returns (undefined | T)[]

    Abstract width

    • width(): number

    • Returns number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Methods

    Abstract get

    • get(index): undefined | T

    • Parameters

      • index: number

      Returns undefined | T

    Abstract getPorts

    Abstract set

    • set(index, value): void

    • Parameters

      • index: number
      • value: T

      Returns void

    Abstract values

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

    • Returns (undefined | T)[]

    Abstract width

    • width(): number

    • Returns number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/WritablePort.html b/classes/WritablePort.html index 0dfa8d5b..804a7fe3 100644 --- a/classes/WritablePort.html +++ b/classes/WritablePort.html @@ -2,8 +2,8 @@ regular port. In addition to a get method, it also has a set method and a method for retrieving the port that it wraps. We have this abstract class so that we can do instanceof checks.

    -

    Type Parameters

    Implements

    Constructors

    constructor +

    Type Parameters

    • T

    Implements

    Constructors

    constructor

    Methods

    get getPort set -

    Constructors

    constructor

    Methods

    Abstract get

    • get(): undefined | T

    • Returns undefined | T

    Abstract getPort

    Abstract set

    • set(value): void

    • Parameters

      • value: T

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Methods

    Abstract get

    • get(): undefined | T

    • Returns undefined | T

    Abstract getPort

    Abstract set

    • set(value): void

    • Parameters

      • value: T

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/enums/Log.LogLevel.html b/enums/Log.LogLevel.html index 2be0d268..656cba91 100644 --- a/enums/Log.LogLevel.html +++ b/enums/Log.LogLevel.html @@ -2,9 +2,9 @@ This LogLevel is inherited from ULog and is kept for compatibility/abstraction purposes. As we switch to pinojs, it adds fatal but lacks log.

    See

    Log

    -

    Enumeration Members

    DEBUG +

    Enumeration Members

    DEBUG ERROR FATAL INFO WARN -

    Enumeration Members

    DEBUG

    DEBUG: "debug"

    ERROR

    ERROR: "error"

    FATAL

    FATAL: "fatal"

    INFO

    INFO: "info"

    WARN

    WARN: "warn"

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    DEBUG

    DEBUG: "debug"

    ERROR

    ERROR: "error"

    FATAL

    FATAL: "fatal"

    INFO

    INFO: "info"

    WARN

    WARN: "warn"

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/enums/Origin.html b/enums/Origin.html index ba780a84..dd8d434b 100644 --- a/enums/Origin.html +++ b/enums/Origin.html @@ -1,6 +1,6 @@ Origin | @lf-lang/reactor-ts

    Enumeration Origin

    A descriptor to be used when scheduling events to denote as to whether an event should occur with a delay relative to physical time or logical time.

    -

    Enumeration Members

    logical +

    Enumeration Members

    logical physical -

    Enumeration Members

    logical

    logical: "logical"

    physical

    physical: "physical"

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    logical

    logical: "logical"

    physical

    physical: "physical"

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/enums/TimeUnit.html b/enums/TimeUnit.html index 5095bc22..06978b47 100644 --- a/enums/TimeUnit.html +++ b/enums/TimeUnit.html @@ -1,5 +1,5 @@ TimeUnit | @lf-lang/reactor-ts

    Enumeration TimeUnit

    Units (and conversion factors from nanoseconds) for time values.

    -

    Enumeration Members

    day +

    Enumeration Members

    day hour minute msec @@ -7,4 +7,4 @@ sec usec week -

    Enumeration Members

    day

    day: 86400000000000

    hour

    hour: 3600000000000

    minute

    minute: 60000000000

    msec

    msec: 1000000

    nsec

    nsec: 1

    sec

    sec: 1000000000

    usec

    usec: 1000

    week

    week: 604800000000000

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    day

    day: 86400000000000

    hour

    hour: 3600000000000

    minute

    minute: 60000000000

    msec

    msec: 1000000

    nsec

    nsec: 1

    sec

    sec: 1000000000

    usec

    usec: 1000

    week

    week: 604800000000000

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/Log.debug.html b/functions/Log.debug.html index 5541ae06..8dd3326c 100644 --- a/functions/Log.debug.html +++ b/functions/Log.debug.html @@ -1 +1 @@ -debug | @lf-lang/reactor-ts

    Function debug

    • debug(obj, message, module?): void

    • Parameters

      • obj: unknown
      • message: (() => string)
          • (): string

          • Returns string

      • Optional module: string

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +debug | @lf-lang/reactor-ts

    Function debug

    • debug(obj, message, module?): void

    • Parameters

      • obj: unknown
      • message: (() => string)
          • (): string

          • Returns string

      • Optional module: string

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/Log.error.html b/functions/Log.error.html index 3bcf682f..a82329e2 100644 --- a/functions/Log.error.html +++ b/functions/Log.error.html @@ -1 +1 @@ -error | @lf-lang/reactor-ts

    Function error

    • error(obj, message, module?): void

    • Parameters

      • obj: unknown
      • message: (() => string)
          • (): string

          • Returns string

      • Optional module: string

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +error | @lf-lang/reactor-ts

    Function error

    • error(obj, message, module?): void

    • Parameters

      • obj: unknown
      • message: (() => string)
          • (): string

          • Returns string

      • Optional module: string

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/Log.fatal.html b/functions/Log.fatal.html index df5ef837..f53d2dc2 100644 --- a/functions/Log.fatal.html +++ b/functions/Log.fatal.html @@ -1 +1 @@ -fatal | @lf-lang/reactor-ts

    Function fatal

    • fatal(obj, message, module?): void

    • Parameters

      • obj: unknown
      • message: (() => string)
          • (): string

          • Returns string

      • Optional module: string

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +fatal | @lf-lang/reactor-ts

    Function fatal

    • fatal(obj, message, module?): void

    • Parameters

      • obj: unknown
      • message: (() => string)
          • (): string

          • Returns string

      • Optional module: string

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/Log.getInstance.html b/functions/Log.getInstance.html index 83463068..97b08f56 100644 --- a/functions/Log.getInstance.html +++ b/functions/Log.getInstance.html @@ -1,4 +1,4 @@ getInstance | @lf-lang/reactor-ts

    Function getInstance

    • getInstance(module): Logger

    • Get the logger instance associated with the given module. If it does not exist, it is created.

      Parameters

      • module: string

        The name associated with the logger

        -

      Returns Logger

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Logger

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/Log.info.html b/functions/Log.info.html index d33ba011..81ede368 100644 --- a/functions/Log.info.html +++ b/functions/Log.info.html @@ -1 +1 @@ -info | @lf-lang/reactor-ts

    Function info

    • info(obj, message, module?): void

    • Parameters

      • obj: unknown
      • message: (() => string)
          • (): string

          • Returns string

      • Optional module: string

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +info | @lf-lang/reactor-ts

    Function info

    • info(obj, message, module?): void

    • Parameters

      • obj: unknown
      • message: (() => string)
          • (): string

          • Returns string

      • Optional module: string

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/Log.log.html b/functions/Log.log.html index c4d001df..f119ba43 100644 --- a/functions/Log.log.html +++ b/functions/Log.log.html @@ -1 +1 @@ -log | @lf-lang/reactor-ts

    Function log

    • log(obj, message, module?): void

    • Parameters

      • obj: unknown
      • message: (() => string)
          • (): string

          • Returns string

      • Optional module: string

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +log | @lf-lang/reactor-ts

    Function log

    • log(obj, message, module?): void

    • Parameters

      • obj: unknown
      • message: (() => string)
          • (): string

          • Returns string

      • Optional module: string

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/Log.setLevel.html b/functions/Log.setLevel.html index 3b44df8d..0ca4d04c 100644 --- a/functions/Log.setLevel.html +++ b/functions/Log.setLevel.html @@ -1 +1 @@ -setLevel | @lf-lang/reactor-ts

    Function setLevel

    • setLevel(severity, module?): void

    • Parameters

      • severity: LogLevel
      • Optional module: string

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +setLevel | @lf-lang/reactor-ts

    Function setLevel

    • setLevel(severity, module?): void

    • Parameters

      • severity: LogLevel
      • Optional module: string

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/Log.warn.html b/functions/Log.warn.html index 7461f223..9f46f73b 100644 --- a/functions/Log.warn.html +++ b/functions/Log.warn.html @@ -1 +1 @@ -warn | @lf-lang/reactor-ts

    Function warn

    • warn(obj, message, module?): void

    • Parameters

      • obj: unknown
      • message: (() => string)
          • (): string

          • Returns string

      • Optional module: string

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +warn | @lf-lang/reactor-ts

    Function warn

    • warn(obj, message, module?): void

    • Parameters

      • obj: unknown
      • message: (() => string)
          • (): string

          • Returns string

      • Optional module: string

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/booleanCLAType.html b/functions/booleanCLAType.html index 7873c909..c72b13b8 100644 --- a/functions/booleanCLAType.html +++ b/functions/booleanCLAType.html @@ -4,4 +4,4 @@ actually a flag that is either absent or true. https://github.com/75lb/command-line-args/wiki/Notation-rules We need this custom boolean parsing because our command line arguments are true, false, or absent.

    -

    Parameters

    Returns boolean | null

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns boolean | null

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/dontIndent.html b/functions/dontIndent.html index 12a482fb..9de8efa6 100644 --- a/functions/dontIndent.html +++ b/functions/dontIndent.html @@ -1,4 +1,4 @@ dontIndent | @lf-lang/reactor-ts

    Function dontIndent

    • dontIndent(template): string

    • Remove indentation in the multi-line string.

      Parameters

      • template: TemplateStringsArray

        Multi-line string whose indentation should be removed.

      Returns string

      String without indentation.

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/getCurrentPhysicalTime.html b/functions/getCurrentPhysicalTime.html index cd915810..6b48b587 100644 --- a/functions/getCurrentPhysicalTime.html +++ b/functions/getCurrentPhysicalTime.html @@ -1,3 +1,3 @@ getCurrentPhysicalTime | @lf-lang/reactor-ts

    Function getCurrentPhysicalTime

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns TimeValue

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/loggingCLAType.html b/functions/loggingCLAType.html index acd68483..e5fb4302 100644 --- a/functions/loggingCLAType.html +++ b/functions/loggingCLAType.html @@ -1,4 +1,4 @@ loggingCLAType | @lf-lang/reactor-ts

    Function loggingCLAType

    • loggingCLAType(logging): LogLevel | null

    • Function to convert a string into a LogLevel for command line argument parsing. Returns null if the input is malformed.

      Parameters

      • logging: string

        the raw command line argument

        -

      Returns LogLevel | null

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns LogLevel | null

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/stringCLAType.html b/functions/stringCLAType.html index d1f2446e..c9c70357 100644 --- a/functions/stringCLAType.html +++ b/functions/stringCLAType.html @@ -1,2 +1,2 @@ stringCLAType | @lf-lang/reactor-ts

    Function stringCLAType

    • stringCLAType(arg): string

    • Function to return an argument string as is.

      -

      Parameters

      • arg: string

      Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/unitBasedTimeValueCLAType.html b/functions/unitBasedTimeValueCLAType.html index f64cc6b4..ea65fc0c 100644 --- a/functions/unitBasedTimeValueCLAType.html +++ b/functions/unitBasedTimeValueCLAType.html @@ -1,3 +1,3 @@ unitBasedTimeValueCLAType | @lf-lang/reactor-ts

    Function unitBasedTimeValueCLAType

    • unitBasedTimeValueCLAType(timeout): TimeValue | null

    • Function to convert a string into a UnitBasedTimeValue for command line argument parsing Returns null if the input is malformed.

      -

      Parameters

      • timeout: string

      Returns TimeValue | null

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns TimeValue | null

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/Call.html b/interfaces/Call.html index d2b3af03..4738c256 100644 --- a/interfaces/Call.html +++ b/interfaces/Call.html @@ -1,5 +1,5 @@ Call | @lf-lang/reactor-ts

    Interface Call<A, R>

    Interface for the invocation of remote procedures.

    -
    interface Call<A, R> {
        get: (() => undefined | R);
        invoke: ((args) => undefined | R);
        set: ((value) => void);
    }

    Type Parameters

    • A

    • R

    Hierarchy (view full)

    Properties

    get +
    interface Call<A, R> {
        get: (() => undefined | R);
        invoke: ((args) => undefined | R);
        set: ((value) => void);
    }

    Type Parameters

    • A

    • R

    Hierarchy (view full)

    Properties

    get invoke set -

    Properties

    get

    get: (() => undefined | R)

    Type declaration

      • (): undefined | R

      • Returns undefined | R

    invoke

    invoke: ((args) => undefined | R)

    Type declaration

      • (args): undefined | R

      • Parameters

        • args: A

        Returns undefined | R

    set

    set: ((value) => void)

    Type declaration

      • (value): void

      • Parameters

        • value: A

        Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    get

    get: (() => undefined | R)

    Type declaration

      • (): undefined | R

      • Returns undefined | R

    invoke

    invoke: ((args) => undefined | R)

    Type declaration

      • (args): undefined | R

      • Parameters

        • args: A

        Returns undefined | R

    set

    set: ((value) => void)

    Type declaration

      • (value): void

      • Parameters

        • value: A

        Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/FederateConfig.html b/interfaces/FederateConfig.html index f5230167..124acf90 100644 --- a/interfaces/FederateConfig.html +++ b/interfaces/FederateConfig.html @@ -1,5 +1,5 @@ FederateConfig | @lf-lang/reactor-ts

    Interface FederateConfig

    Interface for passing in configuration options to a federate

    -
    interface FederateConfig {
        dependsOn: number[];
        executionTimeout?: TimeValue;
        fast: boolean;
        federateID: number;
        federationID: string;
        keepAlive?: boolean;
        minOutputDelay?: TimeValue;
        networkMessageActions: string[];
        rtiHost: string;
        rtiPort: number;
        sendsTo: number[];
        upstreamConnectionDelays: TimeValue[][];
    }

    Properties

    dependsOn +
    interface FederateConfig {
        dependsOn: number[];
        executionTimeout?: TimeValue;
        fast: boolean;
        federateID: number;
        federationID: string;
        keepAlive?: boolean;
        minOutputDelay?: TimeValue;
        networkMessageActions: string[];
        rtiHost: string;
        rtiPort: number;
        sendsTo: number[];
        upstreamConnectionDelays: TimeValue[][];
    }

    Properties

    dependsOn executionTimeout? fast federateID @@ -11,4 +11,4 @@ rtiPort sendsTo upstreamConnectionDelays -

    Properties

    dependsOn

    dependsOn: number[]

    Optional executionTimeout

    executionTimeout?: TimeValue

    fast

    fast: boolean

    federateID

    federateID: number

    federationID

    federationID: string

    Optional keepAlive

    keepAlive?: boolean

    Optional minOutputDelay

    minOutputDelay?: TimeValue

    networkMessageActions

    networkMessageActions: string[]

    rtiHost

    rtiHost: string

    rtiPort

    rtiPort: number

    sendsTo

    sendsTo: number[]

    upstreamConnectionDelays

    upstreamConnectionDelays: TimeValue[][]

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    dependsOn

    dependsOn: number[]

    Optional executionTimeout

    executionTimeout?: TimeValue

    fast

    fast: boolean

    federateID

    federateID: number

    federationID

    federationID: string

    Optional keepAlive

    keepAlive?: boolean

    Optional minOutputDelay

    minOutputDelay?: TimeValue

    networkMessageActions

    networkMessageActions: string[]

    rtiHost

    rtiHost: string

    rtiPort

    rtiPort: number

    sendsTo

    sendsTo: number[]

    upstreamConnectionDelays

    upstreamConnectionDelays: TimeValue[][]

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/MultiRead.html b/interfaces/MultiRead.html index 2bcc3e16..195ddde5 100644 --- a/interfaces/MultiRead.html +++ b/interfaces/MultiRead.html @@ -1,4 +1,4 @@ -MultiRead | @lf-lang/reactor-ts

    Interface MultiRead<T>

    interface MultiRead<T> {
        get: ((index) => undefined | T);
        width: (() => number);
    }

    Type Parameters

    • T

    Implemented by

    Properties

    get +MultiRead | @lf-lang/reactor-ts

    Interface MultiRead<T>

    interface MultiRead<T> {
        get: ((index) => undefined | T);
        width: (() => number);
    }

    Type Parameters

    • T

    Implemented by

    Properties

    get width

    Properties

    get

    get: ((index) => undefined | T)

    Given an index that identifies a particular channel, return the current value of the identified channel.

    @@ -8,6 +8,6 @@

    Returns undefined | T

    the value that corresponds to the identified channel

    Param: index

    the index that identifies the channel to return the value of

    Returns

    the value that corresponds to the identified channel

    -

    width

    width: (() => number)

    Return the number of channels.

    +

    width

    width: (() => number)

    Return the number of channels.

    Type declaration

      • (): number

      • Return the number of channels.

        -

        Returns number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/MultiWrite.html b/interfaces/MultiWrite.html index 4d159e6d..a3a86560 100644 --- a/interfaces/MultiWrite.html +++ b/interfaces/MultiWrite.html @@ -1,6 +1,6 @@ -MultiWrite | @lf-lang/reactor-ts

    Interface MultiWrite<T>

    interface MultiWrite<T> {
        set: ((index, value) => void);
        values: (() => (undefined | T)[]);
        width: (() => number);
    }

    Type Parameters

    • T

    Properties

    set +MultiWrite | @lf-lang/reactor-ts

    Interface MultiWrite<T>

    interface MultiWrite<T> {
        set: ((index, value) => void);
        values: (() => (undefined | T)[]);
        width: (() => number);
    }

    Type Parameters

    • T

    Properties

    set values width -

    Properties

    set

    set: ((index, value) => void)

    Type declaration

      • (index, value): void

      • Parameters

        • index: number
        • value: T

        Returns void

    values

    values: (() => (undefined | T)[])

    Type declaration

      • (): (undefined | T)[]

      • Returns (undefined | T)[]

    width

    width: (() => number)

    Return the number of channels.

    +

    Properties

    set

    set: ((index, value) => void)

    Type declaration

      • (index, value): void

      • Parameters

        • index: number
        • value: T

        Returns void

    values

    values: (() => (undefined | T)[])

    Type declaration

      • (): (undefined | T)[]

      • Returns (undefined | T)[]

    width

    width: (() => number)

    Return the number of channels.

    Type declaration

      • (): number

      • Return the number of channels.

        -

        Returns number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/MutationSandbox.html b/interfaces/MutationSandbox.html index cffeb144..4c690e7c 100644 --- a/interfaces/MutationSandbox.html +++ b/interfaces/MutationSandbox.html @@ -1,8 +1,8 @@ -MutationSandbox | @lf-lang/reactor-ts

    Interface MutationSandbox

    interface MutationSandbox {
        connect: (<A, R, T, S>(src, dst) => void);
        delete: ((reactor) => void);
        disconnect: (<R, S>(src, dst?) => void);
        getBankIndex: (() => number);
        getReactor: (() => Reactor);
        util: UtilityFunctions;
    }

    Hierarchy (view full)

    Properties

    connect +MutationSandbox | @lf-lang/reactor-ts

    Interface MutationSandbox

    interface MutationSandbox {
        connect: (<A, R, T, S>(src, dst) => void);
        delete: ((reactor) => void);
        disconnect: (<R, S>(src, dst?) => void);
        getBankIndex: (() => number);
        getReactor: (() => Reactor);
        util: UtilityFunctions;
    }

    Hierarchy (view full)

    Properties

    connect delete disconnect getBankIndex getReactor util -

    Properties

    connect

    connect: (<A, R, T, S>(src, dst) => void)

    Type declaration

    delete

    delete: ((reactor) => void)

    Type declaration

      • (reactor): void

      • Parameters

        Returns void

    disconnect

    disconnect: (<R, S>(src, dst?) => void)

    Type declaration

      • <R, S>(src, dst?): void

      • Type Parameters

        • R

        • S

        Parameters

        Returns void

    getBankIndex

    getBankIndex: (() => number)

    Type declaration

      • (): number

      • Returns number

    getReactor

    getReactor: (() => Reactor)

    Type declaration

    util

    util: UtilityFunctions

    Collection of utility functions accessible from within a react function.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    connect

    connect: (<A, R, T, S>(src, dst) => void)

    Type declaration

    delete

    delete: ((reactor) => void)

    Type declaration

      • (reactor): void

      • Parameters

        Returns void

    disconnect

    disconnect: (<R, S>(src, dst?) => void)

    Type declaration

      • <R, S>(src, dst?): void

      • Type Parameters

        • R

        • S

        Parameters

        Returns void

    getBankIndex

    getBankIndex: (() => number)

    Type declaration

      • (): number

      • Returns number

    getReactor

    getReactor: (() => Reactor)

    Type declaration

    util

    util: UtilityFunctions

    Collection of utility functions accessible from within a react function.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/PrioritySetElement.html b/interfaces/PrioritySetElement.html index c87072e0..71840a94 100644 --- a/interfaces/PrioritySetElement.html +++ b/interfaces/PrioritySetElement.html @@ -1,19 +1,19 @@ PrioritySetElement | @lf-lang/reactor-ts

    Interface PrioritySetElement<P>

    Interface for prioritized elements than be hooked into a linked list.

    -
    interface PrioritySetElement<P> {
        getPriority: (() => P);
        hasPriorityOver: ((node) => boolean);
        next: undefined | PrioritySetElement<P>;
        updateIfDuplicateOf: ((node) => boolean);
    }

    Type Parameters

    • P

    Implemented by

    Properties

    getPriority +
    interface PrioritySetElement<P> {
        getPriority: (() => P);
        hasPriorityOver: ((node) => boolean);
        next: undefined | PrioritySetElement<P>;
        updateIfDuplicateOf: ((node) => boolean);
    }

    Type Parameters

    • P

    Implemented by

    Properties

    getPriority hasPriorityOver next updateIfDuplicateOf

    Properties

    getPriority

    getPriority: (() => P)

    Return the priority of this node.

    Type declaration

      • (): P

      • Return the priority of this node.

        -

        Returns P

    hasPriorityOver

    hasPriorityOver: ((node) => boolean)

    Return true if this node has priority over the given node, false otherwise.

    +

    Returns P

    hasPriorityOver

    hasPriorityOver: ((node) => boolean)

    Return true if this node has priority over the given node, false otherwise.

    Type declaration

      • (node): boolean

      • Return true if this node has priority over the given node, false otherwise.

        Parameters

        Returns boolean

    Param: node

    A node to compare the priority of this node to.

    -

    next

    next: undefined | PrioritySetElement<P>

    Pointer to the next node in the priority set.

    -

    updateIfDuplicateOf

    updateIfDuplicateOf: ((node) => boolean)

    If the given node is considered a duplicate of this node, then +

    next

    next: undefined | PrioritySetElement<P>

    Pointer to the next node in the priority set.

    +

    updateIfDuplicateOf

    updateIfDuplicateOf: ((node) => boolean)

    If the given node is considered a duplicate of this node, then update this node if needed, and return true. Return false otherwise.

    Type declaration

      • (node): boolean

      • If the given node is considered a duplicate of this node, then update this node if needed, and return true. Return false otherwise.

        Parameters

        • node: undefined | PrioritySetElement<P>

          A node that may or may not be a duplicate of this node.

        Returns boolean

    Param: node

    A node that may or may not be a duplicate of this node.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/ProcessedCommandLineArgs.html b/interfaces/ProcessedCommandLineArgs.html index 8fdc6fbc..c140f86d 100644 --- a/interfaces/ProcessedCommandLineArgs.html +++ b/interfaces/ProcessedCommandLineArgs.html @@ -1,10 +1,10 @@ ProcessedCommandLineArgs | @lf-lang/reactor-ts

    Interface ProcessedCommandLineArgs

    The type returned by the commandLineArguments function. This type must change if the CommandLineOptionDefs changes.

    -
    interface ProcessedCommandLineArgs {
        advanceMessageInterval: undefined | TimeValue;
        fast: undefined | boolean;
        help: boolean;
        id: undefined | string;
        keepalive: undefined | boolean;
        logging: undefined | LogLevel;
        timeout: undefined | null | TimeValue;
    }

    Properties

    advanceMessageInterval +
    interface ProcessedCommandLineArgs {
        advanceMessageInterval: undefined | TimeValue;
        fast: undefined | boolean;
        help: boolean;
        id: undefined | string;
        keepalive: undefined | boolean;
        logging: undefined | LogLevel;
        timeout: undefined | null | TimeValue;
    }

    Properties

    advanceMessageInterval fast help id keepalive logging timeout -

    Properties

    advanceMessageInterval

    advanceMessageInterval: undefined | TimeValue

    fast

    fast: undefined | boolean

    help

    help: boolean

    id

    id: undefined | string

    keepalive

    keepalive: undefined | boolean

    logging

    logging: undefined | LogLevel

    timeout

    timeout: undefined | null | TimeValue

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    advanceMessageInterval

    advanceMessageInterval: undefined | TimeValue

    fast

    fast: undefined | boolean

    help

    help: boolean

    id

    id: undefined | string

    keepalive

    keepalive: undefined | boolean

    logging

    logging: undefined | LogLevel

    timeout

    timeout: undefined | null | TimeValue

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/ReactionSandbox.html b/interfaces/ReactionSandbox.html index 24aec9a7..9a52ce3d 100644 --- a/interfaces/ReactionSandbox.html +++ b/interfaces/ReactionSandbox.html @@ -1,4 +1,4 @@ -ReactionSandbox | @lf-lang/reactor-ts

    Interface ReactionSandbox

    interface ReactionSandbox {
        getBankIndex: (() => number);
        util: UtilityFunctions;
    }

    Hierarchy (view full)

    Properties

    getBankIndex +ReactionSandbox | @lf-lang/reactor-ts

    Interface ReactionSandbox

    interface ReactionSandbox {
        getBankIndex: (() => number);
        util: UtilityFunctions;
    }

    Hierarchy (view full)

    Properties

    getBankIndex util -

    Properties

    getBankIndex

    getBankIndex: (() => number)

    Type declaration

      • (): number

      • Returns number

    util

    util: UtilityFunctions

    Collection of utility functions accessible from within a react function.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    getBankIndex

    getBankIndex: (() => number)

    Type declaration

      • (): number

      • Returns number

    util

    util: UtilityFunctions

    Collection of utility functions accessible from within a react function.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/Read.html b/interfaces/Read.html index 0852936b..cb077829 100644 --- a/interfaces/Read.html +++ b/interfaces/Read.html @@ -1,3 +1,3 @@ Read | @lf-lang/reactor-ts

    Interface Read<T>

    Interface for readable variables.

    -
    interface Read<T> {
        get: (() => undefined | T);
    }

    Type Parameters

    • T

    Hierarchy (view full)

    Implemented by

    Properties

    get -

    Properties

    get

    get: (() => undefined | T)

    Type declaration

      • (): undefined | T

      • Returns undefined | T

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +
    interface Read<T> {
        get: (() => undefined | T);
    }

    Type Parameters

    Hierarchy (view full)

    Implemented by

    Properties

    get +

    Properties

    get

    get: (() => undefined | T)

    Type declaration

      • (): undefined | T

      • Returns undefined | T

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/Runtime.html b/interfaces/Runtime.html index f418d6f6..116cee80 100644 --- a/interfaces/Runtime.html +++ b/interfaces/Runtime.html @@ -1,7 +1,7 @@ -Runtime | @lf-lang/reactor-ts

    Interface Runtime

    interface Runtime {
        delete: ((r) => void);
        initialize: ((timer) => void);
        isRunning: (() => boolean);
        schedule: ((e) => void);
        stage: ((reaction) => void);
        util: UtilityFunctions;
    }

    Properties

    delete +Runtime | @lf-lang/reactor-ts

    Interface Runtime

    interface Runtime {
        delete: ((r) => void);
        initialize: ((timer) => void);
        isRunning: (() => boolean);
        schedule: ((e) => void);
        stage: ((reaction) => void);
        util: UtilityFunctions;
    }

    Properties

    delete initialize isRunning schedule stage util -

    Properties

    delete

    delete: ((r) => void)

    Type declaration

      • (r): void

      • Parameters

        Returns void

    initialize

    initialize: ((timer) => void)

    Type declaration

      • (timer): void

      • Parameters

        Returns void

    isRunning

    isRunning: (() => boolean)

    Type declaration

      • (): boolean

      • Returns boolean

    schedule

    schedule: ((e) => void)

    Type declaration

    stage

    stage: ((reaction) => void)

    Type declaration

    util

    util: UtilityFunctions

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    delete

    delete: ((r) => void)

    Type declaration

      • (r): void

      • Parameters

        Returns void

    initialize

    initialize: ((timer) => void)

    Type declaration

      • (timer): void

      • Parameters

        Returns void

    isRunning

    isRunning: (() => boolean)

    Type declaration

      • (): boolean

      • Returns boolean

    schedule

    schedule: ((e) => void)

    Type declaration

    stage

    stage: ((reaction) => void)

    Type declaration

    util

    util: UtilityFunctions

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/Sched.html b/interfaces/Sched.html index 6b18f3c8..a51c2db5 100644 --- a/interfaces/Sched.html +++ b/interfaces/Sched.html @@ -1,4 +1,4 @@ Sched | @lf-lang/reactor-ts

    Interface Sched<T>

    Interface for schedulable actions.

    -
    interface Sched<T> {
        get: (() => undefined | T);
        schedule: ((extraDelay, value, intendedTag?) => void);
    }

    Type Parameters

    • T

    Hierarchy (view full)

    Implemented by

    Properties

    get +
    interface Sched<T> {
        get: (() => undefined | T);
        schedule: ((extraDelay, value, intendedTag?) => void);
    }

    Type Parameters

    • T

    Hierarchy (view full)

    Implemented by

    Properties

    get schedule -

    Properties

    get

    get: (() => undefined | T)

    Type declaration

      • (): undefined | T

      • Returns undefined | T

    schedule

    schedule: ((extraDelay, value, intendedTag?) => void)

    Type declaration

      • (extraDelay, value, intendedTag?): void

      • Parameters

        Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    get

    get: (() => undefined | T)

    Type declaration

      • (): undefined | T

      • Returns undefined | T

    schedule

    schedule: ((extraDelay, value, intendedTag?) => void)

    Type declaration

      • (extraDelay, value, intendedTag?): void

      • Parameters

        Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/Sortable.html b/interfaces/Sortable.html index a186ad95..ddc1b909 100644 --- a/interfaces/Sortable.html +++ b/interfaces/Sortable.html @@ -1,2 +1,2 @@ -Sortable | @lf-lang/reactor-ts

    Interface Sortable<P>

    interface Sortable<P> {
        setPriority: ((priority) => void);
    }

    Type Parameters

    • P

    Implemented by

    Properties

    setPriority -

    Properties

    setPriority

    setPriority: ((priority) => void)

    Type declaration

      • (priority): void

      • Parameters

        • priority: P

        Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +Sortable | @lf-lang/reactor-ts

    Interface Sortable<P>

    interface Sortable<P> {
        setPriority: ((priority) => void);
    }

    Type Parameters

    • P

    Implemented by

    Properties

    setPriority +

    Properties

    setPriority

    setPriority: ((priority) => void)

    Type declaration

      • (priority): void

      • Parameters

        • priority: P

        Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/TriggerManager.html b/interfaces/TriggerManager.html index a56d4a0d..b4f206c8 100644 --- a/interfaces/TriggerManager.html +++ b/interfaces/TriggerManager.html @@ -1,4 +1,4 @@ -TriggerManager | @lf-lang/reactor-ts

    Interface TriggerManager

    interface TriggerManager {
        addReaction: ((reaction) => void);
        delReaction: ((reaction) => void);
        getContainer: (() => Reactor);
    }

    Properties

    addReaction +TriggerManager | @lf-lang/reactor-ts

    Interface TriggerManager

    interface TriggerManager {
        addReaction: ((reaction) => void);
        delReaction: ((reaction) => void);
        getContainer: (() => Reactor);
    }

    Properties

    addReaction delReaction getContainer -

    Properties

    addReaction

    addReaction: ((reaction) => void)

    Type declaration

    delReaction

    delReaction: ((reaction) => void)

    Type declaration

    getContainer

    getContainer: (() => Reactor)

    Type declaration

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    addReaction

    addReaction: ((reaction) => void)

    Type declaration

    delReaction

    delReaction: ((reaction) => void)

    Type declaration

    getContainer

    getContainer: (() => Reactor)

    Type declaration

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/Write.html b/interfaces/Write.html index 2997166b..b9b7e96c 100644 --- a/interfaces/Write.html +++ b/interfaces/Write.html @@ -1,3 +1,3 @@ Write | @lf-lang/reactor-ts

    Interface Write<T>

    Interface for writable ports.

    -
    interface Write<T> {
        set: ((value) => void);
    }

    Type Parameters

    • T

    Hierarchy (view full)

    Implemented by

    Properties

    set -

    Properties

    set

    set: ((value) => void)

    Type declaration

      • (value): void

      • Parameters

        • value: T

        Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +
    interface Write<T> {
        set: ((value) => void);
    }

    Type Parameters

    Hierarchy (view full)

    Implemented by

    Properties

    set +

    Properties

    set

    set: ((value) => void)

    Type declaration

      • (value): void

      • Parameters

        • value: T

        Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/Log.html b/modules/Log.html index debd2ce4..cc8cc49c 100644 --- a/modules/Log.html +++ b/modules/Log.html @@ -1,5 +1,5 @@ Log | @lf-lang/reactor-ts

    Namespace Log

    Global logging facility that has multiple levels of severity.

    -

    Index

    Enumerations

    LogLevel +

    Index

    Enumerations

    LogLevel

    Variables

    globalLogger hr

    Functions

    debug diff --git a/types/Absent.html b/types/Absent.html index a8fd32f7..0117dc7d 100644 --- a/types/Absent.html +++ b/types/Absent.html @@ -1,3 +1,3 @@ Absent | @lf-lang/reactor-ts

    Type alias Absent

    Absent: undefined

    Type that denotes the absence of a value.

    See

    Variable

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/ArgList.html b/types/ArgList.html index 16bc6f97..00b0733a 100644 --- a/types/ArgList.html +++ b/types/ArgList.html @@ -2,4 +2,4 @@ T is inferred to be a subtype of Variable[] it will yield T; it will yield never if T is not a subtype of Variable[].

    Type Parameters

    See

    Reaction

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/CommandLineOptionSpec.html b/types/CommandLineOptionSpec.html index 3822631c..a88698c8 100644 --- a/types/CommandLineOptionSpec.html +++ b/types/CommandLineOptionSpec.html @@ -1 +1 @@ -CommandLineOptionSpec | @lf-lang/reactor-ts

    Type alias CommandLineOptionSpec

    CommandLineOptionSpec: {
        alias?: string;
        description: string;
        name: string;
        type: ((arg0) => unknown);
        typeLabel?: string;
    }[]

    Type declaration

    • Optional alias?: string
    • description: string
    • name: string
    • type: ((arg0) => unknown)
        • (arg0): unknown

        • Parameters

          • arg0: string

          Returns unknown

    • Optional typeLabel?: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +CommandLineOptionSpec | @lf-lang/reactor-ts

    Type alias CommandLineOptionSpec

    CommandLineOptionSpec: {
        alias?: string;
        description: string;
        name: string;
        type: ((arg0) => unknown);
        typeLabel?: string;
    }[]

    Type declaration

    • Optional alias?: string
    • description: string
    • name: string
    • type: ((arg0) => unknown)
        • (arg0): unknown

        • Parameters

          • arg0: string

          Returns unknown

    • Optional typeLabel?: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/MultiReadWrite.html b/types/MultiReadWrite.html index 0b30de02..3e4ef3c1 100644 --- a/types/MultiReadWrite.html +++ b/types/MultiReadWrite.html @@ -1 +1 @@ -MultiReadWrite | @lf-lang/reactor-ts

    Type alias MultiReadWrite<T>

    MultiReadWrite<T>: MultiRead<T> & MultiWrite<T>

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +MultiReadWrite | @lf-lang/reactor-ts

    Type alias MultiReadWrite<T>

    MultiReadWrite<T>: MultiRead<T> & MultiWrite<T>

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/ParmList.html b/types/ParmList.html index bee28291..70a66ab5 100644 --- a/types/ParmList.html +++ b/types/ParmList.html @@ -1,3 +1,3 @@ ParmList | @lf-lang/reactor-ts

    Type alias ParmList<T>

    ParmList<T>: T extends unknown[]
        ? T
        : never

    Type that describes a tuple of parameters passed into the constructor of a reactor class.

    -

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/Priority.html b/types/Priority.html index b599be0e..784ca076 100644 --- a/types/Priority.html +++ b/types/Priority.html @@ -1,4 +1,4 @@ Priority | @lf-lang/reactor-ts

    Type alias Priority

    Priority: number

    A number that indicates a reaction's position with respect to other reactions in an acyclic precedence graph.

    See

    ReactionQueue

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/ReactorClass.html b/types/ReactorClass.html index b0300d92..b80490e3 100644 --- a/types/ReactorClass.html +++ b/types/ReactorClass.html @@ -1,3 +1,3 @@ ReactorClass | @lf-lang/reactor-ts

    Type alias ReactorClass<T, S>

    ReactorClass<T, S>: (new (...parameters) => T)

    Type that describes a class with a constructor of which the arguments are of type ReactorArgs.

    -

    Type Parameters

    Type declaration

      • new (...parameters): T

      • Parameters

        Returns T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/ReadWrite.html b/types/ReadWrite.html index d2f71743..3da4daa0 100644 --- a/types/ReadWrite.html +++ b/types/ReadWrite.html @@ -1,2 +1,2 @@ ReadWrite | @lf-lang/reactor-ts

    Type alias ReadWrite<T>

    ReadWrite<T>: Read<T> & Write<T>

    Type for simple variables that are both readable and writable.

    -

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/Variable.html b/types/Variable.html index 25fc527c..9c2a9779 100644 --- a/types/Variable.html +++ b/types/Variable.html @@ -5,4 +5,4 @@
  • Write
  • Sched
    • -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/BUFFER_SIZE.html b/variables/BUFFER_SIZE.html index ffe308bd..b7b322c7 100644 --- a/variables/BUFFER_SIZE.html +++ b/variables/BUFFER_SIZE.html @@ -1,4 +1,4 @@ BUFFER_SIZE | @lf-lang/reactor-ts

    Variable BUFFER_SIZEConst

    BUFFER_SIZE: 256 = 256

    Size of the buffer used for messages sent between federates. This is used by both the federates and the rti, so message lengths should generally match.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/CONNECT_NUM_RETRIES.html b/variables/CONNECT_NUM_RETRIES.html index 67ec4a9c..53ecf89d 100644 --- a/variables/CONNECT_NUM_RETRIES.html +++ b/variables/CONNECT_NUM_RETRIES.html @@ -2,4 +2,4 @@ A federate will retry every CONNECT_RETRY_INTERVAL seconds this many times before giving up. E.g., 500 retries every 2 seconds results in retrying for about 16 minutes.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/CONNECT_RETRY_INTERVAL.html b/variables/CONNECT_RETRY_INTERVAL.html index fddc2bb3..6114401f 100644 --- a/variables/CONNECT_RETRY_INTERVAL.html +++ b/variables/CONNECT_RETRY_INTERVAL.html @@ -1,3 +1,3 @@ CONNECT_RETRY_INTERVAL | @lf-lang/reactor-ts

    Variable CONNECT_RETRY_INTERVALConst

    CONNECT_RETRY_INTERVAL: TimeValue = ...

    Number of seconds that elapse between a federate's attempts to connect to the RTI.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/CommandLineOptionDefs.html b/variables/CommandLineOptionDefs.html index a39f985a..f28a04d8 100644 --- a/variables/CommandLineOptionDefs.html +++ b/variables/CommandLineOptionDefs.html @@ -1,4 +1,4 @@ CommandLineOptionDefs | @lf-lang/reactor-ts

    Variable CommandLineOptionDefsConst

    CommandLineOptionDefs: CommandLineOptionSpec = ...

    Configuration for command line arguments. If this configuration changes, the ProcessedCommandLineArgs type must change too.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/CommandLineUsageDefs.html b/variables/CommandLineUsageDefs.html index 33435f3a..98212b4b 100644 --- a/variables/CommandLineUsageDefs.html +++ b/variables/CommandLineUsageDefs.html @@ -1,3 +1,3 @@ CommandLineUsageDefs | @lf-lang/reactor-ts

    Variable CommandLineUsageDefsConst

    CommandLineUsageDefs: {
        content?: string;
        header: string;
        optionList?: CommandLineOptionSpec;
    }[] = ...

    Configuration for command line argument usage information. Note: The order of the elements in the list is important.

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/Log.globalLogger.html b/variables/Log.globalLogger.html index 1df081d1..aaba4041 100644 --- a/variables/Log.globalLogger.html +++ b/variables/Log.globalLogger.html @@ -1,2 +1,2 @@ globalLogger | @lf-lang/reactor-ts

    Variable globalLoggerConst

    globalLogger: Logger<never> = ...

    Global instance of ulog that performs the logging.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/Log.hr.html b/variables/Log.hr.html index 4c537693..ec8bb9c1 100644 --- a/variables/Log.hr.html +++ b/variables/Log.hr.html @@ -1,2 +1,2 @@ hr | @lf-lang/reactor-ts

    Variable hrConst

    hr: string = ...

    Horizontal rule.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file