diff --git a/classes/Action.html b/classes/Action.html index dfff66ec..428946c0 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,52 +44,52 @@ 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.

    -

    Protectedmanager

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

    ReadonlyminDelay

    minDelay: TimeValue

    ReadonlyminInterArrival

    minInterArrival: TimeValue = defaultMIT

    Readonlyorigin

    origin: Origin

    Protectedreactions

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

    Reactions to trigger.

    -

    Protectedruntime

    runtime: Runtime

    Protectedscheduler

    scheduler: (Anonymous class)<T, T> = ...

    Protectedtag

    tag: undefined | Tag

    Protectedvalue

    value: undefined | T = undefined

    StaticpathSeparator

    pathSeparator: string = "."

    Methods

    Protected_getContainer

    _getFullyQualifiedName

    Protectedmanager

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

    ReadonlyminDelay

    minDelay: TimeValue

    ReadonlyminInterArrival

    minInterArrival: TimeValue = defaultMIT

    Readonlyorigin

    origin: Origin

    Protectedreactions

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

    Reactions to trigger.

    +

    Protectedruntime

    runtime: Runtime

    Protectedscheduler

    scheduler: (Anonymous class)<T, T> = ...

    Protectedtag

    tag: undefined | Tag

    Protectedvalue

    value: undefined | T = undefined

    StaticpathSeparator

    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

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

    • toString(): string

    • Returns a string representation of an object.

      -

      Returns string

    update

    toString

    • toString(): string

    • Returns a string representation of an object.

      +

      Returns string

    update

    • update(e): void

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

      Parameters

      Returns void

    StatickeyOfMatchingBank

    StatickeyOfMatchingEntry

    • keyOfMatchingEntry(component, object): string

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

    Returns void

    StatickeyOfMatchingBank

    StatickeyOfMatchingEntry

    • keyOfMatchingEntry(component, object): string

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

      Parameters

      • component: Component

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

      • object: object

        the assumed container of the component

      Returns string

      the key of the entry that matches the component

      -

    StatickeyOfMatchingMultiport

    StatickeyOfMatchingMultiport

    • keyOfMatchingMultiport(port, reactor): string

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

      Parameters

      • port: Component

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

      • reactor: Reactor

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

      Returns string

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

      -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/Alarm.html b/classes/Alarm.html index 961cfa73..5268de27 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 @@ -11,16 +11,16 @@

    Methods

    set 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

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

    • Set the alarm.

      +

    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.

      • Optionalcallback: ((waitTime: TimeValue) => 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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/App.html b/classes/App.html index 40abed82..58dede88 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 _active _alarm @@ -97,42 +97,42 @@
  • 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.

    -

    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.

    +

    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_errored

    _errored: boolean = false

    Protected Optional_errorMessage

    _errorMessage?: string

    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_errored

    _errored: boolean = false

    Protected Optional_errorMessage

    _errorMessage?: string

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

    failure

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

    Optional callback to be used to indicate a failed execution.

    -

    Readonlyshutdown

    shutdown: Shutdown

    This reactor's shutdown action.

    -

    Readonlystartup

    startup: Startup

    This reactor's startup action.

    -

    success

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

    Optional callback to be used to indicate a successful execution.

    -

    Protectedutil

    util: UtilityFunctions = ...

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

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

    failure

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

    Optional callback to be used to indicate a failed execution.

    +

    Readonlyshutdown

    shutdown: Shutdown

    This reactor's shutdown action.

    +

    Readonlystartup

    startup: Startup

    This reactor's startup action.

    +

    success

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

    Optional callback to be used to indicate a successful execution.

    +

    Protectedutil

    util: UtilityFunctions = ...

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

    -

    StaticpathSeparator

    pathSeparator: string = "."

    Methods

    Protected_addDummyEvent

    StaticpathSeparator

    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_cancelNext

    • _cancelNext(): void

    • Disable the alarm and clear possible immediate next.

      -

      Returns void

    Protected_canProceed

    • _canProceed(event): boolean

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

      +

      Returns void

    Protected_cancelNext

    • _cancelNext(): void

    • Disable the alarm and clear possible immediate next.

      +

      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_connect

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

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

    Returns boolean

    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 @@ -142,9 +142,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 @@ -152,18 +152,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.

      • Optionaldst: 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

    • _getFullyQualifiedName(): string

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

      -

      Returns string

    _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 @@ -173,15 +173,15 @@

      Parameters

      • component: Trigger

        The component to look up the key for.

      • Optionalkey: 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 @@ -195,64 +195,64 @@

    • 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

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

    • _startExecuting(): void

    • Start executing reactions.

      -

      Returns void

    Protected_startTimeStep

    • _startTimeStep(): void

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

      Returns void

    _start

    Protected_startExecuting

    • _startExecuting(): void

    • Start executing reactions.

      +

      Returns void

    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

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

    ProtectedaddMutation

    ProtectedaddReaction

    • 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

    ProtectedaddMutation

    ProtectedaddReaction

    • 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): CanConnectResult

    • 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 @@ -267,39 +267,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 CanConnectResult

    canConnectCall

    getBankIndex

    • getBankIndex(): number

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

    Returns CanConnectResult

    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

    ProtectednextReaction

    ProtectednextReaction

    ProtectedprevReaction

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

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

    Returns undefined | Reaction<Variable[]>

    ProtectedprevReaction

    Protectedschedulable

    ProtectedsendRTIMessage

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

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

    Returns undefined | Reaction<Variable[]>

    Protectedschedulable

    ProtectedsendRTIMessage

    • 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

    ProtectedsendRTIPortAbsent

    • sendRTIPortAbsent(destFederateID, destPortID, additionalDelay): void

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

    Returns void

    ProtectedsendRTIPortAbsent

    • 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

    ProtectedsendRTITimedMessage

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

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

    • additionalDelay: undefined | TimeValue

    Returns void

    ProtectedsendRTITimedMessage

    • 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

    • setAdvanceMessageInterval(advanceMessageInterval): void

    • Parameters

      Returns void

    toString

    writable

    StatickeyOfMatchingBank

    StatickeyOfMatchingEntry

    • keyOfMatchingEntry(component, object): string

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

    • time: undefined | TimeValue

    Returns void

    setAdvanceMessageInterval

    • setAdvanceMessageInterval(advanceMessageInterval): void

    • Parameters

      Returns void

    toString

    writable

    StatickeyOfMatchingBank

    StatickeyOfMatchingEntry

    • keyOfMatchingEntry(component, object): string

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

      Parameters

      • component: Component

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

      • object: object

        the assumed container of the component

      Returns string

      the key of the entry that matches the component

      -

    StatickeyOfMatchingMultiport

    StatickeyOfMatchingMultiport

    • keyOfMatchingMultiport(port, reactor): string

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

      Parameters

      • port: Component

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

      • reactor: Reactor

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

      Returns string

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

      -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    _addDummyEvent_advanceTime_analyzeDependencies_cancelNext_canProceed_connect_connectCall_connectMulti_deregister_determineStartAndEndOfExecution_disconnect_finish_getCausalityInterface_getContainer_getEndOfExecution_getFirstReactionOrMutation_getFullyQualifiedName_getKey_getLastMutation_getLastReactionOrMutation_getMutations_getName_getPrecedenceGraph_getReactionIndex_getReactions_getReactionsAndMutations_initializeMutationScope_initializeReactionScope_isContainedBy_isContainedByContainerOf_isDownstream_isRegistered_isUpstream_iterationComplete_linkToRuntimeObject_loadStartupReactions_react_receiveRuntimeObject_register_requestImmediateInvocationOfNext_requestRuntimeObject_setAlarmOrYield_setEndOfExecution_shutdown_start_startExecuting_startTimeStep_unplug_unsetTimer_unsetTimersaddMutationaddReactionallWritablecanConnectcanConnectCallgetBankIndexnextReactionprevReactionschedulablesendRTIMessagesendRTIPortAbsentsendRTITimedMessagesetAdvanceMessageIntervaltoStringwritablekeyOfMatchingBankkeyOfMatchingEntrykeyOfMatchingMultiport
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    _addDummyEvent_advanceTime_analyzeDependencies_cancelNext_canProceed_connect_connectCall_connectMulti_deregister_determineStartAndEndOfExecution_disconnect_finish_getCausalityInterface_getContainer_getEndOfExecution_getFirstReactionOrMutation_getFullyQualifiedName_getKey_getLastMutation_getLastReactionOrMutation_getMutations_getName_getPrecedenceGraph_getReactionIndex_getReactions_getReactionsAndMutations_initializeMutationScope_initializeReactionScope_isContainedBy_isContainedByContainerOf_isDownstream_isRegistered_isUpstream_iterationComplete_linkToRuntimeObject_loadStartupReactions_react_receiveRuntimeObject_register_requestImmediateInvocationOfNext_requestRuntimeObject_setAlarmOrYield_setEndOfExecution_shutdown_start_startExecuting_startTimeStep_unplug_unsetTimer_unsetTimersaddMutationaddReactionallWritablecanConnectcanConnectCallgetBankIndexnextReactionprevReactionschedulablesendRTIMessagesendRTIPortAbsentsendRTITimedMessagesetAdvanceMessageIntervaltoStringwritablekeyOfMatchingBankkeyOfMatchingEntrykeyOfMatchingMultiport
    diff --git a/classes/Bank.html b/classes/Bank.html index 1632d7b1..4fd748ce 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

    initializationMap

    Methods

    all allWritable @@ -11,14 +11,14 @@

    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

    Static ReadonlyinitializationMap

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

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

    Returns Bank<T, S>

    Properties

    Static ReadonlyinitializationMap

    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: T) => 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

    • toString(): string

    • Returns string

    writable

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    toString

    writable

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/CalleePort.html b/classes/CalleePort.html index ed06ad34..afc5da75 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,44 +31,44 @@ 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

    ProtectedlastCaller

    lastCaller: undefined | Reaction<Variable[]>

    Protectedmanager

    manager: CalleeManager = ...

    Protectedprocedure

    procedure: undefined | Procedure<Variable[]>

    Protectedreactions

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

    Reactions to trigger.

    -

    Protectedreceivers

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

    retValue

    retValue: undefined | R

    Protectedruntime

    runtime: Runtime

    Protectedtag

    tag: undefined | Tag

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

    -

    Protectedvalue

    value: undefined | A

    The current value associated with this port.

    -

    StaticpathSeparator

    pathSeparator: string = "."

    Methods

    Protected_getContainer

    _getFullyQualifiedName

    • _getFullyQualifiedName(): string

    • Return a string that identifies this component. +

    argValue

    argValue: undefined | A

    ProtectedlastCaller

    lastCaller: undefined | Reaction<Variable[]>

    Protectedmanager

    manager: CalleeManager = ...

    Protectedprocedure

    procedure: undefined | Procedure<Variable[]>

    Protectedreactions

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

    Reactions to trigger.

    +

    Protectedreceivers

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

    retValue

    retValue: undefined | R

    Protectedruntime

    runtime: Runtime

    Protectedtag

    tag: undefined | Tag

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

    +

    Protectedvalue

    value: undefined | A

    The current value associated with this port.

    +

    StaticpathSeparator

    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

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

    _isRegistered

    Returns boolean

    _isRegistered

    Protected_linkToRuntimeObject

    Protected_linkToRuntimeObject

    _receiveRuntimeObject

    get

    getContainer

    getManager

    invoke

    isPresent

    return

    set

    toString

    StatickeyOfMatchingBank

    StatickeyOfMatchingEntry

    _receiveRuntimeObject

    get

    getContainer

    getManager

    invoke

    isPresent

    return

    set

    toString

    StatickeyOfMatchingBank

    StatickeyOfMatchingEntry

    StatickeyOfMatchingMultiport

    StatickeyOfMatchingMultiport

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/CallerPort.html b/classes/CallerPort.html index 51d353c5..02213dbb 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,44 +27,44 @@ 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.

    -

    Protectedmanager

    manager: TriggerManager = ...

    Protectedreactions

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

    Reactions to trigger.

    -

    Protectedreceivers

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

    remotePort

    remotePort: undefined | CalleePort<A, R>

    Protectedruntime

    runtime: Runtime

    Protectedtag

    tag: undefined | Tag

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

    -

    Protectedvalue

    value: undefined | R

    The current value associated with this port.

    -

    StaticpathSeparator

    pathSeparator: string = "."

    Methods

    Protected_getContainer

    _getFullyQualifiedName

    • _getFullyQualifiedName(): string

    • Return a string that identifies this component. +

    Protectedmanager

    manager: TriggerManager = ...

    Protectedreactions

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

    Reactions to trigger.

    +

    Protectedreceivers

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

    remotePort

    remotePort: undefined | CalleePort<A, R>

    Protectedruntime

    runtime: Runtime

    Protectedtag

    tag: undefined | Tag

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

    +

    Protectedvalue

    value: undefined | R

    The current value associated with this port.

    +

    StaticpathSeparator

    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

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

    _isRegistered

    Returns boolean

    _isRegistered

    Protected_linkToRuntimeObject

    Protected_linkToRuntimeObject

    _receiveRuntimeObject

    get

    getContainer

    getManager

    invoke

    isPresent

    set

    toString

    StatickeyOfMatchingBank

    StatickeyOfMatchingEntry

    _receiveRuntimeObject

    get

    getContainer

    getManager

    invoke

    isPresent

    set

    toString

    StatickeyOfMatchingBank

    StatickeyOfMatchingEntry

    StatickeyOfMatchingMultiport

    StatickeyOfMatchingMultiport

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/Component.html b/classes/Component.html index 78336e17..1de9a10d 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

    _key pathSeparator

    Methods

    _getContainer @@ -25,39 +25,39 @@

    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

    Protected_key

    _key: symbol = ...

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

    Returns Component

    Properties

    Protected_key

    _key: symbol = ...

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

    -

    StaticpathSeparator

    pathSeparator: string = "."

    Methods

    Protected_getContainer

    _getFullyQualifiedName

    • _getFullyQualifiedName(): string

    • Return a string that identifies this component. +

    StaticpathSeparator

    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

    StatickeyOfMatchingBank

    StatickeyOfMatchingEntry

    • 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

    StatickeyOfMatchingBank

    StatickeyOfMatchingEntry

    • keyOfMatchingEntry(component, object): string

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

      Parameters

      • component: Component

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

      • object: object

        the assumed container of the component

      Returns string

      the key of the entry that matches the component

      -

    StatickeyOfMatchingMultiport

    • keyOfMatchingMultiport(port, reactor): string

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

    StatickeyOfMatchingMultiport

    • keyOfMatchingMultiport(port, reactor): string

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

      Parameters

      • port: Component

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

      • reactor: Reactor

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

      Returns string

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

      -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/ConnectablePort.html b/classes/ConnectablePort.html index 77eecfbc..f43d7287 100644 --- a/classes/ConnectablePort.html +++ b/classes/ConnectablePort.html @@ -1,6 +1,6 @@ ConnectablePort | @lf-lang/reactor-ts

    Class ConnectablePort<T>

    Interface for readable variables.

    -

    Type Parameters

    • T

    Implements

    Constructors

    constructor +

    Type Parameters

    • T

    Implements

    Constructors

    constructor

    Properties

    port

    Methods

    get getPort -

    Constructors

    constructor

    Properties

    port

    port: IOPort<T>

    Methods

    get

    getPort

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Constructors

    constructor

    Properties

    port

    port: IOPort<T>

    Methods

    get

    getPort

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/Dummy.html b/classes/Dummy.html index 9812fab1..6e0a20e6 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,52 +35,52 @@ 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.

    -

    Protectedmanager

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

    ReadonlyminDelay

    minDelay: TimeValue

    ReadonlyminInterArrival

    minInterArrival: TimeValue = defaultMIT

    Readonlyorigin

    origin: Origin

    Protectedreactions

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

    Reactions to trigger.

    -

    Protectedruntime

    runtime: Runtime

    Protectedscheduler

    scheduler: (Anonymous class)<unknown, unknown> = ...

    Protectedtag

    tag: undefined | Tag

    Protectedvalue

    value: unknown = undefined

    StaticpathSeparator

    pathSeparator: string = "."

    Methods

    Protected_getContainer

    _getFullyQualifiedName

    • _getFullyQualifiedName(): string

    • Return a string that identifies this component. +

    Protectedmanager

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

    ReadonlyminDelay

    minDelay: TimeValue

    ReadonlyminInterArrival

    minInterArrival: TimeValue = defaultMIT

    Readonlyorigin

    origin: Origin

    Protectedreactions

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

    Reactions to trigger.

    +

    Protectedruntime

    runtime: Runtime

    Protectedscheduler

    scheduler: (Anonymous class)<unknown, unknown> = ...

    Protectedtag

    tag: undefined | Tag

    Protectedvalue

    value: unknown = undefined

    StaticpathSeparator

    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

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

    _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

    • update(e): void

    • Update the current value of this timer in accordance with the given +

      Returns boolean

    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

    StatickeyOfMatchingBank

    StatickeyOfMatchingEntry

    • keyOfMatchingEntry(component, object): string

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

    Returns void

    StatickeyOfMatchingBank

    StatickeyOfMatchingEntry

    • keyOfMatchingEntry(component, object): string

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

      Parameters

      • component: Component

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

      • object: object

        the assumed container of the component

      Returns string

      the key of the entry that matches the component

      -

    StatickeyOfMatchingMultiport

    StatickeyOfMatchingMultiport

    • keyOfMatchingMultiport(port, reactor): string

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

      Parameters

      • port: Component

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

      • reactor: Reactor

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

      Returns string

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

      -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/FederatePortAction.html b/classes/FederatePortAction.html index 10eba573..0ea6128b 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,52 +35,52 @@ 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.

    -

    Protectedmanager

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

    ReadonlyminDelay

    minDelay: TimeValue

    ReadonlyminInterArrival

    minInterArrival: TimeValue = defaultMIT

    Readonlyorigin

    origin: Origin

    Protectedreactions

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

    Reactions to trigger.

    -

    Protectedruntime

    runtime: Runtime

    Protectedscheduler

    scheduler: (Anonymous class)<T, T> = ...

    Protectedtag

    tag: undefined | Tag

    Protectedvalue

    value: undefined | T = undefined

    StaticpathSeparator

    pathSeparator: string = "."

    Methods

    Protected_getContainer

    _getFullyQualifiedName

    • _getFullyQualifiedName(): string

    • Return a string that identifies this component. +

    Protectedmanager

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

    ReadonlyminDelay

    minDelay: TimeValue

    ReadonlyminInterArrival

    minInterArrival: TimeValue = defaultMIT

    Readonlyorigin

    origin: Origin

    Protectedreactions

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

    Reactions to trigger.

    +

    Protectedruntime

    runtime: Runtime

    Protectedscheduler

    scheduler: (Anonymous class)<T, T> = ...

    Protectedtag

    tag: undefined | Tag

    Protectedvalue

    value: undefined | T = undefined

    StaticpathSeparator

    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

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

    _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

    • update(e): void

    • Update the current value of this timer in accordance with the given +

      Returns boolean

    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

    StatickeyOfMatchingBank

    StatickeyOfMatchingEntry

    • keyOfMatchingEntry(component, object): string

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

    Returns void

    StatickeyOfMatchingBank

    StatickeyOfMatchingEntry

    • keyOfMatchingEntry(component, object): string

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

      Parameters

      • component: Component

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

      • object: object

        the assumed container of the component

      Returns string

      the key of the entry that matches the component

      -

    StatickeyOfMatchingMultiport

    StatickeyOfMatchingMultiport

    • keyOfMatchingMultiport(port, reactor): string

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

      Parameters

      • port: Component

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

      • reactor: Reactor

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

      Returns string

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

      -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/FederatedApp.html b/classes/FederatedApp.html index ed42bfcc..03f170d3 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 @@ -115,49 +115,49 @@ is the federateID and the rtiPort.

    Parameters

    • config: FederateConfig
    • Optionalsuccess: (() => void)

      Optional argument. Called when the FederatedApp exits with success.

        • (): void

        • Returns void

    • Optionalfailure: (() => 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_errored

    _errored: boolean = false

    Protected Optional_errorMessage

    _errorMessage?: string

    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_errored

    _errored: boolean = false

    Protected Optional_errorMessage

    _errorMessage?: string

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

    failure

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

    Optional callback to be used to indicate a failed execution.

    -

    rtiHost

    rtiHost: string

    rtiPort

    rtiPort: number

    Readonlyshutdown

    shutdown: Shutdown

    This reactor's shutdown action.

    -

    Readonlystartup

    startup: Startup

    This reactor's startup action.

    -

    success

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

    Optional callback to be used to indicate a successful execution.

    -

    Protectedutil

    util: UtilityFunctions = ...

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

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

    failure

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

    Optional callback to be used to indicate a failed execution.

    +

    rtiHost

    rtiHost: string

    rtiPort

    rtiPort: number

    Readonlyshutdown

    shutdown: Shutdown

    This reactor's shutdown action.

    +

    Readonlystartup

    startup: Startup

    This reactor's startup action.

    +

    success

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

    Optional callback to be used to indicate a successful execution.

    +

    Protectedutil

    util: UtilityFunctions = ...

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

    -

    StaticpathSeparator

    pathSeparator: string = "."

    Methods

    Protected_addDummyEvent

    • _addDummyEvent(tag): void

    • Add a dummy event to the event queue. +

    StaticpathSeparator

    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_cancelNext

    Protected_canProceed

    Protected_cancelNext

    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_connect

    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 @@ -167,9 +167,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 @@ -177,19 +177,19 @@

      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.

      • Optionaldst: 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

    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 @@ -199,15 +199,15 @@

      Parameters

      • component: Trigger

        The component to look up the key for.

      • Optionalkey: 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 @@ -221,68 +221,68 @@

    • 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(port): boolean

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

      Returns boolean

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

    _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

    • Send RTI the MSG_STOP_REQUEST +

    Returns void

    Protected_requestImmediateInvocationOfNext

    _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

    • 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

    addDownstreamFederate

    • addDownstreamFederate(fedID): void

    • Parameters

      • fedID: number

      Returns void

    ProtectedaddMutation

    ProtectedaddReaction

    • 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

    addDownstreamFederate

    • addDownstreamFederate(fedID): void

    • Parameters

      • fedID: number

      Returns void

    ProtectedaddMutation

    ProtectedaddReaction

    • 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): CanConnectResult

    • 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 @@ -297,37 +297,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 CanConnectResult

    canConnectCall

    getBankIndex

    • getBankIndex(): number

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

    Returns CanConnectResult

    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

    ProtectednextReaction

    ProtectednextReaction

    ProtectedprevReaction

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

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

    Returns undefined | Reaction<Variable[]>

    ProtectedprevReaction

    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

    Protectedschedulable

    sendRTILogicalTimeComplete

    • sendRTILogicalTimeComplete(completeTag): void

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

    Returns void

    Protectedschedulable

    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.

        @@ -335,31 +335,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

    • toString(): string

    • Return the fully qualified name of this reactor.

      -

      Returns string

    writable

    StatickeyOfMatchingBank

    StatickeyOfMatchingEntry

    • keyOfMatchingEntry(component, object): string

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

      Returns void

    toString

    • toString(): string

    • Return the fully qualified name of this reactor.

      +

      Returns string

    writable

    StatickeyOfMatchingBank

    StatickeyOfMatchingEntry

    • keyOfMatchingEntry(component, object): string

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

      Parameters

      • component: Component

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

      • object: object

        the assumed container of the component

      Returns string

      the key of the entry that matches the component

      -

    StatickeyOfMatchingMultiport

    • keyOfMatchingMultiport(port, reactor): string

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

    StatickeyOfMatchingMultiport

    • keyOfMatchingMultiport(port, reactor): string

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

      Parameters

      • port: Component

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

      • reactor: Reactor

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

      Returns string

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

      -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    _addDummyEvent_addEdgesForTpoLevels_advanceTime_analyzeDependencies_cancelNext_canProceed_connect_connectCall_connectMulti_deregister_determineStartAndEndOfExecution_disconnect_finish_getCausalityInterface_getContainer_getEndOfExecution_getFirstReactionOrMutation_getFullyQualifiedName_getGreatestTimeAdvanceGrant_getKey_getLastMutation_getLastReactionOrMutation_getMutations_getName_getPrecedenceGraph_getReactionIndex_getReactions_getReactionsAndMutations_initializeMutationScope_initializeReactionScope_isContainedBy_isContainedByContainerOf_isDownstream_isRegistered_isUpstream_iterationComplete_linkToRuntimeObject_loadStartupReactions_react_receiveRuntimeObject_register_requestImmediateInvocationOfNext_requestRuntimeObject_setAlarmOrYield_setEndOfExecution_shutdown_start_startExecuting_startTimeStep_unplug_unsetTimer_unsetTimersaddDownstreamFederateaddMutationaddReactionaddUpstreamFederateallWritablecanConnectcanConnectCallgetBankIndexnextReactionprevReactionregisterNetworkReceiverregisterNetworkSenderschedulablesendRTILogicalTimeCompletesendRTIMessagesendRTINextEventTagsendRTIPortAbsentsendRTIResignsendRTIStopRequestsendRTIStopRequestReplysendRTITimedMessagesetAdvanceMessageIntervalsetMinDelayFromPhysicalActionToFederateOutputshutdownRTIClienttoStringwritablekeyOfMatchingBankkeyOfMatchingEntrykeyOfMatchingMultiport
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    _addDummyEvent_addEdgesForTpoLevels_advanceTime_analyzeDependencies_cancelNext_canProceed_connect_connectCall_connectMulti_deregister_determineStartAndEndOfExecution_disconnect_finish_getCausalityInterface_getContainer_getEndOfExecution_getFirstReactionOrMutation_getFullyQualifiedName_getGreatestTimeAdvanceGrant_getKey_getLastMutation_getLastReactionOrMutation_getMutations_getName_getPrecedenceGraph_getReactionIndex_getReactions_getReactionsAndMutations_initializeMutationScope_initializeReactionScope_isContainedBy_isContainedByContainerOf_isDownstream_isRegistered_isUpstream_iterationComplete_linkToRuntimeObject_loadStartupReactions_react_receiveRuntimeObject_register_requestImmediateInvocationOfNext_requestRuntimeObject_setAlarmOrYield_setEndOfExecution_shutdown_start_startExecuting_startTimeStep_unplug_unsetTimer_unsetTimersaddDownstreamFederateaddMutationaddReactionaddUpstreamFederateallWritablecanConnectcanConnectCallgetBankIndexnextReactionprevReactionregisterNetworkReceiverregisterNetworkSenderschedulablesendRTILogicalTimeCompletesendRTIMessagesendRTINextEventTagsendRTIPortAbsentsendRTIResignsendRTIStopRequestsendRTIStopRequestReplysendRTITimedMessagesetAdvanceMessageIntervalsetMinDelayFromPhysicalActionToFederateOutputshutdownRTIClienttoStringwritablekeyOfMatchingBankkeyOfMatchingEntrykeyOfMatchingMultiport
    diff --git a/classes/IOPort.html b/classes/IOPort.html index cdc27b08..2a334595 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 @@ -27,49 +27,49 @@ 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.

    -

    Protectedmanager

    manager: IOPortManager<T> = ...

    Inner class instance to let the container configure this port.

    -

    Protectedreactions

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

    Reactions to trigger.

    -

    Protectedreceivers

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

    Protectedruntime

    runtime: Runtime

    Protectedtag

    tag: undefined | Tag

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

    -

    Protectedvalue

    value: undefined | T

    The current value associated with this port.

    -

    Protectedwriter

    writer: (Anonymous class)<T> = ...

    Inner class instance to gain access to Write interface.

    -

    StaticpathSeparator

    pathSeparator: string = "."

    Methods

    Protected_getContainer

    _getFullyQualifiedName

    • _getFullyQualifiedName(): string

    • Return a string that identifies this component. +

    Protectedmanager

    manager: IOPortManager<T> = ...

    Inner class instance to let the container configure this port.

    +

    Protectedreactions

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

    Reactions to trigger.

    +

    Protectedreceivers

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

    Protectedruntime

    runtime: Runtime

    Protectedtag

    tag: undefined | Tag

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

    +

    Protectedvalue

    value: undefined | T

    The current value associated with this port.

    +

    Protectedwriter

    writer: (Anonymous class)<T> = ...

    Inner class instance to gain access to Write interface.

    +

    StaticpathSeparator

    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

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

    _isRegistered

    Returns boolean

    _isRegistered

    Protected_linkToRuntimeObject

    Protected_linkToRuntimeObject

    _receiveRuntimeObject

    asConnectable

    asWritable

    get

    _receiveRuntimeObject

    asConnectable

    asWritable

    get

    getContainer

    getManager

    isPresent

    toString

    StatickeyOfMatchingBank

    StatickeyOfMatchingEntry

    getContainer

    getManager

    isPresent

    toString

    StatickeyOfMatchingBank

    StatickeyOfMatchingEntry

    StatickeyOfMatchingMultiport

    StatickeyOfMatchingMultiport

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/InMultiPort.html b/classes/InMultiPort.html index 4f8a491e..881b5d1f 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,66 +30,66 @@ 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.

    -

    Protectedmanager

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

    Inner class instance to let the container configure this port.

    -

    Protectedreactions

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

    Reactions to trigger.

    -

    Protectedwriter

    writer: (Anonymous class)<T> = ...

    Inner class instance to gain access to MultiWrite interface.

    -

    StaticpathSeparator

    pathSeparator: string = "."

    Methods

    Protected_getContainer

    _getFullyQualifiedName

    Protectedmanager

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

    Inner class instance to let the container configure this port.

    +

    Protectedreactions

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

    Reactions to trigger.

    +

    Protectedwriter

    writer: (Anonymous class)<T> = ...

    Inner class instance to gain access to MultiWrite interface.

    +

    StaticpathSeparator

    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

    _isRegistered

    Returns boolean

    _isRegistered

    Protected_linkToRuntimeObject

    Protected_linkToRuntimeObject

    _receiveRuntimeObject

    asWritable

    channel

    _receiveRuntimeObject

    asWritable

    channel

    channels

    get

    channels

    get

    getContainer

    getManager

    getContainer

    getManager

    isPresent

    Returns TriggerManager

    isPresent

    toString

    values

    toString

    values

    width

    width

    StatickeyOfMatchingBank

    StatickeyOfMatchingEntry

    StatickeyOfMatchingBank

    StatickeyOfMatchingEntry

    StatickeyOfMatchingMultiport

    StatickeyOfMatchingMultiport

    Staticvalues

    Staticvalues

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/InPort.html b/classes/InPort.html index 33f86c16..d6b34504 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 @@ -27,49 +27,49 @@ 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.

    -

    Protectedmanager

    manager: IOPortManager<T> = ...

    Inner class instance to let the container configure this port.

    -

    Protectedreactions

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

    Reactions to trigger.

    -

    Protectedreceivers

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

    Protectedruntime

    runtime: Runtime

    Protectedtag

    tag: undefined | Tag

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

    -

    Protectedvalue

    value: undefined | T

    The current value associated with this port.

    -

    Protectedwriter

    writer: (Anonymous class)<T> = ...

    Inner class instance to gain access to Write interface.

    -

    StaticpathSeparator

    pathSeparator: string = "."

    Methods

    Protected_getContainer

    _getFullyQualifiedName

    • _getFullyQualifiedName(): string

    • Return a string that identifies this component. +

    Protectedmanager

    manager: IOPortManager<T> = ...

    Inner class instance to let the container configure this port.

    +

    Protectedreactions

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

    Reactions to trigger.

    +

    Protectedreceivers

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

    Protectedruntime

    runtime: Runtime

    Protectedtag

    tag: undefined | Tag

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

    +

    Protectedvalue

    value: undefined | T

    The current value associated with this port.

    +

    Protectedwriter

    writer: (Anonymous class)<T> = ...

    Inner class instance to gain access to Write interface.

    +

    StaticpathSeparator

    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

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

    _isRegistered

    Returns boolean

    _isRegistered

    Protected_linkToRuntimeObject

    Protected_linkToRuntimeObject

    _receiveRuntimeObject

    asConnectable

    asWritable

    get

    _receiveRuntimeObject

    asConnectable

    asWritable

    get

    getContainer

    getManager

    isPresent

    toString

    StatickeyOfMatchingBank

    StatickeyOfMatchingEntry

    getContainer

    getManager

    isPresent

    toString

    StatickeyOfMatchingBank

    StatickeyOfMatchingEntry

    StatickeyOfMatchingMultiport

    StatickeyOfMatchingMultiport

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/MultiPort.html b/classes/MultiPort.html index a213c3ed..106701a1 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

    Hierarchy (view full)

    Implements

    Constructors

    constructor

    Properties

    _channels _key manager @@ -34,66 +34,66 @@

    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.

    -

    Protectedmanager

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

    Inner class instance to let the container configure this port.

    -

    Protectedreactions

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

    Reactions to trigger.

    -

    Protectedwriter

    writer: (Anonymous class)<T> = ...

    Inner class instance to gain access to MultiWrite interface.

    -

    StaticpathSeparator

    pathSeparator: string = "."

    Methods

    Protected_getContainer

    _getFullyQualifiedName

    • _getFullyQualifiedName(): string

    • Return a string that identifies this component. +

    Protectedmanager

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

    Inner class instance to let the container configure this port.

    +

    Protectedreactions

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

    Reactions to trigger.

    +

    Protectedwriter

    writer: (Anonymous class)<T> = ...

    Inner class instance to gain access to MultiWrite interface.

    +

    StaticpathSeparator

    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

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

    _receiveRuntimeObject

    asWritable

    Abstractchannel

    _receiveRuntimeObject

    asWritable

    Abstractchannel

    • channel(index): IOPort<T>

    • Return the channel identified by the given index.

      Parameters

      • index: number

        the index of the requested channel

        -

      Returns IOPort<T>

    Abstractchannels

    get

    • get(index): undefined | T

    • Parameters

      • index: number

        the index that identifies the channel to return the value of

        +

      Returns IOPort<T>

    Abstractchannels

    get

    • get(index): undefined | T

    • Parameters

      • index: number

        the index that identifies the channel to return the value of

      Returns undefined | T

      the value that corresponds to the identified channel

      -

    getContainer

    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

    • toString(): string

    • Returns a string representation of an object.

      -

      Returns string

    values

    toString

    • toString(): string

    • Returns a string representation of an object.

      +

      Returns string

    values

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

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

      Returns (undefined | T)[]

      an array of values

      -

    width

    • width(): number

    • Return the number of channels of this multiport.

      +

    width

    • width(): number

    • Return the number of channels of this multiport.

      Returns number

      the number of channels

      -

    StatickeyOfMatchingBank

    StatickeyOfMatchingEntry

    • keyOfMatchingEntry(component, object): string

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

    StatickeyOfMatchingBank

    StatickeyOfMatchingEntry

    • keyOfMatchingEntry(component, object): string

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

      Parameters

      • component: Component

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

      • object: object

        the assumed container of the component

      Returns string

      the key of the entry that matches the component

      -

    StatickeyOfMatchingMultiport

    StatickeyOfMatchingMultiport

    • keyOfMatchingMultiport(port, reactor): string

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

      Parameters

      • port: Component

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

      • reactor: Reactor

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

      Returns string

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

      -

    Staticvalues

    Staticvalues

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

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

      Type Parameters

      • T

      Parameters

      • ports: IOPort<T>[]

        the ports to return the values of

      Returns (undefined | T)[]

      the current values of the given ports

      -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/Mutation.html b/classes/Mutation.html index 28d04121..818104da 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.

    -

    Readonlyargs

    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 +

    Readonlyargs

    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.

    -

    Readonlyparent

    parent: Reactor

    Readonlytrigs

    trigs: Variable[]

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

    Readonlyparent

    parent: Reactor

    Readonlytrigs

    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(another): boolean

    • Return whether or not this reaction has priority over another.

      +

      Returns number

    hasPriorityOver

    • hasPriorityOver(another): boolean

    • Return whether or not this reaction has priority over another.

      Parameters

      • another: undefined | PrioritySetElement<number>

        Reaction to compare this reaction's priority against.

        -

      Returns boolean

    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

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    Returns boolean

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/NetworkReceiver.html b/classes/NetworkReceiver.html index 6a54b6b4..0a73506d 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 @@ -62,20 +62,20 @@ 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.

    -

    Readonlyshutdown

    shutdown: Shutdown

    This reactor's shutdown action.

    -

    Readonlystartup

    startup: Startup

    This reactor's startup action.

    -

    Protected Optional ReadonlytpoLevel

    tpoLevel?: number

    Protectedutil

    util: UtilityFunctions

    Collection of utility functions for this reactor and its subclasses.

    -

    StaticpathSeparator

    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 +

    Readonlyshutdown

    shutdown: Shutdown

    This reactor's shutdown action.

    +

    Readonlystartup

    startup: Startup

    This reactor's startup action.

    +

    Protected Optional ReadonlytpoLevel

    tpoLevel?: number

    Protectedutil

    util: UtilityFunctions

    Collection of utility functions for this reactor and its subclasses.

    +

    StaticpathSeparator

    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 @@ -85,18 +85,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

    Protected_disconnect

    Protected_disconnect

    Protected_getCausalityInterface

    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

    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

    ProtectedaddMutation

    ProtectedaddReaction

    Returns void

    Protected_unsetTimers

    ProtectedaddMutation

    ProtectedaddReaction

    allWritable

    canConnect

    allWritable

    canConnect

    Type Parameters

    Parameters

    Returns CanConnectResult

    canConnectCall

    getBankIndex

    Returns CanConnectResult

    canConnectCall

    getBankIndex

    getNetworkInputActionOrigin

    getReactions

    getNetworkInputActionOrigin

    getReactions

    getTpoLevel

    handleMessage

    getTpoLevel

    handleMessage

    handleTimedMessage

    Returns void

    handleTimedMessage

    ProtectednextReaction

    Returns void

    ProtectednextReaction

    ProtectedprevReaction

    Returns undefined | Reaction<Variable[]>

    ProtectedprevReaction

    registerNetworkInputAction

    Returns undefined | Reaction<Variable[]>

    registerNetworkInputAction

    Protectedschedulable

    toString

    writable

    StatickeyOfMatchingBank

    StatickeyOfMatchingEntry

    Returns void

    Protectedschedulable

    toString

    writable

    StatickeyOfMatchingBank

    StatickeyOfMatchingEntry

    StatickeyOfMatchingMultiport

    StatickeyOfMatchingMultiport

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/NetworkSender.html b/classes/NetworkSender.html index b39318e9..ca7add26 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.

    -

    Readonlyshutdown

    shutdown: Shutdown

    This reactor's shutdown action.

    -

    Readonlystartup

    startup: Startup

    This reactor's startup action.

    -

    Protected Optional ReadonlytpoLevel

    tpoLevel?: number

    Protectedutil

    util: UtilityFunctions

    Collection of utility functions for this reactor and its subclasses.

    -

    StaticpathSeparator

    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 +

    Readonlyshutdown

    shutdown: Shutdown

    This reactor's shutdown action.

    +

    Readonlystartup

    startup: Startup

    This reactor's startup action.

    +

    Protected Optional ReadonlytpoLevel

    tpoLevel?: number

    Protectedutil

    util: UtilityFunctions

    Collection of utility functions for this reactor and its subclasses.

    +

    StaticpathSeparator

    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

    Protected_disconnect

    Protected_disconnect

    Protected_getCausalityInterface

    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

    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

    ProtectedaddMutation

    ProtectedaddReaction

    Returns void

    Protected_unsetTimers

    ProtectedaddMutation

    ProtectedaddReaction

    allWritable

    canConnect

    allWritable

    canConnect

    Type Parameters

    Parameters

    Returns CanConnectResult

    canConnectCall

    getBankIndex

    Returns CanConnectResult

    canConnectCall

    getBankIndex

    getPortAbsentReaction

    getPortAbsentReaction

    getReactions

    getReactions

    getTpoLevel

    ProtectednextReaction

    getTpoLevel

    ProtectednextReaction

    ProtectedprevReaction

    Returns undefined | Reaction<Variable[]>

    ProtectedprevReaction

    Protectedschedulable

    toString

    writable

    StatickeyOfMatchingBank

    StatickeyOfMatchingEntry

    Returns undefined | Reaction<Variable[]>

    Protectedschedulable

    toString

    writable

    StatickeyOfMatchingBank

    StatickeyOfMatchingEntry

    StatickeyOfMatchingMultiport

    StatickeyOfMatchingMultiport

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/OutMultiPort.html b/classes/OutMultiPort.html index f45c96fa..a24ffc23 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,66 +30,66 @@ 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.

    -

    Protectedmanager

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

    Inner class instance to let the container configure this port.

    -

    Protectedreactions

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

    Reactions to trigger.

    -

    Protectedwriter

    writer: (Anonymous class)<T> = ...

    Inner class instance to gain access to MultiWrite interface.

    -

    StaticpathSeparator

    pathSeparator: string = "."

    Methods

    Protected_getContainer

    _getFullyQualifiedName

    Protectedmanager

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

    Inner class instance to let the container configure this port.

    +

    Protectedreactions

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

    Reactions to trigger.

    +

    Protectedwriter

    writer: (Anonymous class)<T> = ...

    Inner class instance to gain access to MultiWrite interface.

    +

    StaticpathSeparator

    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

    _isRegistered

    Returns boolean

    _isRegistered

    Protected_linkToRuntimeObject

    Protected_linkToRuntimeObject

    _receiveRuntimeObject

    asWritable

    channel

    _receiveRuntimeObject

    asWritable

    channel

    channels

    get

    channels

    get

    getContainer

    getManager

    getContainer

    getManager

    isPresent

    Returns TriggerManager

    isPresent

    toString

    values

    toString

    values

    width

    width

    StatickeyOfMatchingBank

    StatickeyOfMatchingEntry

    StatickeyOfMatchingBank

    StatickeyOfMatchingEntry

    StatickeyOfMatchingMultiport

    StatickeyOfMatchingMultiport

    Staticvalues

    Staticvalues

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/OutPort.html b/classes/OutPort.html index 2e234e2a..110c5ed3 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 @@ -27,49 +27,49 @@ 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.

    -

    Protectedmanager

    manager: IOPortManager<T> = ...

    Inner class instance to let the container configure this port.

    -

    Protectedreactions

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

    Reactions to trigger.

    -

    Protectedreceivers

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

    Protectedruntime

    runtime: Runtime

    Protectedtag

    tag: undefined | Tag

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

    -

    Protectedvalue

    value: undefined | T

    The current value associated with this port.

    -

    Protectedwriter

    writer: (Anonymous class)<T> = ...

    Inner class instance to gain access to Write interface.

    -

    StaticpathSeparator

    pathSeparator: string = "."

    Methods

    Protected_getContainer

    _getFullyQualifiedName

    • _getFullyQualifiedName(): string

    • Return a string that identifies this component. +

    Protectedmanager

    manager: IOPortManager<T> = ...

    Inner class instance to let the container configure this port.

    +

    Protectedreactions

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

    Reactions to trigger.

    +

    Protectedreceivers

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

    Protectedruntime

    runtime: Runtime

    Protectedtag

    tag: undefined | Tag

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

    +

    Protectedvalue

    value: undefined | T

    The current value associated with this port.

    +

    Protectedwriter

    writer: (Anonymous class)<T> = ...

    Inner class instance to gain access to Write interface.

    +

    StaticpathSeparator

    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

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

    _isRegistered

    Returns boolean

    _isRegistered

    Protected_linkToRuntimeObject

    Protected_linkToRuntimeObject

    _receiveRuntimeObject

    asConnectable

    asWritable

    get

    _receiveRuntimeObject

    asConnectable

    asWritable

    get

    getContainer

    getManager

    isPresent

    toString

    StatickeyOfMatchingBank

    StatickeyOfMatchingEntry

    getContainer

    getManager

    isPresent

    toString

    StatickeyOfMatchingBank

    StatickeyOfMatchingEntry

    StatickeyOfMatchingMultiport

    StatickeyOfMatchingMultiport

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/Parameter.html b/classes/Parameter.html index fb916779..103ba410 100644 --- a/classes/Parameter.html +++ b/classes/Parameter.html @@ -1,6 +1,6 @@ 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

    Methods

    get -

    Constructors

    constructor

    Methods

    get

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    +

    Constructors

    constructor

    Methods

    get

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    diff --git a/classes/Port.html b/classes/Port.html index 59dc6b63..6a75ddbd 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.

    -

    Protectedreactions

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

    Reactions to trigger.

    -

    Protectedreceivers

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

    Protectedruntime

    runtime: Runtime

    Protectedtag

    tag: undefined | Tag

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

    -

    Protectedvalue

    value: undefined | T

    The current value associated with this port.

    -

    StaticpathSeparator

    pathSeparator: string = "."

    Methods

    Protected_getContainer

    _getFullyQualifiedName

    • _getFullyQualifiedName(): string

    • Return a string that identifies this component. +

    Protectedreactions

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

    Reactions to trigger.

    +

    Protectedreceivers

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

    Protectedruntime

    runtime: Runtime

    Protectedtag

    tag: undefined | Tag

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

    +

    Protectedvalue

    value: undefined | T

    The current value associated with this port.

    +

    StaticpathSeparator

    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

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

    _isRegistered

    Returns boolean

    _isRegistered

    Protected_linkToRuntimeObject

    Protected_linkToRuntimeObject

    _receiveRuntimeObject

    getContainer

    AbstractgetManager

    _receiveRuntimeObject

    getContainer

    AbstractgetManager

    isPresent

    StatickeyOfMatchingBank

    StatickeyOfMatchingEntry

    Returns TriggerManager

    isPresent

    StatickeyOfMatchingBank

    StatickeyOfMatchingEntry

    StatickeyOfMatchingMultiport

    StatickeyOfMatchingMultiport

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/PrecedenceGraph.html b/classes/PrecedenceGraph.html index 3ac9c6fe..ce49b9b9 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

    ProtectedadjacencyMap

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

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

    -

    ProtectednumberOfEdges

    numberOfEdges: number = 0

    The total number of edges in the graph.

    -

    toString

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

    Methods

    addAll

    • addAll(pg): void

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

      +

    ProtectednumberOfEdges

    numberOfEdges: number = 0

    The total number of edges in the graph.

    +

    toString

    toString: (() => 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

    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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/PrioritySet.html b/classes/PrioritySet.html index 3156fc23..9a8873be 100644 --- a/classes/PrioritySet.html +++ b/classes/PrioritySet.html @@ -1,16 +1,16 @@ 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

    Methods

    empty peek pop push size

    Constructors

    constructor

    Methods

    empty

    • empty(): void

    • Empty the queue.

      -

      Returns void

    peek

    pop

    push

    • push(element): void

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

      Returns void

    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

    On This Page

    Constructors
    Methods
    +

    Returns void

    size

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    diff --git a/classes/Procedure.html b/classes/Procedure.html index a22f4d1d..e85d5d3d 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

  • Optionaldeadline: 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: ArgList<T>) => 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.

    -

    Readonlyargs

    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 +

    Readonlyargs

    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.

    -

    Readonlytrigs

    trigs: Variable[]

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

    Readonlytrigs

    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(another): boolean

    • Return whether or not this reaction has priority over another.

      +

      Returns number

    hasPriorityOver

    • hasPriorityOver(another): boolean

    • Return whether or not this reaction has priority over another.

      Parameters

      • another: undefined | PrioritySetElement<number>

        Reaction to compare this reaction's priority against.

        -

      Returns boolean

    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

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    Returns boolean

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/Reaction.html b/classes/Reaction.html index f31a1273..81479534 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 next @@ -31,33 +31,33 @@
      • (...args): void

      • Parameters

        Returns void

  • Optionaldeadline: 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: ArgList<T>) => 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.

    -

    Readonlyargs

    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 +

    Readonlyargs

    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.

    -

    Readonlytrigs

    trigs: Variable[]

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

    Readonlytrigs

    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

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    Returns boolean

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/ReactionGraph.html b/classes/ReactionGraph.html index 8daf0488..047adbd0 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

    ProtectedadjacencyMap

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

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

    -

    ProtectednumberOfEdges

    numberOfEdges: number = 0

    The total number of edges in the graph.

    -

    toString

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

    Methods

    addAll

    • addAll(pg): void

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

      +

    Constructors

    constructor

    Properties

    ProtectedadjacencyMap

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

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

    +

    ProtectednumberOfEdges

    numberOfEdges: number = 0

    The total number of edges in the graph.

    +

    toString

    toString: (() => 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

    addNode

    getDownstreamNeighbors

    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

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/Reactor.html b/classes/Reactor.html index 54be168e..a67d8205 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 _dependencyGraph @@ -60,18 +60,18 @@ 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).

    -

    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.

    -

    Readonlyshutdown

    shutdown: Shutdown

    This reactor's shutdown action.

    -

    Readonlystartup

    startup: Startup

    This reactor's startup action.

    -

    Protectedutil

    util: UtilityFunctions

    Collection of utility functions for this reactor and its subclasses.

    -

    StaticpathSeparator

    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 +

    Readonlyshutdown

    shutdown: Shutdown

    This reactor's shutdown action.

    +

    Readonlystartup

    startup: Startup

    This reactor's startup action.

    +

    Protectedutil

    util: UtilityFunctions

    Collection of utility functions for this reactor and its subclasses.

    +

    StaticpathSeparator

    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 @@ -81,18 +81,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.

      • Optionaldst: 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

    • _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 @@ -102,15 +102,15 @@

      Parameters

      • component: Trigger

        The component to look up the key for.

      • Optionalkey: 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

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

    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 @@ -124,51 +124,51 @@

    • 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

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

    _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

    _requestRuntimeObject

    Protected_unplug

    • _unplug(): void

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

    Returns void

    _requestRuntimeObject

    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

    ProtectedaddMutation

    ProtectedaddReaction

    • 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

    ProtectedaddMutation

    ProtectedaddReaction

    • 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): CanConnectResult

    • 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 @@ -183,26 +183,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 CanConnectResult

    canConnectCall

    getBankIndex

    • getBankIndex(): number

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

    Returns CanConnectResult

    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

    ProtectednextReaction

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

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

      Returns number

    ProtectednextReaction

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

    • Given a reaction, return the reaction within this reactior that directly succeeds it, or undefined if there is none.

      Parameters

      Returns undefined | Reaction<Variable[]>

    ProtectedprevReaction

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

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

    Returns undefined | Reaction<Variable[]>

    ProtectedprevReaction

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

    • Given a reaction, return the reaction within this reactor that directly precedes it, or undefined if there is none.

      Parameters

      Returns undefined | Reaction<Variable[]>

    Protectedschedulable

    toString

    • toString(): string

    • Return the fully qualified name of this reactor.

      -

      Returns string

    writable

    StatickeyOfMatchingBank

    StatickeyOfMatchingEntry

    • keyOfMatchingEntry(component, object): string

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

    Returns undefined | Reaction<Variable[]>

    Protectedschedulable

    toString

    • toString(): string

    • Return the fully qualified name of this reactor.

      +

      Returns string

    writable

    StatickeyOfMatchingBank

    StatickeyOfMatchingEntry

    • keyOfMatchingEntry(component, object): string

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

      Parameters

      • component: Component

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

      • object: object

        the assumed container of the component

      Returns string

      the key of the entry that matches the component

      -

    StatickeyOfMatchingMultiport

    StatickeyOfMatchingMultiport

    • keyOfMatchingMultiport(port, reactor): string

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

      Parameters

      • port: Component

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

      • reactor: Reactor

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

      Returns string

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

      -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/RemoteFederatePort.html b/classes/RemoteFederatePort.html index 07e94c24..30cca208 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

    On This Page

    Constructors
    Properties
    +

    Constructors

    constructor

    Properties

    federateID

    federateID: number

    portID

    portID: number

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    diff --git a/classes/SchedulableAction.html b/classes/SchedulableAction.html index fabe0699..cceded15 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

    Abstractget

    Abstractschedule

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    +

    Constructors

    constructor

    Methods

    Abstractget

    Abstractschedule

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    diff --git a/classes/ScheduledTrigger.html b/classes/ScheduledTrigger.html index 14894d5c..5d868060 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.

    -

    Protectedmanager

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

    Protectedreactions

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

    Reactions to trigger.

    -

    Protectedruntime

    runtime: Runtime

    Protectedtag

    tag: undefined | Tag

    Protectedvalue

    value: undefined | T = undefined

    StaticpathSeparator

    pathSeparator: string = "."

    Methods

    Protected_getContainer

    _getFullyQualifiedName

    • _getFullyQualifiedName(): string

    • Return a string that identifies this component. +

    Protectedmanager

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

    Protectedreactions

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

    Reactions to trigger.

    +

    Protectedruntime

    runtime: Runtime

    Protectedtag

    tag: undefined | Tag

    Protectedvalue

    value: undefined | T = undefined

    StaticpathSeparator

    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

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

    _isRegistered

    Returns boolean

    _isRegistered

    Protected_linkToRuntimeObject

    Protected_linkToRuntimeObject

    _receiveRuntimeObject

    getContainer

    getManager

    _receiveRuntimeObject

    getContainer

    getManager

    isPresent

    Returns TriggerManager

    isPresent

    update

    update

    StatickeyOfMatchingBank

    StatickeyOfMatchingEntry

    Returns void

    StatickeyOfMatchingBank

    StatickeyOfMatchingEntry

    StatickeyOfMatchingMultiport

    StatickeyOfMatchingMultiport

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/Shutdown.html b/classes/Shutdown.html index 2e8940d3..4dc54067 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,52 +35,52 @@ 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.

    -

    Protectedmanager

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

    ReadonlyminDelay

    minDelay: TimeValue

    ReadonlyminInterArrival

    minInterArrival: TimeValue = defaultMIT

    Readonlyorigin

    origin: Origin

    Protectedreactions

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

    Reactions to trigger.

    -

    Protectedruntime

    runtime: Runtime

    Protectedscheduler

    scheduler: (Anonymous class)<unknown, unknown> = ...

    Protectedtag

    tag: undefined | Tag

    Protectedvalue

    value: unknown = undefined

    StaticpathSeparator

    pathSeparator: string = "."

    Methods

    Protected_getContainer

    _getFullyQualifiedName

    • _getFullyQualifiedName(): string

    • Return a string that identifies this component. +

    Protectedmanager

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

    ReadonlyminDelay

    minDelay: TimeValue

    ReadonlyminInterArrival

    minInterArrival: TimeValue = defaultMIT

    Readonlyorigin

    origin: Origin

    Protectedreactions

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

    Reactions to trigger.

    +

    Protectedruntime

    runtime: Runtime

    Protectedscheduler

    scheduler: (Anonymous class)<unknown, unknown> = ...

    Protectedtag

    tag: undefined | Tag

    Protectedvalue

    value: unknown = undefined

    StaticpathSeparator

    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

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

    _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

    • update(e): void

    • Update the current value of this timer in accordance with the given +

      Returns boolean

    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

    StatickeyOfMatchingBank

    StatickeyOfMatchingEntry

    • keyOfMatchingEntry(component, object): string

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

    Returns void

    StatickeyOfMatchingBank

    StatickeyOfMatchingEntry

    • keyOfMatchingEntry(component, object): string

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

      Parameters

      • component: Component

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

      • object: object

        the assumed container of the component

      Returns string

      the key of the entry that matches the component

      -

    StatickeyOfMatchingMultiport

    StatickeyOfMatchingMultiport

    • keyOfMatchingMultiport(port, reactor): string

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

      Parameters

      • port: Component

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

      • reactor: Reactor

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

      Returns string

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

      -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/SortablePrecedenceGraph.html b/classes/SortablePrecedenceGraph.html index 41d94583..a7a19d56 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

    • Optionaltype: (new (...args: never[]) => T)

      A type that extends T.

        • new (...args): T

        • Parameters

          • Rest...args: never[]

          Returns T

    • Optionalpg: PrecedenceGraph<unknown>

      A precedence graph.

      -

    Returns SortablePrecedenceGraph<T>

    Properties

    ProtectedadjacencyMap

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

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

    -

    ProtectednumberOfEdges

    numberOfEdges: number = 0

    The total number of edges in the graph.

    -

    toString

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

    Methods

    addAll

    • addAll(pg): void

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

      +

    Returns SortablePrecedenceGraph<T>

    Properties

    ProtectedadjacencyMap

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

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

    +

    ProtectednumberOfEdges

    numberOfEdges: number = 0

    The total number of edges in the graph.

    +

    toString

    toString: (() => 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

    addNode

    getDownstreamNeighbors

    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

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/Startup.html b/classes/Startup.html index da7cc7e3..b1818808 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,52 +35,52 @@ 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.

    -

    Protectedmanager

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

    ReadonlyminDelay

    minDelay: TimeValue

    ReadonlyminInterArrival

    minInterArrival: TimeValue = defaultMIT

    Readonlyorigin

    origin: Origin

    Protectedreactions

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

    Reactions to trigger.

    -

    Protectedruntime

    runtime: Runtime

    Protectedscheduler

    scheduler: (Anonymous class)<unknown, unknown> = ...

    Protectedtag

    tag: undefined | Tag

    Protectedvalue

    value: unknown = undefined

    StaticpathSeparator

    pathSeparator: string = "."

    Methods

    Protected_getContainer

    _getFullyQualifiedName

    • _getFullyQualifiedName(): string

    • Return a string that identifies this component. +

    Protectedmanager

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

    ReadonlyminDelay

    minDelay: TimeValue

    ReadonlyminInterArrival

    minInterArrival: TimeValue = defaultMIT

    Readonlyorigin

    origin: Origin

    Protectedreactions

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

    Reactions to trigger.

    +

    Protectedruntime

    runtime: Runtime

    Protectedscheduler

    scheduler: (Anonymous class)<unknown, unknown> = ...

    Protectedtag

    tag: undefined | Tag

    Protectedvalue

    value: unknown = undefined

    StaticpathSeparator

    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

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

    _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

    • update(e): void

    • Update the current value of this timer in accordance with the given +

      Returns boolean

    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

    StatickeyOfMatchingBank

    StatickeyOfMatchingEntry

    • keyOfMatchingEntry(component, object): string

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

    Returns void

    StatickeyOfMatchingBank

    StatickeyOfMatchingEntry

    • keyOfMatchingEntry(component, object): string

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

      Parameters

      • component: Component

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

      • object: object

        the assumed container of the component

      Returns string

      the key of the entry that matches the component

      -

    StatickeyOfMatchingMultiport

    StatickeyOfMatchingMultiport

    • keyOfMatchingMultiport(port, reactor): string

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

      Parameters

      • port: Component

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

      • reactor: Reactor

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

      Returns string

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

      -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/State.html b/classes/State.html index 5ff7a25e..eee70fbc 100644 --- a/classes/State.html +++ b/classes/State.html @@ -1,11 +1,11 @@ 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

    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>

    Methods

    get

    • get(): T

    • Return the current value of this state variable.

      -

      Returns T

    set

    • set(value): void

    • Set the current value of this state variable.

      -

      Parameters

      • value: T

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    +

    Returns State<T>

    Methods

    get

    • get(): T

    • Return the current value of this state variable.

      +

      Returns T

    set

    • set(value): void

    • Set the current value of this state variable.

      +

      Parameters

      • value: T

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    diff --git a/classes/Tag.html b/classes/Tag.html index 88afde1d..0ee02080 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

    Readonlymicrostep

    microstep: number = 0

    Superdense time index.

    -

    Readonlytime

    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

    Readonlymicrostep

    microstep: number = 0

    Superdense time index.

    +

    Readonlytime

    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

    StaticfromBinary

    • 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

    StaticfromBinary

    • 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

    On This Page

    Constructors
    Properties
    Methods
    +

    Returns Tag

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/TaggedEvent.html b/classes/TaggedEvent.html index ae84bbf0..a6ff239c 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

    • hasPriorityOver(node): boolean

    • Return true if this event has a smaller tag than the given event, false +

    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

    On This Page

    Constructors
    Properties
    Methods
    +

    Returns boolean

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/TimeValue.html b/classes/TimeValue.html index a5b47646..0f55b466 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

    Protectednanoseconds

    nanoseconds: number = 0

    Remaining number of nanoseconds (defaults to zero).

    -

    Protectedseconds

    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

    Protectednanoseconds

    nanoseconds: number = 0

    Remaining number of nanoseconds (defaults to zero).

    +

    Protectedseconds

    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

    • isForever(): boolean

    • Returns boolean

    isLaterThan

    • isLaterThan(other): boolean

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

      +

    Returns boolean

    isForever

    • isForever(): boolean

    • Returns boolean

    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

    • isNever(): boolean

    • Returns boolean

    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

    • isNever(): boolean

    • Returns boolean

    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]

    Staticforever

    StaticfromBinary

    • fromBinary(buffer): TimeValue

    • Create a TimeValue from a 64bit little endian unsigned integer in a buffer.

      +

      Returns [number, number]

    Staticforever

    StaticfromBinary

    • 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

    Staticmsec

    Staticmsecs

    Staticnever

    Staticnsec

    Staticnsecs

    Staticsec

    Staticsecs

    StaticsecsAndNs

    Staticusec

    Staticusecs

    StaticwithUnits

    • withUnits(value, unit): TimeValue

    • Give a value and time unit, return a new time value.

      +

    Returns TimeValue

    Staticmsec

    Staticmsecs

    Staticnever

    Staticnsec

    Staticnsecs

    Staticsec

    Staticsecs

    StaticsecsAndNs

    Staticusec

    Staticusecs

    StaticwithUnits

    • 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

    Staticzero

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Returns TimeValue

    Staticzero

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/Timer.html b/classes/Timer.html index 0289bafd..87d7a49b 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,52 +37,52 @@ 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.

    -

    Protectedmanager

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

    offset

    offset: TimeValue

    period

    period: TimeValue

    Protectedreactions

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

    Reactions to trigger.

    -

    Protectedruntime

    runtime: Runtime

    Protectedtag

    tag: undefined | Tag

    Protectedvalue

    value: undefined | Tag = undefined

    StaticpathSeparator

    pathSeparator: string = "."

    Methods

    Protected_getContainer

    _getFullyQualifiedName

    Protectedmanager

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

    offset

    offset: TimeValue

    period

    period: TimeValue

    Protectedreactions

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

    Reactions to trigger.

    +

    Protectedruntime

    runtime: Runtime

    Protectedtag

    tag: undefined | Tag

    Protectedvalue

    value: undefined | Tag = undefined

    StaticpathSeparator

    pathSeparator: string = "."

    Methods

    Protected_getContainer

    _getFullyQualifiedName

    _getName

    _getName

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

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

    • toString(): string

    • Returns a string representation of an object.

      -

      Returns string

    update

    toString

    • toString(): string

    • Returns a string representation of an object.

      +

      Returns string

    update

    • update(e): void

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

      Parameters

      Returns void

    StatickeyOfMatchingBank

    StatickeyOfMatchingEntry

    • keyOfMatchingEntry(component, object): string

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

    Returns void

    StatickeyOfMatchingBank

    StatickeyOfMatchingEntry

    • keyOfMatchingEntry(component, object): string

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

      Parameters

      • component: Component

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

      • object: object

        the assumed container of the component

      Returns string

      the key of the entry that matches the component

      -

    StatickeyOfMatchingMultiport

    StatickeyOfMatchingMultiport

    • keyOfMatchingMultiport(port, reactor): string

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

      Parameters

      • port: Component

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

      • reactor: Reactor

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

      Returns string

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

      -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/Trigger.html b/classes/Trigger.html index 5eadbad3..d34308f6 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.

    -

    Protectedreactions

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

    Reactions to trigger.

    -

    StaticpathSeparator

    pathSeparator: string = "."

    Methods

    Protected_getContainer

    _getFullyQualifiedName

    Protectedreactions

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

    Reactions to trigger.

    +

    StaticpathSeparator

    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

    _isRegistered

    Returns boolean

    _isRegistered

    Protected_linkToRuntimeObject

    Protected_linkToRuntimeObject

    Abstract_receiveRuntimeObject

    getContainer

    AbstractgetManager

    Abstract_receiveRuntimeObject

    getContainer

    AbstractgetManager

    AbstractisPresent

    StatickeyOfMatchingBank

    StatickeyOfMatchingEntry

    Returns TriggerManager

    AbstractisPresent

    StatickeyOfMatchingBank

    StatickeyOfMatchingEntry

    StatickeyOfMatchingMultiport

    StatickeyOfMatchingMultiport

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/WritableMultiPort.html b/classes/WritableMultiPort.html index 7319cc7d..dddcc527 100644 --- a/classes/WritableMultiPort.html +++ b/classes/WritableMultiPort.html @@ -1,4 +1,4 @@ -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 @@ -8,5 +8,5 @@ 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

    -

    AbstractgetPorts

    Abstractset

    • set(index, value): void

    • Parameters

      • index: number
      • value: T

      Returns void

    Abstractvalues

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

    • Returns (undefined | T)[]

    Abstractwidth

    • width(): number

    • Return the number of channels.

      -

      Returns number

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    +

    AbstractgetPorts

    Abstractset

    Abstractvalues

    Abstractwidth

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    diff --git a/classes/WritablePort.html b/classes/WritablePort.html index 21c965a6..fffb55b2 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

    Abstractget

    • get(): undefined | T

    • Returns undefined | T

    AbstractgetPort

    Abstractset

    • set(value): void

    • Parameters

      • value: T

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    +

    Constructors

    constructor

    Methods

    Abstractget

    • get(): undefined | T

    • Returns undefined | T

    AbstractgetPort

    Abstractset

    • set(value): void

    • Parameters

      • value: T

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    diff --git a/enums/CanConnectResult.html b/enums/CanConnectResult.html index d9f0cb69..687f65a5 100644 --- a/enums/CanConnectResult.html +++ b/enums/CanConnectResult.html @@ -1,4 +1,4 @@ -CanConnectResult | @lf-lang/reactor-ts

    Enumeration CanConnectResult

    Enumeration Members

    DESTINATION_OCCUPIED +CanConnectResult | @lf-lang/reactor-ts

    Enumeration CanConnectResult

    Enumeration Members

    DESTINATION_OCCUPIED DOWNSTREAM_WRITE_CONFLICT MUTATION_CAUSALITY_LOOP NOT_IN_SCOPE @@ -7,4 +7,4 @@ RT_DIRECT_FEED_THROUGH SELF_LOOP SUCCESS -

    Enumeration Members

    DESTINATION_OCCUPIED

    DESTINATION_OCCUPIED

    DOWNSTREAM_WRITE_CONFLICT

    DOWNSTREAM_WRITE_CONFLICT

    MUTATION_CAUSALITY_LOOP

    MUTATION_CAUSALITY_LOOP

    NOT_IN_SCOPE

    NOT_IN_SCOPE

    RT_CONNECTION_OUTSIDE_CONTAINER

    RT_CONNECTION_OUTSIDE_CONTAINER

    RT_CYCLE

    RT_CYCLE

    RT_DIRECT_FEED_THROUGH

    RT_DIRECT_FEED_THROUGH

    SELF_LOOP

    SELF_LOOP

    SUCCESS

    SUCCESS

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Enumeration Members

    DESTINATION_OCCUPIED

    DESTINATION_OCCUPIED

    DOWNSTREAM_WRITE_CONFLICT

    DOWNSTREAM_WRITE_CONFLICT

    MUTATION_CAUSALITY_LOOP

    MUTATION_CAUSALITY_LOOP

    NOT_IN_SCOPE

    NOT_IN_SCOPE

    RT_CONNECTION_OUTSIDE_CONTAINER

    RT_CONNECTION_OUTSIDE_CONTAINER

    RT_CYCLE

    RT_CYCLE

    RT_DIRECT_FEED_THROUGH

    RT_DIRECT_FEED_THROUGH

    SELF_LOOP

    SELF_LOOP

    SUCCESS

    SUCCESS

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/enums/Log.LogLevel.html b/enums/Log.LogLevel.html index c08e0ab9..c5e63a36 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

    ERROR

    ERROR

    FATAL

    FATAL

    INFO

    INFO

    WARN

    WARN

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Enumeration Members

    DEBUG

    DEBUG

    ERROR

    ERROR

    FATAL

    FATAL

    INFO

    INFO

    WARN

    WARN

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/enums/Origin.html b/enums/Origin.html index bccd87a4..fa845fbc 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

    physical

    physical

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Enumeration Members

    logical

    logical

    physical

    physical

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/enums/TimeUnit.html b/enums/TimeUnit.html index a4d69156..723305cc 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

    hour

    hour

    minute

    minute

    msec

    msec

    nsec

    nsec

    sec

    sec

    usec

    usec

    week

    week

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Enumeration Members

    day

    day

    hour

    hour

    minute

    minute

    msec

    msec

    nsec

    nsec

    sec

    sec

    usec

    usec

    week

    week

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/functions/Log.debug.html b/functions/Log.debug.html index 77c3b717..7500d13f 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

      • Optionalmodule: string

      Returns void

    Settings

    Member Visibility
    +debug | @lf-lang/reactor-ts

    Function debug

    • debug(obj, message, module?): void

    • Parameters

      • obj: unknown
      • message: (() => string)
          • (): string

          • Returns string

      • Optionalmodule: string

      Returns void

    Settings

    Member Visibility
    diff --git a/functions/Log.error.html b/functions/Log.error.html index bad1abd1..a7d9d787 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

      • Optionalmodule: string

      Returns void

    Settings

    Member Visibility
    +error | @lf-lang/reactor-ts

    Function error

    • error(obj, message, module?): void

    • Parameters

      • obj: unknown
      • message: (() => string)
          • (): string

          • Returns string

      • Optionalmodule: string

      Returns void

    Settings

    Member Visibility
    diff --git a/functions/Log.fatal.html b/functions/Log.fatal.html index 39ec411b..ea89bd57 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

      • Optionalmodule: string

      Returns void

    Settings

    Member Visibility
    +fatal | @lf-lang/reactor-ts

    Function fatal

    • fatal(obj, message, module?): void

    • Parameters

      • obj: unknown
      • message: (() => string)
          • (): string

          • Returns string

      • Optionalmodule: string

      Returns void

    Settings

    Member Visibility
    diff --git a/functions/Log.getInstance.html b/functions/Log.getInstance.html index 0b6017a9..55b93e00 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
    +

    Returns Logger

    Settings

    Member Visibility
    diff --git a/functions/Log.info.html b/functions/Log.info.html index 3c205be4..69484094 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

      • Optionalmodule: string

      Returns void

    Settings

    Member Visibility
    +info | @lf-lang/reactor-ts

    Function info

    • info(obj, message, module?): void

    • Parameters

      • obj: unknown
      • message: (() => string)
          • (): string

          • Returns string

      • Optionalmodule: string

      Returns void

    Settings

    Member Visibility
    diff --git a/functions/Log.log.html b/functions/Log.log.html index b32a621b..26d36e06 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

      • Optionalmodule: string

      Returns void

    Settings

    Member Visibility
    +log | @lf-lang/reactor-ts

    Function log

    • log(obj, message, module?): void

    • Parameters

      • obj: unknown
      • message: (() => string)
          • (): string

          • Returns string

      • Optionalmodule: string

      Returns void

    Settings

    Member Visibility
    diff --git a/functions/Log.setLevel.html b/functions/Log.setLevel.html index 8d715da1..a7893e34 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
      • Optionalmodule: string

      Returns void

    Settings

    Member Visibility
    +setLevel | @lf-lang/reactor-ts

    Function setLevel

    • setLevel(severity, module?): void

    • Parameters

      • severity: LogLevel
      • Optionalmodule: string

      Returns void

    Settings

    Member Visibility
    diff --git a/functions/Log.warn.html b/functions/Log.warn.html index a7c7f4e5..77bbb2c9 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

      • Optionalmodule: string

      Returns void

    Settings

    Member Visibility
    +warn | @lf-lang/reactor-ts

    Function warn

    • warn(obj, message, module?): void

    • Parameters

      • obj: unknown
      • message: (() => string)
          • (): string

          • Returns string

      • Optionalmodule: string

      Returns void

    Settings

    Member Visibility
    diff --git a/functions/booleanCLAType.html b/functions/booleanCLAType.html index a18e79ef..1343f5d3 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
    +

    Parameters

    Returns boolean | null

    Settings

    Member Visibility
    diff --git a/functions/dontIndent.html b/functions/dontIndent.html index a696606f..ce7bce35 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
    +

    Settings

    Member Visibility
    diff --git a/functions/getCurrentPhysicalTime.html b/functions/getCurrentPhysicalTime.html index c2c84dd0..866d4bec 100644 --- a/functions/getCurrentPhysicalTime.html +++ b/functions/getCurrentPhysicalTime.html @@ -1,3 +1,3 @@ getCurrentPhysicalTime | @lf-lang/reactor-ts

    Function getCurrentPhysicalTime

    • getCurrentPhysicalTime(): TimeValue

    • Return a time value that reflects the current physical time as reported by the platform.

      -

      Returns TimeValue

    Settings

    Member Visibility
    +

    Returns TimeValue

    Settings

    Member Visibility
    diff --git a/functions/loggingCLAType.html b/functions/loggingCLAType.html index 384fa4ab..e2722bef 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
    +

    Returns LogLevel | null

    Settings

    Member Visibility
    diff --git a/functions/stringCLAType.html b/functions/stringCLAType.html index 6acc504b..8e6c4e11 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
    +

    Parameters

    Returns string

    Settings

    Member Visibility
    diff --git a/functions/unitBasedTimeValueCLAType.html b/functions/unitBasedTimeValueCLAType.html index fad604f4..a280bc8d 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
    +

    Parameters

    Returns TimeValue | null

    Settings

    Member Visibility
    diff --git a/interfaces/Call.html b/interfaces/Call.html index b7fd5862..b3518eef 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: A) => undefined | R);
        set: ((value: A) => void);
    }

    Type Parameters

    • A
    • R

    Hierarchy (view full)

    Properties

    get +
    interface Call<A, R> {
        get: (() => undefined | R);
        invoke: ((args: A) => undefined | R);
        set: ((value: A) => void);
    }

    Type Parameters

    • A
    • R

    Hierarchy (view full)

    Properties

    get invoke set -

    Properties

    get

    get: (() => undefined | R)

    invoke

    invoke: ((args: A) => undefined | R)

    set

    set: ((value: A) => void)

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    get

    get: (() => undefined | R)

    invoke

    invoke: ((args: A) => undefined | R)

    set

    set: ((value: A) => void)

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/FederateConfig.html b/interfaces/FederateConfig.html index 12c5b1a6..7fb9b2b9 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[]

    OptionalexecutionTimeout

    executionTimeout?: TimeValue

    fast

    fast: boolean

    federateID

    federateID: number

    federationID

    federationID: string

    OptionalkeepAlive

    keepAlive?: boolean

    OptionalminOutputDelay

    minOutputDelay?: TimeValue

    networkMessageActions

    networkMessageActions: string[]

    rtiHost

    rtiHost: string

    rtiPort

    rtiPort: number

    sendsTo

    sendsTo: number[]

    upstreamConnectionDelays

    upstreamConnectionDelays: TimeValue[][]

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    dependsOn

    dependsOn: number[]

    OptionalexecutionTimeout

    executionTimeout?: TimeValue

    fast

    fast: boolean

    federateID

    federateID: number

    federationID

    federationID: string

    OptionalkeepAlive

    keepAlive?: boolean

    OptionalminOutputDelay

    minOutputDelay?: TimeValue

    networkMessageActions

    networkMessageActions: string[]

    rtiHost

    rtiHost: string

    rtiPort

    rtiPort: number

    sendsTo

    sendsTo: number[]

    upstreamConnectionDelays

    upstreamConnectionDelays: TimeValue[][]

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/MultiRead.html b/interfaces/MultiRead.html index 6f77e5d5..6f65ad0a 100644 --- a/interfaces/MultiRead.html +++ b/interfaces/MultiRead.html @@ -1,8 +1,8 @@ -MultiRead | @lf-lang/reactor-ts

    Interface MultiRead<T>

    interface MultiRead<T> {
        get: ((index: number) => undefined | T);
        width: (() => number);
    }

    Type Parameters

    • T

    Implemented by

    Properties

    get +MultiRead | @lf-lang/reactor-ts

    Interface MultiRead<T>

    interface MultiRead<T> {
        get: ((index: number) => undefined | T);
        width: (() => number);
    }

    Type Parameters

    • T

    Implemented by

    Properties

    get width

    Properties

    get

    get: ((index: number) => undefined | T)

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

    Type declaration

      • (index): undefined | T

      • Parameters

        • index: number

          the index that identifies the channel to return the value of

        Returns undefined | T

        the value that corresponds to the identified channel

        -

    width

    width: (() => number)

    Return the number of channels.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    width

    width: (() => number)

    Return the number of channels.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/MultiWrite.html b/interfaces/MultiWrite.html index 01939534..1838a01b 100644 --- a/interfaces/MultiWrite.html +++ b/interfaces/MultiWrite.html @@ -1,5 +1,5 @@ -MultiWrite | @lf-lang/reactor-ts

    Interface MultiWrite<T>

    interface MultiWrite<T> {
        set: ((index: number, value: T) => void);
        values: (() => (undefined | T)[]);
        width: (() => number);
    }

    Type Parameters

    • T

    Properties

    set +MultiWrite | @lf-lang/reactor-ts

    Interface MultiWrite<T>

    interface MultiWrite<T> {
        set: ((index: number, value: T) => void);
        values: (() => (undefined | T)[]);
        width: (() => number);
    }

    Type Parameters

    • T

    Properties

    set values width -

    Properties

    set

    set: ((index: number, value: T) => void)

    values

    values: (() => (undefined | T)[])

    width

    width: (() => number)

    Return the number of channels.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    set

    set: ((index: number, value: T) => void)

    values

    values: (() => (undefined | T)[])

    width

    width: (() => number)

    Return the number of channels.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/MutationSandbox.html b/interfaces/MutationSandbox.html index 8915ef9b..8319c6bc 100644 --- a/interfaces/MutationSandbox.html +++ b/interfaces/MutationSandbox.html @@ -1,8 +1,8 @@ -MutationSandbox | @lf-lang/reactor-ts

    Interface MutationSandbox

    interface MutationSandbox {
        connect: {
            <R, S>(src: ConnectablePort<S>, dst: ConnectablePort<R>): void;
            <A, R, T, S>(src: CallerPort<A, R>, dst: CalleePort<T, S>): void;
        };
        delete: ((reactor: Reactor) => void);
        disconnect: (<R, S>(src: IOPort<S>, dst?: IOPort<R>) => void);
        getBankIndex: (() => number);
        getReactor: (() => Reactor);
        util: UtilityFunctions;
    }

    Hierarchy (view full)

    Properties

    connect +MutationSandbox | @lf-lang/reactor-ts

    Interface MutationSandbox

    interface MutationSandbox {
        connect: {
            <R, S>(src: ConnectablePort<S>, dst: ConnectablePort<R>): void;
            <A, R, T, S>(src: CallerPort<A, R>, dst: CalleePort<T, S>): void;
        };
        delete: ((reactor: Reactor) => void);
        disconnect: (<R, S>(src: IOPort<S>, dst?: IOPort<R>) => void);
        getBankIndex: (() => number);
        getReactor: (() => Reactor);
        util: UtilityFunctions;
    }

    Hierarchy (view full)

    Properties

    connect delete disconnect getBankIndex getReactor util -

    Properties

    connect

    connect: {
        <R, S>(src: ConnectablePort<S>, dst: ConnectablePort<R>): void;
        <A, R, T, S>(src: CallerPort<A, R>, dst: CalleePort<T, S>): void;
    }

    delete

    delete: ((reactor: Reactor) => void)

    disconnect

    disconnect: (<R, S>(src: IOPort<S>, dst?: IOPort<R>) => void)

    getBankIndex

    getBankIndex: (() => number)

    getReactor

    getReactor: (() => Reactor)

    util

    util: UtilityFunctions

    Collection of utility functions accessible from within a react function.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    connect

    connect: {
        <R, S>(src: ConnectablePort<S>, dst: ConnectablePort<R>): void;
        <A, R, T, S>(src: CallerPort<A, R>, dst: CalleePort<T, S>): void;
    }

    delete

    delete: ((reactor: Reactor) => void)

    disconnect

    disconnect: (<R, S>(src: IOPort<S>, dst?: IOPort<R>) => void)

    getBankIndex

    getBankIndex: (() => number)

    getReactor

    getReactor: (() => Reactor)

    util

    util: UtilityFunctions

    Collection of utility functions accessible from within a react function.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/PrioritySetElement.html b/interfaces/PrioritySetElement.html index 8357aa10..6751a1a9 100644 --- a/interfaces/PrioritySetElement.html +++ b/interfaces/PrioritySetElement.html @@ -1,13 +1,13 @@ 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: PrioritySetElement<P>) => boolean);
        next: undefined | PrioritySetElement<P>;
        updateIfDuplicateOf: ((node: undefined | PrioritySetElement<P>) => boolean);
    }

    Type Parameters

    • P

    Implemented by

    Properties

    getPriority +
    interface PrioritySetElement<P> {
        getPriority: (() => P);
        hasPriorityOver: ((node: PrioritySetElement<P>) => boolean);
        next: undefined | PrioritySetElement<P>;
        updateIfDuplicateOf: ((node: undefined | PrioritySetElement<P>) => boolean);
    }

    Type Parameters

    • P

    Implemented by

    Properties

    getPriority hasPriorityOver next updateIfDuplicateOf

    Properties

    getPriority

    getPriority: (() => P)

    Return the priority of this node.

    -

    hasPriorityOver

    hasPriorityOver: ((node: PrioritySetElement<P>) => boolean)

    Return true if this node has priority over the given node, false otherwise.

    +

    hasPriorityOver

    hasPriorityOver: ((node: PrioritySetElement<P>) => boolean)

    Return true if this node has priority over the given node, false otherwise.

    Type declaration

      • (node): boolean

      • Parameters

        Returns boolean

    next

    next: undefined | PrioritySetElement<P>

    Pointer to the next node in the priority set.

    -

    updateIfDuplicateOf

    updateIfDuplicateOf: ((node: undefined | PrioritySetElement<P>) => boolean)

    If the given node is considered a duplicate of this node, then +

    Returns boolean

    next

    next: undefined | PrioritySetElement<P>

    Pointer to the next node in the priority set.

    +

    updateIfDuplicateOf

    updateIfDuplicateOf: ((node: undefined | PrioritySetElement<P>) => 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

      • Parameters

        • node: undefined | PrioritySetElement<P>

          A node that may or may not be a duplicate of this node.

          -

        Returns boolean

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Returns boolean

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/ProcessedCommandLineArgs.html b/interfaces/ProcessedCommandLineArgs.html index 18be74ed..5c9e5ef7 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

    On This Page

    Properties
    +

    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

    On This Page

    Properties
    diff --git a/interfaces/ReactionSandbox.html b/interfaces/ReactionSandbox.html index e4d539ed..72ae0a02 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)

    util

    util: UtilityFunctions

    Collection of utility functions accessible from within a react function.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    getBankIndex

    getBankIndex: (() => number)

    util

    util: UtilityFunctions

    Collection of utility functions accessible from within a react function.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/Read.html b/interfaces/Read.html index 6529debf..b50b073d 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)

    Settings

    Member Visibility

    On This Page

    Properties
    +
    interface Read<T> {
        get: (() => undefined | T);
    }

    Type Parameters

    Hierarchy (view full)

    Implemented by

    Properties

    get +

    Properties

    get

    get: (() => undefined | T)

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/Runtime.html b/interfaces/Runtime.html index 4898bd55..346eda35 100644 --- a/interfaces/Runtime.html +++ b/interfaces/Runtime.html @@ -1,7 +1,7 @@ -Runtime | @lf-lang/reactor-ts

    Interface Runtime

    interface Runtime {
        delete: ((r: Reactor) => void);
        initialize: ((timer: Timer) => void);
        isRunning: (() => boolean);
        schedule: ((e: TaggedEvent<unknown>) => void);
        stage: ((reaction: Reaction<Variable[]>) => void);
        util: UtilityFunctions;
    }

    Properties

    delete +Runtime | @lf-lang/reactor-ts

    Interface Runtime

    interface Runtime {
        delete: ((r: Reactor) => void);
        initialize: ((timer: Timer) => void);
        isRunning: (() => boolean);
        schedule: ((e: TaggedEvent<unknown>) => void);
        stage: ((reaction: Reaction<Variable[]>) => void);
        util: UtilityFunctions;
    }

    Properties

    delete initialize isRunning schedule stage util -

    Properties

    delete

    delete: ((r: Reactor) => void)

    initialize

    initialize: ((timer: Timer) => void)

    isRunning

    isRunning: (() => boolean)

    schedule

    schedule: ((e: TaggedEvent<unknown>) => void)

    stage

    stage: ((reaction: Reaction<Variable[]>) => void)

    util

    util: UtilityFunctions

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    delete

    delete: ((r: Reactor) => void)

    initialize

    initialize: ((timer: Timer) => void)

    isRunning

    isRunning: (() => boolean)

    schedule

    schedule: ((e: TaggedEvent<unknown>) => void)

    stage

    stage: ((reaction: Reaction<Variable[]>) => void)

    util

    util: UtilityFunctions

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/Sched.html b/interfaces/Sched.html index 0954c6a0..f1dfa8d5 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: 0 | TimeValue, value: T, intendedTag?: Tag) => void);
    }

    Type Parameters

    • T

    Hierarchy (view full)

    Implemented by

    Properties

    get +
    interface Sched<T> {
        get: (() => undefined | T);
        schedule: ((extraDelay: 0 | TimeValue, value: T, intendedTag?: Tag) => void);
    }

    Type Parameters

    • T

    Hierarchy (view full)

    Implemented by

    Properties

    get schedule -

    Properties

    get

    get: (() => undefined | T)

    schedule

    schedule: ((extraDelay: 0 | TimeValue, value: T, intendedTag?: Tag) => void)

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    get

    get: (() => undefined | T)

    schedule

    schedule: ((extraDelay: 0 | TimeValue, value: T, intendedTag?: Tag) => void)

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/Sortable.html b/interfaces/Sortable.html index 25c1684e..249a9fa6 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: P) => void);
    }

    Type Parameters

    • P

    Implemented by

    Properties

    setPriority -

    Properties

    setPriority

    setPriority: ((priority: P) => void)

    Settings

    Member Visibility

    On This Page

    Properties
    +Sortable | @lf-lang/reactor-ts

    Interface Sortable<P>

    interface Sortable<P> {
        setPriority: ((priority: P) => void);
    }

    Type Parameters

    • P

    Implemented by

    Properties

    setPriority +

    Properties

    setPriority

    setPriority: ((priority: P) => void)

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/TriggerManager.html b/interfaces/TriggerManager.html index 36dbe6e3..d175c5a1 100644 --- a/interfaces/TriggerManager.html +++ b/interfaces/TriggerManager.html @@ -1,4 +1,4 @@ -TriggerManager | @lf-lang/reactor-ts

    Interface TriggerManager

    interface TriggerManager {
        addReaction: ((reaction: Reaction<Variable[]>) => void);
        delReaction: ((reaction: Reaction<Variable[]>) => void);
        getContainer: (() => Reactor);
    }

    Properties

    addReaction +TriggerManager | @lf-lang/reactor-ts

    Interface TriggerManager

    interface TriggerManager {
        addReaction: ((reaction: Reaction<Variable[]>) => void);
        delReaction: ((reaction: Reaction<Variable[]>) => void);
        getContainer: (() => Reactor);
    }

    Properties

    addReaction delReaction getContainer -

    Properties

    addReaction

    addReaction: ((reaction: Reaction<Variable[]>) => void)

    delReaction

    delReaction: ((reaction: Reaction<Variable[]>) => void)

    getContainer

    getContainer: (() => Reactor)

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    addReaction

    addReaction: ((reaction: Reaction<Variable[]>) => void)

    delReaction

    delReaction: ((reaction: Reaction<Variable[]>) => void)

    getContainer

    getContainer: (() => Reactor)

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/Write.html b/interfaces/Write.html index c575167b..809397ba 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: T) => void);
    }

    Type Parameters

    • T

    Hierarchy (view full)

    Implemented by

    Properties

    set -

    Properties

    set

    set: ((value: T) => void)

    Settings

    Member Visibility

    On This Page

    Properties
    +
    interface Write<T> {
        set: ((value: T) => void);
    }

    Type Parameters

    Hierarchy (view full)

    Implemented by

    Properties

    set +

    Properties

    set

    set: ((value: T) => void)

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/modules/Log.html b/modules/Log.html index 4b3c52e7..53359a33 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 15abc42a..db74489d 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
    +

    Settings

    Member Visibility
    diff --git a/types/ArgList.html b/types/ArgList.html index 288ef55b..753ea22f 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
    +

    Settings

    Member Visibility
    diff --git a/types/CommandLineOptionSpec.html b/types/CommandLineOptionSpec.html index ae49c0ae..2b8dcec0 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: string) => unknown);
        typeLabel?: string;
    }[]

    Settings

    Member Visibility
    +CommandLineOptionSpec | @lf-lang/reactor-ts

    Type Alias CommandLineOptionSpec

    CommandLineOptionSpec: {
        alias?: string;
        description: string;
        name: string;
        type: ((arg0: string) => unknown);
        typeLabel?: string;
    }[]

    Settings

    Member Visibility
    diff --git a/types/MultiReadWrite.html b/types/MultiReadWrite.html index 9dc83a7d..761e4658 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
    +MultiReadWrite | @lf-lang/reactor-ts

    Type Alias MultiReadWrite<T>

    MultiReadWrite<T>: MultiRead<T> & MultiWrite<T>

    Type Parameters

    • T

    Settings

    Member Visibility
    diff --git a/types/ParmList.html b/types/ParmList.html index d31ea9b0..c80138a6 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
    +

    Type Parameters

    Settings

    Member Visibility
    diff --git a/types/Priority.html b/types/Priority.html index 9b9dfd84..cd8776eb 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
    +

    Settings

    Member Visibility
    diff --git a/types/ReactorClass.html b/types/ReactorClass.html index 2d0b0672..5032d85c 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: ParmList<S>) => T)

    Type that describes a class with a constructor of which the arguments are of type ReactorArgs.

    -

    Type Parameters

    Settings

    Member Visibility
    +

    Type Parameters

    Settings

    Member Visibility
    diff --git a/types/ReadWrite.html b/types/ReadWrite.html index d2aeb9e6..e63e0aa8 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
    +

    Type Parameters

    Settings

    Member Visibility
    diff --git a/types/Variable.html b/types/Variable.html index 156f8cae..f79ea6e8 100644 --- a/types/Variable.html +++ b/types/Variable.html @@ -5,4 +5,4 @@
  • Write
  • Sched
    • -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/variables/BUFFER_SIZE.html b/variables/BUFFER_SIZE.html index fd004bb0..6f3409a3 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

    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
    +

    Settings

    Member Visibility
    diff --git a/variables/CONNECT_NUM_RETRIES.html b/variables/CONNECT_NUM_RETRIES.html index c04f992d..ad00c541 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
    +

    Settings

    Member Visibility
    diff --git a/variables/CONNECT_RETRY_INTERVAL.html b/variables/CONNECT_RETRY_INTERVAL.html index 5b2d0add..c181ec1b 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
    +

    Settings

    Member Visibility
    diff --git a/variables/CommandLineOptionDefs.html b/variables/CommandLineOptionDefs.html index 7ac7b5b4..eaade85c 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
    +

    Settings

    Member Visibility
    diff --git a/variables/CommandLineUsageDefs.html b/variables/CommandLineUsageDefs.html index 32f3f968..422e4444 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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/variables/Log.globalLogger.html b/variables/Log.globalLogger.html index ea7b5cee..4c1523b9 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, boolean> = ...

    Global instance of ulog that performs the logging.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/variables/Log.hr.html b/variables/Log.hr.html index 5ee93b0b..1cf75d37 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
    +

    Settings

    Member Visibility