From b31e86e8a3f8bba598923ebd498ad4c52f1c765a Mon Sep 17 00:00:00 2001 From: trevorhardy Date: Fri, 7 Jun 2024 18:40:08 +0000 Subject: [PATCH] deploy: 4290dff29fcc8c849a4557dde8622ab6fb33b980 --- .nojekyll | 0 404.html | 452 ++ CNAME | 1 + api/bin-py/index.html | 565 ++ api/capi-py/index.html | 7149 +++++++++++++++++ api/cli-py/index.html | 559 ++ api/database-py/index.html | 759 ++ api/flaskr/index.html | 1256 +++ api/index.html | 558 ++ api/observer-py/index.html | 551 ++ api/profile-py/index.html | 526 ++ api/status_checker-py/index.html | 594 ++ api/utils-py/index.html | 552 ++ api/vcredist-py/index.html | 562 ++ assets/images/favicon.png | Bin 0 -> 1870 bytes assets/javascripts/bundle.ad660dcc.min.js | 29 + assets/javascripts/bundle.ad660dcc.min.js.map | 7 + assets/javascripts/lunr/min/lunr.ar.min.js | 1 + assets/javascripts/lunr/min/lunr.da.min.js | 18 + assets/javascripts/lunr/min/lunr.de.min.js | 18 + assets/javascripts/lunr/min/lunr.du.min.js | 18 + assets/javascripts/lunr/min/lunr.el.min.js | 1 + assets/javascripts/lunr/min/lunr.es.min.js | 18 + assets/javascripts/lunr/min/lunr.fi.min.js | 18 + assets/javascripts/lunr/min/lunr.fr.min.js | 18 + assets/javascripts/lunr/min/lunr.he.min.js | 1 + assets/javascripts/lunr/min/lunr.hi.min.js | 1 + assets/javascripts/lunr/min/lunr.hu.min.js | 18 + assets/javascripts/lunr/min/lunr.hy.min.js | 1 + assets/javascripts/lunr/min/lunr.it.min.js | 18 + assets/javascripts/lunr/min/lunr.ja.min.js | 1 + assets/javascripts/lunr/min/lunr.jp.min.js | 1 + assets/javascripts/lunr/min/lunr.kn.min.js | 1 + assets/javascripts/lunr/min/lunr.ko.min.js | 1 + assets/javascripts/lunr/min/lunr.multi.min.js | 1 + assets/javascripts/lunr/min/lunr.nl.min.js | 18 + assets/javascripts/lunr/min/lunr.no.min.js | 18 + assets/javascripts/lunr/min/lunr.pt.min.js | 18 + assets/javascripts/lunr/min/lunr.ro.min.js | 18 + assets/javascripts/lunr/min/lunr.ru.min.js | 18 + assets/javascripts/lunr/min/lunr.sa.min.js | 1 + .../lunr/min/lunr.stemmer.support.min.js | 1 + assets/javascripts/lunr/min/lunr.sv.min.js | 18 + assets/javascripts/lunr/min/lunr.ta.min.js | 1 + assets/javascripts/lunr/min/lunr.te.min.js | 1 + assets/javascripts/lunr/min/lunr.th.min.js | 1 + assets/javascripts/lunr/min/lunr.tr.min.js | 18 + assets/javascripts/lunr/min/lunr.vi.min.js | 1 + assets/javascripts/lunr/min/lunr.zh.min.js | 1 + assets/javascripts/lunr/tinyseg.js | 206 + assets/javascripts/lunr/wordcut.js | 6708 ++++++++++++++++ .../workers/search.b8dbb3d2.min.js | 42 + .../workers/search.b8dbb3d2.min.js.map | 7 + assets/stylesheets/main.6543a935.min.css | 1 + assets/stylesheets/main.6543a935.min.css.map | 1 + assets/stylesheets/palette.06af60db.min.css | 1 + .../stylesheets/palette.06af60db.min.css.map | 1 + callbacks/index.html | 736 ++ cli-interface/index.html | 617 ++ examples/10-federates-1-topic/pireceiver.py | 45 + examples/10-federates-1-topic/pisender.py | 56 + examples/10-federates-1-topic/runner.json | 77 + examples/2-federates-1-topic/index.html | 509 ++ examples/2-federates-1-topic/old-pisender.py | 53 + examples/2-federates-1-topic/pireceiver.py | 45 + examples/2-federates-1-topic/pisender.py | 55 + examples/2-federates-1-topic/runner.json | 30 + examples/2-federates-3-topics/index.html | 509 ++ examples/2-federates-3-topics/pireceiver.py | 50 + examples/2-federates-3-topics/pisender.py | 61 + examples/2-federates-3-topics/profile.txt | 76 + examples/2-federates-3-topics/runner.json | 30 + examples/20-federates-10-topics/index.html | 497 ++ examples/20-federates-10-topics/pireceiver.py | 43 + examples/20-federates-10-topics/pisender.py | 59 + examples/20-federates-10-topics/profile.txt | 480 ++ examples/20-federates-10-topics/runner.json | 132 + index.html | 521 ++ installation/index.html | 827 ++ interface/index.html | 469 ++ migration-helics2-helics3/index.html | 703 ++ pythonic-interface/index.html | 539 ++ search/search_index.json | 1 + sitemap.xml | 3 + sitemap.xml.gz | Bin 0 -> 127 bytes usage/index.html | 561 ++ web-interface/index.html | 497 ++ 87 files changed, 29655 insertions(+) create mode 100644 .nojekyll create mode 100644 404.html create mode 100644 CNAME create mode 100644 api/bin-py/index.html create mode 100644 api/capi-py/index.html create mode 100644 api/cli-py/index.html create mode 100644 api/database-py/index.html create mode 100644 api/flaskr/index.html create mode 100644 api/index.html create mode 100644 api/observer-py/index.html create mode 100644 api/profile-py/index.html create mode 100644 api/status_checker-py/index.html create mode 100644 api/utils-py/index.html create mode 100644 api/vcredist-py/index.html create mode 100644 assets/images/favicon.png create mode 100644 assets/javascripts/bundle.ad660dcc.min.js create mode 100644 assets/javascripts/bundle.ad660dcc.min.js.map create mode 100644 assets/javascripts/lunr/min/lunr.ar.min.js create mode 100644 assets/javascripts/lunr/min/lunr.da.min.js create mode 100644 assets/javascripts/lunr/min/lunr.de.min.js create mode 100644 assets/javascripts/lunr/min/lunr.du.min.js create mode 100644 assets/javascripts/lunr/min/lunr.el.min.js create mode 100644 assets/javascripts/lunr/min/lunr.es.min.js create mode 100644 assets/javascripts/lunr/min/lunr.fi.min.js create mode 100644 assets/javascripts/lunr/min/lunr.fr.min.js create mode 100644 assets/javascripts/lunr/min/lunr.he.min.js create mode 100644 assets/javascripts/lunr/min/lunr.hi.min.js create mode 100644 assets/javascripts/lunr/min/lunr.hu.min.js create mode 100644 assets/javascripts/lunr/min/lunr.hy.min.js create mode 100644 assets/javascripts/lunr/min/lunr.it.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ja.min.js create mode 100644 assets/javascripts/lunr/min/lunr.jp.min.js create mode 100644 assets/javascripts/lunr/min/lunr.kn.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ko.min.js create mode 100644 assets/javascripts/lunr/min/lunr.multi.min.js create mode 100644 assets/javascripts/lunr/min/lunr.nl.min.js create mode 100644 assets/javascripts/lunr/min/lunr.no.min.js create mode 100644 assets/javascripts/lunr/min/lunr.pt.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ro.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ru.min.js create mode 100644 assets/javascripts/lunr/min/lunr.sa.min.js create mode 100644 assets/javascripts/lunr/min/lunr.stemmer.support.min.js create mode 100644 assets/javascripts/lunr/min/lunr.sv.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ta.min.js create mode 100644 assets/javascripts/lunr/min/lunr.te.min.js create mode 100644 assets/javascripts/lunr/min/lunr.th.min.js create mode 100644 assets/javascripts/lunr/min/lunr.tr.min.js create mode 100644 assets/javascripts/lunr/min/lunr.vi.min.js create mode 100644 assets/javascripts/lunr/min/lunr.zh.min.js create mode 100644 assets/javascripts/lunr/tinyseg.js create mode 100644 assets/javascripts/lunr/wordcut.js create mode 100644 assets/javascripts/workers/search.b8dbb3d2.min.js create mode 100644 assets/javascripts/workers/search.b8dbb3d2.min.js.map create mode 100644 assets/stylesheets/main.6543a935.min.css create mode 100644 assets/stylesheets/main.6543a935.min.css.map create mode 100644 assets/stylesheets/palette.06af60db.min.css create mode 100644 assets/stylesheets/palette.06af60db.min.css.map create mode 100644 callbacks/index.html create mode 100644 cli-interface/index.html create mode 100644 examples/10-federates-1-topic/pireceiver.py create mode 100644 examples/10-federates-1-topic/pisender.py create mode 100644 examples/10-federates-1-topic/runner.json create mode 100644 examples/2-federates-1-topic/index.html create mode 100644 examples/2-federates-1-topic/old-pisender.py create mode 100644 examples/2-federates-1-topic/pireceiver.py create mode 100644 examples/2-federates-1-topic/pisender.py create mode 100644 examples/2-federates-1-topic/runner.json create mode 100644 examples/2-federates-3-topics/index.html create mode 100644 examples/2-federates-3-topics/pireceiver.py create mode 100644 examples/2-federates-3-topics/pisender.py create mode 100644 examples/2-federates-3-topics/profile.txt create mode 100644 examples/2-federates-3-topics/runner.json create mode 100644 examples/20-federates-10-topics/index.html create mode 100644 examples/20-federates-10-topics/pireceiver.py create mode 100644 examples/20-federates-10-topics/pisender.py create mode 100644 examples/20-federates-10-topics/profile.txt create mode 100644 examples/20-federates-10-topics/runner.json create mode 100644 index.html create mode 100644 installation/index.html create mode 100644 interface/index.html create mode 100644 migration-helics2-helics3/index.html create mode 100644 pythonic-interface/index.html create mode 100644 search/search_index.json create mode 100644 sitemap.xml create mode 100644 sitemap.xml.gz create mode 100644 usage/index.html create mode 100644 web-interface/index.html diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 00000000..e69de29b diff --git a/404.html b/404.html new file mode 100644 index 00000000..8f16894e --- /dev/null +++ b/404.html @@ -0,0 +1,452 @@ + + + + + + + + + + + + + + + + + + + PyHELICS + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ +

404 - Not found

+ +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/CNAME b/CNAME new file mode 100644 index 00000000..9ed16e5a --- /dev/null +++ b/CNAME @@ -0,0 +1 @@ +python.helics.org diff --git a/api/bin-py/index.html b/api/bin-py/index.html new file mode 100644 index 00000000..94c39749 --- /dev/null +++ b/api/bin-py/index.html @@ -0,0 +1,565 @@ + + + + + + + + + + + + + + + + + + + helics.bin - PyHELICS + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + +

Module helics.bin

+

Functions

+

helics_app

+
def helics_app()
+
+
+

helics_broker

+
def helics_broker()
+
+
+

helics_broker_server

+
def helics_broker_server()
+
+
+

helics_player

+
def helics_player()
+
+
+

helics_recorder

+
def helics_recorder()
+
+ + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/capi-py/index.html b/api/capi-py/index.html new file mode 100644 index 00000000..f9f80d73 --- /dev/null +++ b/api/capi-py/index.html @@ -0,0 +1,7149 @@ + + + + + + + + + + + + + + + + + + + helics.capi - PyHELICS + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + +

Module helics.capi

+

Classes

+

HelicsBroker

+
class HelicsBroker(handle, cleanup=True)
+
+
+

Base classes

+
    +
  • helics.capi._HelicsCHandle
    • +
+
+

Instance attributes

+
    +
  • +

    address Get the connection address for the broker.

    +
    • +
  • +

    identifier Get the local identification for the broker.

    +
    • +
  • +

    name Get the local identification for the broker.

    +
    • +
+
+

Methods

+

add_alias

+
def add_alias(self, interface_name: str, alias: str)
+
+

Create an alias for an interface.

+

Parameters

+
    +
  • interfaceName: The current name of an interface.
    • +
  • alias: The additional name to use for the given interface.
    • +
+
+

add_destination_filter_to_endpoint

+
def add_destination_filter_to_endpoint(self, filter: str, target: str)
+
+

Create a filter connection between a named filter and a named endpoint for destination processing.

+

Parameters

+
    +
  • filter: the name of the filter.
    • +
  • target: the name of the source target.
    • +
+
+

add_source_filter_to_endpoint

+
def add_source_filter_to_endpoint(self, filter: str, target: str)
+
+

Create a filter connection between a named filter and a named endpoint for messages coming from that endpoint.

+

Parameters

+

filter: the name of the filter. +target: the name of the source target.

+
+

data_link

+
def data_link(self, source: str, target: str)
+
+

Create a data link between a named publication and a named input.

+

Parameters

+
    +
  • source: the name of the publication.
    • +
  • target: the name of the input.
    • +
+
+

disconnect

+
def disconnect(self)
+
+

Disconnect the broker from any other brokers and communications.

+
+

global_error

+
def global_error(self, error_code: int, error_string: str)
+
+

Generate a global error to terminate the federation.

+

Parameters

+
    +
  • error_code: an error code to give to the error.
    • +
  • error_string: a string message associated with the error.
    • +
+
+

is_connected

+
def is_connected(self)
+
+

Check if the broker is connected.

+
+

query

+
def query(self, target: str, query: str, mode: HelicsSequencingMode = HelicsSequencingMode.FAST) -> JSONType
+
+

Make a query of the broker.

+

This call is blocking until the value is returned which may take some time depending on the size of the federation and the specific string being queried.

+

Parameters

+
    +
  • target: the target of the query can be “federation”, “federate”, “broker”, “core”, or a specific name of a federate, core, or broker.
    • +
  • query: a string with the query, see other documentation for specific properties to query, can be defined by the federate.
    • +
+

Returns: a string with the value requested. This is either going to be a vector of strings value or a JSON string stored in the first element of the vector. The string “#invalid” is returned if the query was not valid.

+
+

set_global

+
def set_global(self, name: str, value: str)
+
+

Set a federation global value.

+

This overwrites any previous value for this name. globals can be queried with a target of “global” and query of the value to Query.

+

Parameters

+
    +
  • name: the name of the global to set.
    • +
  • value: the value of the global.
    • +
+
+

wait_for_disconnect

+
def wait_for_disconnect(self, ms_to_wait: int = -1)
+
+

Waits in the current thread until the broker is disconnected.

+

Parameters

+
    +
  • ms_to_wait: the timeout to wait for disconnect (-1) implies no timeout
    • +
+

Returns: True if the disconnect was successful false if it timed out

+
+

HelicsCallbackFederate

+
class HelicsCallbackFederate(handle)
+
+
+

Base classes

+ +
+

Instance attributes

+
    +
  • +

    core

    +
    • +
  • +

    current_time

    +
    • +
  • +

    n_endpoints

    +
    • +
  • +

    n_filters

    +
    • +
  • +

    n_inputs

    +
    • +
  • +

    n_pending_messages Returns the number of pending receives for all endpoints.

    +
    • +
  • +

    n_publications Get the number of publications in this federate.

    +
    • +
  • +

    n_subscriptions Get the number of inputs in this federate.

    +
    • +
  • +

    name

    +
    • +
  • +

    separator

    +
    • +
  • +

    state

    +
    • +
+
+

HelicsCloningFilter

+
class HelicsCloningFilter(handle, cleanup=True)
+
+
+

Base classes

+ +
+

Instance attributes

+
    +
  • +

    info Get the interface information field of the filter.

    +
    • +
  • +

    name Get the name of the filter.

    +
    • +
+
+

HelicsCombinationFederate

+
class HelicsCombinationFederate(handle)
+
+
+

Base classes

+ +
+

Instance attributes

+
    +
  • +

    core

    +
    • +
  • +

    current_time

    +
    • +
  • +

    n_endpoints

    +
    • +
  • +

    n_filters

    +
    • +
  • +

    n_inputs

    +
    • +
  • +

    n_pending_messages Returns the number of pending receives for all endpoints.

    +
    • +
  • +

    n_publications Get the number of publications in this federate.

    +
    • +
  • +

    n_subscriptions Get the number of inputs in this federate.

    +
    • +
  • +

    name

    +
    • +
  • +

    separator

    +
    • +
  • +

    state

    +
    • +
+
+

HelicsCore

+
class HelicsCore(handle, cleanup=True)
+
+
+

Base classes

+
    +
  • helics.capi._HelicsCHandle
    • +
+
+

Instance attributes

+
    +
  • +

    address Get the connection network or connection address for the core.

    +
    • +
  • +

    identifier Get an identifier string for the core.

    +
    • +
+
+

Methods

+

add_alias

+
def add_alias(self, interface_name: str, alias: str)
+
+

Create an alias for an interface.

+

Parameters

+
    +
  • interface_name: The current name of an interface.
    • +
  • alias: The additional name to use for the given interface.
    • +
+
+

clone

+
def clone(self)
+
+
+

disconnect

+
def disconnect(self)
+
+

Disconnect the core from its broker.

+
+

global_error

+
def global_error(self, error_code: int, error_string: str)
+
+

Generate a global error to terminate the federation.

+

Parameters

+
    +
  • error_code: an error code to give to the error.
    • +
  • error_string: a string message associated with the error.
    • +
+
+

is_connected

+
def is_connected(self) -> bool
+
+

Check if the core is connected to the broker.

+
+

is_valid

+
def is_valid(self) -> bool
+
+

Check if the core is valid.

+
+

query

+
def query(self, target: str, query: str, mode: HelicsSequencingMode = HelicsSequencingMode.FAST) -> JSONType
+
+

Make a query of the core.

+

This call is blocking until the value is returned which may take some time depending +on the size of the federation and the specific string being queried

+

target: the target of the query can be “federation”, “federate”, “broker”, “core”, or a specific name of a federate, core, or broker +query: a string with the query, see other documentation for specific properties to query, can be defined by the federate

+

Returns: a string with the value requested. this is either going to be a vector of strings value +or a JSON string stored in the first element of the vector. The string “#invalid” is returned +if the query was not valid

+
+

register_cloning_filter

+
def register_cloning_filter(self, delivery_endpoint: str) -> HelicsCloningFilter
+
+

Create a cloning Filter on the specified federate.

+

Cloning filters copy a message and send it to multiple locations source and destination can be added through other functions

+

Parameters

+

delivery_endpoint: the specified endpoint to deliver the message

+

Returns: a helics.HelicsFilter object.

+
+

register_filter

+
def register_filter(self, kind: HelicsFilterType, name: str = "") -> HelicsFilter
+
+

Create a destination Filter on the specified federate.

+

Filters can be created through a federate or a core , linking through a federate allows +a few extra features of name matching to function on the federate interface but otherwise +equivalent behavior

+

kind: the type of filter to create +name: the name of the filter (can be NULL)

+

Returns: a helics.HelicsFilter object.

+
+

set_global

+
def set_global(self, name: str, value: str)
+
+

Set a global federation value.

+

Parameters

+

name: the name of the global value to set +value: actual value of the global variable

+
+

set_ready_to_init

+
def set_ready_to_init(self)
+
+

Set the core to ready to enter init.

+

This function only needs to be called for cores that don’t have any federates but may have filters for cores with federates it won’t do anything.

+
+

wait_for_disconnect

+
def wait_for_disconnect(self, ms_to_wait: int = -1) -> bool
+
+

Waits in the current thread until the broker is disconnected

+

Parameters

+

ms_to_wait: the timeout to wait for disconnect (-1) implies no timeout

+

Returns: true if the disconnect was successful false if it timed out.

+
+

HelicsCoreFlag

+
class HelicsCoreFlag(*values)
+
+

Enum where members are also (and must be) ints

+
+

Base classes

+
    +
  • enum.IntEnum
    • +
+
+

HelicsCoreType

+
class HelicsCoreType(*values)
+
+
    +
  • ****DEFAULT****
    • +
  • ****TEST****
    • +
  • ****INTERPROCESS****
    • +
  • ****IPC****
    • +
  • ****TCP****
    • +
  • ****UDP****
    • +
  • ****NNG****
    • +
  • ****ZMQ_TEST****
    • +
  • ****TCP_SS****
    • +
  • ****HTTP****
    • +
  • ****WEBSOCKET****
    • +
  • ****INPROC****
    • +
  • ****NULL****
    • +
+
+

Base classes

+
    +
  • enum.IntEnum
    • +
+
+

HelicsDataBuffer

+
class HelicsDataBuffer(self, handle, cleanup=False)
+
+

Initialize self. See help(type(self)) for accurate signature.

+
+

Base classes

+
    +
  • helics.capi._HelicsCHandle
    • +
+
+

HelicsDataType

+
class HelicsDataType(*values)
+
+
    +
  • ****STRING****
    • +
  • ****DOUBLE****
    • +
  • ****INT****
    • +
  • ****COMPLEX****
    • +
  • ****VECTOR****
    • +
  • ****COMPLEX_VECTOR****
    • +
  • ****NAMED_POINT****
    • +
  • ****BOOLEAN****
    • +
  • ****TIME****
    • +
  • ****RAW****
    • +
  • ****JSON****
    • +
  • ****MULTI****
    • +
  • ****ANY****
    • +
+
+

Base classes

+
    +
  • enum.IntEnum
    • +
+
+

HelicsEndpoint

+
class HelicsEndpoint(handle, cleanup=True)
+
+
+

Base classes

+
    +
  • helics.capi._HelicsCHandle
    • +
+
+

Instance attributes

+
    +
  • +

    default_destination Get the default destination for an endpoint.

    +
    • +
  • +

    info Get the interface information field of the filter.

    +
    • +
  • +

    n_pending_messages Returns the number of pending receives for endpoint.

    +
    • +
  • +

    name Get the name of the endpoint.

    +
    • +
  • +

    type Get the specified type of the endpoint.

    +
    • +
+
+

Methods

+

create_message

+
def create_message(self) -> HelicsMessage
+
+

Create a message object.

+
+

get_message

+
def get_message(self) -> HelicsMessage
+
+

Get a packet from an endpoint.

+
+

has_message

+
def has_message(self) -> bool
+
+

Checks if endpoint has unread messages.

+
+

is_valid

+
def is_valid(self) -> bool
+
+

Check if the input is valid.

+
+

send_data

+
def send_data(self, data: Union[bytes, HelicsMessage], destination: str = None, time=None)
+
+
+

subscribe

+
def subscribe(self, name: str)
+
+

Subscribe an endpoint to a publication.

+
+

HelicsError

+
class HelicsError(*values)
+
+
    +
  • ****FATAL****
    • +
  • ****EXTERNAL_TYPE****
    • +
  • ****OTHER****
    • +
  • ****INSUFFICIENT_SPACE****
    • +
  • ****EXECUTION_FAILURE****
    • +
  • ****INVALID_FUNCTION_CALL****
    • +
  • ****INVALID_STATE_TRANSITION****
    • +
  • ****WARNING****
    • +
  • ****SYSTEM_FAILURE****
    • +
  • ****DISCARD****
    • +
  • ****INVALID_ARGUMENT****
    • +
  • ****INVALID_OBJECT****
    • +
  • ****CONNECTION_FAILURE****
    • +
  • ****REGISTRATION_FAILURE****
    • +
  • ****OK****
    • +
+
+

Base classes

+
    +
  • enum.IntEnum
    • +
+
+

HelicsException

+
class HelicsException(self, *args, **kwargs)
+
+

Common base class for all non-exit exceptions.

+
+

Base classes

+
    +
  • builtins.Exception
    • +
+
+

HelicsFederate

+
class HelicsFederate(self, handle, cleanup=True)
+
+

Initialize self. See help(type(self)) for accurate signature.

+
+

Base classes

+
    +
  • helics.capi._HelicsCHandle
    • +
+
+

Instance attributes

+
    +
  • +

    core

    +
    • +
  • +

    current_time

    +
    • +
  • +

    n_endpoints

    +
    • +
  • +

    n_filters

    +
    • +
  • +

    n_inputs

    +
    • +
  • +

    n_pending_messages Returns the number of pending receives for all endpoints.

    +
    • +
  • +

    n_publications

    +
    • +
  • +

    name

    +
    • +
  • +

    separator

    +
    • +
  • +

    state

    +
    • +
+
+

Methods

+

add_alias

+
def add_alias(self, interface_name: str, alias: str)
+
+

Create an alias for an interface.

+

Parameters

+
    +
  • interface_name: The current name of an interface.
    • +
  • alias: The additional name to use for the given interface.
    • +
+
+

add_dependency

+
def add_dependency(self, federate_name)
+
+

Add a dependency for this federate.

+

Adds an additional internal time dependency for the federate.

+

Parameters

+
    +
  • fed_name: the name of the federate to add a dependency on.
    • +
+
+

disconnect

+
def disconnect(self)
+
+

Terminate the simulation.

+

Call is will block until the disconnect has been acknowledged, no commands that interact with the core may be called after this function function.

+
+

disconnect_async

+
def disconnect_async(self)
+
+

Terminate the simulation in a non-blocking call. +self.disconnect_complete() must be called after this call to complete the disconnect procedure.

+
+

disconnect_complete

+
def disconnect_complete(self)
+
+

Complete the asynchronous terminate pair.

+
+

enter_executing_mode

+
def enter_executing_mode(self, iterate: HelicsIterationRequest = HelicsIterationRequest.NO_ITERATION)
+
+

Enter the normal execution mode.

+

Call will block until all federates have entered this mode.

+

Parameters

+
    +
  • iterate: An optional flag indicating the desired iteration mode.
    • +
+
+

enter_executing_mode_async

+
def enter_executing_mode_async(self, iterate: HelicsIterationRequest = HelicsIterationRequest.NO_ITERATION)
+
+

Enter the normal execution mode.

+

Call will return immediately but enter_executing_mode_complete should be called to complete the operation.

+

Parameters

+
    +
  • iterate: An optional flag indicating the desired iteration mode.
    • +
+
+

enter_executing_mode_complete

+
def enter_executing_mode_complete(self)
+
+

Complete the async call for entering Execution state.

+

Call will not block but will return quickly. +The enter_initializing_mode_complete must be called before doing other operations.

+
+

enter_initializing_mode

+
def enter_initializing_mode(self)
+
+

Enter the initialization mode after all interfaces have been defined.

+

The call will block until all federates have entered initialization mode.

+
+

enter_initializing_mode_async

+
def enter_initializing_mode_async(self)
+
+

Enter the initialization mode after all interfaces have been defined.

+

The call will not block but a call to enter_initializing_mode_complete should be made to complete the call sequence.

+
+

enter_initializing_mode_complete

+
def enter_initializing_mode_complete(self)
+
+

Second part of the async process for entering initializationState call after a call to enter_initializing_mode_async if call any other time it will throw an InvalidFunctionCall exception

+
+

enter_initializing_mode_iterative

+
def enter_initializing_mode_iterative(self)
+
+

Trigger a blocking call and return to created state after all federates have either triggered an iteration or are waiting to enter initializing mode.

+
+

enter_initializing_mode_iterative_async

+
def enter_initializing_mode_iterative_async(self)
+
+

Non-blocking alternative to enter_initializing_mode_async.

+

A call to enter_initializing_mode_iterative_complete should be made to complete the call sequence.

+
+

enter_initializing_mode_iterative_complete

+
def enter_initializing_mode_iterative_complete(self)
+
+

Complete the call to enter initializing mode iterative that was initiated with enter_initializing_mode_iterative_async.

+
+

finalize

+
def finalize(self)
+
+

Terminate the simulation.

+

Call is will block until the finalize has been acknowledged, no commands that interact with the core may be called after this function function.

+

DEPRECATED

+
+

finalize_async

+
def finalize_async(self)
+
+

Terminate the simulation in a non-blocking call. +self.finalize_complete() must be called after this call to complete the finalize procedure.

+

DEPRECATED

+
+

finalize_complete

+
def finalize_complete(self)
+
+

Complete the asynchronous terminate pair.

+

DEPRECATED

+
+

get_filter_by_index

+
def get_filter_by_index(self, filter_index)
+
+

Get a filter by index.

+

Parameters

+
    +
  • index: the index of a filter.
    • +
+

Returns: A reference to a filter object which could be invalid if filter_name is not valid.

+
+

get_filter_by_name

+
def get_filter_by_name(self, filter_name)
+
+

Get the id of a source filter from the name of the endpoint.

+

Parameters

+
    +
  • filter_name: the name of the filter.
    • +
+

Returns: a reference to a filter object which could be invalid if filter_name is not valid.

+
+

global_error

+
def global_error(self, error_code: int, error_string: str)
+
+

Generate a global error to terminate the federation.

+

Parameters

+
    +
  • error_code: an error code to give to the error.
    • +
  • error_string: a string message associated with the error.
    • +
+
+

is_async_operation_completed

+
def is_async_operation_completed(self)
+
+

Called after one of the async calls and will indicate true if an async operation has completed. +Only call from the same thread as the one that called the initial async call and will return false if called when no aysnc operation is in flight

+
+

local_error

+
def local_error(self, error_code: int, error_string: str)
+
+

Generate a local federate error.

+

Parameters

+
    +
  • error_code: an error code to give to the error.
    • +
  • error_string: a string message associated with the error.
    • +
+
+

log_message

+
def log_message(self, message: str, level: HelicsLogLevel)
+
+

Log an message.

+
+

query

+
def query(self, target: str, query: str, mode: HelicsSequencingMode = HelicsSequencingMode.FAST) -> JSONType
+
+

Make a query of the federate.

+

This call is blocking until the value is returned which make take some time depending on the size of the federation and the specific string being queried.

+

Parameters

+
    +
  • target: the target of the query can be “federation”, “federate”, “broker”, “core”, or a specific name of a federate, core, or broker.
    • +
  • query: a string with the query see other documentation for specific properties to query, can be defined by the federate.
    • +
+

Returns: a string with the value requested. +this is either going to be a vector of strings value or a JSON string stored in the first element of the vector. The string “#invalid” is returned if the query was not valid.

+
+

register_cloning_filter

+
def register_cloning_filter(self, delivery_endpoint: str) -> HelicsCloningFilter
+
+

Create a HelicsCloningFilter on the specified federate.

+

Cloning filters copy a message and send it to multiple locations source and destination can be added through other functions.

+

Parameters

+
    +
  • delivery_endpoint: the specified endpoint to deliver the message.
    • +
+

Returns: A HelicsCloningFilter object.

+
+

register_filter

+
def register_filter(self, kind: HelicsFilterType, filter_name: str) -> HelicsFilter
+
+

Define a filter interface.

+

A filter will modify messages coming from or going to target endpoints.

+

Parameters

+
    +
  • kind: the type of the filter to register.
    • +
  • filter_name: the name of the filter.
    • +
+
+

register_global_cloning_filter

+
def register_global_cloning_filter(self, delivery_endpoint: str) -> HelicsCloningFilter
+
+

Create a cloning Filter on the specified federate

+

Cloning filters copy a message and send it to multiple locations source and destination can be added through other functions.

+

Parameters

+
    +
  • delivery_endpoint: the specified endpoint to deliver the message.
    • +
+

Returns: A CloningFilter object.

+
+

register_global_filter

+
def register_global_filter(self, kind: HelicsFilterType, filter_name: str) -> HelicsFilter
+
+

Define a filter interface.

+

A filter will modify messages coming from or going to target endpoints.

+

Parameters

+
    +
  • kind: the type of the filter to register.
    • +
  • filter_name: the name of the filter.
    • +
+
+

register_interfaces

+
def register_interfaces(self, config)
+
+

Register a set of interfaces defined in a file.

+

Call is only valid in startup mode

+

Parameters

+
    +
  • configString: the location of the file or config String to load to generate the interfaces
    • +
+
+

request_next_step

+
def request_next_step(self) -> HelicsTime
+
+

Request a time advancement to the next allowed time.

+

Returns: The granted time step.

+
+

request_time

+
def request_time(self, time: HelicsTime) -> HelicsTime
+
+

Parameters

+
    +
  • time: the next requested time step.
    • +
+

Returns: The granted time step.

+
+

request_time_advance

+
def request_time_advance(self, time_delta: HelicsTime) -> HelicsTime
+
+

Request a time advancement to the next allowed time.

+

Parameters

+
    +
  • timeDelta: The amount of time requested to advance.
    • +
+

Returns: The granted time step.

+
+

request_time_async

+
def request_time_async(self, time: HelicsTime)
+
+

Request a time advancement and return immediately for asynchronous function. +self.request_time_complete() should be called to finish the operation and get the result.

+

Parameters

+
    +
  • time: the next requested time step
    • +
+
+

request_time_complete

+
def request_time_complete(self) -> HelicsTime
+
+

Request a time advancement.

+

Returns: the granted time step.

+
+

request_time_iterative

+
def request_time_iterative(self, time: float, iterate: HelicsIterationRequest) -> Tuple[HelicsTime, HelicsIterationResult]
+
+

Request a time advancement.

+

Parameters

+
    +
  • time: the next requested time step.
    • +
  • iterate: a requested iteration mode.
    • +
+

Returns: The granted time step in a structure containing a return time and an iteration_result.

+
+

request_time_iterative_async

+
def request_time_iterative_async(self, time: float, iterate: HelicsIterationRequest)
+
+

Request a time advancement with iterative call and return for asynchronous function. +self.request_time_iterative_complete() should be called to finish the operation and get the result.

+

Parameters

+
    +
  • time: the next requested time step.
    • +
  • iterate: a requested iteration level (none, require, optional).
    • +
+
+

request_time_iterative_complete

+
def request_time_iterative_complete(self) -> Tuple[HelicsTime, HelicsIterationResult]
+
+

Finalize the time advancement request.

+

Returns: the granted time step and iteration result.

+
+

set_global

+
def set_global(self, name: str, value: str)
+
+

Set a federation global value.

+

This overwrites any previous value for this name.

+

Parameters

+
    +
  • name: the name of the global to set.
    • +
  • value: the value of the global.
    • +
+
+

HelicsFederateFlag

+
class HelicsFederateFlag(*values)
+
+
    +
  • ****OBSERVER****
    • +
  • ****UNINTERRUPTIBLE****
    • +
  • ****INTERRUPTIBLE****
    • +
  • ****SOURCE_ONLY****
    • +
  • ****ONLY_TRANSMIT_ON_CHANGE****
    • +
  • ****ONLY_UPDATE_ON_CHANGE****
    • +
  • ****WAIT_FOR_CURRENT_TIME_UPDATE****
    • +
  • ****RESTRICTIVE_TIME_POLICY****
    • +
  • ****ROLLBACK****
    • +
  • ****FORWARD_COMPUTE****
    • +
  • ****REALTIME****
    • +
  • ****SINGLE_THREAD_FEDERATE****
    • +
  • ****MULTI_THREAD_CORE****
    • +
  • ****SINGLE_THREAD_CORE****
    • +
  • ****REENTRANT****
    • +
  • ****IGNORE_TIME_MISMATCH_WARNINGS****
    • +
  • ****STRICT_CONFIG_CHECKING****
    • +
  • ****USE_JSON_SERIALIZATION****
    • +
  • ****EVENT_TRIGGERED****
    • +
  • ****LOCAL_PROFILING_CAPTURE****
    • +
  • ****CALLBACK_FEDERATE****
    • +
  • ****AUTOMATED_TIME_REQUEST****
    • +
+
+

Base classes

+
    +
  • enum.IntEnum
    • +
+
+

HelicsFederateInfo

+
class HelicsFederateInfo(self, handle, cleanup=True)
+
+

Initialize self. See help(type(self)) for accurate signature.

+
+

Base classes

+
    +
  • helics.capi._HelicsCHandle
    • +
+
+

Instance attributes

+
    +
  • +

    broker

    +
    • +
  • +

    broker_init

    +
    • +
  • +

    broker_key

    +
    • +
  • +

    broker_port

    +
    • +
  • +

    core_init

    +
    • +
  • +

    core_name

    +
    • +
  • +

    core_type

    +
    • +
  • +

    local_port

    +
    • +
  • +

    separator

    +
    • +
+
+

HelicsFederateState

+
class HelicsFederateState(*values)
+
+
    +
  • ****STARTUP****
    • +
  • ****INITIALIZATION****
    • +
  • ****EXECUTION****
    • +
  • ****FINALIZE****
    • +
  • ****ERROR****
    • +
  • ****PENDING_INIT****
    • +
  • ****PENDING_EXEC****
    • +
  • ****PENDING_TIME****
    • +
  • ****PENDING_ITERATIVE_TIME****
    • +
  • ****PENDING_FINALIZE****
    • +
  • ****FINISHED****
    • +
+
+

Base classes

+
    +
  • enum.IntEnum
    • +
+
+

HelicsFilter

+
class HelicsFilter(self, handle, cleanup=True)
+
+

Initialize self. See help(type(self)) for accurate signature.

+
+

Base classes

+
    +
  • helics.capi._HelicsCHandle
    • +
+
+

Instance attributes

+
    +
  • +

    info Get the interface information field of the filter.

    +
    • +
  • +

    name Get the name of the filter.

    +
    • +
+
+

Methods

+

add_delivery_endpoint

+
def add_delivery_endpoint(self, delivery_endpoint: str)
+
+

Add a delivery destination from a filter.

+

Parameters

+
    +
  • delivery_endpoint - A string with the delivery endpoint to add.
    • +
+
+

add_destination_target

+
def add_destination_target(self, destination: str)
+
+

Add a destination target to a cloning filter. +All messages going to a destination are copied to the delivery address(es).

+
+

add_source_target

+
def add_source_target(self, source: str)
+
+

Add a source target to a cloning filter. +All messages coming from a source are copied to the delivery address(es).

+
+

remove_delivery_endpoint

+
def remove_delivery_endpoint(self, delivery_endpoint: str)
+
+

Remove a delivery destination from a filter.

+

Parameters

+
    +
  • delivery_endpoint - A string with the delivery endpoint to remove.
    • +
+
+

remove_destination_target

+
def remove_destination_target(self, destination: str)
+
+

remove a destination target from a cloning filter.

+
+

set

+
def set(self, property: str, value: float)
+
+

Set a property on a filter.

+
+

HelicsFilterType

+
class HelicsFilterType(*values)
+
+
    +
  • ****CUSTOM****
    • +
  • ****DELAY****
    • +
  • ****RANDOM_DELAY****
    • +
  • ****RANDOM_DROP****
    • +
  • ****REROUTE****
    • +
  • ****CLONE****
    • +
  • ****FIREWALL****
    • +
+
+

Base classes

+
    +
  • enum.IntEnum
    • +
+
+

HelicsFlag

+
class HelicsFlag(*values)
+
+

Enum where members are also (and must be) ints

+
+

Base classes

+
    +
  • enum.IntEnum
    • +
+
+

HelicsHandleOption

+
class HelicsHandleOption(*values)
+
+
    +
  • ****CONNECTION_REQUIRED****
    • +
  • ****CONNECTION_OPTIONAL****
    • +
  • ****SINGLE_CONNECTION_ONLY****
    • +
  • ****MULTIPLE_CONNECTIONS_ALLOWED****
    • +
  • ****BUFFER_DATA****
    • +
  • ****RECONNECTABLE****
    • +
  • ****STRICT_TYPE_CHECKING****
    • +
  • ****RECEIVE_ONLY****
    • +
  • ****SOURCE_ONLY****
    • +
  • ****IGNORE_UNIT_MISMATCH****
    • +
  • ****ONLY_TRANSMIT_ON_CHANGE****
    • +
  • ****ONLY_UPDATE_ON_CHANGE****
    • +
  • ****IGNORE_INTERRUPTS****
    • +
  • ****MULTI_INPUT_HANDLING_METHOD****
    • +
  • ****INPUT_PRIORITY_LOCATION****
    • +
  • ****CLEAR_PRIORITY_LIST****
    • +
  • ****CONNECTIONS****
    • +
+
+

Base classes

+
    +
  • enum.IntEnum
    • +
+
+

HelicsInput

+
class HelicsInput(self, handle)
+
+

Initialize self. See help(type(self)) for accurate signature.

+
+

Base classes

+
    +
  • helics.capi._HelicsCHandle
    • +
+
+

Instance attributes

+
    +
  • +

    boolean Get the value as a boolean.

    +
    • +
  • +

    bytes Get a raw value as a character vector.

    +
    • +
  • +

    complex Get the value as a complex number.

    +
    • +
  • +

    complex_vector get the current value as a vector of complex.

    +
    • +
  • +

    double Get the value as a double.

    +
    • +
  • +

    info Get the interface information field of the filter.

    +
    • +
  • +

    injection_units Get the units associated with an inputs publication.

    +
    • +
  • +

    integer Get the current value as a 64 bit integer.

    +
    • +
  • +

    json Get a raw value as a character vector.

    +
    • +
  • +

    key Get the name/key for the input +the name is the local name if given, key is the full key name.

    +
    • +
+

DEPRECATED

+
    +
  • +

    name Get the name/key for the input +the name is the local name if given, key is the full key name.

    +
    • +
  • +

    named_point Get the current value as a named point.

    +
    • +
  • +

    publication_type Get the units associated with a publication of an input.

    +
    • +
  • +

    string Get the current value as a string.

    +
    • +
  • +

    target Get the target of the input.

    +
    • +
  • +

    type Get the type of the input.

    +
    • +
  • +

    units Get the units associated with a input.

    +
    • +
  • +

    value

    +
    • +
  • +

    vector get the current value as a vector of doubles.

    +
    • +
+
+

Methods

+

add_target

+
def add_target(self, target: str)
+
+

Add a publication target to the input.

+
+

clear_update

+
def clear_update(self)
+
+

Clear the updated flag.

+
+

get_last_update_time

+
def get_last_update_time(self) -> HelicsTime
+
+

Get the last time an input was updated.

+
+

is_updated

+
def is_updated(self) -> bool
+
+

Check if an input is updated.

+
+

is_valid

+
def is_valid(self) -> bool
+
+

Check if the input is valid.

+
+

set_default

+
def set_default(self, data: Union[bytes, str, int, bool, float, complex, List[float], List[complex]])
+
+

Set the default value as a raw data +Set the default value as a string +Set the default value as an integer +Set the default value as a bool +Set the default value as a double +Set the default value as a vector of doubles

+
+

HelicsIterationRequest

+
class HelicsIterationRequest(*values)
+
+
    +
  • ****NO_ITERATION****
    • +
  • ****FORCE_ITERATION****
    • +
  • ****ITERATE_IF_NEEDED****
    • +
+
+

Base classes

+
    +
  • enum.IntEnum
    • +
+
+

HelicsIterationResult

+
class HelicsIterationResult(*values)
+
+
    +
  • ****NEXT_STEP****
    • +
  • ****ERROR****
    • +
  • ****HALTED****
    • +
  • ****ITERATING****
    • +
+
+

Base classes

+
    +
  • enum.IntEnum
    • +
+
+

HelicsLogLevel

+
class HelicsLogLevel(*values)
+
+
    +
  • ****NO_PRINT****
    • +
  • ****ERROR****
    • +
  • ****WARNING****
    • +
  • ****SUMMARY****
    • +
  • ****CONNECTIONS****
    • +
  • ****INTERFACES****
    • +
  • ****TIMING****
    • +
  • ****DATA****
    • +
  • ****DEBUG****
    • +
  • ****TRACE****
    • +
+
+

Base classes

+
    +
  • enum.IntEnum
    • +
+
+

HelicsMessage

+
class HelicsMessage(self, handle, cleanup=True)
+
+

Initialize self. See help(type(self)) for accurate signature.

+
+

Base classes

+
    +
  • helics.capi._HelicsCHandle
    • +
+
+

Instance attributes

+
    +
  • +

    data

    +
    • +
  • +

    destination

    +
    • +
  • +

    message_id

    +
    • +
  • +

    original_dest

    +
    • +
  • +

    original_destination

    +
    • +
  • +

    original_source

    +
    • +
  • +

    raw_data

    +
    • +
  • +

    source

    +
    • +
  • +

    time

    +
    • +
+
+

Methods

+

append

+
def append(self, data: bytes)
+
+
+

is_valid

+
def is_valid(self) -> bool
+
+
+

HelicsMessageFederate

+
class HelicsMessageFederate(self, handle)
+
+

Initialize self. See help(type(self)) for accurate signature.

+
+

Base classes

+ +
+

Instance attributes

+
    +
  • +

    core

    +
    • +
  • +

    current_time

    +
    • +
  • +

    n_endpoints

    +
    • +
  • +

    n_filters

    +
    • +
  • +

    n_inputs

    +
    • +
  • +

    n_pending_messages Returns the number of pending receives for all endpoints.

    +
    • +
  • +

    n_publications

    +
    • +
  • +

    name

    +
    • +
  • +

    separator

    +
    • +
  • +

    state

    +
    • +
+
+

Methods

+

create_message

+
def create_message(self) -> HelicsMessage
+
+

Create a message object.

+
+

get_endpoint_by_index

+
def get_endpoint_by_index(self, index: int) -> HelicsEndpoint
+
+

Get an Endpoint from an index.

+

Parameters

+
    +
  • index: the index of the endpoint to retrieve index is 0 based
    • +
+

Return an Endpoint

+
+

get_endpoint_by_name

+
def get_endpoint_by_name(self, name: str) -> HelicsEndpoint
+
+

Get an Endpoint from its name.

+

Parameters

+
    +
  • name: the name of the endpoint to retrieve.
    • +
+

Returns: an Endpoint

+
+

get_message

+
def get_message(self) -> HelicsMessage
+
+

Get a packet for any endpoints in the federate.

+
+

has_message

+
def has_message(self) -> bool
+
+

Checks if federate has any messages.

+
+

register_endpoint

+
def register_endpoint(self, name: str, kind: str = "") -> HelicsEndpoint
+
+

Register an endpoint.

+

Call is only valid in startup mode

+
    +
  • name: the name of the endpoint
    • +
  • kind: the defined type of the interface for endpoint checking if requested
    • +
+

Returns: an Endpoint Object

+
+

register_global_endpoint

+
def register_global_endpoint(self, name: str, kind: str = "") -> HelicsEndpoint
+
+

Register an endpoint directly without prepending the federate name.

+
    +
  • name: the name of the endpoint
    • +
  • kind: the defined type of the interface for endpoint checking if requested
    • +
+

Returns: an Endpoint Object

+
+

HelicsMultiInputMode

+
class HelicsMultiInputMode(*values)
+
+
    +
  • ****NO_OP****
    • +
  • ****VECTORIZE_OPERATION****
    • +
  • ****AND_OPERATION****
    • +
  • ****OR_OPERATION****
    • +
  • ****SUM_OPERATION****
    • +
  • ****DIFF_OPERATION****
    • +
  • ****MAX_OPERATION****
    • +
  • ****MIN_OPERATION****
    • +
  • ****AVERAGE_OPERATION****
    • +
+
+

Base classes

+
    +
  • enum.IntEnum
    • +
+
+

HelicsProperty

+
class HelicsProperty(*values)
+
+
    +
  • ****TIME_DELTA****
    • +
  • ****TIME_PERIOD****
    • +
  • ****TIME_OFFSET****
    • +
  • ****TIME_RT_LAG****
    • +
  • ****TIME_RT_LEAD****
    • +
  • ****TIME_RT_TOLERANCE****
    • +
  • ****TIME_INPUT_DELAY****
    • +
  • ****TIME_OUTPUT_DELAY****
    • +
  • ****TIME_STOPTIME****
    • +
  • ****TIME_GRANT_TIMEOUT****
    • +
  • ****INT_CURRENT_ITERATION****
    • +
  • ****INT_MAX_ITERATIONS****
    • +
  • ****INT_LOG_LEVEL****
    • +
  • ****INT_FILE_LOG_LEVEL****
    • +
  • ****INT_CONSOLE_LOG_LEVEL****
    • +
  • ****INT_LOG_BUFFER****
    • +
  • ****INT_INDEX_GROUP****
    • +
+
+

Base classes

+
    +
  • enum.IntEnum
    • +
+
+

HelicsPublication

+
class HelicsPublication(self, handle)
+
+

Initialize self. See help(type(self)) for accurate signature.

+
+

Base classes

+
    +
  • helics.capi._HelicsCHandle
    • +
+
+

Instance attributes

+
    +
  • +

    info Get the interface information field of the publication.

    +
    • +
  • +

    key Get the key for the publication.

    +
    • +
+

DEPRECATED

+
    +
  • +

    name Get the key for the publication.

    +
    • +
  • +

    type Get the type for the publication.

    +
    • +
  • +

    units Get the units of the publication.

    +
    • +
+
+

Methods

+

add_target

+
def add_target(self, name: str)
+
+

Add a named input to the list of targets a publication publishes to.

+
+

is_valid

+
def is_valid(self) -> bool
+
+

Check if the publication is valid.

+
+

publish

+
def publish(self, data: Union[bytes, str, int, complex, float, List[complex], List[float], Tuple[str, float], bool])
+
+

publish raw bytes +publish a string +publish an int value +publish a double +publish a complex number +publish a vector of doubles +publish a named point with a string and double +publish a boolean value

+
+

HelicsQuery

+
class HelicsQuery(self, handle, cleanup=False)
+
+

Initialize self. See help(type(self)) for accurate signature.

+
+

Base classes

+
    +
  • helics.capi._HelicsCHandle
    • +
+
+

HelicsQueryBuffer

+
class HelicsQueryBuffer(self, handle, cleanup=False)
+
+

Initialize self. See help(type(self)) for accurate signature.

+
+

Base classes

+
    +
  • helics.capi._HelicsCHandle
    • +
+
+

HelicsSequencingMode

+
class HelicsSequencingMode(*values)
+
+

Enumeration of sequencing modes for queries +fast is the default, meaning the query travels along priority channels and takes precedence of over +existing messages; ordered means it follows normal priority patterns and will be ordered along with +existing messages

+
    +
  • ****FAST****
    • +
  • ****ORDERED****
    • +
  • ****DEFAULT****
    • +
+
+

Base classes

+
    +
  • enum.IntEnum
    • +
+
+

HelicsTranslator

+
class HelicsTranslator(self, handle, cleanup=True)
+
+

Initialize self. See help(type(self)) for accurate signature.

+
+

Base classes

+
    +
  • helics.capi._HelicsCHandle
    • +
+
+

HelicsTranslatorTypes

+
class HelicsTranslatorTypes(*values)
+
+

Rnumeration of the predefined translator types

+

A custom filter type that executes a user defined callback +- ****CUSTOM**** +A translator type that converts to and from JSON +- ****JSON**** +A translator type that just encodes the message again in binary +- ****BINARY****

+
+

Base classes

+
    +
  • enum.IntEnum
    • +
+
+

HelicsValueFederate

+
class HelicsValueFederate(self, handle)
+
+

Initialize self. See help(type(self)) for accurate signature.

+
+

Base classes

+ +
+

Instance attributes

+
    +
  • +

    core

    +
    • +
  • +

    current_time

    +
    • +
  • +

    n_endpoints

    +
    • +
  • +

    n_filters

    +
    • +
  • +

    n_inputs

    +
    • +
  • +

    n_pending_messages Returns the number of pending receives for all endpoints.

    +
    • +
  • +

    n_publications Get the number of publications in this federate.

    +
    • +
  • +

    n_subscriptions Get the number of inputs in this federate.

    +
    • +
  • +

    name

    +
    • +
  • +

    separator

    +
    • +
  • +

    state

    +
    • +
+
+

Methods

+

clear_updates

+
def clear_updates(self)
+
+

Clear all the update flags from all federate inputs.

+
+

get_publication_by_index

+
def get_publication_by_index(self, index: int) -> HelicsPublication
+
+

Get a publication by index.

+

Parameters

+
    +
  • index: a 0 based index of the publication to retrieve
    • +
+

Returns: a Publication object

+
+

get_publication_by_name

+
def get_publication_by_name(self, name: str) -> HelicsPublication
+
+

Get publication by name.

+
+

get_subscription_by_index

+
def get_subscription_by_index(self, index: int) -> HelicsInput
+
+

Get a subscription by index.

+
+

get_subscription_by_name

+
def get_subscription_by_name(self, name: str) -> HelicsInput
+
+

Get an input by index.

+
+

get_subscription_by_target

+
def get_subscription_by_target(self, target: str) -> HelicsInput
+
+

Get an input by target.

+
+

publish_json

+
def publish_json(self, data: Union[dict, str])
+
+

Publish data contained in a JSON file.

+
+

register_from_publication_json

+
def register_from_publication_json(self, data: Union[dict, str])
+
+

Register publications from a JSON output file or string.

+

Generates interface based on the data contained in a JSON file or string.

+
+

register_global_input

+
def register_global_input(self, name: str, kind: Union[str, HelicsDataType], units: str = "") -> HelicsInput
+
+

Register an input.

+

Call is only valid in startup mode.

+

Parameters

+
    +
  • name: the name of the input
    • +
  • kind: a string defining the type of the input
    • +
  • units: a string defining the units of the input [optional]
    • +
+

Returns: an input object for use as an identifier.

+
+

register_global_publication

+
def register_global_publication(self, name: str, kind: Union[str, HelicsDataType], units: str = "") -> HelicsPublication
+
+

Register a publication

+

Call is only valid in startup mode

+

Parameters

+
    +
  • name: the name of the publication
    • +
  • kind: the type of the publication
    • +
  • units: a string defining the units of the publication [optional]
    • +
+

Returns: a publication object for use as an identifier

+
+

register_input

+
def register_input(self, name: str, kind: Union[str, HelicsDataType], units: str = "") -> HelicsInput
+
+

Register an input.

+

Call is only valid in startup mode.

+

Parameters

+
    +
  • name: the name of the input
    • +
  • kind: the type of input to register
    • +
  • units: a string defining the units of the input [optional]
    • +
+

Returns: an input id object for use as an identifier

+
+

register_publication

+
def register_publication(self, name: str, kind: Union[str, HelicsDataType], units: str = "", local: bool = True) -> HelicsPublication
+
+

Register a publication.

+

Call is only valid in startup mode.

+

Parameters

+
    +
  • name: the name of the publication.
    • +
  • kind: the type of the publication.
    • +
  • units: a string defining the units of the publication [optional]
    • +
  • local: a bool defining whether the publication is global or not [optional]
    • +
+

Returns: a publication id object for use as an identifier

+
+

register_subscription

+
def register_subscription(self, name: str, units: str = "") -> HelicsInput
+
+

Functions

+

cchar

+
def cchar(c: str) -> bytes
+
+
+

cdouble

+
def cdouble(d: float) -> float
+
+
+

cstring

+
def cstring(s: str) -> str
+
+
+

generate_cleanup_callback

+
def generate_cleanup_callback(obj)
+
+
+

helicsAbort

+
def helicsAbort(error_code: int, message: str)
+
+
+

helicsBrokerAddAlias

+
def helicsBrokerAddAlias(broker: HelicsBroker, interface_name: str, alias: str)
+
+

Create an alias for an interface.

+

Parameters

+
    +
  • interface_name: The current name of an interface.
    • +
  • alias: The additional name to use for the given interface.
    • +
+
+

helicsBrokerAddDestinationFilterToEndpoint

+
def helicsBrokerAddDestinationFilterToEndpoint(broker: HelicsBroker, filter_name: str, endpoint_name: str)
+
+

Link a named filter to a destination endpoint.

+

Parameters

+
    +
  • broker - The broker to generate the connection from.
    • +
  • filter - The name of the filter.
    • +
  • endpoint - The name of the endpoint to filter the data going to.
    • +
+
+

helicsBrokerAddSourceFilterToEndpoint

+
def helicsBrokerAddSourceFilterToEndpoint(broker: HelicsBroker, filter_name: str, endpoint_name: str)
+
+

Link a named filter to a source endpoint.

+

Parameters

+
    +
  • broker - The broker to generate the connection from.
    • +
  • filter - The name of the filter.
    • +
  • endpoint - The name of the endpoint to filter the data from.
    • +
+
+

helicsBrokerClearTimeBarrier

+
def helicsBrokerClearTimeBarrier(broker: HelicsBroker)
+
+
+

helicsBrokerClone

+
def helicsBrokerClone(broker: HelicsBroker) -> HelicsBroker
+
+

Create a new reference to an existing broker. +This will create a new broker object that references the existing broker it must be freed as well.

+

Parameters

+
    +
  • broker - An existing helics.HelicsBroker.
    • +
+

Returns: helics.HelicsBroker.

+
+ +
def helicsBrokerDataLink(broker: HelicsBroker, source_name: str, target_name: str)
+
+

Link a named publication and named input using a broker.

+

Parameters

+
    +
  • broker - The broker to generate the connection from.
    • +
  • source_name - The name of the publication.
    • +
  • target_name - The name of the target to send the publication data.
    • +
+
+

helicsBrokerDestroy

+
def helicsBrokerDestroy(broker: HelicsBroker)
+
+

Disconnect and free a broker.

+
+

helicsBrokerDisconnect

+
def helicsBrokerDisconnect(broker: HelicsBroker)
+
+

Disconnect a broker.

+

Parameters

+
    +
  • broker - The broker to disconnect.
    • +
+
+

helicsBrokerFree

+
def helicsBrokerFree(broker: HelicsBroker)
+
+

Release the memory associated with a broker.

+
+

helicsBrokerGetAddress

+
def helicsBrokerGetAddress(broker: HelicsBroker) -> str
+
+

Get the network address associated with a broker.

+

Parameters

+
    +
  • broker - The broker to query.
    • +
+

Returns: A string with the network address of the broker.

+
+

helicsBrokerGetIdentifier

+
def helicsBrokerGetIdentifier(broker: HelicsBroker) -> str
+
+

Get an identifier for the broker.

+

Parameters

+
    +
  • broker - The broker to query.
    • +
+

Returns: A string containing the identifier for the broker.

+
+

helicsBrokerGlobalError

+
def helicsBrokerGlobalError(broker: HelicsBroker, error_code: int, error_string: str)
+
+
+

helicsBrokerIsConnected

+
def helicsBrokerIsConnected(broker: HelicsBroker) -> bool
+
+

Check if a broker is connected. +A connected broker implies it is attached to cores or cores could reach out to communicate.

+

Returns: True if connected, False if not connected.

+
+

helicsBrokerIsValid

+
def helicsBrokerIsValid(broker: HelicsBroker) -> bool
+
+

Check if a broker object is a valid object.

+

Parameters

+
    +
  • broker - The helics.HelicsBroker object to test.
    • +
+

Returns: True if valid, False if not valid.

+
+

helicsBrokerMakeConnections

+
def helicsBrokerMakeConnections(broker: HelicsBroker, file: str)
+
+

Load a file containing connection information.

+

Parameters

+
    +
  • broker - The broker to generate the connections from.
    • +
  • file - A JSON or TOML file containing connection information.
    • +
+
+

helicsBrokerSendCommand

+
def helicsBrokerSendCommand(broker, target, command, err)
+
+

Send a command to another helics object through a broker using asynchronous(fast) messages.

+
    +
  • broker: The broker to send the command through.
    • +
  • target: The name of the object to send the command to.
    • +
  • command: The command to send.
    • +
+
+

helicsBrokerSendOrderedCommand

+
def helicsBrokerSendOrderedCommand(broker, target, command, err)
+
+

Send a command to another helics object through a broker using ordered sequencing.

+
    +
  • broker: The broker to send the command through.
    • +
  • target: The name of the object to send the command to.
    • +
  • command: The command to send.
    • +
+
+

helicsBrokerSetGlobal

+
def helicsBrokerSetGlobal(broker: HelicsBroker, name: str, value: str)
+
+

Set a federation global value. +This overwrites any previous value for this name.

+

Parameters

+
    +
  • broker - The broker to set the global through.
    • +
  • name - The name of the global to set.
    • +
  • value - The value of the global.
    • +
+
+

helicsBrokerSetLogFile

+
def helicsBrokerSetLogFile(broker: HelicsBroker, log_file: str)
+
+

Set the log file on a broker.

+

Parameters

+
    +
  • broker - The broker to set the log file for.
    • +
  • log_file - The name of the file to log to.
    • +
+
+

helicsBrokerSetLoggingCallback

+
def helicsBrokerSetLoggingCallback(broker: HelicsBroker, logger, user_data)
+
+

Set the logging callback for a helics.HelicsBroker

+

Add a logging callback function for the C. +The logging callback will be called when a message flows from helics.HelicsBroker or from the core.

+

Parameters

+
    +
  • broker: the helics.HelicsBroker that is created with helics.helicsCreateBroker
    • +
  • logger: a callback with signature void(int, const char *, const char *, void *); the function arguments are loglevel, an identifier string, and a message string, and a pointer to user data
    • +
  • user_data: a pointer to user data that is passed to the function when executing
    • +
+
+

helicsBrokerSetTimeBarrier

+
def helicsBrokerSetTimeBarrier(broker: HelicsBroker, barrier_time: HelicsTime)
+
+

Set the broker time barrier

+

Parameters

+
    +
  • broker: the helics.HelicsBroker
    • +
  • barrier_time: the barrier time
    • +
+
+

helicsBrokerWaitForDisconnect

+
def helicsBrokerWaitForDisconnect(broker: HelicsBroker, ms_to_wait: int) -> bool
+
+

Wait for the broker to disconnect.

+

Parameters

+
    +
  • broker - The broker to wait for.
    • +
  • ms_to_wait - The time out in millisecond (<0 for infinite timeout).
    • +
+
+

helicsCallbackFederateInitializeCallback

+
def helicsCallbackFederateInitializeCallback(fed: HelicsFederate, initialize, user_data)
+
+

Set callback for initialization

+

This callback will be executed when computing whether to iterate in initialization mode

+

Parameters

+
    +
  • fed: The federate to set the callback for.
    • +
  • initialize: A callback with signature HelicsIterationRequest(void *user_data);
    • +
  • user_data: A pointer to user data that is passed to the function when executing.
    • +
+
+

helicsCallbackFederateNextTimeCallback

+
def helicsCallbackFederateNextTimeCallback(fed: HelicsFederate, time_update, user_data)
+
+

Set callback for the next time update

+

This callback will be triggered to compute the next time update for a callback federate

+

Parameters

+
    +
  • fed: The federate to set the callback for.
    • +
  • time_update: A callback with signature HelicsTime(HelicsTime time, void *user_data);
    • +
  • user_data: A pointer to user data that is passed to the function when executing.
    • +
+
+

helicsCallbackFederateNextTimeIterativeCallback

+
def helicsCallbackFederateNextTimeIterativeCallback(fed: HelicsFederate, time_update, user_data)
+
+

Set callback for the next time update with iteration capability

+

This callback will be triggered to compute the next time update for a callback federate

+

Parameters

+
    +
  • fed: The federate to set the callback for.
    • +
  • time_update: A callback with signature HelicsTime(HelicsTime time, void *user_data);
    • +
  • user_data: A pointer to user data that is passed to the function when executing.
    • +
+
+

helicsCleanupLibrary

+
def helicsCleanupLibrary()
+
+

Function to do some housekeeping work. +This runs some cleanup routines and tries to close out any residual thread that haven’t been shutdown yet.

+
+

helicsClearSignalHandler

+
def helicsClearSignalHandler()
+
+
+

helicsCloseLibrary

+
def helicsCloseLibrary()
+
+

Call when done using the helics library. +This function will ensure the threads are closed properly. If possible this should be the last call before exiting.

+
+

helicsCoreAddAlias

+
def helicsCoreAddAlias(core: HelicsCore, interface_name: str, alias: str)
+
+

Create an alias for an interface.

+

Parameters

+
    +
  • interface_name: The current name of an interface.
    • +
  • alias: The additional name to use for the given interface.
    • +
+
+

helicsCoreAddDestinationFilterToEndpoint

+
def helicsCoreAddDestinationFilterToEndpoint(core: HelicsCore, filter_name: str, endpoint_name: str)
+
+

Link a named filter to a destination endpoint.

+

Parameters

+
    +
  • core - The core to generate the connection from.
    • +
  • filter - The name of the filter.
    • +
  • endpoint - The name of the endpoint to filter the data going to.
    • +
+
+

helicsCoreAddSourceFilterToEndpoint

+
def helicsCoreAddSourceFilterToEndpoint(core: HelicsCore, filter_name: str, endpoint_name: str)
+
+

Link a named filter to a source endpoint.

+

Parameters

+
    +
  • core - The core to generate the connection from.
    • +
  • filter - The name of the filter.
    • +
  • endpoint - The name of the endpoint to filter the data from.
    • +
+
+

helicsCoreClone

+
def helicsCoreClone(core: HelicsCore) -> HelicsCore
+
+

Create a new reference to an existing core. +This will create a new helics.HelicsCore that references the existing core. +The new helics.HelicsCore must be freed as well.

+

Parameters

+
    +
  • core - An existing helics.HelicsCore.
    • +
+

Returns: helics.HelicsCore.

+
+

helicsCoreConnect

+
def helicsCoreConnect(core: HelicsCore) -> bool
+
+

Connect a core to the federate based on current configuration.

+

Parameters

+
    +
  • core - The core to connect.
    • +
+

Returns: True if core is connected successfully, else False.

+
+ +
def helicsCoreDataLink(core: HelicsCore, source_name: str, target_name: str)
+
+

Link a named publication and named input using a core.

+

Parameters

+
    +
  • core - The core to generate the connection from.
    • +
  • source_name - The name of the publication.
    • +
  • target_name - The name of the target to send the publication data.
    • +
+
+

helicsCoreDestroy

+
def helicsCoreDestroy(core: HelicsCore)
+
+

Disconnect and free a core.

+
+

helicsCoreDisconnect

+
def helicsCoreDisconnect(core: HelicsCore)
+
+

Disconnect a core from the federation.

+

Parameters

+
    +
  • core - The core to query.
    • +
+
+

helicsCoreFree

+
def helicsCoreFree(core: HelicsCore)
+
+

Release the memory associated with a core.

+
+

helicsCoreGetAddress

+
def helicsCoreGetAddress(core: HelicsCore) -> str
+
+

Get the network address associated with a core.

+

Parameters

+
    +
  • core - The core to query.
    • +
+

Returns: A string with the network address of the broker.

+
+

helicsCoreGetIdentifier

+
def helicsCoreGetIdentifier(core: HelicsCore) -> str
+
+

Get an identifier for the core.

+

Parameters

+
    +
  • core - The core to query.
    • +
+

Returns: A string with the identifier of the core.

+
+

helicsCoreGlobalError

+
def helicsCoreGlobalError(core: HelicsCore, error_code: int, error_string: str)
+
+
+

helicsCoreIsConnected

+
def helicsCoreIsConnected(core: HelicsCore) -> bool
+
+

Check if a core is connected. +A connected core implies it is attached to federates or federates could be attached to it.

+

Returns: True if connected, False if not connected.

+
+

helicsCoreIsValid

+
def helicsCoreIsValid(core: HelicsCore) -> bool
+
+

Check if a helics.HelicsCore is a valid object.

+

Parameters

+
    +
  • core - The helics.HelicsCore object to test.
    • +
+

Returns: True if valid, False if not valid.

+
+

helicsCoreMakeConnections

+
def helicsCoreMakeConnections(core: HelicsCore, file: str)
+
+

Load a file containing connection information.

+

Parameters

+
    +
  • core - The core to generate the connections from.
    • +
  • file - A JSON or TOML file containing connection information.
    • +
+
+

helicsCoreRegisterCloningFilter

+
def helicsCoreRegisterCloningFilter(core: HelicsCore, name: str) -> HelicsCloningFilter
+
+

Create a cloning Filter on the specified core. +Cloning filters copy a message and send it to multiple locations, source and destination can be added through other functions.

+

Parameters

+
    +
  • core - The core to register through.
    • +
  • name - The name of the filter (can be NULL).
    • +
+

Returns: helics.HelicsFilter.

+
+

helicsCoreRegisterFilter

+
def helicsCoreRegisterFilter(core: HelicsCore, type: HelicsFilterType, name: str) -> HelicsFilter
+
+

Create a source Filter on the specified core. +Filters can be created through a federate or a core.handle, linking through a federate allows a few extra features of name matching to function on the federate interface but otherwise equivalent behavior.

+

Parameters

+
    +
  • core - The core to register through.
    • +
  • type - The type of filter to create helics.HelicsFilterType.
    • +
  • name - The name of the filter (can be NULL).
    • +
+

Returns: helics.HelicsFilter.

+
+

helicsCoreRegisterTranslator

+
def helicsCoreRegisterTranslator(core: HelicsCore, type: HelicsTranslatorTypes, name: str) -> HelicsTranslator
+
+

Create a source Translator on the specified core.

+

Translators can be created through a federate or a core, linking through a federate allows a few extra features of name matching to function on the federate interface but otherwise equivalent behavior.

+

Parameters

+
    +
  • core - The core to register through.
    • +
  • type - The type of translator to create /ref HelicsTranslatorTypes.
    • +
  • name - The name of the translator (can be NULL).
    • +
+

Returns: helics.HelicsTranslator.

+
+

helicsCoreSendCommand

+
def helicsCoreSendCommand(core, target, command, err)
+
+

Send a command to another helics object through a core using asynchronous(fast) messages.

+
    +
  • core: The broker to send the command through.
    • +
  • target: The name of the object to send the command to.
    • +
  • command: The command to send.
    • +
+
+

helicsCoreSendOrderedCommand

+
def helicsCoreSendOrderedCommand(core, target, command, err)
+
+

Send a command to another helics object through a core using ordered sequencing.

+
    +
  • core: The broker to send the command through.
    • +
  • target: The name of the object to send the command to.
    • +
  • command: The command to send.
    • +
+
+

helicsCoreSetGlobal

+
def helicsCoreSetGlobal(core: HelicsCore, name: str, value: str)
+
+

Set a global value in a core. +This overwrites any previous value for this name.

+

Parameters

+
    +
  • core - The core to set the global through.
    • +
  • name - The name of the global to set.
    • +
  • value - The value of the global.
    • +
+
+

helicsCoreSetLogFile

+
def helicsCoreSetLogFile(core: HelicsCore, log_file: str)
+
+

Set the log file on a core.

+

Parameters

+
    +
  • core - The core to set the log file for.
    • +
  • log_file - The name of the file to log to.
    • +
+
+

helicsCoreSetLoggingCallback

+
def helicsCoreSetLoggingCallback(core: HelicsCore, logger, user_data)
+
+

Set the logging callback for a helics.HelicsCore

+

Add a logging callback function for the C. +The logging callback will be called when a message flows from helics.HelicsCore or from the core.

+

Parameters

+
    +
  • core: the helics.HelicsCore that is created with helics.helicsCreateCore
    • +
  • logger: a callback with signature void(int, const char *, const char *, void *); the function arguments are loglevel, an identifier string, and a message string, and a pointer to user data
    • +
  • user_data: a pointer to user data that is passed to the function when executing
    • +
+
+

helicsCoreSetReadyToInit

+
def helicsCoreSetReadyToInit(core: HelicsCore)
+
+

Set the core to ready for init. +This function is used for cores that have filters but no federates so there needs to be a direct signal to the core to trigger the federation initialization.

+

Parameters

+
    +
  • core - The helics.HelicsCore to enable init values for.
    • +
+
+

helicsCoreWaitForDisconnect

+
def helicsCoreWaitForDisconnect(core: HelicsCore, ms_to_wait: int) -> bool
+
+

Wait for the core to disconnect.

+

Parameters

+
    +
  • core - The core to wait for.
    • +
  • ms_to_wait - The time out in millisecond (<0 for infinite timeout).
    • +
+
+

helicsCreateBroker

+
def helicsCreateBroker(type: str, name: str = "", init_string: str = "") -> HelicsBroker
+
+

Create a broker object

+

Parameters

+
    +
  • type - The type of the broker to create.
    • +
  • name - The name of the broker. It can be a nullptr or empty string to have a name automatically assigned.
    • +
  • init_string - An initialization string to send to the core-the format is similar to command line arguments. Typical options include a broker address such as –broker=”XSSAF” if this is a subbroker, or the number of federates, or the address.
    • +
+

Returns: helics.HelicsBroker.

+
+

helicsCreateBrokerFromArgs

+
def helicsCreateBrokerFromArgs(type: str, name: str, arguments: List[str]) -> HelicsBroker
+
+

Create a helics.HelicsCore by passing command line arguments.

+

Parameters

+
    +
  • type - The type of the core to create.
    • +
  • name - The name of the core. It can be a nullptr or empty string to have a name automatically assigned.
    • +
  • arguments - The list of string values from a command line.
    • +
+

Returns: helics.HelicsBroker.

+
+

helicsCreateCallbackFederate

+
def helicsCreateCallbackFederate(fed_name: str, fedInfo: HelicsFederateInfo = None) -> HelicsCallbackFederate
+
+

Create a callback federate from helics.HelicsFederateInfo. +Callback federates are both value federates and message federates, objects can be used in all functions +that take a helics.HelicsFederate object as an argument.

+
    +
  • fed_name - A string with the name of the federate, can be NULL or an empty string to pull the default name from fi.
    • +
  • fedInfo - The federate info object that contains details on the federate.
    • +
+

Returns: helics.HelicsCallbackFederate.

+
+

helicsCreateCallbackFederateFromConfig

+
def helicsCreateCallbackFederateFromConfig(config_file: str) -> HelicsCallbackFederate
+
+

Create a callback federate from a JSON file or JSON string or TOML file. +Callback federates are both value federates and message federates, objects can be used in all functions +that take a helics.HelicsFederate object as an argument.

+

Parameters

+
    +
  • config_file - A JSON file or a JSON string or TOML file that contains setup and configuration information.
    • +
+

Returns: helics.HelicsCallbackFederate.

+
+

helicsCreateCombinationFederate

+
def helicsCreateCombinationFederate(fed_name: str, fedInfo: HelicsFederateInfo = None) -> HelicsCombinationFederate
+
+

Create a combination federate from helics.HelicsFederateInfo. +Combination federates are both value federates and message federates, objects can be used in all functions +that take a helics.HelicsFederate object as an argument.

+

Parameters

+
    +
  • fed_name - A string with the name of the federate, can be NULL or an empty string to pull the default name from fi.
    • +
  • fedInfo - The federate info object that contains details on the federate.
    • +
+

Returns: helics.HelicsCombinationFederate.

+
+

helicsCreateCombinationFederateFromConfig

+
def helicsCreateCombinationFederateFromConfig(config_file: str) -> HelicsCombinationFederate
+
+

Create a combination federate from a JSON file or JSON string or TOML file. +Combination federates are both value federates and message federates, objects can be used in all functions +that take a helics.HelicsFederate object as an argument.

+

Parameters

+
    +
  • config_file - A JSON file or a JSON string or TOML file that contains setup and configuration information.
    • +
+

Returns: helics.HelicsCombinationFederate.

+
+

helicsCreateCore

+
def helicsCreateCore(type: str, name: str = "", init_string: str = "") -> HelicsCore
+
+

Create a helics.HelicsCore.

+

Parameters

+
    +
  • type - The type of the core to create.
    • +
  • name - The name of the core. It can be a nullptr or empty string to have a name automatically assigned.
    • +
  • init_string - An initialization string to send to the core. The format is similar to command line arguments. Typical options include a broker name, the broker address, the number of federates, etc.
    • +
+

Returns: helics.HelicsCore.

+
+

helicsCreateCoreFromArgs

+
def helicsCreateCoreFromArgs(type: str, name: str, arguments: List[str]) -> HelicsCore
+
+

Create a helics.HelicsCore by passing command line arguments.

+

Parameters

+
    +
  • type - The type of the core to create.
    • +
  • name - The name of the core. It can be a nullptr or empty string to have a name automatically assigned.
    • +
  • arguments - The list of string values from a command line.
    • +
+

Returns: helics.HelicsCore.

+
+

helicsCreateDataBuffer

+
def helicsCreateDataBuffer(initial_capacity: int) -> HelicsDataBuffer
+
+

Create a helics managed data buffer with initial capacity

+
+

helicsCreateFederateInfo

+
def helicsCreateFederateInfo() -> HelicsFederateInfo
+
+

Create helics.HelicsFederateInfo for specifying federate information when constructing a federate.

+

Returns: helics.HelicsFederateInfo.

+
+

helicsCreateMessageFederate

+
def helicsCreateMessageFederate(fed_name: str, fedInfo: HelicsFederateInfo = None) -> HelicsMessageFederate
+
+

Create helics.HelicsMessageFederate from helics.HelicsFederateInfo. +helics.HelicsMessageFederate objects can be used in all functions that take a helics.HelicsFederate as an argument.

+

Parameters

+
    +
  • fed_name - The name of the federate to create.
    • +
  • fedInfo - The federate info object that contains details on the federate.
    • +
+

Returns: helics.HelicsMessageFederate.

+
+

helicsCreateMessageFederateFromConfig

+
def helicsCreateMessageFederateFromConfig(config_file: str) -> HelicsMessageFederate
+
+

Create helics.HelicsMessageFederate from a JSON file or JSON string or TOML file. +helics.HelicsMessageFederate objects can be used in all functions that take a helics.HelicsFederate object as an argument.

+

Parameters

+
    +
  • config_file - A config (JSON,TOML) file or a JSON string that contains setup and configuration information.
    • +
+

Returns: helics.HelicsMessageFederate.

+
+

helicsCreateQuery

+
def helicsCreateQuery(target_name: str, query_string: str) -> HelicsQuery
+
+

Create a query object. +A query object consists of a target and query string.

+

Parameters

+
    +
  • target_name - The name of the target to query.
    • +
  • query_string - The query to make of the target.
    • +
+

Returns: helics.HelicsQuery.

+
+

helicsCreateValueFederate

+
def helicsCreateValueFederate(fed_name: str, fedInfo: HelicsFederateInfo = None) -> HelicsValueFederate
+
+

Creation and destruction of Federates. +Create helics.HelicsValueFederate from helics.HelicsFederateInfo. +helics.HelicsValueFederate objects can be used in all functions that take a helics.HelicsFederate as an argument.

+

Parameters

+
    +
  • fed_name - The name of the federate to create, can NULL or an empty string to use the default name from fi or an assigned name.
    • +
  • fedInfo - The federate info object that contains details on the federate.
    • +
+

Returns: helics.HelicsValueFederate.

+
+

helicsCreateValueFederateFromConfig

+
def helicsCreateValueFederateFromConfig(config_file: str) -> HelicsValueFederate
+
+

Create helics.HelicsValueFederate from a JSON file, JSON string, or TOML file. +helics.HelicsValueFederate objects can be used in all functions that take a helics.HelicsFederate as an argument.

+

Parameters

+
    +
  • config_file - A JSON file or a JSON string or TOML file that contains setup and configuration information.
    • +
+

Returns: helics.HelicsValueFederate.

+
+

helicsDataBufferCapacity

+
def helicsDataBufferCapacity(data: HelicsDataBuffer) -> int
+
+
+

helicsDataBufferClone

+
def helicsDataBufferClone(data: HelicsDataBuffer) -> HelicsDataBuffer
+
+
+

helicsDataBufferConvertToType

+
def helicsDataBufferConvertToType(data: HelicsDataBuffer, new_data_type: int)
+
+
+

helicsDataBufferData

+
def helicsDataBufferData(data: HelicsDataBuffer) -> bytes
+
+
+

helicsDataBufferFillFromBoolean

+
def helicsDataBufferFillFromBoolean(data: HelicsDataBuffer, value: bool) -> int
+
+

Convert a bool to serialized bytes

+
+

helicsDataBufferFillFromChar

+
def helicsDataBufferFillFromChar(data: HelicsDataBuffer, value: str) -> int
+
+

Convert a bool to serialized bytes

+
+

helicsDataBufferFillFromComplex

+
def helicsDataBufferFillFromComplex(data: HelicsDataBuffer, value: complex) -> int
+
+

Convert a complex to serialized bytes

+
+

helicsDataBufferFillFromComplexObject

+
def helicsDataBufferFillFromComplexObject(data: HelicsDataBuffer, value: complex) -> int
+
+

Convert a complex to serialized bytes

+
+

helicsDataBufferFillFromComplexVector

+
def helicsDataBufferFillFromComplexVector(data: HelicsDataBuffer, value: List[complex]) -> int
+
+

Convert a complex to serialized bytes

+
+

helicsDataBufferFillFromDouble

+
def helicsDataBufferFillFromDouble(data: HelicsDataBuffer, value: float) -> int
+
+

Convert a double to serialized bytes

+
+

helicsDataBufferFillFromInteger

+
def helicsDataBufferFillFromInteger(data: HelicsDataBuffer, value: int) -> int
+
+

Convert an integer to serialized bytes

+
+

helicsDataBufferFillFromNamedPoint

+
def helicsDataBufferFillFromNamedPoint(data: HelicsDataBuffer, name: str, value: float) -> int
+
+

Convert a named point to serialized bytes

+
+

helicsDataBufferFillFromRawString

+
def helicsDataBufferFillFromRawString(data: HelicsDataBuffer, string: bytes) -> int
+
+

Convert a raw string to serialized bytes

+
+

helicsDataBufferFillFromString

+
def helicsDataBufferFillFromString(data: HelicsDataBuffer, string: str) -> int
+
+

Convert a string to serialized bytes

+
+

helicsDataBufferFillFromTime

+
def helicsDataBufferFillFromTime(data: HelicsDataBuffer, value: HelicsTime)
+
+

Convert a bool to serialized bytes

+
+

helicsDataBufferFillFromVector

+
def helicsDataBufferFillFromVector(data: HelicsDataBuffer, value: List[float]) -> int
+
+

Convert a complex to serialized bytes

+
+

helicsDataBufferFree

+
def helicsDataBufferFree(data: HelicsDataBuffer)
+
+
+

helicsDataBufferIsValid

+
def helicsDataBufferIsValid(data: HelicsDataBuffer) -> bool
+
+
+

helicsDataBufferReserve

+
def helicsDataBufferReserve(data: HelicsDataBuffer, new_capacity) -> bool
+
+
+

helicsDataBufferSize

+
def helicsDataBufferSize(data: HelicsDataBuffer) -> int
+
+
+

helicsDataBufferStringSize

+
def helicsDataBufferStringSize(data: HelicsDataBuffer) -> int
+
+
+

helicsDataBufferToBoolean

+
def helicsDataBufferToBoolean(data: HelicsDataBuffer) -> bool
+
+
+

helicsDataBufferToChar

+
def helicsDataBufferToChar(data: HelicsDataBuffer) -> str
+
+
+

helicsDataBufferToComplex

+
def helicsDataBufferToComplex(data: HelicsDataBuffer) -> complex
+
+
+

helicsDataBufferToComplexObject

+
def helicsDataBufferToComplexObject(data: HelicsDataBuffer) -> complex
+
+
+

helicsDataBufferToComplexVector

+
def helicsDataBufferToComplexVector(data: HelicsDataBuffer) -> List[complex]
+
+
+

helicsDataBufferToDouble

+
def helicsDataBufferToDouble(data: HelicsDataBuffer) -> float
+
+
+

helicsDataBufferToInteger

+
def helicsDataBufferToInteger(data: HelicsDataBuffer) -> int
+
+
+

helicsDataBufferToNamedPoint

+
def helicsDataBufferToNamedPoint(data: HelicsDataBuffer) -> Tuple[str, float]
+
+
+

helicsDataBufferToRawString

+
def helicsDataBufferToRawString(data: HelicsDataBuffer) -> str
+
+
+

helicsDataBufferToString

+
def helicsDataBufferToString(data: HelicsDataBuffer) -> str
+
+
+

helicsDataBufferToTime

+
def helicsDataBufferToTime(data: HelicsDataBuffer) -> HelicsTime
+
+
+

helicsDataBufferToVector

+
def helicsDataBufferToVector(data: HelicsDataBuffer) -> List[float]
+
+
+

helicsDataBufferType

+
def helicsDataBufferType(data: HelicsDataBuffer) -> int
+
+
+

helicsDataBufferVectorSize

+
def helicsDataBufferVectorSize(data: HelicsDataBuffer) -> int
+
+
+

helicsEndpointAddDestinationFilter

+
def helicsEndpointAddDestinationFilter(endpoint: HelicsEndpoint, filter_name: str)
+
+

Add destination filter to endpoint

+

Parameters

+
    +
  • endpoint - The endpoint.
    • +
  • filter_name - The name of the filter.
    • +
+
+

helicsEndpointAddDestinationTarget

+
def helicsEndpointAddDestinationTarget(endpoint: HelicsEndpoint, destination_name: str)
+
+

Add a destination target to a endpoint. +All messages coming from a source are copied to the delivery address(es).

+

Parameters

+
    +
  • endpoint - The given endpoint.
    • +
  • source_name - The name of the endpoint to add as a source target.
    • +
+
+

helicsEndpointAddSourceFilter

+
def helicsEndpointAddSourceFilter(endpoint: HelicsEndpoint, filter_name: str)
+
+

Add source filter to endpoint

+

Parameters

+
    +
  • endpoint - The endpoint.
    • +
  • filter_name - The name of the filter.
    • +
+
+

helicsEndpointAddSourceTarget

+
def helicsEndpointAddSourceTarget(endpoint: HelicsEndpoint, source_name: str)
+
+

Add a source target to a endpoint. +All messages coming from a source are copied to the delivery address(es).

+

Parameters

+
    +
  • endpoint - The given endpoint.
    • +
  • source_name - The name of the endpoint to add as a source target.
    • +
+
+

helicsEndpointClearMessages

+
def helicsEndpointClearMessages(endpoint: HelicsEndpoint)
+
+

Clear all message from an endpoint.

+

_**Deprecated: Use helics.helicsFederateClearMessages to free all messages, or helics.helicsMessageFree to clear an individual message.

+

Parameters

+
    +
  • endpoint - The endpoint object to operate on.
    • +
+

DEPRECATED

+
+

helicsEndpointCreateMessage

+
def helicsEndpointCreateMessage(endpoint: HelicsEndpoint) -> HelicsMessage
+
+

Create a new empty message object. +The message is empty and isValid will return false since there is no data associated with the message yet.

+

Parameters

+
    +
  • endpoint - The endpoint object to associate the message with.
    • +
+
+

helicsEndpointCreateMessageObject

+
def helicsEndpointCreateMessageObject(endpoint: HelicsEndpoint) -> HelicsMessage
+
+

Create a new empty message. +The message is empty and isValid will return false since there is no data associated with the message yet.

+

Parameters

+
    +
  • endpoint - The endpoint object to associate the message with.
    • +
+

DEPRECATED

+
+

helicsEndpointGetDefaultDestination

+
def helicsEndpointGetDefaultDestination(endpoint: HelicsEndpoint) -> str
+
+

Get the default destination for an endpoint.

+

Parameters

+
    +
  • endpoint - The endpoint to set the destination for.
    • +
+

Returns: A string with the default destination.

+
+

helicsEndpointGetInfo

+
def helicsEndpointGetInfo(endpoint: HelicsEndpoint) -> str
+
+

Get the data in the info field of a filter.

+

Parameters

+
    +
  • end - The filter to query.
    • +
+

Returns: A string with the info field string.

+
+

helicsEndpointGetMessage

+
def helicsEndpointGetMessage(endpoint: HelicsEndpoint) -> HelicsMessage
+
+

Receive a packet from a particular endpoint.

+

Parameters

+
    +
  • endpoint - The identifier for the endpoint.
    • +
+

Returns: A message object.

+
+

helicsEndpointGetMessageObject

+
def helicsEndpointGetMessageObject(endpoint: HelicsEndpoint) -> HelicsMessage
+
+

Receive a packet from a particular endpoint.

+

Parameters

+
    +
  • endpoint - The identifier for the endpoint.
    • +
+

Returns: A message.

+

DEPRECATED

+
+

helicsEndpointGetName

+
def helicsEndpointGetName(endpoint: HelicsEndpoint) -> str
+
+

Get the name of an endpoint.

+

Parameters

+
    +
  • endpoint - The endpoint object in question.
    • +
+

Returns: The name of the endpoint.

+
+

helicsEndpointGetOption

+
def helicsEndpointGetOption(endpoint: HelicsEndpoint, option: HelicsHandleOption) -> int
+
+

Get the value of handle option on an endpoint.

+

Parameters

+
    +
  • endpoint - The endpoint to modify.
    • +
  • option - Integer code for the option to set helics.HelicsHandleOption.
    • +
+

Returns: the value of the option, for boolean options will be 0 or 1.

+
+

helicsEndpointGetTag

+
def helicsEndpointGetTag(endpoint: HelicsEndpoint, tagname: str)
+
+

Get the data in a specified tag of a endpoint.

+

Parameters

+
    +
  • endpoint: The endpoint object to query.
    • +
  • tagname: The name of the tag to query.
    • +
+

Returns

+

A string with the tag data.

+
+

helicsEndpointGetType

+
def helicsEndpointGetType(endpoint: HelicsEndpoint) -> str
+
+

Get the type specified for an endpoint.

+

Parameters

+
    +
  • endpoint - The endpoint object in question.
    • +
+

Returns: The defined type of the endpoint.

+
+

helicsEndpointHasMessage

+
def helicsEndpointHasMessage(endpoint: HelicsEndpoint) -> bool
+
+

Check if a given endpoint has any unread messages.

+

Parameters

+
    +
  • endpoint - The endpoint to check.
    • +
+

Returns: True if the endpoint has a message, False otherwise.

+
+

helicsEndpointIsValid

+
def helicsEndpointIsValid(endpoint: HelicsEndpoint) -> bool
+
+

Check if an endpoint is valid.

+

Parameters

+
    +
  • endpoint - The endpoint object to check.
    • +
+

Returns: True if the Endpoint object represents a valid endpoint.

+
+

helicsEndpointPendingMessageCount

+
def helicsEndpointPendingMessageCount(endpoint: HelicsEndpoint) -> int
+
+

Returns the number of pending receives for all endpoints of a particular federate.

+

Parameters

+
    +
  • endpoint - The endpoint to query.
    • +
+
+

helicsEndpointPendingMessages

+
def helicsEndpointPendingMessages(endpoint: HelicsEndpoint) -> int
+
+

Returns the number of pending receives for all endpoints of a particular federate.

+

Parameters

+
    +
  • endpoint - The endpoint to query.
    • +
+

DEPRECATED

+
+

helicsEndpointRemoveTarget

+
def helicsEndpointRemoveTarget(endpoint: HelicsEndpoint, target: str)
+
+

Remove target from endpoint

+

Parameters

+
    +
  • endpoint - The given endpoint.
    • +
  • target_name - The name of the endpoint to remove.
    • +
+
+

helicsEndpointSendBytes

+
def helicsEndpointSendBytes(endpoint: HelicsEndpoint, data: bytes)
+
+

Send a message from a specific endpoint.

+

Parameters

+
    +
  • endpoint - The endpoint to send the data from.
    • +
  • data - The data to send
    • +
+
+

helicsEndpointSendBytesAt

+
def helicsEndpointSendBytesAt(endpoint: HelicsEndpoint, data: bytes, time: HelicsTime)
+
+

Send a message at a specific time to the targeted destinations

+
    +
  • endpoint: The endpoint to send the data from.
    • +
  • data: The data to send.
    • +
  • time: The time the message should be sent.
    • +
+
+

helicsEndpointSendBytesTo

+
def helicsEndpointSendBytesTo(endpoint: HelicsEndpoint, data: bytes, destination: str)
+
+

Send a message to the specified destination.

+

Parameters

+
    +
  • endpoint - The endpoint to send the data from.
    • +
  • data - The data to send.
    • +
  • destination - The target destination.
    • +
+
+

helicsEndpointSendBytesToAt

+
def helicsEndpointSendBytesToAt(endpoint: HelicsEndpoint, data: bytes, destination: str, time: HelicsTime)
+
+

Send a message at a specific time to the specified destination.

+

Parameters

+
    +
  • endpoint - The endpoint to send the data from.
    • +
  • data - The data to send.
    • +
  • destination - The target destination.
    • +
  • time - The time the message should be sent.
    • +
+
+

helicsEndpointSendEventRaw

+
def helicsEndpointSendEventRaw(
+    endpoint: HelicsEndpoint,
+    destination: str,
+    data: bytes,
+    time: HelicsTime,
+)
+
+

Send a message at a specific time to the specified destination.

+

Parameters

+
    +
  • endpoint - The endpoint to send the data from.
    • +
  • destination - The target destination.
    • +
  • data - The data to send.
    • +
  • time - The time the message should be sent.
    • +
+

DEPRECATED

+

Use helicsEndpointSendBytesToAt instead.

+
+

helicsEndpointSendMessage

+
def helicsEndpointSendMessage(endpoint: HelicsEndpoint, message: HelicsMessage)
+
+

Send a message object from a specific endpoint.

+

Parameters

+
    +
  • endpoint - The endpoint to send the data from.
    • +
  • message - The actual message to send which will be copied.
    • +
+
+

helicsEndpointSendMessageObject

+
def helicsEndpointSendMessageObject(endpoint: HelicsEndpoint, message: HelicsMessage)
+
+

Send a message object from a specific endpoint.

+

Parameters

+
    +
  • endpoint - The endpoint to send the data from.
    • +
  • message - The actual message to send which will be copied.
    • +
+

DEPRECATED

+
+

helicsEndpointSendMessageObjectZeroCopy

+
def helicsEndpointSendMessageObjectZeroCopy(endpoint: HelicsEndpoint, message: HelicsMessage)
+
+

Send a message object from a specific endpoint.

+

Parameters

+
    +
  • endpoint - The endpoint to send the data from.
    • +
  • message - The actual message to send which will be copied.
    • +
+

DEPRECATED

+
+

helicsEndpointSendMessageRaw

+
def helicsEndpointSendMessageRaw(endpoint: HelicsEndpoint, destination: str, data: bytes)
+
+

Send a message to the specified destination.

+

Parameters

+
    +
  • endpoint - The endpoint to send the data from.
    • +
  • destination - The target destination.
    • +
  • data - The data to send.
    • +
+

DEPRECATED

+

Use helicsEndpointSendBytesTo instead

+
+

helicsEndpointSendMessageZeroCopy

+
def helicsEndpointSendMessageZeroCopy(endpoint: HelicsEndpoint, message: HelicsMessage)
+
+

Send a message object from a specific endpoint, the message will not be copied and the message object will no longer be valid after the call.

+

Parameters

+
    +
  • endpoint - The endpoint to send the data from.
    • +
  • message - The actual message to send which will be copied.
    • +
+
+

helicsEndpointSetDefaultDestination

+
def helicsEndpointSetDefaultDestination(endpoint: HelicsEndpoint, destination: str)
+
+

Set the default destination for an endpoint if no other endpoint is given.

+

Parameters

+
    +
  • endpoint - The endpoint to set the destination for.
    • +
  • destination - A string naming the desired default endpoint.
    • +
+
+

helicsEndpointSetInfo

+
def helicsEndpointSetInfo(endpoint: HelicsEndpoint, info: str)
+
+

Set the data in the info field for a filter.

+

Parameters

+
    +
  • endpoint - The endpoint to query.
    • +
  • info - The string to set.
    • +
+
+

helicsEndpointSetOption

+
def helicsEndpointSetOption(endpoint: HelicsEndpoint, option: HelicsHandleOption, value: int)
+
+

Set a handle option on an endpoint.

+

Parameters

+
    +
  • endpoint - The endpoint to modify.
    • +
  • option - Integer code for the option to set helics.HelicsHandleOption.
    • +
  • value - The value to set the option to.
    • +
+
+

helicsEndpointSetTag

+
def helicsEndpointSetTag(endpoint: HelicsEndpoint, tagname: str, tagvalue: str)
+
+

Set the data in a specific tag for a endpoint.

+

endpoint: The endpoint object to set a tag for. +tagname: The name of the tag to set. +tagvalue: The string value to associate with a tag.

+
+

helicsEndpointSubscribe

+
def helicsEndpointSubscribe(endpoint: HelicsEndpoint, name: str)
+
+

Subscribe an endpoint to a publication.

+

Parameters

+
    +
  • endpoint - The endpoint to use.
    • +
  • name - The name of the publication.
    • +
+
+

helicsErrorClear

+
def helicsErrorClear(err: HelicsError)
+
+

Clear an error object.

+
+

helicsErrorInitialize

+
def helicsErrorInitialize()
+
+

Return an initialized error object.

+
+

helicsFederateAddAlias

+
def helicsFederateAddAlias(fed: HelicsFederate, interface_name: str, alias: str)
+
+

Create an alias for an interface.

+

Parameters

+
    +
  • interface_name: The current name of an interface.
    • +
  • alias: The additional name to use for the given interface.
    • +
+
+

helicsFederateAddDependency

+
def helicsFederateAddDependency(fed: HelicsFederate, name: str)
+
+

Add a time dependency for a federate. The federate will depend on the given named federate for time synchronization.

+

Parameters

+
    +
  • fed - The federate to add the dependency for.
    • +
  • name - The name of the federate to depend on.
    • +
+
+

helicsFederateClearMessages

+
def helicsFederateClearMessages(fed: HelicsFederate)
+
+

Clear all stored messages from a federate. +This clears messages retrieved through helics.helicsFederateGetMessage or helics.helicsFederateGetMessageObject.

+

Parameters

+
    +
  • fed - The federate to clear the message for.
    • +
+
+

helicsFederateClearUpdates

+
def helicsFederateClearUpdates(fed: HelicsFederate)
+
+

Clear all the update flags from a federates inputs.

+

Parameters

+
    +
  • fed - The value helics.HelicsFederate for which to clear update flags.
    • +
+
+

helicsFederateClone

+
def helicsFederateClone(fed: HelicsFederate) -> HelicsFederate
+
+

Create a new reference to an existing federate. +This will create a new helics.HelicsFederate object that references the existing federate. +The new object must be freed as well.

+

Parameters

+
    +
  • fed - An existing helics.HelicsFederate.
    • +
+

Returns: helics.HelicsFederate.

+
+

helicsFederateCosimulationTerminationCallback

+
def helicsFederateCosimulationTerminationCallback(fed: HelicsFederate, cosim_termination, user_data)
+
+

Set callback for cosimulation termination

+

This callback will be executed once when the time advance of the federate/co-simulation has terminated. This may be called as part of the finalize operation, or when a maxTime signal is returned from requestTime or when an error is encountered

+

Parameters

+
    +
  • fed: The federate to set the callback for.
    • +
  • cosim_termination: A callback with signature void( void *user_data);
    • +
  • user_data: A pointer to user data that is passed to the function when executing.
    • +
+
+

helicsFederateCreateMessage

+
def helicsFederateCreateMessage(fed: HelicsFederate) -> HelicsMessage
+
+

Create a new empty message object. +The message is empty and isValid will return false since there is no data associated with the message yet.

+

Parameters

+
    +
  • fed - the helics.HelicsFederate to associate the message with.
    • +
+
+

helicsFederateCreateMessageObject

+
def helicsFederateCreateMessageObject(fed: HelicsFederate) -> HelicsMessage
+
+

Create a new empty message object. +The message is empty and isValid will return false since there is no data associated with the message yet.

+

Parameters

+
    +
  • fed - the helics.HelicsFederate to associate the message with.
    • +
+

DEPRECATED

+
+

helicsFederateDestroy

+
def helicsFederateDestroy(fed: HelicsFederate)
+
+

Disconnect and free a federate.

+
+

helicsFederateDisconnect

+
def helicsFederateDisconnect(fed: HelicsFederate)
+
+

Disconnect the federate. This function halts all communication in the federate and disconnects it from the core.

+
+

helicsFederateDisconnectAsync

+
def helicsFederateDisconnectAsync(fed: HelicsFederate)
+
+

Disconnect the federate in an async call.

+
+

helicsFederateDisconnectComplete

+
def helicsFederateDisconnectComplete(fed: HelicsFederate)
+
+

Complete the asynchronous disconnect call.

+
+

helicsFederateEnterExecutingMode

+
def helicsFederateEnterExecutingMode(fed: HelicsFederate)
+
+

Request that the federate enter the Execution mode. +This call is blocking until granted entry by the helics.HelicsCore. On return from this call the federate will be at time 0. For an asynchronous alternative call see helics.helicsFederateEnterExecutingModeAsync

+

Parameters

+
    +
  • fed - A federate to change modes.
    • +
+
+

helicsFederateEnterExecutingModeAsync

+
def helicsFederateEnterExecutingModeAsync(fed: HelicsFederate)
+
+

Request that the federate enter the Execution mode. +This call is non-blocking and will return immediately. Call helics.helicsFederateEnterExecutingModeComplete to finish the call sequence

+

Parameters

+
    +
  • fed - The helics.HelicsFederate to complete the call.
    • +
+
+

helicsFederateEnterExecutingModeComplete

+
def helicsFederateEnterExecutingModeComplete(fed: HelicsFederate)
+
+

Complete the call to helics.helicsFederateEnterExecutingModeAsync.

+

Parameters

+
    +
  • fed - The helics.HelicsFederate to complete the call.
    • +
+
+

helicsFederateEnterExecutingModeIterative

+
def helicsFederateEnterExecutingModeIterative(fed: HelicsFederate, iterate: HelicsIterationRequest) -> HelicsIterationResult
+
+

Request an iterative time. +This call allows for finer grain control of the iterative process than helics.helicsFederateRequestTime. It takes a time and iteration request, and returns a time and iteration status.

+

Parameters

+
    +
  • fed - The federate to make the request of.
    • +
  • iterate - helics.HelicsIterationRequest, i.e. the requested iteration mode.
    • +
+

Returns: helics.HelicsIterationResult.

+
+

helicsFederateEnterExecutingModeIterativeAsync

+
def helicsFederateEnterExecutingModeIterativeAsync(fed: HelicsFederate, iterate: HelicsIterationRequest)
+
+

Request an iterative entry to the execution mode. +This call allows for finer grain control of the iterative process than helics.helicsFederateRequestTime. It takes a time and iteration request, and returns a time and iteration status.

+

Parameters

+
    +
  • fed - The federate to make the request of.
    • +
  • iterate - helics.HelicsIterationRequest, i.e. the requested iteration mode.
    • +
+
+

helicsFederateEnterExecutingModeIterativeComplete

+
def helicsFederateEnterExecutingModeIterativeComplete(
+    fed: HelicsFederate,
+) -> HelicsIterationResult
+
+

Complete the asynchronous iterative call into ExecutionMode.

+

Parameters

+
    +
  • fed - The federate to make the request of.
    • +
+

Returns: helics.HelicsIterationResult.

+
+

helicsFederateEnterInitializingMode

+
def helicsFederateEnterInitializingMode(fed: HelicsFederate)
+
+

Initialization, execution, and time requests. +Enter the initialization state of a federate. +The initialization state allows initial values to be set and received if the iteration is requested on entry to the execution state. This is a blocking call and will block until the core allows it to proceed.

+

Parameters

+
    +
  • fed - The federate to operate on.
    • +
+
+

helicsFederateEnterInitializingModeAsync

+
def helicsFederateEnterInitializingModeAsync(fed: HelicsFederate)
+
+

Non blocking alternative to helics.helicsFederateEnterInitializingMode. +The function helicsFederateEnterInitializationModeFinalize must be called to finish the operation.

+

Parameters

+
    +
  • fed - The federate to operate on.
    • +
+
+

helicsFederateEnterInitializingModeComplete

+
def helicsFederateEnterInitializingModeComplete(fed: HelicsFederate)
+
+

Finalize the entry to initialize mode that was initiated with helics.helicsFederateEnterInitializingModeAsync.

+

Parameters

+
    +
  • fed - The federate desiring to complete the initialization step.
    • +
+
+

helicsFederateEnterInitializingModeIterative

+
def helicsFederateEnterInitializingModeIterative(fed: HelicsFederate)
+
+

Trigger a blocking call and return to created state after all federates have either triggered an iteration or are waiting to enter initializing mode.

+

Parameters

+
    +
  • fed - The federate to operate on.
    • +
+
+

helicsFederateEnterInitializingModeIterativeAsync

+
def helicsFederateEnterInitializingModeIterativeAsync(fed: HelicsFederate)
+
+

Non-blocking alternative to helics.helicsFederateEnterInitializingModeIterative.

+

A call to helics.helicsFederateEnterInitializingModeIterativeComplete should be made to complete the call sequence.

+

Parameters

+
    +
  • fed - The federate to operate on.
    • +
+
+

helicsFederateEnterInitializingModeIterativeComplete

+
def helicsFederateEnterInitializingModeIterativeComplete(fed: HelicsFederate)
+
+

Complete the call to enter initializing mode iterative that was initiated with helics.helicsFederateEnterInitializingModeIterativeAsync.

+

Parameters

+
    +
  • fed - The federate to operate on.
    • +
+
+

helicsFederateErrorHandlerCallback

+
def helicsFederateErrorHandlerCallback(fed: HelicsFederate, error_handler, user_data)
+
+

Set callback for error handling

+

This callback will be when a federate error is encountered

+

Parameters

+
    +
  • fed: The federate to set the callback for.
    • +
  • error_handler: A callback with signature void(int errorCode, const char *errorString, void *user_data);
    • +
  • user_data A pointer to user data that is passed to the function when executing.
    • +
+
+

helicsFederateExecutingEntryCallback

+
def helicsFederateExecutingEntryCallback(fed: HelicsFederate, executing_entry, user_data)
+
+

Set callback for the entry to ExecutingMode.

+

This callback will be executed once on first entry to executing Mode

+

Parameters

+
    +
  • fed: The federate to set the callback for.
    • +
  • executing_entry: A callback with signature void( void *user_data);
    • +
  • user_data: A pointer to user data that is passed to the function when executing.
    • +
+
+

helicsFederateFinalize

+
def helicsFederateFinalize(fed: HelicsFederate)
+
+

Finalize the federate. This function halts all communication in the federate and disconnects it from the core.

+

DEPRECATED

+
+

helicsFederateFinalizeAsync

+
def helicsFederateFinalizeAsync(fed: HelicsFederate)
+
+

Finalize the federate in an async call.

+

DEPRECATED

+
+

helicsFederateFinalizeComplete

+
def helicsFederateFinalizeComplete(fed: HelicsFederate)
+
+

Complete the asynchronous disconnect call.

+

DEPRECATED

+
+

helicsFederateFree

+
def helicsFederateFree(fed: HelicsFederate)
+
+

Release the memory associated with a federate.

+
+

helicsFederateGetCommand

+
def helicsFederateGetCommand(fed: HelicsFederate) -> str
+
+
+

helicsFederateGetCommandSource

+
def helicsFederateGetCommandSource(fed: HelicsFederate) -> str
+
+
+

helicsFederateGetCore

+
def helicsFederateGetCore(fed: HelicsFederate) -> HelicsCore
+
+

Get the helics.HelicsCore associated with a federate.

+

Parameters

+
    +
  • fed - helics.HelicsFederate.
    • +
+

Returns: helics.HelicsCore.

+
+

helicsFederateGetCoreObject

+
def helicsFederateGetCoreObject(fed: HelicsFederate) -> HelicsCore
+
+

Get the helics.HelicsCore associated with a federate.

+

Parameters

+
    +
  • fed - helics.HelicsFederate.
    • +
+

Returns: helics.HelicsCore.

+

DEPRECATED

+
+

helicsFederateGetCurrentTime

+
def helicsFederateGetCurrentTime(fed: HelicsFederate) -> HelicsTime
+
+

Get the current time of the federate.

+

Parameters

+
    +
  • fed - The helics.HelicsFederate to query.
    • +
+

Returns: helics.HelicsTime.

+
+

helicsFederateGetEndpoint

+
def helicsFederateGetEndpoint(fed: HelicsFederate, name: str) -> HelicsEndpoint
+
+

Get an endpoint object from a name.

+

Parameters

+
    +
  • fed - The message helics.HelicsFederate to use to get the endpoint.
    • +
  • name - The name of the endpoint.
    • +
+

Returns: helics.HelicsEndpoint.

+
+

helicsFederateGetEndpointByIndex

+
def helicsFederateGetEndpointByIndex(fed: HelicsFederate, index: int) -> HelicsEndpoint
+
+

Get an endpoint by its index, typically already created via registerInterfaces file or something of that nature.

+

Parameters

+
    +
  • fed - The helics.HelicsFederate in which to create a publication.
    • +
  • index - The index of the publication to get.
    • +
+

Returns: helics.HelicsEndpoint.

+
+

helicsFederateGetEndpointCount

+
def helicsFederateGetEndpointCount(fed: HelicsFederate) -> int
+
+

Get the number of endpoints in a federate.

+

Parameters

+
    +
  • fed - The message federate to query.
    • +
+

Returns: (-1) if fed was not a valid federate, otherwise returns the number of endpoints.

+
+

helicsFederateGetFilter

+
def helicsFederateGetFilter(fed: HelicsFederate, name: str) -> HelicsFilter
+
+

Get a filter by its name, typically already created via registerInterfaces file or something of that nature.

+

Parameters

+
    +
  • fed - The helics.HelicsFederate to use to get the filter.
    • +
  • name - The name of the filter.
    • +
+

Returns: helics.HelicsFilter.

+
+

helicsFederateGetFilterByIndex

+
def helicsFederateGetFilterByIndex(fed: HelicsFederate, index: int) -> HelicsFilter
+
+

Get a filter by its index, typically already created via registerInterfaces file or something of that nature.

+

Parameters

+
    +
  • fed - The helics.HelicsFederate in which to create a publication.
    • +
  • index - The index of the publication to get.
    • +
+

Returns: helics.HelicsFilter.

+
+

helicsFederateGetFilterCount

+
def helicsFederateGetFilterCount(fed: HelicsFederate) -> int
+
+

Get the number of filters registered through a federate.

+

Parameters

+
    +
  • fed - The helics.HelicsFederate to use to get the filter.
    • +
+

Returns: A count of the number of filters registered through a federate.

+
+

helicsFederateGetFlagOption

+
def helicsFederateGetFlagOption(fed: HelicsFederate, flag: Union[int, HelicsFederateFlag, HelicsFlag]) -> bool
+
+

Get a flag value for a federate.

+

Parameters

+
    +
  • fed - The federate to get the flag for.
    • +
  • flag - The helics.HelicsFederateFlag to query.
    • +
+
+

helicsFederateGetInput

+
def helicsFederateGetInput(fed: HelicsFederate, name: str) -> HelicsInput
+
+

Get an input object from a name.

+

Parameters

+
    +
  • fed - The value helics.HelicsFederate to use to get the publication.
    • +
  • name - The name of the input.
    • +
+

Returns: helics.HelicsInput.

+
+

helicsFederateGetInputByIndex

+
def helicsFederateGetInputByIndex(fed: HelicsFederate, index: int) -> HelicsInput
+
+

Get an input by its index, typically already created via registerInterfaces file or something of that nature.

+

Parameters

+
    +
  • fed - The helics.HelicsFederate in which to create a publication.
    • +
  • index - The index of the publication to get.
    • +
+

Returns: helics.HelicsInput

+
+

helicsFederateGetInputByTarget

+
def helicsFederateGetInputByTarget(fed: HelicsFederate, target: str) -> HelicsInput
+
+

Get an input object from a target.

+

Parameters

+
    +
  • fed - The value helics.HelicsFederate to use to get the input.
    • +
  • target - The name of the publication that an input is targeting.
    • +
+

Returns: helics.HelicsInput

+
+

helicsFederateGetInputCount

+
def helicsFederateGetInputCount(fed: HelicsFederate) -> int
+
+

Get the number of subscriptions in a federate.

+

Returns: (-1) if fed was not a valid federate otherwise returns the number of subscriptions.

+
+

helicsFederateGetIntegerProperty

+
def helicsFederateGetIntegerProperty(fed: HelicsFederate, property: HelicsProperty) -> int
+
+

Get the current value of an integer property (such as a logging level).

+

Parameters

+
    +
  • fed - The federate to get the flag for.
    • +
  • property - A code for the property to set helics.HelicsProperty.
    • +
+
+

helicsFederateGetMessage

+
def helicsFederateGetMessage(fed: HelicsFederate) -> HelicsMessage
+
+

Receive a communication message for any endpoint in the federate. +The return order will be in order of endpoint creation. +So all messages that are available for the first endpoint.handle, then all for the second, and so on. +Within a single endpoint.handle, the messages are ordered by time, then source_id, then order of arrival.

+

Returns: A helics.HelicsMessage which references the data in the message.

+
+

helicsFederateGetMessageObject

+
def helicsFederateGetMessageObject(fed: HelicsFederate) -> HelicsMessage
+
+

Receive a communication message for any endpoint in the federate. +The return order will be in order of endpoint creation. +So all messages that are available for the first endpoint.handle, then all for the second, and so on. +Within a single endpoint.handle, the messages are ordered by time, then source_id, then order of arrival.

+

Returns: A helics.HelicsMessage which references the data in the message.

+

DEPRECATED

+
+

helicsFederateGetName

+
def helicsFederateGetName(fed: HelicsFederate) -> str
+
+

Get the name of the federate.

+

Parameters

+
    +
  • fed - The helics.HelicsFederate to query.
    • +
+

Returns: A string with the name.

+
+

helicsFederateGetPublication

+
def helicsFederateGetPublication(fed: HelicsFederate, name: str) -> HelicsPublication
+
+

Get a helics.HelicsPublication from a name.

+

Parameters

+
    +
  • fed - The value helics.HelicsFederate to use to get the publication.
    • +
  • name - The name of the publication.
    • +
+

Returns: helics.HelicsPublication.

+
+

helicsFederateGetPublicationByIndex

+
def helicsFederateGetPublicationByIndex(fed: HelicsFederate, index: int) -> HelicsPublication
+
+

Get a publication by its index, typically already created via registerInterfaces file or something of that nature.

+

Parameters

+
    +
  • fed - The helics.HelicsFederate in which to create a publication.
    • +
  • index - The index of the publication to get.
    • +
+

Returns: helics.HelicsPublication.

+
+

helicsFederateGetPublicationCount

+
def helicsFederateGetPublicationCount(fed: HelicsFederate) -> int
+
+

Get the number of publications in a federate.

+

Returns: (-1) if fed was not a valid federate otherwise returns the number of publications.

+
+

helicsFederateGetState

+
def helicsFederateGetState(fed: HelicsFederate) -> HelicsFederateState
+
+

Get the current state of a federate.

+

Parameters

+
    +
  • fed - The federate to query.
    • +
+

Returns: helics.HelicsFederateState.

+
+

helicsFederateGetSubscription

+
def helicsFederateGetSubscription(fed: HelicsFederate, name: str) -> HelicsInput
+
+

Get an input object from a subscription target.

+

Parameters

+
    +
  • fed - The value helics.HelicsFederate to use to get the publication.
    • +
  • name - The name of the publication that a subscription is targeting.
    • +
+

Returns: helics.HelicsInput

+

DEPRECATED

+
+

helicsFederateGetTag

+
def helicsFederateGetTag(fed: HelicsFederate, tagname: str)
+
+

Get the data in a specified tag of a federate.

+

Parameters

+
    +
  • fed: The federate object to query.
    • +
  • tagname: The name of the tag to query.
    • +
+

Returns

+

A string with the tag data.

+
+

helicsFederateGetTimeProperty

+
def helicsFederateGetTimeProperty(fed: HelicsFederate, time_property: int) -> HelicsTime
+
+

Get the current value of a time based property in a federate.

+

Parameters

+
    +
  • fed - The federate query.
    • +
  • time_property - The property to query.
    • +
+

Returns: helics.HelicsTime.

+
+

helicsFederateGetTranslator

+
def helicsFederateGetTranslator(fed: HelicsFederate, name: str) -> HelicsTranslator
+
+

Get a translator by its name, typically already created via registerInterfaces file or something of that nature.

+
    +
  • fed The federate object to use to get the translator.
    • +
  • name The name of the translator.
    • +
+

Returns: A helics.HelicsTranslator object

+
+

helicsFederateGetTranslatorByIndex

+
def helicsFederateGetTranslatorByIndex(fed: HelicsFederate, index: int) -> HelicsTranslator
+
+

Get a translator by its name, typically already created via registerInterfaces file or something of that nature.

+
    +
  • fed The federate object to use to get the translator.
    • +
  • index The index of the translator.
    • +
+

Returns: A helics.HelicsTranslator object

+
+

helicsFederateGetTranslatorCount

+
def helicsFederateGetTranslatorCount(fed: HelicsFederate) -> int
+
+

Get the number of translators registered through a federate.

+

Parameters

+
    +
  • fed - The federate object to use to get the translator.
    • +
+

Returns: A count of the number of translators registered through a federate.

+
+

helicsFederateGlobalError

+
def helicsFederateGlobalError(fed: HelicsFederate, error_code: int, error_string: str)
+
+

Generate a global error from a federate. +A global error halts the co-simulation completely.

+

Parameters

+
    +
  • fed - The federate to create an error in.
    • +
  • error_code - The integer code for the error.
    • +
  • error_string - A string describing the error.
    • +
+
+

helicsFederateHasMessage

+
def helicsFederateHasMessage(fed: HelicsFederate) -> bool
+
+

Check if the federate has any outstanding messages.

+

Parameters

+
    +
  • fed - The federate to check.
    • +
+

Returns: True if the federate has a message waiting, False otherwise.

+
+

helicsFederateInfoClone

+
def helicsFederateInfoClone(fedInfo: HelicsFederateInfo) -> HelicsFederateInfo
+
+

Create helics.HelicsFederateInfo from an existing one and clone the information.

+

Parameters

+
    +
  • fedInfo - A federateInfo object to duplicate.
    • +
+

Returns: helics.HelicsFederateInfo.

+
+

helicsFederateInfoFree

+
def helicsFederateInfoFree(fedInfo: HelicsFederateInfo)
+
+

Delete the memory associated with helics.HelicsFederateInfo.

+
+

helicsFederateInfoLoadFromArgs

+
def helicsFederateInfoLoadFromArgs(fedInfo: HelicsFederateInfo, arguments: List[str])
+
+

Load federate info from command line arguments.

+

Parameters

+
    +
  • fedInfo - A federateInfo object.
    • +
  • argc - The number of command line arguments.
    • +
  • argv - An array of strings from the command line.
    • +
+
+

helicsFederateInfoLoadFromString

+
def helicsFederateInfoLoadFromString(fedInfo: HelicsFederateInfo, arguments: str)
+
+

Load federate info from command line arguments contained in a string.

+

Parameters

+
    +
  • fedInfo - A federateInfo object.
    • +
  • arguments - Command line argument specified in a string
    • +
+
+

helicsFederateInfoSetBroker

+
def helicsFederateInfoSetBroker(fedInfo: HelicsFederateInfo, broker_string: str)
+
+

Set the name or connection information for a broker. +This is only used if the core is automatically created, the broker information will be transferred to the core for connection.

+

Parameters

+
    +
  • fedInfo - The federate info object to alter.
    • +
  • broker_string - A string which defines the connection information for a broker either a name or an address.
    • +
+
+

helicsFederateInfoSetBrokerInitString

+
def helicsFederateInfoSetBrokerInitString(fedInfo: HelicsFederateInfo, broker_init_string: str)
+
+

Set the initialization string that a core will pass to a generated broker usually in the form of command line arguments.

+

Parameters

+
    +
  • fedInfo - The federate info object to alter.
    • +
  • broker_init_string - A string with command line arguments for a generated broker.
    • +
+
+

helicsFederateInfoSetBrokerKey

+
def helicsFederateInfoSetBrokerKey(fedInfo: HelicsFederateInfo, broker_key: str)
+
+

Set the key for a broker connection. +This is only used if the core is automatically created, the broker information will be transferred to the core for connection.

+

Parameters

+
    +
  • fedInfo - The federate info object to alter.
    • +
  • broker_key - A string containing a key for the broker to connect.
    • +
+
+

helicsFederateInfoSetBrokerPort

+
def helicsFederateInfoSetBrokerPort(fedInfo: HelicsFederateInfo, broker_port: Union[int, str])
+
+

Set the port to use for the broker. +This is only used if the core is automatically created, the broker information will be transferred to the core for connection. +This will only be useful for network broker connections.

+

Parameters

+
    +
  • fedInfo - The federate info object to alter.
    • +
  • broker_port - The integer port number to use for connection with a broker.
    • +
+
+

helicsFederateInfoSetCoreInitString

+
def helicsFederateInfoSetCoreInitString(fedInfo: HelicsFederateInfo, core_init_string: str)
+
+

Set the initialization string for the core usually in the form of command line arguments.

+

Parameters

+
    +
  • fedInfo - The federate info object to alter.
    • +
  • core_init_string - A string containing command line arguments to be passed to the core.
    • +
+
+

helicsFederateInfoSetCoreName

+
def helicsFederateInfoSetCoreName(fedInfo: HelicsFederateInfo, core_name: str)
+
+

Set the name of the core to link to for a federate.

+

Parameters

+
    +
  • fedInfo - The federate info object to alter.
    • +
  • core_name - The identifier for a core to link to.
    • +
+
+

helicsFederateInfoSetCoreType

+
def helicsFederateInfoSetCoreType(fedInfo: HelicsFederateInfo, core_type: HelicsCoreType)
+
+

Set the core type by integer code. +Valid values available by definitions in api-data.h.

+

Parameters

+
    +
  • fedInfo - The federate info object to alter.
    • +
  • core_type - An numerical code for a core type see helics.HelicsCoreType.
    • +
+
+

helicsFederateInfoSetCoreTypeFromString

+
def helicsFederateInfoSetCoreTypeFromString(fedInfo: HelicsFederateInfo, core_type: str)
+
+

Set the core type from a string.

+

Parameters

+
    +
  • fedInfo - The federate info object to alter.
    • +
  • core_type - A string naming a core type.
    • +
+
+

helicsFederateInfoSetFlagOption

+
def helicsFederateInfoSetFlagOption(fedInfo: HelicsFederateInfo, flag: Union[int, HelicsFederateFlag, HelicsFlag], value: bool)
+
+

Set a flag in the info structure +Valid flags are available helics.HelicsFederateFlag.

+

Parameters

+
    +
  • fedInfo - The federate info object to alter.
    • +
  • flag - A numerical index for a flag.
    • +
  • value - The desired value of the flag True or False.
    • +
+
+

helicsFederateInfoSetIntegerProperty

+
def helicsFederateInfoSetIntegerProperty(fedInfo: HelicsFederateInfo, property: HelicsProperty, value: int)
+
+

Set an integer property for a federate. +Set known properties.

+

Parameters

+
    +
  • fedInfo - The federateInfo object to alter.
    • +
  • property - helics.HelicsProperty.
    • +
  • value - The value to set the property to.
    • +
+
+

helicsFederateInfoSetLocalPort

+
def helicsFederateInfoSetLocalPort(fedInfo: HelicsFederateInfo, local_port: Union[int, str])
+
+

Set the local port to use. +This is only used if the core is automatically created, the port information will be transferred to the core for connection.

+

Parameters

+
    +
  • fedInfo - The federate info object to alter.
    • +
  • local_port - A string with the port information to use as the local server port can be a number or “auto” or “os_local”.
    • +
+
+

helicsFederateInfoSetSeparator

+
def helicsFederateInfoSetSeparator(fedInfo: HelicsFederateInfo, separator: str)
+
+

Set the separator character in the info structure. +The separator character is the separation character for local publications/endpoints in creating their global name. +For example if the separator character is ‘/’ then a local endpoint would have a globally reachable name of fedName/localName.

+

Parameters

+
    +
  • fedInfo - The federate info object to alter.
    • +
  • separator - The character to use as a separator.
    • +
+
+

helicsFederateInfoSetTimeProperty

+
def helicsFederateInfoSetTimeProperty(fedInfo: HelicsFederateInfo, time_property: HelicsProperty, value: HelicsTime)
+
+

Set the output delay for a federate.

+

Parameters

+
    +
  • fedInfo - The federate info object to alter.
    • +
  • time_property - An integer representation of the time based property to set see helics.HelicsProperty.
    • +
  • propertyValue - The value of the property to set the timeProperty to.
    • +
+
+

helicsFederateInitializingEntryCallback

+
def helicsFederateInitializingEntryCallback(fed: HelicsFederate, initializing_entry, user_data)
+
+

Set callback for the entry to initializingMode.

+

This callback will be executed when the initializingMode is entered

+

Parameters

+
    +
  • fed: The federate to set the callback for.
    • +
  • initializing_entry: A callback with signature void(HelicsBool iterating, void *user_data); the bool parameter is set to true if the entry is iterative, therefore the first time this is called the bool is false. all subsequent times it is false.
    • +
  • user_data: A pointer to user data that is passed to the function when executing.
    • +
+
+

helicsFederateIsAsyncOperationCompleted

+
def helicsFederateIsAsyncOperationCompleted(fed: HelicsFederate) -> bool
+
+

Check if the current Asynchronous operation has completed.

+

Parameters

+
    +
  • fed - The federate to operate on.
    • +
+

Returns: True if current operation has completed, else False.

+
+

helicsFederateIsProtected

+
def helicsFederateIsProtected(fed_name: str) -> bool
+
+

Checks if an existing federate is protected

+

Parameters

+
    +
  • fedName: The name of an existing HelicsFederate.
    • +
+

Returns: boolean if existing federate is protected

+
+

helicsFederateIsValid

+
def helicsFederateIsValid(fed: HelicsFederate) -> bool
+
+

Check if a helics.HelicsFederate is valid.

+

Returns: True if the federate is a valid active federate, False otherwise.

+
+

helicsFederateLocalError

+
def helicsFederateLocalError(fed: HelicsFederate, error_code: int, error_string: str)
+
+

Generate a local error in a federate. +This will propagate through the co-simulation but not necessarily halt the co-simulation, it has a similar effect to finalize but does allow some interaction with a core for a brief time.

+

Parameters

+
    +
  • fed - The federate to create an error in.
    • +
  • error_code - The integer code for the error.
    • +
  • error_string - A string describing the error.
    • +
+
+

helicsFederateLogDebugMessage

+
def helicsFederateLogDebugMessage(fed: HelicsFederate, log_message: str)
+
+

Log a debug message through a federate.

+

Parameters

+
    +
  • fed - The federate to log the debug message through.
    • +
  • log_message - The message to put in the log.
    • +
+
+

helicsFederateLogErrorMessage

+
def helicsFederateLogErrorMessage(fed: HelicsFederate, log_message: str)
+
+

Log an error message through a federate.

+

Parameters

+
    +
  • fed - The federate to log the error message through.
    • +
  • log_message - The message to put in the log.
    • +
+
+

helicsFederateLogInfoMessage

+
def helicsFederateLogInfoMessage(fed: HelicsFederate, log_message: str)
+
+

Log an info message through a federate.

+

Parameters

+
    +
  • fed - The federate to log the info message through.
    • +
  • log_message - The message to put in the log.
    • +
+
+

helicsFederateLogLevelMessage

+
def helicsFederateLogLevelMessage(fed: HelicsFederate, log_level: HelicsLogLevel, log_message: str)
+
+

Log a message through a federate.

+

Parameters

+
    +
  • fed - The federate to log the message through.
    • +
  • log_level - The level of the message to log see helics.HelicsLogLevel.
    • +
  • log_message - The message to put in the log.
    • +
+
+

helicsFederateLogWarningMessage

+
def helicsFederateLogWarningMessage(fed: HelicsFederate, log_message: str)
+
+

Log a warning message through a federate.

+

Parameters

+
    +
  • fed - The federate to log the warning message through.
    • +
  • log_message - The message to put in the log.
    • +
+
+

helicsFederatePendingMessageCount

+
def helicsFederatePendingMessageCount(fed: HelicsFederate) -> int
+
+

Returns the number of pending receives for the specified destination endpoint.

+

Parameters

+
    +
  • fed - The federate to get the number of waiting messages from.
    • +
+
+

helicsFederatePendingMessages

+
def helicsFederatePendingMessages(fed: HelicsFederate) -> int
+
+

Returns the number of pending receives for the specified destination endpoint.

+

Parameters

+
    +
  • fed - The federate to get the number of waiting messages from.
    • +
+

DEPRECATED

+
+

helicsFederateProcessCommunications

+
def helicsFederateProcessCommunications(fed: HelicsFederate, period: HelicsTime)
+
+

Tell helics to process internal communications for a period of time.

+

Parameters

+
    +
  • fed: The federate to tell to process.
    • +
  • period: The length of time to process communications and then return control.
    • +
+
+

helicsFederateProtect

+
def helicsFederateProtect(fed_name: str)
+
+

Protect a federate from finalizing and closing if all references go out of scope

+

This function allows a federate to be retrieved on demand, it must be explicitly close later otherwise it will be destroyed +when the library is closed

+

Parameters

+
    +
  • fedName: The name of an existing HelicsFederate.
    • +
+
+

helicsFederatePublishJSON

+
def helicsFederatePublishJSON(fed: HelicsFederate, json: str)
+
+

Publish data contained in a JSON file or string.

+

Parameters

+
    +
  • fed - The value helics.HelicsFederate through which to publish the data.
    • +
  • json - The publication file name or literal JSON data string.
    • +
+
+

helicsFederateRegisterCloningFilter

+
def helicsFederateRegisterCloningFilter(fed: HelicsFederate, name: str) -> HelicsCloningFilter
+
+

Create a cloning Filter on the specified federate. +Cloning filters copy a message and send it to multiple locations, source and destination can be added through other functions.

+

Parameters

+
    +
  • fed - The federate to register through.
    • +
  • name - The name of the filter (can be NULL).
    • +
+

Returns: helics.HelicsCloningFilter.

+
+

helicsFederateRegisterEndpoint

+
def helicsFederateRegisterEndpoint(fed: HelicsFederate, name: str, type: str = "") -> HelicsEndpoint
+
+

MessageFederate Calls. +Create an endpoint. +The endpoint becomes part of the federate and is destroyed when the federate is freed so there are no separate free functions for endpoints.

+

Parameters

+
    +
  • fed - The helics.HelicsFederate in which to create an endpoint must have been created with helicsCreateMessageFederate or helicsCreateCombinationFederate.
    • +
  • name - The identifier for the endpoint. This will be prepended with the federate name for the global identifier.
    • +
  • type - A string describing the expected type of the publication (optional).
    • +
+

Returns: helics.HelicsEndpoint.

+
+

helicsFederateRegisterFilter

+
def helicsFederateRegisterFilter(fed: HelicsFederate, type: HelicsFilterType, name: str) -> HelicsFilter
+
+

Create a source Filter on the specified federate. +Filters can be created through a federate or a core.handle, linking through a federate allows a few extra features of name matching to function on the federate interface but otherwise equivalent behavior.

+

Parameters

+
    +
  • fed - The federate to register through.
    • +
  • type - The type of filter to create helics.HelicsFilterType.
    • +
  • name - The name of the filter (can be NULL).
    • +
+

Returns: helics.HelicsFilter.

+
+

helicsFederateRegisterFromPublicationJSON

+
def helicsFederateRegisterFromPublicationJSON(fed: HelicsFederate, json: str)
+
+

Register the publications via JSON publication string.

+

Parameters

+
    +
  • fed - The value helics.HelicsFederate to use to register the publications.
    • +
  • json - The JSON publication string.
    • +
+
+

helicsFederateRegisterGlobalCloningFilter

+
def helicsFederateRegisterGlobalCloningFilter(fed: HelicsFederate, name: str) -> HelicsCloningFilter
+
+

Create a global cloning Filter on the specified federate. +Cloning filters copy a message and send it to multiple locations, source and destination can be added through other functions.

+

Parameters

+
    +
  • fed - The federate to register through.
    • +
  • name - The name of the filter (can be NULL).
    • +
+

Returns: helics.HelicsFilter.

+
+

helicsFederateRegisterGlobalEndpoint

+
def helicsFederateRegisterGlobalEndpoint(fed: HelicsFederate, name: str, type: str = "") -> HelicsEndpoint
+
+

Create an endpoint. +The endpoint becomes part of the federate and is destroyed when the federate is freed so there are no separate free functions for endpoints.

+

Parameters

+
    +
  • fed - The helics.HelicsFederate in which to create an endpoint must have been created with helicsCreateMessageFederate or helicsCreateCombinationFederate.
    • +
  • name - The identifier for the endpoint.handle, the given name is the global identifier.
    • +
  • type - A string describing the expected type of the publication (optional).
    • +
+

Returns: helics.HelicsEndpoint.

+
+

helicsFederateRegisterGlobalFilter

+
def helicsFederateRegisterGlobalFilter(fed: HelicsFederate, type: HelicsFilterType, name: str) -> HelicsFilter
+
+

Create a global source filter through a federate. +Filters can be created through a federate or a core.handle, linking through a federate allows a few extra features of name matching to function on the federate interface but otherwise equivalent behavior.

+

Parameters

+
    +
  • fed - The federate to register through.
    • +
  • type - The type of filter to create helics.HelicsFilterType.
    • +
  • name - The name of the filter (can be NULL).
    • +
+

Returns: helics.HelicsFilter.

+
+

helicsFederateRegisterGlobalInput

+
def helicsFederateRegisterGlobalInput(fed: HelicsFederate, name: str, type: HelicsDataType, units: str = "") -> HelicsInput
+
+

Register a global named input. +The publication becomes part of the federate and is destroyed when the federate is freed so there are no separate free functions for subscriptions and publications.

+

Parameters

+
    +
  • fed - The helics.HelicsFederate in which to create a publication.
    • +
  • name - The identifier for the publication.
    • +
  • type - A code identifying the type of the input see helics.HelicsDataType for available options.
    • +
  • units - A string listing the units of the subscription (optional).
    • +
+

Returns: helics.HelicsPublication.

+
+

helicsFederateRegisterGlobalPublication

+
def helicsFederateRegisterGlobalPublication(fed: HelicsFederate, name: str, type: HelicsDataType, units: str = "") -> HelicsPublication
+
+

Register a global named publication with an arbitrary type. +The publication becomes part of the federate and is destroyed when the federate is freed so there are no separate free functions for subscriptions and publications.

+

Parameters

+
    +
  • fed - The helics.HelicsFederate in which to create a publication.
    • +
  • name - The identifier for the publication.
    • +
  • type - A code identifying the type of the input see helics.HelicsDataType for available options.
    • +
  • units - A string listing the units of the subscription (optional).
    • +
+

Returns: helics.HelicsPublication.

+
+

helicsFederateRegisterGlobalTargetedEndpoint

+
def helicsFederateRegisterGlobalTargetedEndpoint(fed: HelicsFederate, name: str, type: str = "")
+
+

Create a globally targeted endpoint. +The endpoint becomes part of the federate and is destroyed when the federate is freed so there are no separate free functions for endpoints.

+

Parameters

+
    +
  • fed - The helics.HelicsFederate in which to create an endpoint must have been created with helicsCreateMessageFederate or helicsCreateCombinationFederate.
    • +
  • name - The identifier for the endpoint. This will be prepended with the federate name for the global identifier.
    • +
  • type - A string describing the expected type of the publication (optional). +Returns: helics.HelicsEndpoint.
    • +
+
+

helicsFederateRegisterGlobalTranslator

+
def helicsFederateRegisterGlobalTranslator(fed: HelicsFederate, type: HelicsTranslatorTypes, name: str) -> HelicsTranslator
+
+

Create a source Translator on the specified federate.

+

Translators can be created through a federate or a core, linking through a federate allows +a few extra features of name matching to function on the federate interface but otherwise equivalent behavior

+

Parameters

+
    +
  • fed - The federate to register through.
    • +
  • type - The type of translator to create /ref HelicsTranslatorTypes.
    • +
  • name - The name of the translator (can be NULL).
    • +
+

Returns: helics.HelicsTranslator.

+
+

helicsFederateRegisterGlobalTypeInput

+
def helicsFederateRegisterGlobalTypeInput(fed: HelicsFederate, name: str, type: str, units: str = "") -> HelicsInput
+
+

Register a global publication with an arbitrary type. +The publication becomes part of the federate and is destroyed when the federate is freed so there are no separate free functions for subscriptions and publications.

+

Parameters

+
    +
  • fed - The helics.HelicsFederate in which to create a publication.
    • +
  • name - The identifier for the publication.
    • +
  • type - A string defining the type of the input.
    • +
  • units - A string listing the units of the subscription (optional).
    • +
+

Returns: helics.HelicsPublication.

+
+

helicsFederateRegisterGlobalTypePublication

+
def helicsFederateRegisterGlobalTypePublication(fed: HelicsFederate, name: str, type: str, units: str = "") -> HelicsPublication
+
+

Register a global publication with a defined type. +The publication becomes part of the federate and is destroyed when the federate is freed so there are no separate free functions for subscriptions and publications.

+

Parameters

+
    +
  • fed - The helics.HelicsFederate in which to create a publication.
    • +
  • name - The identifier for the publication.
    • +
  • type - A string describing the expected type of the publication.
    • +
  • units - A string listing the units of the subscription (optional).
    • +
+

Returns: helics.HelicsPublication.

+
+

helicsFederateRegisterInput

+
def helicsFederateRegisterInput(fed: HelicsFederate, name: str, type: HelicsDataType, units: str = "") -> HelicsInput
+
+

Register a named input. +The input becomes part of the federate and is destroyed when the federate is freed so there are no separate free +functions for subscriptions, inputs, and publications.

+

Parameters

+
    +
  • fed - The helics.HelicsFederate in which to create an input.
    • +
  • name - The identifier for the publication the global input name will be prepended with the federate name.
    • +
  • type - A code identifying the type of the input see helics.HelicsDataType for available options.
    • +
  • units - A string listing the units of the input (optional).
    • +
+

Returns: helics.HelicsInput.

+
+

helicsFederateRegisterInterfaces

+
def helicsFederateRegisterInterfaces(fed: HelicsFederate, file: str)
+
+

Load interfaces from a file.

+

Parameters

+
    +
  • fed - The federate to which to load interfaces.
    • +
  • file - The name of a file to load the interfaces from either JSON, or TOML.
    • +
+
+

helicsFederateRegisterPublication

+
def helicsFederateRegisterPublication(fed: HelicsFederate, name: str, type: HelicsDataType, units: str = "") -> HelicsPublication
+
+

Register a publication with a known type. +The publication becomes part of the federate and is destroyed when the federate is freed so there are no separate free functions for subscriptions and publications.

+

Parameters

+
    +
  • fed - The helics.HelicsFederate in which to create a publication.
    • +
  • name - The identifier for the publication the global publication name will be prepended with the federate name.
    • +
  • type - A code identifying the type of the input see helics.HelicsDataType for available options.
    • +
  • units - A string listing the units of the subscription (optional).
    • +
+

Returns: helics.HelicsPublication.

+
+

helicsFederateRegisterSubscription

+
def helicsFederateRegisterSubscription(fed: HelicsFederate, name: str, units: str = "") -> HelicsInput
+
+

Functions related to value federates for the C api. +Create a subscription. +The subscription becomes part of the federate and is destroyed when the federate is freed so there are no separate free functions for subscriptions and publications.

+

Parameters

+
    +
  • fed - The helics.HelicsFederate in which to create a subscription, must have been created with helics.helicsCreateValueFederate or +helics.helicsCreateCombinationFederate.
    • +
  • name - The identifier matching a publication to get a subscription for.
    • +
  • units - A string listing the units of the subscription (optional).
    • +
+

Returns: helics.HelicsSubscription.

+
+

helicsFederateRegisterTargetedEndpoint

+
def helicsFederateRegisterTargetedEndpoint(fed: HelicsFederate, name: str, type: str = "")
+
+

Create an targeted endpoint. +The endpoint becomes part of the federate and is destroyed when the federate is freed so there are no separate free functions for endpoints.

+

Parameters

+
    +
  • fed - The helics.HelicsFederate in which to create an endpoint must have been created with helicsCreateMessageFederate or helicsCreateCombinationFederate.
    • +
  • name - The identifier for the endpoint. This will be prepended with the federate name for the global identifier.
    • +
  • type - A string describing the expected type of the publication (optional). +Returns: helics.HelicsEndpoint.
    • +
+
+

helicsFederateRegisterTranslator

+
def helicsFederateRegisterTranslator(fed: HelicsFederate, type: HelicsTranslatorTypes, name: str) -> HelicsTranslator
+
+

Create a source Translator on the specified federate.

+

Translators can be created through a federate or a core, linking through a federate allows +a few extra features of name matching to function on the federate interface but otherwise equivalent behavior

+

Parameters

+
    +
  • fed - The federate to register through.
    • +
  • type - The type of translator to create /ref HelicsTranslatorTypes.
    • +
  • name - The name of the translator (can be NULL).
    • +
+

Returns: helics.HelicsTranslator.

+
+

helicsFederateRegisterTypeInput

+
def helicsFederateRegisterTypeInput(fed: HelicsFederate, name: str, type: str, units: str = "") -> HelicsInput
+
+

Register an input with a defined type. +The input becomes part of the federate and is destroyed when the federate is freed so there are no separate free +functions for subscriptions, inputs, and publications.

+

Parameters

+
    +
  • fed - The helics.HelicsFederate in which to create an input.
    • +
  • name - The identifier for the input.
    • +
  • type - A string describing the expected type of the input.
    • +
  • units - A string listing the units of the input (optional).
    • +
+

Returns: helics.HelicsPublication.

+
+

helicsFederateRegisterTypePublication

+
def helicsFederateRegisterTypePublication(fed: HelicsFederate, name: str, type: str, units: str = "") -> HelicsPublication
+
+

Register a publication with a defined type. +The publication becomes part of the federate and is destroyed when the federate is freed so there are no separate free functions for subscriptions and publications.

+

Parameters

+
    +
  • fed - The helics.HelicsFederate in which to create a publication.
    • +
  • name - The identifier for the publication.
    • +
  • type - A string labeling the type of the publication.
    • +
  • units - A string listing the units of the subscription (optional).
    • +
+

Returns: helics.HelicsPublication.

+
+

helicsFederateRequestNextStep

+
def helicsFederateRequestNextStep(fed: HelicsFederate) -> HelicsTime
+
+

Request the next time step for federate execution. +Feds should have setup the period or minDelta for this to work well but it will request the next time step which is the current time plus the minimum time step.

+

Parameters

+
    +
  • fed - The federate to make the request of.
    • +
+

Returns: helics.HelicsTime.

+
+

helicsFederateRequestTime

+
def helicsFederateRequestTime(fed: HelicsFederate, request_time: HelicsTime) -> HelicsTime
+
+

Request the next time for federate execution.

+

Parameters

+
    +
  • fed - The federate to make the request of.
    • +
  • request_time - The next requested time.
    • +
+

Returns: helics.HelicsTime.

+
+

helicsFederateRequestTimeAdvance

+
def helicsFederateRequestTimeAdvance(fed: HelicsFederate, time_delta: HelicsTime) -> HelicsTime
+
+

Request the next time for federate execution.

+

Parameters

+
    +
  • fed - The federate to make the request of.
    • +
  • time_delta - The requested amount of time to advance.
    • +
+

Returns: helics.HelicsTime.

+
+

helicsFederateRequestTimeAsync

+
def helicsFederateRequestTimeAsync(fed: HelicsFederate, request_time: HelicsTime)
+
+

Request the next time for federate execution in an asynchronous call. +Call helics.helicsFederateRequestTimeComplete to finish the call.

+

Parameters

+
    +
  • fed - The federate to make the request of.
    • +
  • request_time - The next requested time.
    • +
+
+

helicsFederateRequestTimeComplete

+
def helicsFederateRequestTimeComplete(fed: HelicsFederate) -> HelicsTime
+
+

Complete an asynchronous requestTime call.

+

Parameters

+
    +
  • fed - The federate to make the request of.
    • +
+
+

helicsFederateRequestTimeIterative

+
def helicsFederateRequestTimeIterative(
+    fed: HelicsFederate, request_time: HelicsTime, iterate: HelicsIterationRequest
+) -> Tuple[HelicsTime, HelicsIterationResult]
+
+

Request an iterative time. +This call allows for finer grain control of the iterative process than helics.helicsFederateRequestTime. It takes a time and iteration request, and returns a time and iteration status.

+

Parameters

+
    +
  • fed - The federate to make the request of.
    • +
  • request_time - The next desired time.
    • +
  • iterate - helics.HelicsIterationRequest, i.e. the requested iteration mode.
    • +
+

Returns: (helics.HelicsTime, helics.HelicsIterationResult).

+
+

helicsFederateRequestTimeIterativeAsync

+
def helicsFederateRequestTimeIterativeAsync(fed: HelicsFederate, request_time: HelicsTime, iterate: HelicsIterationRequest)
+
+

Request an iterative time through an asynchronous call. +This call allows for finer grain control of the iterative process than helics.helicsFederateRequestTime. It takes a time and iteration request, and returns a time and iteration status. Call helics.helicsFederateRequestTimeIterativeComplete to finish the process.

+

Parameters

+
    +
  • fed - The federate to make the request of.
    • +
  • request_time - The next desired time.
    • +
  • iterate - helics.HelicsIterationRequest, i.e. the requested iteration mode.
    • +
+
+

helicsFederateRequestTimeIterativeComplete

+
def helicsFederateRequestTimeIterativeComplete(fed: HelicsFederate) -> Tuple[HelicsTime, HelicsIterationResult]
+
+

Complete an iterative time request asynchronous call.

+

Parameters

+
    +
  • fed - The federate to make the request of.
    • +
+

Returns: The iteration specification of the result.

+
+

helicsFederateSendCommand

+
def helicsFederateSendCommand(fed: HelicsFederate, target: str, command: str)
+
+
+

helicsFederateSetFlagOption

+
def helicsFederateSetFlagOption(fed: HelicsFederate, flag: Union[int, HelicsFederateFlag, HelicsFlag], value: bool)
+
+

Set a flag for the federate.

+

Parameters

+
    +
  • fed - The federate to alter a flag for.
    • +
  • flag - The flag to change.
    • +
  • value - The new value of the flag. 0 for false, !=0 for true.
    • +
+
+

helicsFederateSetGlobal

+
def helicsFederateSetGlobal(fed: HelicsFederate, name: str, value: str)
+
+

Set a federation global value through a federate. +This overwrites any previous value for this name.

+

Parameters

+
    +
  • fed - The federate to set the global through.
    • +
  • name - The name of the global to set.
    • +
  • value - The value of the global.
    • +
+
+

helicsFederateSetIntegerProperty

+
def helicsFederateSetIntegerProperty(fed: HelicsFederate, property: HelicsProperty, value: int)
+
+

Set an integer based property of a federate.

+

Parameters

+
    +
  • fed - The federate to change the property for.
    • +
  • property - helics.HelicsProperty.
    • +
  • value - The value of the property.
    • +
+
+

helicsFederateSetLogFile

+
def helicsFederateSetLogFile(fed: HelicsFederate, log_file: str)
+
+

Set the logging file for a federate (actually on the core associated with a federate).

+

Parameters

+
    +
  • fed - The federate to set the log file for.
    • +
  • log_file - The name of the log file.
    • +
+
+

helicsFederateSetLoggingCallback

+
def helicsFederateSetLoggingCallback(fed: HelicsFederate, logger, user_data)
+
+

Set the logging callback for a helics.HelicsFederate

+

Add a logging callback function for the C. +The logging callback will be called when a message flows into a helics.HelicsFederate from the core or from a federate.

+

Parameters

+
    +
  • fed: the helics.HelicsFederate that is created with helics.helicsCreateValueFederate, helics.helicsCreateMessageFederate or helics.helicsCreateCombinationFederate
    • +
  • logger: a callback with signature void(int, const char *, const char *, void *); the function arguments are loglevel, an identifier string, and a message string, and a pointer to user data
    • +
  • user_data: a pointer to user data that is passed to the function when executing
    • +
+
+

helicsFederateSetQueryCallback

+
def helicsFederateSetQueryCallback(fed: HelicsFederate, query, user_data)
+
+

Set the callback for queries executed against a helics.HelicsFederate

+

Add a logging callback function for the C. +The logging callback will be called when a message flows from helics.HelicsBroker or from the core.

+

Parameters

+
    +
  • fed: the helics.HelicsFederate that is created with helics.helicsCreateValueFederate
    • +
  • query: a callback with signature const char *(const char *query, int querySize, HelicsQueryBuffer buffer, void *user_data); The function arguments include the query string requesting an answer along with its size; the string is not guaranteed to be null terminated. HelicsQueryBuffer is the buffer intended to filled out by the userCallback. The buffer can be empty if the query is not recognized and HELICS will generate the appropriate response. The buffer is used to ensure memory ownership separation between user code and HELICS code. The HelicsQueryBufferFill method can be used to load a string into the buffer.
    • +
  • user_data: a pointer to user data that is passed to the function when executing
    • +
+
+

helicsFederateSetSeparator

+
def helicsFederateSetSeparator(fed: HelicsFederate, separator: str)
+
+

Set the separator character in a federate. +The separator character is the separation character for local publications/endpoints in creating their global name. +For example if the separator character is ‘/’ then a local endpoint would have a globally reachable name of fedName/localName.

+

Parameters

+
    +
  • fed - The federate info object to alter.
    • +
  • separator - The character to use as a separator.
    • +
+
+

helicsFederateSetStateChangeCallback

+
def helicsFederateSetStateChangeCallback(fed: HelicsFederate, state_changer, user_data)
+
+

Set the callback for a helics.HelicsFederate state change

+

Add a logging callback function for the C. +The logging callback will be called when a message flows into a helics.HelicsFederate from the core or from a federate.

+

Parameters

+
    +
  • fed: the helics.HelicsFederate that is created with helics.helicsCreateValueFederate, helics.helicsCreateMessageFederate or helics.helicsCreateCombinationFederate
    • +
  • state_changer: a callback with signature void(HelicsFederateState newState, HelicsFederateState oldState, void *user_data);
    • +
  • user_data: a pointer to user data that is passed to the function when executing
    • +
+
+

helicsFederateSetTag

+
def helicsFederateSetTag(fed: HelicsFederate, tagname: str, tagvalue: str)
+
+

Set the data in a specific tag for a federate.

+

fed: The federate object to set a tag for. +tagname: The name of the tag to set. +tagvalue: The string value to associate with a tag.

+
+

helicsFederateSetTimeProperty

+
def helicsFederateSetTimeProperty(fed: HelicsFederate, time_property: int, time: HelicsTime)
+
+

Set a time based property for a federate.

+

Parameters

+
    +
  • fed - The helics.HelicsFederate to set the property for.
    • +
  • time_property - A integer code for a time property.
    • +
  • time - The requested value of the property.
    • +
+
+

helicsFederateSetTimeRequestEntryCallback

+
def helicsFederateSetTimeRequestEntryCallback(fed: HelicsFederate, request_time, user_data)
+
+

Set the callback for the time request

+

This callback will be executed when a valid time request is made. It is intended for the possibility of embedded data grabbers in a callback to simplify user code.

+

Parameters

+
    +
  • fed: the helics.HelicsFederate that is created with helics.helicsCreateValueFederate
    • +
  • request_time: a callback with signature void(HelicsTime currentTime, HelicsTime requestTime, bool iterating, void *user_data); The function arguments are the current time value, the requested time value, a bool indicating that the time is iterating, and pointer to the user_data
    • +
  • user_data: a pointer to user data that is passed to the function when executing
    • +
+
+

helicsFederateSetTimeRequestReturnCallback

+
def helicsFederateSetTimeRequestReturnCallback(fed: HelicsFederate, request_time_return, user_data)
+
+

Set the callback for the time request

+

This callback will be executed when a valid time request is made. It is intended for the possibility of embedded data grabbers in a callback to simplify user code.

+

Parameters

+
    +
  • fed: the helics.HelicsFederate that is created with helics.helicsCreateValueFederate
    • +
  • request_time_return: a callback with signature void(HelicsTime newTime, bool iterating, void *user_data); The function arguments are the current time value, the requested time value, a bool indicating that the time is iterating, and pointer to the user_data
    • +
  • user_data: a pointer to user data that is passed to the function when executing
    • +
+
+

helicsFederateSetTimeUpdateCallback

+
def helicsFederateSetTimeUpdateCallback(fed: HelicsFederate, time_update, user_data)
+
+

Set the callback for the time request

+

This callback will be executed when a valid time request is made. It is intended for the possibility of embedded data grabbers in a callback to simplify user code.

+

Parameters

+
    +
  • fed: the helics.HelicsFederate that is created with helics.helicsCreateValueFederate
    • +
  • update_time: a callback with signature void(HelicsTime newTime, bool iterating, void *user_data); The function arguments are the current time value, the requested time value, a bool indicating that the time is iterating, and pointer to the user_data
    • +
  • user_data: a pointer to user data that is passed to the function when executing
    • +
+
+

helicsFederateUnProtect

+
def helicsFederateUnProtect(fed_name: str)
+
+

Remove the protection of an existing federate

+

This function allows a federate to be retrieved on demand, it must be explicitly close later otherwise it will be destroyed +when the library is closed

+

Parameters

+
    +
  • fedName: The name of an existing HelicsFederate.
    • +
+
+

helicsFederateWaitCommand

+
def helicsFederateWaitCommand(fed: HelicsFederate) -> str
+
+
+

helicsFilterAddDeliveryEndpoint

+
def helicsFilterAddDeliveryEndpoint(filter: HelicsFilter, delivery_endpoint: str)
+
+

Clone filter functions. +Functions that manipulate cloning filters in some way. +Add a delivery endpoint to a cloning filter. +All cloned messages are sent to the delivery address(es).

+

Parameters

+
    +
  • filter - The given filter.
    • +
  • delivery_endpoint - The name of the endpoint to deliver messages to.
    • +
+
+

helicsFilterAddDestinationTarget

+
def helicsFilterAddDestinationTarget(filter: HelicsFilter, destination: str)
+
+

Add a destination target to a filter. +All messages going to a destination are copied to the delivery address(es).

+

Parameters

+
    +
  • filter - The given filter to add a destination target to.
    • +
  • destination - The name of the endpoint to add as a destination target.
    • +
+
+

helicsFilterAddSourceTarget

+
def helicsFilterAddSourceTarget(filter: HelicsFilter, source_name: str)
+
+

Add a source target to a filter. +All messages coming from a source are copied to the delivery address(es).

+

Parameters

+
    +
  • filter - The given filter.
    • +
  • source_name - The name of the endpoint to add as a source target.
    • +
+
+

helicsFilterGetInfo

+
def helicsFilterGetInfo(filter: HelicsFilter) -> str
+
+

Get the data in the info field of a filter.

+

Parameters

+
    +
  • filter - The given filter.
    • +
+

Returns: A string with the info field string.

+
+

helicsFilterGetName

+
def helicsFilterGetName(filter: HelicsFilter) -> str
+
+

Get the name of the filter and store in the given string.

+

Parameters

+
    +
  • filter - The given filter.
    • +
+

Returns: A string with the name of the filter.

+
+

helicsFilterGetOption

+
def helicsFilterGetOption(filter: HelicsFilter, option: HelicsHandleOption) -> int
+
+

Get a handle option for the filter.

+

Parameters

+
    +
  • filter - The given filter to query.
    • +
  • option - The option to query helics.HelicsHandleOption.
    • +
+

Returns: int.

+
+

helicsFilterGetTag

+
def helicsFilterGetTag(filter: HelicsFilter, tagname: str)
+
+

Get the data in a specified tag of a filter.

+

Parameters

+
    +
  • filter: The filter object to query.
    • +
  • tagname: The name of the tag to query.
    • +
+

Returns

+

A string with the tag data.

+
+

helicsFilterIsValid

+
def helicsFilterIsValid(filter: HelicsFilter) -> bool
+
+

Check if a filter is valid.

+

Parameters

+
    +
  • filter - The filter object to check.
    • +
+

Returns: True if the Filter object represents a valid filter.

+
+

helicsFilterRemoveDeliveryEndpoint

+
def helicsFilterRemoveDeliveryEndpoint(filter: HelicsFilter, delivery_endpoint: str)
+
+

Remove a delivery destination from a cloning filter.

+

Parameters

+
    +
  • filter - The given filter (must be a cloning filter).
    • +
  • delivery_endpoint - A string with the delivery endpoint to remove.
    • +
+
+

helicsFilterRemoveTarget

+
def helicsFilterRemoveTarget(filter: HelicsFilter, target_name: str)
+
+

Remove a destination target from a filter.

+

Parameters

+
    +
  • filter - The given filter.
    • +
  • target_name - The named endpoint to remove as a target.
    • +
+
+

helicsFilterSet

+
def helicsFilterSet(filter: HelicsFilter, property: str, value: float)
+
+

Set a property on a filter.

+

Parameters

+
    +
  • filter - The filter to modify.
    • +
  • property - A string containing the property to set.
    • +
  • value - A numerical value for the property.
    • +
+
+

helicsFilterSetCustomCallback

+
def helicsFilterSetCustomCallback(filter: HelicsFilter, callback, user_data)
+
+
+

helicsFilterSetInfo

+
def helicsFilterSetInfo(filter: HelicsFilter, info: str)
+
+

Set the data in the info field for a filter

+

Parameters

+
    +
  • filter - The given filter.
    • +
  • info - The string to set.
    • +
+
+

helicsFilterSetOption

+
def helicsFilterSetOption(filter: HelicsFilter, option: HelicsHandleOption, value: int)
+
+

Set the data in the info field for a filter.

+

Parameters

+
    +
  • filter - The given filter.
    • +
  • option - The option to set helics.HelicsHandleOption.
    • +
  • value - The value of the option commonly 0 for false 1 for true.
    • +
+
+

helicsFilterSetString

+
def helicsFilterSetString(filter: HelicsFilter, property: str, value: str)
+
+

Set a string property on a filter.

+

Parameters

+
    +
  • filter - The filter to modify.
    • +
  • property - A string containing the property to set.
    • +
  • value - A string containing the new value.
    • +
+
+

helicsFilterSetTag

+
def helicsFilterSetTag(filter: HelicsFilter, tagname: str, tagvalue: str)
+
+

Set the data in a specific tag for a filter.

+

filter: The filter object to set a tag for. +tagname: The name of the tag to set. +tagvalue: The string value to associate with a tag.

+
+

helicsGetBuildFlags

+
def helicsGetBuildFlags() -> str
+
+

Get the build flags used to compile HELICS.

+
+

helicsGetCompilerVersion

+
def helicsGetCompilerVersion() -> str
+
+

Get the compiler version used to compile HELICS.

+
+

helicsGetDataType

+
def helicsGetDataType(value: str) -> int
+
+

Get the data type for use in helics.helicsFederateRegisterPublication, helics.helicsFederateRegisterInput, helics.helicsFilterSetOption.

+

Parameters

+
    +
  • value: A string representing a data type.
    • +
+

Returns: An int with the data type or HELICS_DATA_TYPE_UNKNOWN(-1) if not a valid value.

+
+

helicsGetFederateByName

+
def helicsGetFederateByName(fed_name: str) -> HelicsFederate
+
+

Get an existing helics.HelicsFederate from a core by name. +The federate must have been created by one of the other functions and at least one of the objects referencing the created federate must still be active in the process.

+

Parameters

+
    +
  • fed_name - The name of the federate to retrieve.
    • +
+

Returns: helics.HelicsFederate.

+
+

helicsGetFlagIndex

+
def helicsGetFlagIndex(value: str) -> Union[HelicsFlag, HelicsFederateFlag]
+
+

Get a property index for use in helics.helicsFederateInfoSetFlagOption, helics.helicsFederateSetFlagOption.

+

Parameters

+
    +
  • value - A string with the option name.
    • +
+

Returns: An int with the property code or (-1) if not a valid property.

+
+

helicsGetOptionIndex

+
def helicsGetOptionIndex(value: str) -> HelicsHandleOption
+
+

Get an option index for use in helics.helicsPublicationSetOption, helics.helicsInputSetOption, helics.helicsEndpointSetOption, +helics.helicsFilterSetOption, and the corresponding get functions

+

Parameters

+
    +
  • value - A string with the option name
    • +
+

Returns: An int with the option index or (-1) if not a valid property.

+
+

helicsGetOptionValue

+
def helicsGetOptionValue(value: str) -> int
+
+

Get an option value for use in helics.helicsPublicationSetOption, helics.helicsInputSetOption, helics.helicsEndpointSetOption, +helics.helicsFilterSetOption.

+

Parameters

+
    +
  • value - A string representing the value
    • +
+

Returns: An int with the option value or (-1) if not a valid value.

+
+

helicsGetPropertyIndex

+
def helicsGetPropertyIndex(value: str) -> HelicsProperty
+
+

Get a property index for use in helics.helicsFederateInfoSetFlagOption, helics.helicsFederateInfoSetTimeProperty, or helics.helicsFederateInfoSetIntegerProperty.

+

Parameters

+
    +
  • value - A string with the property name.
    • +
+

Returns: An int with the property code or (-1) if not a valid property.

+
+

helicsGetSystemInfo

+
def helicsGetSystemInfo() -> JSONType
+
+

Get a Python dictionary from JSON string containing version info. +The object contains fields with system information like cpu, core count, operating system, and memory, +as well as information about the HELICS build. Used for debugging reports and gathering other information.

+
+

helicsGetVersion

+
def helicsGetVersion() -> str
+
+

Get a version string for HELICS.

+
+

helicsInputAddTarget

+
def helicsInputAddTarget(ipt: HelicsInput, target_name: str)
+
+

Add a publication to the list of data that an input subscribes to.

+

Parameters

+
    +
  • ipt - The named input to modify.
    • +
  • target_name - The name of a publication that an input should subscribe to.
    • +
+
+

helicsInputClearUpdate

+
def helicsInputClearUpdate(ipt: HelicsInput)
+
+

Clear the updated flag from an input.

+
+

helicsInputGetBoolean

+
def helicsInputGetBoolean(ipt: HelicsInput) -> bool
+
+

Get a boolean value from a subscription.

+

Parameters

+
    +
  • ipt - The input to get the data for.
    • +
+

Returns: A boolean value of current input value.

+
+

helicsInputGetByteCount

+
def helicsInputGetByteCount(ipt: HelicsInput) -> int
+
+

Data can be returned in a number of formats, for instance if data is published as a double it can be returned as a string and vice versa, not all translations make that much sense but they do work. +Get the size of the raw value for subscription.

+

Returns: The size of the raw data/string in bytes.

+
+

helicsInputGetBytes

+
def helicsInputGetBytes(ipt: HelicsInput) -> bytes
+
+

Get the raw data for the latest value of a subscription.

+

Parameters

+
    +
  • ipt - The input to get the data for.
    • +
+

Returns: Raw string data.

+
+

helicsInputGetChar

+
def helicsInputGetChar(ipt: HelicsInput) -> str
+
+

Get a single character value from an input.

+

Parameters

+
    +
  • ipt - The input to get the data for.
    • +
+

Returns: The resulting character value.

+
+

helicsInputGetComplex

+
def helicsInputGetComplex(ipt: HelicsInput) -> complex
+
+

Get a pair of double forming a complex number from a subscriptions.

+

Parameters

+
    +
  • ipt - The input to get the data for.
    • +
+

Returns: a pair of floating point values that represent the real and imag values

+
+

helicsInputGetComplexObject

+
def helicsInputGetComplexObject(ipt: HelicsInput) -> complex
+
+

Get a complex object from an input object.

+

Parameters

+
    +
  • ipt - The input to get the data for.
    • +
+

Returns: complex.

+
+

helicsInputGetComplexVector

+
def helicsInputGetComplexVector(ipt: HelicsInput) -> List[complex]
+
+

Get a vector of complex from a subscription.

+

Parameters

+
    +
  • ipt - The input to get the result for.
    • +
+

Returns: a list of floating point values

+
+

helicsInputGetDataBuffer

+
def helicsInputGetDataBuffer(ipt: HelicsInput) -> HelicsDataBuffer
+
+

Get the size of a value for subscription assuming return as a string.

+

Returns: The size of the string.

+
+

helicsInputGetDouble

+
def helicsInputGetDouble(ipt: HelicsInput) -> float
+
+

Get a double value from a subscription..

+

Parameters

+
    +
  • ipt - The input to get the data for.
    • +
+

Returns: The double value of the input.

+
+

helicsInputGetExtractionUnits

+
def helicsInputGetExtractionUnits(ipt: HelicsInput) -> str
+
+

Get the units of an input. +The same as helics.helicsInputGetUnits.

+

Parameters

+
    +
  • ipt - The input to query.
    • +
+

Returns: A string with the units information.

+
+

helicsInputGetInfo

+
def helicsInputGetInfo(ipt: HelicsInput) -> str
+
+

Get the data in the info field of an input.

+

Parameters

+
    +
  • ipt - The input to query.
    • +
+

Returns: A string with the info field string.

+
+

helicsInputGetInjectionUnits

+
def helicsInputGetInjectionUnits(ipt: HelicsInput) -> str
+
+

Get the units of the publication that an input is linked to.

+

Parameters

+
    +
  • ipt - The input to query.
    • +
+

Returns: A string with the units information.

+
+

helicsInputGetInteger

+
def helicsInputGetInteger(ipt: HelicsInput) -> int
+
+

Get an integer value from a subscription.

+

Parameters

+
    +
  • ipt - The input to get the data for.
    • +
+

Returns: An int64_t value with the current value of the input.

+
+

helicsInputGetKey

+
def helicsInputGetKey(ipt: HelicsInput) -> str
+
+

Get the name of an input.

+

Parameters

+
    +
  • ipt - The input to query
    • +
+

Returns: A string with the name information.

+

DEPRECATED

+
+

helicsInputGetName

+
def helicsInputGetName(ipt: HelicsInput) -> str
+
+

Get the name of an input.

+

Parameters

+
    +
  • ipt - The input to query
    • +
+

Returns: A string with the name information.

+
+

helicsInputGetNamedPoint

+
def helicsInputGetNamedPoint(ipt: HelicsInput) -> Tuple[str, float]
+
+

Get a named point from a subscription.

+

Parameters

+
    +
  • ipt - The input to get the result for.
    • +
+

Returns: a string and a double value for the named point

+
+

helicsInputGetOption

+
def helicsInputGetOption(ipt: HelicsInput, option: HelicsHandleOption) -> int
+
+

Get the current value of an input handle option.

+

Parameters

+
    +
  • ipt - The input to query.
    • +
  • option - Integer representation of the option in question see helics.HelicsHandleOption.
    • +
+

Returns: An integer value with the current value of the given option.

+
+

helicsInputGetPublicationDataType

+
def helicsInputGetPublicationDataType(ipt: HelicsInput) -> int
+
+

Get the data type the publisher to an input is sending.

+

Parameters

+
    +
  • ipt - The input to query
    • +
+

Returns: An int containing the enumeration value of the publication type.

+
+

helicsInputGetPublicationType

+
def helicsInputGetPublicationType(ipt: HelicsInput) -> str
+
+

Get the type the publisher to an input is sending.

+

Parameters

+
    +
  • ipt - The input to query
    • +
+

Returns: A string with the type information.

+
+

helicsInputGetRawValue

+
def helicsInputGetRawValue(ipt: HelicsInput) -> bytes
+
+

Get the raw data for the latest value of a subscription.

+

Parameters

+
    +
  • ipt - The input to get the data for.
    • +
+

Returns: Raw string data.

+

DEPRECATED

+
+

helicsInputGetRawValueSize

+
def helicsInputGetRawValueSize(ipt: HelicsInput) -> int
+
+

Data can be returned in a number of formats, for instance if data is published as a double it can be returned as a string and vice versa, not all translations make that much sense but they do work. +Get the size of the raw value for subscription.

+

Returns: The size of the raw data/string in bytes.

+

DEPRECATED

+
+

helicsInputGetString

+
def helicsInputGetString(ipt: HelicsInput) -> str
+
+

Get a string value from a subscription.

+

Parameters

+
    +
  • ipt - The input to get the data for.
    • +
+

Returns: A string data

+
+

helicsInputGetStringSize

+
def helicsInputGetStringSize(ipt: HelicsInput) -> int
+
+

Get the size of a value for subscription assuming return as a string.

+

Returns: The size of the string.

+
+

helicsInputGetTag

+
def helicsInputGetTag(input: HelicsInput, tagname: str)
+
+

Get the data in a specified tag of a input.

+

Parameters

+
    +
  • input: The input object to query.
    • +
  • tagname: The name of the tag to query.
    • +
+

Returns

+

A string with the tag data.

+
+

helicsInputGetTarget

+
def helicsInputGetTarget(ipt: HelicsInput) -> str
+
+

Get the target of an input.

+

Parameters

+
    +
  • ipt - The input to query
    • +
+

Returns: A string with the input target.

+
+

helicsInputGetTime

+
def helicsInputGetTime(ipt: HelicsInput) -> HelicsTime
+
+

Get a time value from a subscription.

+

Parameters

+
    +
  • ipt - The input to get the data for.
    • +
+

Returns: The resulting time value.

+
+

helicsInputGetType

+
def helicsInputGetType(ipt: HelicsInput) -> str
+
+

Get the type of an input.

+

Parameters

+
    +
  • ipt - The input to query
    • +
+

Returns: A string with the type information.

+
+

helicsInputGetUnits

+
def helicsInputGetUnits(ipt: HelicsInput) -> str
+
+

Get the units of an input.

+

Parameters

+
    +
  • ipt - The input to query.
    • +
+

Returns: A string with the units information.

+
+

helicsInputGetVector

+
def helicsInputGetVector(ipt: HelicsInput) -> List[float]
+
+

Get a vector of doubles from a subscription.

+

Parameters

+
    +
  • ipt - The input to get the result for.
    • +
+

Returns: a list of floating point values

+
+

helicsInputGetVectorSize

+
def helicsInputGetVectorSize(ipt: HelicsInput) -> int
+
+

Get the size of a value for subscription assuming return as an array of doubles.

+

Returns: The number of doubles in a returned vector.

+
+

helicsInputIsUpdated

+
def helicsInputIsUpdated(ipt: HelicsInput) -> bool
+
+

Check if a particular subscription was updated.

+

Returns: True if it has been updated since the last value retrieval.

+
+

helicsInputIsValid

+
def helicsInputIsValid(ipt: HelicsInput) -> bool
+
+

Check if an input is valid.

+

Parameters

+
    +
  • ipt - The input to check
    • +
+

Returns: True if the Input object represents a valid input.

+
+

helicsInputLastUpdateTime

+
def helicsInputLastUpdateTime(ipt: HelicsInput) -> HelicsTime
+
+

Get the last time a subscription was updated.

+
+

helicsInputSetDefaultBoolean

+
def helicsInputSetDefaultBoolean(ipt: HelicsInput, value: bool)
+
+

Set the default as a boolean.

+

Parameters

+
    +
  • ipt - The input to set the default for.
    • +
  • value - The default boolean value.
    • +
+
+

helicsInputSetDefaultBytes

+
def helicsInputSetDefaultBytes(ipt: HelicsInput, data: bytes)
+
+

Default Value functions. +These functions set the default value for a subscription. That is the value returned if nothing was published from elsewhere. +Set the default as a raw data array.

+

Parameters

+
    +
  • ipt - The input to set the default for.
    • +
  • data - A pointer to the raw data to use for the default.
    • +
+
+

helicsInputSetDefaultChar

+
def helicsInputSetDefaultChar(ipt: HelicsInput, value: str)
+
+

Set the default as a char.

+

Parameters

+
    +
  • ipt - The input to set the default for.
    • +
  • value - The default char value.
    • +
+
+

helicsInputSetDefaultComplex

+
def helicsInputSetDefaultComplex(ipt: HelicsInput, real: float, imag: float = 0)
+
+

Set the default as a complex number.

+

Parameters

+
    +
  • ipt - The input to set the default for.
    • +
  • real - The default real value.
    • +
  • imag - The default imaginary value.
    • +
+
+

helicsInputSetDefaultComplexVector

+
def helicsInputSetDefaultComplexVector(ipt: HelicsInput, vectorInput: List[complex])
+
+

Set the default as a vector of doubles.

+

Parameters

+
    +
  • ipt - The input to set the default for.
    • +
  • vectorInput - A pointer to an array of double data.
    • +
+
+

helicsInputSetDefaultDouble

+
def helicsInputSetDefaultDouble(ipt: HelicsInput, value: float)
+
+

Set the default as a double.

+

Parameters

+
    +
  • ipt - The input to set the default for.
    • +
  • value - The default double value.
    • +
+
+

helicsInputSetDefaultInteger

+
def helicsInputSetDefaultInteger(ipt: HelicsInput, value: int)
+
+

Set the default as an integer.

+

Parameters

+
    +
  • ipt - The input to set the default for.
    • +
  • value - The default integer.
    • +
+
+

helicsInputSetDefaultNamedPoint

+
def helicsInputSetDefaultNamedPoint(ipt: HelicsInput, string: str, value: float)
+
+

Set the default as a NamedPoint.

+

Parameters

+
    +
  • ipt - The input to set the default for.
    • +
  • string - A pointer to a string representing the name.
    • +
  • value - A double value for the value of the named point.
    • +
+
+

helicsInputSetDefaultRaw

+
def helicsInputSetDefaultRaw(ipt: HelicsInput, data: bytes)
+
+

Default Value functions. +These functions set the default value for a subscription. That is the value returned if nothing was published from elsewhere. +Set the default as a raw data array.

+

Parameters

+
    +
  • ipt - The input to set the default for.
    • +
  • data - A pointer to the raw data to use for the default.
    • +
+

DEPRECATED

+
+

helicsInputSetDefaultString

+
def helicsInputSetDefaultString(ipt: HelicsInput, string: str)
+
+

Set the default as a string.

+

Parameters

+
    +
  • ipt - The input to set the default for.
    • +
  • string - A pointer to the default string.
    • +
+
+

helicsInputSetDefaultTime

+
def helicsInputSetDefaultTime(ipt: HelicsInput, value: HelicsTime)
+
+

Set the default as a time.

+

Parameters

+
    +
  • ipt - The input to set the default for.
    • +
  • value - The default time value.
    • +
+
+

helicsInputSetDefaultVector

+
def helicsInputSetDefaultVector(ipt: HelicsInput, vectorInput: List[float])
+
+

Set the default as a vector of doubles.

+

Parameters

+
    +
  • ipt - The input to set the default for.
    • +
  • vectorInput - A pointer to an array of double data.
    • +
+
+

helicsInputSetInfo

+
def helicsInputSetInfo(ipt: HelicsInput, info: str)
+
+

Set the data in the info field for an input.

+

Parameters

+
    +
  • ipt - The input to query.
    • +
  • info - The string to set.
    • +
+
+

helicsInputSetMinimumChange

+
def helicsInputSetMinimumChange(ipt: HelicsInput, tolerance: float)
+
+

Set the minimum change detection tolerance.

+

Parameters

+
    +
  • ipt - The input to modify.
    • +
  • tolerance - The tolerance level for registering an update, values changing less than this value will not show asbeing updated.
    • +
+
+

helicsInputSetOption

+
def helicsInputSetOption(ipt: HelicsInput, option: HelicsHandleOption, value: int)
+
+

Set an option on an input.

+

Parameters

+
    +
  • ipt - The input to query.
    • +
  • option - The option to set for the input helics.HelicsHandleOption.
    • +
  • value - The value to set the option to.
    • +
+
+

helicsInputSetTag

+
def helicsInputSetTag(input: HelicsInput, tagname: str, tagvalue: str)
+
+

Set the data in a specific tag for a input.

+

input: The input object to set a tag for. +tagname: The name of the tag to set. +tagvalue: The string value to associate with a tag.

+
+

helicsIsCoreTypeAvailable

+
def helicsIsCoreTypeAvailable(type: str) -> bool
+
+

Returns True if core/broker type specified is available in current compilation.

+

Parameters

+
    +
  • type - A string representing a core type. Options include “zmq”, “udp”, “ipc”, “interprocess”, “tcp”, “default”, “mpi”.
    • +
+

Returns: True if type is available, False if type is not available.

+
+

helicsLoadSignalHandler

+
def helicsLoadSignalHandler()
+
+

Load a signal handler that handles Ctrl-C and shuts down the library

+
+

helicsLoadSignalHandlerCallback

+
def helicsLoadSignalHandlerCallback()
+
+
+

helicsLoadSignalHandlerCallbackNoExit

+
def helicsLoadSignalHandlerCallbackNoExit()
+
+
+

helicsLoadThreadedSignalHandler

+
def helicsLoadThreadedSignalHandler()
+
+

Load a threaded signal handler that handles Ctrl-C and shuts down the library

+
+

helicsMessageAppendData

+
def helicsMessageAppendData(message: HelicsMessage, data: bytes)
+
+

Append data to the payload.

+

Parameters

+
    +
  • message - The message object in question.
    • +
  • data - A string containing the message data to append.
    • +
+
+

helicsMessageCheckFlag

+
def helicsMessageCheckFlag(message: HelicsMessage, flag: int) -> bool
+
+

Check if a flag is set on a message.

+

Parameters

+
    +
  • message - The message object in question.
    • +
  • flag - The flag to check should be between [0,15].
    • +
+

Returns: The flags associated with a message.

+

DEPRECATED

+
+

helicsMessageClear

+
def helicsMessageClear(message: HelicsMessage)
+
+

Reset message to empty state

+

Parameters

+
    +
  • message - The message object in question.
    • +
+
+

helicsMessageClearFlags

+
def helicsMessageClearFlags(message: HelicsMessage)
+
+

Clear the flags of a message.

+

Parameters

+
    +
  • message - The message object in question.
    • +
+
+

helicsMessageClone

+
def helicsMessageClone(message: HelicsMessage) -> HelicsMessage
+
+

Clone a message object.

+

Parameters

+
    +
  • message - The message object to copy from.
    • +
+

Returns: helics.HelicsMessage.

+
+

helicsMessageCopy

+
def helicsMessageCopy(source_message: HelicsMessage, destination_message: HelicsMessage)
+
+

Copy a message object.

+

Parameters

+
    +
  • source_message - The message object to copy from.
    • +
  • destination_message - The message object to copy to.
    • +
+
+

helicsMessageDataBuffer

+
def helicsMessageDataBuffer(message: HelicsMessage) -> HelicsDataBuffer
+
+

Get a data buffer to the message object.

+

Parameters

+
    +
  • message - A message object to get the dataBuffer for.
    • +
+

Returns: A HelicsDataBuffer object to the data in a message. Modifying the buffer will directly modify the message contents.

+
+

helicsMessageFree

+
def helicsMessageFree(message: HelicsMessage)
+
+

Free a message object from memory. Memory for message is managed so not using this function does not create memory leaks, this is an indication to the system that the memory for this message is done being used and can be reused for a new message. +helics.helicsFederateClearMessages can also be used to clear up all stored messages at once.

+
+

helicsMessageGetByteCount

+
def helicsMessageGetByteCount(message: HelicsMessage) -> int
+
+

Get the size of the data payload in bytes.

+

Parameters

+
    +
  • message - The message object in question.
    • +
+

Returns: The size of the data payload.

+
+

helicsMessageGetBytes

+
def helicsMessageGetBytes(message: HelicsMessage) -> bytes
+
+

Get the raw data for a message object.

+

Parameters

+
    +
  • message - A message object to get the data for.
    • +
+

Returns: Raw string data.

+
+

helicsMessageGetBytesPointer

+
def helicsMessageGetBytesPointer(message: HelicsMessage) -> pointer
+
+

Get a pointer to the raw data of a message.

+

Parameters

+
    +
  • message - A message object to get the data for.
    • +
+

Returns: A pointer to the raw data in memory, the pointer may be NULL if the message is not a valid message.

+
+

helicsMessageGetDestination

+
def helicsMessageGetDestination(message: HelicsMessage) -> str
+
+

Get the destination endpoint of a message.

+

Parameters

+
    +
  • message - The message object in question.
    • +
+

Returns: A string with the destination endpoint.

+
+

helicsMessageGetFlagOption

+
def helicsMessageGetFlagOption(message: HelicsMessage, flag: int) -> bool
+
+

Get flag on a message.

+

Parameters

+
    +
  • message - The message object in question.
    • +
  • flag - The flag to check should be between [0,15].
    • +
+

Returns: The flags associated with a message.

+
+

helicsMessageGetMessageID

+
def helicsMessageGetMessageID(message: HelicsMessage) -> int
+
+

Get the messageID of a message.

+

Parameters

+
    +
  • message - The message object in question.
    • +
+

Returns: The messageID.

+
+

helicsMessageGetOriginalDestination

+
def helicsMessageGetOriginalDestination(message: HelicsMessage) -> str
+
+

Get the original destination endpoint of a message, the destination may have been modified by filters or other actions.

+

Parameters

+
    +
  • message - The message object in question.
    • +
+

Returns: A string with the original destination of a message.

+
+

helicsMessageGetOriginalSource

+
def helicsMessageGetOriginalSource(message: HelicsMessage) -> str
+
+

Get the original source endpoint of a message, the source may have been modified by filters or other actions.

+

Parameters

+
    +
  • message - The message object in question.
    • +
+

Returns: A string with the source of a message.

+
+

helicsMessageGetRawData

+
def helicsMessageGetRawData(message: HelicsMessage) -> bytes
+
+

Get the raw data for a message object.

+

Parameters

+
    +
  • message - A message object to get the data for.
    • +
+

Returns: Raw string data.

+

DEPRECATED

+
+

helicsMessageGetRawDataPointer

+
def helicsMessageGetRawDataPointer(message: HelicsMessage) -> pointer
+
+

Get a pointer to the raw data of a message.

+

Parameters

+
    +
  • message - A message object to get the data for.
    • +
+

Returns: A pointer to the raw data in memory, the pointer may be NULL if the message is not a valid message.

+

DEPRECATED

+
+

helicsMessageGetRawDataSize

+
def helicsMessageGetRawDataSize(message: HelicsMessage) -> int
+
+

Get the size of the data payload in bytes.

+

Parameters

+
    +
  • message - The message object in question.
    • +
+

Returns: The size of the data payload.

+

DEPRECATED

+
+

helicsMessageGetSource

+
def helicsMessageGetSource(message: HelicsMessage) -> str
+
+

Message operation functions. +Functions for working with helics message envelopes. +Get the source endpoint of a message.

+

Parameters

+
    +
  • message - The message object in question.
    • +
+

Returns: A string with the source endpoint.

+
+

helicsMessageGetString

+
def helicsMessageGetString(message: HelicsMessage) -> str
+
+

Get the payload of a message as a string.

+

Parameters

+
    +
  • message - The message object in question.
    • +
+

Returns: A string representing the payload of a message.

+
+

helicsMessageGetTime

+
def helicsMessageGetTime(message: HelicsMessage) -> HelicsTime
+
+

Get the helics time associated with a message.

+

Parameters

+
    +
  • message - The message object in question.
    • +
+

Returns: The time associated with a message.

+
+

helicsMessageIsValid

+
def helicsMessageIsValid(message: HelicsMessage) -> bool
+
+

A check if the message contains a valid payload.

+

Parameters

+
    +
  • message - The message object in question.
    • +
+

Returns: True if the message contains a payload.

+
+

helicsMessageReserve

+
def helicsMessageReserve(message: HelicsMessage, reserve_size: int)
+
+

Reserve space in a buffer but don’t actually resize. +The message data buffer will be reserved but not resized.

+

Parameters

+
    +
  • message - The message object in question.
    • +
  • reserve_size - The number of bytes to reserve in the message object.
    • +
+
+

helicsMessageResize

+
def helicsMessageResize(message: HelicsMessage, new_size: int)
+
+

Resize the data buffer for a message. +The message data buffer will be resized. There are no guarantees on what is in the buffer in newly allocated space. +If the allocated space is not sufficient new allocations will occur

+

Parameters

+
    +
  • message - The message object in question.
    • +
  • new_size - The new size in bytes of the buffer.
    • +
+
+

helicsMessageSetData

+
def helicsMessageSetData(message: HelicsMessage, data: bytes)
+
+

Set the data payload of a message as raw data.

+

Parameters

+
    +
  • message - The message object in question.
    • +
  • data - A string containing the message data.
    • +
+
+

helicsMessageSetDataBuffer

+
def helicsMessageSetDataBuffer(message: HelicsMessage, data: HelicsDataBuffer)
+
+

Set the data payload of a message from a HelicsDataBuffer Object.

+

Parameters

+
    +
  • message - The message object in question.
    • +
  • data - The dataBuffer containing the appropriate data, if null will clear the message payload.
    • +
+
+

helicsMessageSetDestination

+
def helicsMessageSetDestination(message: HelicsMessage, destination: str)
+
+

Set the destination of a message.

+

Parameters

+
    +
  • message - The message object in question.
    • +
  • destination - A string containing the new destination.
    • +
+
+

helicsMessageSetFlagOption

+
def helicsMessageSetFlagOption(message: HelicsMessage, flag: int, value: bool)
+
+

Set a flag on a message.

+

Parameters

+
    +
  • message - The message object in question.
    • +
  • flag - An index of a flag to set on the message.
    • +
  • value - The desired value of the flag.
    • +
+
+

helicsMessageSetMessageID

+
def helicsMessageSetMessageID(message: HelicsMessage, message_id: int)
+
+

Set the message ID for the message. +Normally this is not needed and the core of HELICS will adjust as needed.

+

Parameters

+
    +
  • message - The message object in question.
    • +
  • message_id - A new message ID.
    • +
+
+

helicsMessageSetOriginalDestination

+
def helicsMessageSetOriginalDestination(message: HelicsMessage, destination: str)
+
+

Set the original destination of a message.

+

Parameters

+
    +
  • message - The message object in question.
    • +
  • destination - A string containing the new original source.
    • +
+
+

helicsMessageSetOriginalSource

+
def helicsMessageSetOriginalSource(message: HelicsMessage, source: str)
+
+

Set the original source of a message.

+

Parameters

+
    +
  • message - The message object in question.
    • +
  • source - A string containing the new original source.
    • +
+
+

helicsMessageSetSource

+
def helicsMessageSetSource(message: HelicsMessage, source: str)
+
+

Set the source of a message.

+

Parameters

+
    +
  • message - The message object in question.
    • +
  • source - A string containing the source.
    • +
+
+

helicsMessageSetString

+
def helicsMessageSetString(message: HelicsMessage, string: str)
+
+

Set the data payload of a message as a string.

+

Parameters

+
    +
  • message - The message object in question.
    • +
  • string - A string containing the message data.
    • +
+
+

helicsMessageSetTime

+
def helicsMessageSetTime(message: HelicsMessage, time: HelicsTime)
+
+

Set the delivery time for a message.

+

Parameters

+
    +
  • message - The message object in question.
    • +
  • time - The time the message should be delivered.
    • +
+
+

helicsPublicationAddTarget

+
def helicsPublicationAddTarget(pub: HelicsPublication, target_name: str)
+
+

Add a named input to the list of targets a publication publishes to.

+

Parameters

+
    +
  • pub - The publication to add the target for.
    • +
  • target_name - The name of an input that the data should be sent to.
    • +
+
+

helicsPublicationGetInfo

+
def helicsPublicationGetInfo(pub: HelicsPublication) -> str
+
+

Get the data in the info field of an publication.

+

Parameters

+
    +
  • pub - The publication to query.
    • +
+

Returns: A string with the info field string.

+
+

helicsPublicationGetKey

+
def helicsPublicationGetKey(pub: HelicsPublication) -> str
+
+

Get the name of a publication. +This will be the global name used to identify the publication to the federation.

+

Parameters

+
    +
  • pub - The publication to query.
    • +
+

Returns: A string with the units information.

+

DEPRECATED

+
+

helicsPublicationGetName

+
def helicsPublicationGetName(pub: HelicsPublication) -> str
+
+

Get the name of a publication. +This will be the global name used to identify the publication to the federation.

+

Parameters

+
    +
  • pub - The publication to query.
    • +
+

Returns: A string with the units information.

+
+

helicsPublicationGetOption

+
def helicsPublicationGetOption(pub: HelicsPublication, option: HelicsHandleOption) -> int
+
+

Get the value of an option for a publication.

+

Parameters

+
    +
  • pub - The publication to query.
    • +
  • option - The value to query see helics.HelicsHandleOption.
    • +
+

Returns: A string with the info field string.

+
+

helicsPublicationGetTag

+
def helicsPublicationGetTag(pub: HelicsPublication, tagname: str)
+
+

Get the data in a specified tag of a publication.

+

Parameters

+
    +
  • pub: The publication object to query.
    • +
  • tagname: The name of the tag to query.
    • +
+

Returns

+

A string with the tag data.

+
+

helicsPublicationGetType

+
def helicsPublicationGetType(pub: HelicsPublication) -> str
+
+

Get the type of a publication.

+

Parameters

+
    +
  • pub - The publication to query
    • +
+

Returns: A string with the publication type information.

+
+

helicsPublicationGetUnits

+
def helicsPublicationGetUnits(pub: HelicsPublication) -> str
+
+

Get the units of a publication.

+

Parameters

+
    +
  • pub - The publication to query.
    • +
+

Returns: A string with the units information.

+
+

helicsPublicationIsValid

+
def helicsPublicationIsValid(pub: HelicsPublication) -> bool
+
+

Publication functions. +Functions for publishing data of various kinds. +The data will get translated to the type specified when the publication was constructed automatically regardless of the function used to publish the data. +Check if a publication is valid.

+

Parameters

+
    +
  • pub - The publication to check
    • +
+

Returns: True if the publication is a valid publication.

+
+

helicsPublicationPublishBoolean

+
def helicsPublicationPublishBoolean(pub: HelicsPublication, value: bool)
+
+

Publish a Boolean Value.

+

Parameters

+
    +
  • pub - The publication to publish for.
    • +
  • value - The boolean value to publish.
    • +
+
+

helicsPublicationPublishBytes

+
def helicsPublicationPublishBytes(pub: HelicsPublication, data: bytes)
+
+

Publish raw data from a char * and length.

+

Parameters

+
    +
  • pub - The publication to publish for.
    • +
  • data - A pointer to the raw data.
    • +
+
+

helicsPublicationPublishChar

+
def helicsPublicationPublishChar(pub: HelicsPublication, value: str)
+
+

Publish a single character.

+

Parameters

+
    +
  • pub - The publication to publish for.
    • +
  • value - The numerical value to publish.
    • +
+
+

helicsPublicationPublishComplex

+
def helicsPublicationPublishComplex(pub: HelicsPublication, real: float, imag: float = 0)
+
+

Publish a complex value (or pair of values).

+

Parameters

+
    +
  • pub - The publication to publish for.
    • +
  • real - float number or complex number
    • +
  • imag - float number
    • +
+
+

helicsPublicationPublishComplexVector

+
def helicsPublicationPublishComplexVector(pub: HelicsPublication, vectorInput: List[complex])
+
+

Publish a vector of complexes.

+

Parameters

+
    +
  • pub - The publication to publish for.
    • +
  • vectorInput - A list of complex data.
    • +
+
+

helicsPublicationPublishDataBuffer

+
def helicsPublicationPublishDataBuffer(pub: HelicsPublication, buffer: HelicsDataBuffer)
+
+

Publish a data buffer.

+

Parameters

+
    +
  • pub - The publication to publish for.
    • +
  • buffer - A HelicsDataBuffer to publish.
    • +
+
+

helicsPublicationPublishDouble

+
def helicsPublicationPublishDouble(pub: HelicsPublication, value: float)
+
+

Publish a double floating point value.

+

Parameters

+
    +
  • pub - The publication to publish for.
    • +
  • value - The numerical value to publish.
    • +
+
+

helicsPublicationPublishInteger

+
def helicsPublicationPublishInteger(pub: HelicsPublication, value: int)
+
+

Publish an integer value.

+

Parameters

+
    +
  • pub - The publication to publish for.
    • +
  • value - The numerical value to publish.
    • +
+
+

helicsPublicationPublishNamedPoint

+
def helicsPublicationPublishNamedPoint(pub: HelicsPublication, string: str, value: float)
+
+

Publish a named point.

+

Parameters

+
    +
  • pub - The publication to publish for.
    • +
  • string - A string for the name to publish.
    • +
  • value - A double for the value to publish.
    • +
+
+

helicsPublicationPublishRaw

+
def helicsPublicationPublishRaw(pub: HelicsPublication, data: bytes)
+
+

Publish raw data from a char * and length.

+

Parameters

+
    +
  • pub - The publication to publish for.
    • +
  • data - A pointer to the raw data.
    • +
+

DEPRECATED

+
+

helicsPublicationPublishString

+
def helicsPublicationPublishString(pub: HelicsPublication, string: str)
+
+

Publish a string.

+

Parameters

+
    +
  • pub - The publication to publish for.
    • +
  • string - The string to publish.
    • +
+
+

helicsPublicationPublishTime

+
def helicsPublicationPublishTime(pub: HelicsPublication, value: HelicsTime)
+
+

Publish a time value.

+

Parameters

+
    +
  • pub - The publication to publish for.
    • +
  • value - The numerical value to publish.
    • +
+
+

helicsPublicationPublishVector

+
def helicsPublicationPublishVector(pub: HelicsPublication, vectorInput: List[float])
+
+

Publish a vector of doubles.

+

Parameters

+
    +
  • pub - The publication to publish for.
    • +
  • vectorInput - A list of double data.
    • +
+
+

helicsPublicationSetInfo

+
def helicsPublicationSetInfo(pub: HelicsPublication, info: str)
+
+

Set the data in the info field for a publication.

+

Parameters

+
    +
  • pub - The publication to set the info field for.
    • +
  • info - The string to set.
    • +
+
+

helicsPublicationSetMinimumChange

+
def helicsPublicationSetMinimumChange(pub: HelicsPublication, tolerance: float)
+
+

Set the minimum change detection tolerance.

+

Parameters

+
    +
  • pub - The publication to modify.
    • +
  • tolerance - The tolerance level for publication, values changing less than this value will not be published.
    • +
+
+

helicsPublicationSetOption

+
def helicsPublicationSetOption(pub: HelicsPublication, option: HelicsHandleOption, value: int)
+
+

Set the value of an option for a publication.

+

Parameters

+
    +
  • pub - The publication to query.
    • +
  • option - Integer code for the option to set helics.HelicsHandleOption.
    • +
  • value - The value to set the option to.
    • +
+
+

helicsPublicationSetTag

+
def helicsPublicationSetTag(pub: HelicsPublication, tagname: str, tagvalue: str)
+
+

Set the data in a specific tag for a publication.

+

pub: The publication object to set a tag for. +tagname: The name of the tag to set. +tagvalue: The string value to associate with a tag.

+
+

helicsQueryBrokerExecute

+
def helicsQueryBrokerExecute(query: HelicsQuery, broker: HelicsBroker) -> JSONType
+
+

Execute a query directly on a broker. +The call will block until the query finishes which may require communication or other delays.

+

Parameters

+
    +
  • query - The query object to use in the query.
    • +
  • broker - The broker to send the query to.
    • +
+

Returns: String that contains the result of the query that was executed.

+
+

helicsQueryBufferFill

+
def helicsQueryBufferFill(buffer: HelicsQueryBuffer, string: str)
+
+

Set the data for a query callback.

+

There are many queries that HELICS understands directly, but it is occasionally useful to have a federate be able to respond to specific queries with answers specific to a federate.

+
    +
  • buffer: The buffer received in a helicsQueryCallback.
    • +
  • string: Pointer to the data to fill the buffer with.
    • +
+
+

helicsQueryCoreExecute

+
def helicsQueryCoreExecute(query: HelicsQuery, core: HelicsCore) -> JSONType
+
+

Execute a query directly on a core. +The call will block until the query finishes which may require communication or other delays.

+

Parameters

+
    +
  • query - The query object to use in the query.
    • +
  • core - The core to send the query to.
    • +
+

Returns: String that contains the result of the query that was executed.

+
+

helicsQueryExecute

+
def helicsQueryExecute(query: HelicsQuery, fed: HelicsFederate) -> JSONType
+
+

Execute a query. +The call will block until the query finishes which may require communication or other delays.

+

Parameters

+
    +
  • query - The query object to use in the query.
    • +
  • fed - A federate to send the query through.
    • +
+

Returns: String that contains the result of the query that was executed.

+
+

helicsQueryExecuteAsync

+
def helicsQueryExecuteAsync(query: HelicsQuery, fed: HelicsFederate)
+
+

Execute a query in a non-blocking call.

+

Parameters

+
    +
  • query - The query object to use in the query.
    • +
  • fed - A federate to send the query through.
    • +
+
+

helicsQueryExecuteComplete

+
def helicsQueryExecuteComplete(query: HelicsQuery) -> JSONType
+
+

Complete the return from a query called with helics.helicsExecuteQueryAsync. +The function will block until the query completes isQueryComplete can be called to determine if a query has completed or not.

+

Parameters

+
    +
  • query - The query object to complete execution of.
    • +
+

Returns: String that contains the result of the query that was executed.

+
+

helicsQueryFree

+
def helicsQueryFree(query: HelicsQuery)
+
+

Free the memory associated with a query object.

+
+

helicsQueryIsCompleted

+
def helicsQueryIsCompleted(query: HelicsQuery) -> bool
+
+

Check if an asynchronously executed query has completed. +This function should usually be called after a QueryExecuteAsync function has been called.

+

Parameters

+
    +
  • query - The query object to check if completed
    • +
+

Returns: Will return True if an asynchronous query has completed or a regular query call was made with a result, and false if an asynchronous query has not completed or is invalid.

+
+

helicsQuerySetOrdering

+
def helicsQuerySetOrdering(query: HelicsQuery, mode: int)
+
+

Update the ordering mode of the query, fast runs on priority channels, ordered goes on normal channels but goes in sequence

+

Parameters

+
    +
  • query: The query object to change the order for.
    • +
  • mode: 0 for fast, 1 for ordered.
    • +
+
+

helicsQuerySetQueryString

+
def helicsQuerySetQueryString(query: HelicsQuery, query_string: str)
+
+

Update the queryString of a query.

+

Parameters

+
    +
  • query - The query object to change the target of.
    • +
  • query_string - the new queryString.
    • +
+
+

helicsQuerySetTarget

+
def helicsQuerySetTarget(query: HelicsQuery, target_name: str)
+
+

Update the target of a query.

+

Parameters

+
    +
  • query - The query object to change the target of.
    • +
  • target_name - the name of the target to query.
    • +
+
+

helicsSubscriptionGetKey

+
def helicsSubscriptionGetKey(ipt: HelicsInput) -> str
+
+

Get the name of a subscription.

+

Parameters

+
    +
  • ipt - The input to query
    • +
+

Returns: A string with the subscription name.

+

DEPRECATED

+
+

helicsSubscriptionGetTarget

+
def helicsSubscriptionGetTarget(ipt: HelicsInput) -> str
+
+

Get the target of a subscription.

+

Parameters

+
    +
  • ipt - The input to query
    • +
+

Returns: A string with the subscription target.

+

DEPRECATED

+
+

helicsTranslatorAddDestinationEndpoint

+
def helicsTranslatorAddDestinationEndpoint(translator: HelicsTranslator, destination: str)
+
+

Add a destination target to a translator. +All messages coming from a source are copied to the delivery address(es).

+

Parameters

+
    +
  • translator - The given translator.
    • +
  • destination - The name of the translator to add as a source target.
    • +
+
+

helicsTranslatorAddInputTarget

+
def helicsTranslatorAddInputTarget(translator: HelicsTranslator, input: str)
+
+

Add an input to send a translator output.

+

All messages going to a destination are copied to the delivery address(es).

+

Parameters

+
    +
  • translator - The given translator to add a input target to.
    • +
  • input - The name of the endpoint to add as a input target.
    • +
+
+

helicsTranslatorAddPublicationTarget

+
def helicsTranslatorAddPublicationTarget(translator: HelicsTranslator, publication: str)
+
+

Add a source publication target to a translator.

+

All messages coming from a source are copied to the delivery address(es).

+
    +
  • translator - The given translator.
    • +
  • publication - The name of the endpoint to add as a publication target.
    • +
+
+

helicsTranslatorAddSourceEndpoint

+
def helicsTranslatorAddSourceEndpoint(translator: HelicsTranslator, source: str)
+
+

Add a source endpoint target to a translator.

+

All messages coming from a source are copied to the delivery address(es).

+
    +
  • trans - The given translator.
    • +
  • `source`` - The name of the endpoint to add as a source target.
    • +
+
+

helicsTranslatorGetInfo

+
def helicsTranslatorGetInfo(translator: HelicsTranslator) -> str
+
+

Get the data in the info field of an translator.

+

Parameters

+
    +
  • translator - The translator to query.
    • +
+

Returns: A string with the info field string.

+
+

helicsTranslatorGetName

+
def helicsTranslatorGetName(translator: HelicsTranslator) -> str
+
+

Get the name of a translator.

+

Parameters

+
    +
  • translator - The translator to query.
    • +
+

Returns: A string with the name of the translator.

+
+

helicsTranslatorGetOption

+
def helicsTranslatorGetOption(translator: HelicsTranslator, option: HelicsHandleOption) -> int
+
+

Get the current value of an translator handle option.

+

Parameters

+
    +
  • translator - The translator to query.
    • +
  • option - Integer representation of the option in question see helics.HelicsHandleOption.
    • +
+

Returns: An integer value with the current value of the given option.

+
+

helicsTranslatorGetTag

+
def helicsTranslatorGetTag(translator: HelicsTranslator) -> str
+
+

Get the data in the tag for an translator.

+

Parameters

+
    +
  • translator - The translator to query.
    • +
+

Returns: A string with the info field string.

+
+

helicsTranslatorIsValid

+
def helicsTranslatorIsValid(translator: HelicsTranslator) -> bool
+
+

Check if a translator is valid.

+
    +
  • translator The translator object to check.
    • +
+

Returns: True if the Translator object represents a valid translator.

+
+

helicsTranslatorRemoveTarget

+
def helicsTranslatorRemoveTarget(translator: HelicsTranslator, target: str)
+
+

Remove target from translator

+

Parameters

+
    +
  • translator - The given translator.
    • +
  • target_name - The name of the translator to remove.
    • +
+
+

helicsTranslatorSet

+
def helicsTranslatorSet(translator: HelicsTranslator, property: str, value: float)
+
+

Set a property on a translator.

+
    +
  • translator: The translator to modify.
    • +
  • prop: A string containing the property to set.
    • +
  • val: A numerical value for the property.
    • +
+
+

helicsTranslatorSetCustomCallback

+
def helicsTranslatorSetCustomCallback(translator, to_message_call, to_value_call, user_data)
+
+

Set a general callback for a custom translator.

+

Add a pair of custom callbacks for running a translator operation in the C shared library.

+

Parameters

+
    +
  • translator: The translator object to set the callbacks for.
    • +
  • to_message_call: A callback with signature void(HelicsDataBuffer, HelicsMessage, void *); The function arguments are raw Value data, the messageObject to fill out and a pointer to user data.
    • +
  • to_value_call: A callback with signature void(HelicsMessage, HelicsDataBuffer, void *); The function arguments are a message object, the data buffer to fill out and a pointer to user data.
    • +
  • user_data: A pointer to user data that is passed to the functions when executing.
    • +
+
+

helicsTranslatorSetInfo

+
def helicsTranslatorSetInfo(translator: HelicsTranslator, info: str)
+
+

Set the data in the info field for an translator.

+

Parameters

+
    +
  • translator - The translator to query.
    • +
  • info - The string to set.
    • +
+
+

helicsTranslatorSetOption

+
def helicsTranslatorSetOption(translator: HelicsTranslator, option: HelicsHandleOption, value: int)
+
+

Set an option on an translator.

+

Parameters

+
    +
  • translator - The translator to query.
    • +
  • option - The option to set for the translator helics.HelicsHandleOption.
    • +
  • value - The value to set the option to.
    • +
+
+

helicsTranslatorSetString

+
def helicsTranslatorSetString(translator: HelicsTranslator, property: str, value: str)
+
+

Set string property on a translator.

+

Parameters

+
    +
  • translator - The translator to modify
    • +
  • property: A string containing the property to set.
    • +
  • value: A string value for the property.
    • +
+
+

helicsTranslatorSetTag

+
def helicsTranslatorSetTag(translator: HelicsTranslator, tag: str)
+
+

Set the data in the tag for an translator.

+

Parameters

+
    +
  • translator - The translator to query.
    • +
  • tag - The string to set.
    • +
+
+

helicsWrapDataInBuffer

+
def helicsWrapDataInBuffer(data: bytes, data_capacity: int) -> HelicsDataBuffer
+
+

Wrap user data in a buffer object

+
+

loadSym

+
def loadSym(s)
+
+ + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/cli-py/index.html b/api/cli-py/index.html new file mode 100644 index 00000000..eb7340dd --- /dev/null +++ b/api/cli-py/index.html @@ -0,0 +1,559 @@ + + + + + + + + + + + + + + + + + + + helics.cli - PyHELICS + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + +

Module helics.cli

+

HELICS command line interface

+

Classes

+

Job

+
class Job(name: str, process: subprocess.Popen, file: str)
+
+

Job(name: str, process: subprocess.Popen, file: str)

+

Initialize self. See help(type(self)) for accurate signature.

+
+

Output

+
class Output(name: str, file: Optional[_io.TextIOWrapper])
+
+

Output(name: str, file: Optional[_io.TextIOWrapper])

+

Initialize self. See help(type(self)) for accurate signature.

+

Functions

+

fetch

+
def fetch(url, data={}, method="POST")
+
+ + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/database-py/index.html b/api/database-py/index.html new file mode 100644 index 00000000..f79a38c2 --- /dev/null +++ b/api/database-py/index.html @@ -0,0 +1,759 @@ + + + + + + + + + + + + + + + + + + + helics.database - PyHELICS + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + +

Module helics.database

+

Classes

+

Brokers

+
class Brokers(**kwargs)
+
+

The base class of the class hierarchy.

+

When called, it accepts no arguments and returns a new featureless +instance that has no instance attributes and cannot be given any.

+
+

Base classes

+
    +
  • sqlalchemy.Base
    • +
+
+

Cores

+
class Cores(**kwargs)
+
+

The base class of the class hierarchy.

+

When called, it accepts no arguments and returns a new featureless +instance that has no instance attributes and cannot be given any.

+
+

Base classes

+
    +
  • sqlalchemy.Base
    • +
+
+

DataGraph

+
class DataGraph(**kwargs)
+
+

The base class of the class hierarchy.

+

When called, it accepts no arguments and returns a new featureless +instance that has no instance attributes and cannot be given any.

+
+

Base classes

+
    +
  • sqlalchemy.Base
    • +
+
+

FederateEventLogs

+
class FederateEventLogs(**kwargs)
+
+

The base class of the class hierarchy.

+

When called, it accepts no arguments and returns a new featureless +instance that has no instance attributes and cannot be given any.

+
+

Base classes

+
    +
  • sqlalchemy.Base
    • +
+
+

FederateGraph

+
class FederateGraph(**kwargs)
+
+

The base class of the class hierarchy.

+

When called, it accepts no arguments and returns a new featureless +instance that has no instance attributes and cannot be given any.

+
+

Base classes

+
    +
  • sqlalchemy.Base
    • +
+
+

Federates

+
class Federates(**kwargs)
+
+

The base class of the class hierarchy.

+

When called, it accepts no arguments and returns a new featureless +instance that has no instance attributes and cannot be given any.

+
+

Base classes

+
    +
  • sqlalchemy.Base
    • +
+
+

Inputs

+
class Inputs(**kwargs)
+
+

The base class of the class hierarchy.

+

When called, it accepts no arguments and returns a new featureless +instance that has no instance attributes and cannot be given any.

+
+

Base classes

+
    +
  • sqlalchemy.Base
    • +
+
+

MetaData

+
class MetaData(**kwargs)
+
+

The base class of the class hierarchy.

+

When called, it accepts no arguments and returns a new featureless +instance that has no instance attributes and cannot be given any.

+
+

Base classes

+
    +
  • sqlalchemy.Base
    • +
+
+

Publications

+
class Publications(**kwargs)
+
+

The base class of the class hierarchy.

+

When called, it accepts no arguments and returns a new featureless +instance that has no instance attributes and cannot be given any.

+
+

Base classes

+
    +
  • sqlalchemy.Base
    • +
+
+

Subscriptions

+
class Subscriptions(**kwargs)
+
+

The base class of the class hierarchy.

+

When called, it accepts no arguments and returns a new featureless +instance that has no instance attributes and cannot be given any.

+
+

Base classes

+
    +
  • sqlalchemy.Base
    • +
+
+

SystemInfo

+
class SystemInfo(**kwargs)
+
+

The base class of the class hierarchy.

+

When called, it accepts no arguments and returns a new featureless +instance that has no instance attributes and cannot be given any.

+
+

Base classes

+
    +
  • sqlalchemy.Base
    • +
+

Functions

+

as_dict

+
def as_dict(t)
+
+ + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/flaskr/index.html b/api/flaskr/index.html new file mode 100644 index 00000000..9c9954ca --- /dev/null +++ b/api/flaskr/index.html @@ -0,0 +1,1256 @@ + + + + + + + + + + + + + + + + + + + helics.flaskr - PyHELICS + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + +

Module helics.flaskr

+

Classes

+

APIException

+
class APIException(self, code, message)
+
+

Common base class for all non-exit exceptions.

+

Initialize self. See help(type(self)) for accurate signature.

+
+

Base classes

+
    +
  • builtins.Exception
    • +
+
+

Instance attributes

+
    +
  • +

    code

    +
    • +
  • +

    message

    +
    • +
+
+

BrokerServer

+
class BrokerServer()
+
+

Represents an abstract RESTful resource. Concrete resources should +extend from this class and expose methods for each supported HTTP +method. If a resource is invoked with an unsupported HTTP method, +the API will return a response with status 405 Method Not Allowed. +Otherwise the appropriate method is called and passed all arguments +from the url rule used when adding the resource to an Api instance. See +:meth:~flask_restful.Api.add_resource for details.

+
+

Base classes

+
    +
  • flask_restful.Resource
    • +
+
+

Methods

+

get

+
def get(self)
+
+
+

post

+
def post(self)
+
+
+

Cores

+
class Cores()
+
+

Represents an abstract RESTful resource. Concrete resources should +extend from this class and expose methods for each supported HTTP +method. If a resource is invoked with an unsupported HTTP method, +the API will return a response with status 405 Method Not Allowed. +Otherwise the appropriate method is called and passed all arguments +from the url rule used when adding the resource to an Api instance. See +:meth:~flask_restful.Api.add_resource for details.

+
+

Base classes

+
    +
  • flask_restful.Resource
    • +
+
+

Methods

+

get

+
def get(self)
+
+
+

DataTable

+
class DataTable()
+
+

Represents an abstract RESTful resource. Concrete resources should +extend from this class and expose methods for each supported HTTP +method. If a resource is invoked with an unsupported HTTP method, +the API will return a response with status 405 Method Not Allowed. +Otherwise the appropriate method is called and passed all arguments +from the url rule used when adding the resource to an Api instance. See +:meth:~flask_restful.Api.add_resource for details.

+
+

Base classes

+
    +
  • flask_restful.Resource
    • +
+
+

Methods

+

get

+
def get(self)
+
+
+

Database

+
class Database()
+
+

Represents an abstract RESTful resource. Concrete resources should +extend from this class and expose methods for each supported HTTP +method. If a resource is invoked with an unsupported HTTP method, +the API will return a response with status 405 Method Not Allowed. +Otherwise the appropriate method is called and passed all arguments +from the url rule used when adding the resource to an Api instance. See +:meth:~flask_restful.Api.add_resource for details.

+
+

Base classes

+
    +
  • flask_restful.Resource
    • +
+
+

Methods

+

get

+
def get(self)
+
+
+

post

+
def post(self)
+
+
+

DatabaseManager

+
class DatabaseManager(self, path_to_helics_db=cache["path"])
+
+

Initialize self. See help(type(self)) for accurate signature.

+
+

Methods

+

instaniate

+
def instaniate(self)
+
+
+

Federates

+
class Federates()
+
+

Represents an abstract RESTful resource. Concrete resources should +extend from this class and expose methods for each supported HTTP +method. If a resource is invoked with an unsupported HTTP method, +the API will return a response with status 405 Method Not Allowed. +Otherwise the appropriate method is called and passed all arguments +from the url rule used when adding the resource to an Api instance. See +:meth:~flask_restful.Api.add_resource for details.

+
+

Base classes

+
    +
  • flask_restful.Resource
    • +
+
+

Methods

+

get

+
def get(self)
+
+
+

Graph

+
class Graph()
+
+

Represents an abstract RESTful resource. Concrete resources should +extend from this class and expose methods for each supported HTTP +method. If a resource is invoked with an unsupported HTTP method, +the API will return a response with status 405 Method Not Allowed. +Otherwise the appropriate method is called and passed all arguments +from the url rule used when adding the resource to an Api instance. See +:meth:~flask_restful.Api.add_resource for details.

+
+

Base classes

+
    +
  • flask_restful.Resource
    • +
+
+

Methods

+

get

+
def get(self)
+
+
+

Health

+
class Health()
+
+

Represents an abstract RESTful resource. Concrete resources should +extend from this class and expose methods for each supported HTTP +method. If a resource is invoked with an unsupported HTTP method, +the API will return a response with status 405 Method Not Allowed. +Otherwise the appropriate method is called and passed all arguments +from the url rule used when adding the resource to an Api instance. See +:meth:~flask_restful.Api.add_resource for details.

+
+

Base classes

+
    +
  • flask_restful.Resource
    • +
+
+

Methods

+

get

+
def get(self)
+
+
+

Inputs

+
class Inputs()
+
+

Represents an abstract RESTful resource. Concrete resources should +extend from this class and expose methods for each supported HTTP +method. If a resource is invoked with an unsupported HTTP method, +the API will return a response with status 405 Method Not Allowed. +Otherwise the appropriate method is called and passed all arguments +from the url rule used when adding the resource to an Api instance. See +:meth:~flask_restful.Api.add_resource for details.

+
+

Base classes

+
    +
  • flask_restful.Resource
    • +
+
+

Methods

+

get

+
def get(self)
+
+
+

Profile

+
class Profile()
+
+

Represents an abstract RESTful resource. Concrete resources should +extend from this class and expose methods for each supported HTTP +method. If a resource is invoked with an unsupported HTTP method, +the API will return a response with status 405 Method Not Allowed. +Otherwise the appropriate method is called and passed all arguments +from the url rule used when adding the resource to an Api instance. See +:meth:~flask_restful.Api.add_resource for details.

+
+

Base classes

+
    +
  • flask_restful.Resource
    • +
+
+

Methods

+

get

+
def get(self)
+
+
+

post

+
def post(self)
+
+
+

Publications

+
class Publications()
+
+

Represents an abstract RESTful resource. Concrete resources should +extend from this class and expose methods for each supported HTTP +method. If a resource is invoked with an unsupported HTTP method, +the API will return a response with status 405 Method Not Allowed. +Otherwise the appropriate method is called and passed all arguments +from the url rule used when adding the resource to an Api instance. See +:meth:~flask_restful.Api.add_resource for details.

+
+

Base classes

+
    +
  • flask_restful.Resource
    • +
+
+

Methods

+

get

+
def get(self)
+
+
+

RunnerFile

+
class RunnerFile()
+
+

Represents an abstract RESTful resource. Concrete resources should +extend from this class and expose methods for each supported HTTP +method. If a resource is invoked with an unsupported HTTP method, +the API will return a response with status 405 Method Not Allowed. +Otherwise the appropriate method is called and passed all arguments +from the url rule used when adding the resource to an Api instance. See +:meth:~flask_restful.Api.add_resource for details.

+
+

Base classes

+
    +
  • flask_restful.Resource
    • +
+
+

Methods

+

get

+
def get(self)
+
+
+

post

+
def post(self)
+
+
+

RunnerFileEdit

+
class RunnerFileEdit()
+
+

Represents an abstract RESTful resource. Concrete resources should +extend from this class and expose methods for each supported HTTP +method. If a resource is invoked with an unsupported HTTP method, +the API will return a response with status 405 Method Not Allowed. +Otherwise the appropriate method is called and passed all arguments +from the url rule used when adding the resource to an Api instance. See +:meth:~flask_restful.Api.add_resource for details.

+
+

Base classes

+
    +
  • flask_restful.Resource
    • +
+
+

Methods

+

delete

+
def delete(self)
+
+
+

post

+
def post(self)
+
+
+

put

+
def put(self)
+
+
+

RunnerFileFolder

+
class RunnerFileFolder()
+
+

Represents an abstract RESTful resource. Concrete resources should +extend from this class and expose methods for each supported HTTP +method. If a resource is invoked with an unsupported HTTP method, +the API will return a response with status 405 Method Not Allowed. +Otherwise the appropriate method is called and passed all arguments +from the url rule used when adding the resource to an Api instance. See +:meth:~flask_restful.Api.add_resource for details.

+
+

Base classes

+
    +
  • flask_restful.Resource
    • +
+
+

Methods

+

post

+
def post(self)
+
+
+

RunnerFileName

+
class RunnerFileName()
+
+

Represents an abstract RESTful resource. Concrete resources should +extend from this class and expose methods for each supported HTTP +method. If a resource is invoked with an unsupported HTTP method, +the API will return a response with status 405 Method Not Allowed. +Otherwise the appropriate method is called and passed all arguments +from the url rule used when adding the resource to an Api instance. See +:meth:~flask_restful.Api.add_resource for details.

+
+

Base classes

+
    +
  • flask_restful.Resource
    • +
+
+

Methods

+

post

+
def post(self)
+
+
+

RunnerFilePath

+
class RunnerFilePath()
+
+

Represents an abstract RESTful resource. Concrete resources should +extend from this class and expose methods for each supported HTTP +method. If a resource is invoked with an unsupported HTTP method, +the API will return a response with status 405 Method Not Allowed. +Otherwise the appropriate method is called and passed all arguments +from the url rule used when adding the resource to an Api instance. See +:meth:~flask_restful.Api.add_resource for details.

+
+

Base classes

+
    +
  • flask_restful.Resource
    • +
+
+

Methods

+

post

+
def post(self)
+
+
+

RunnerKillBroker

+
class RunnerKillBroker()
+
+

Represents an abstract RESTful resource. Concrete resources should +extend from this class and expose methods for each supported HTTP +method. If a resource is invoked with an unsupported HTTP method, +the API will return a response with status 405 Method Not Allowed. +Otherwise the appropriate method is called and passed all arguments +from the url rule used when adding the resource to an Api instance. See +:meth:~flask_restful.Api.add_resource for details.

+
+

Base classes

+
    +
  • flask_restful.Resource
    • +
+
+

Methods

+

post

+
def post(self)
+
+
+

RunnerLog

+
class RunnerLog()
+
+

Represents an abstract RESTful resource. Concrete resources should +extend from this class and expose methods for each supported HTTP +method. If a resource is invoked with an unsupported HTTP method, +the API will return a response with status 405 Method Not Allowed. +Otherwise the appropriate method is called and passed all arguments +from the url rule used when adding the resource to an Api instance. See +:meth:~flask_restful.Api.add_resource for details.

+
+

Base classes

+
    +
  • flask_restful.Resource
    • +
+
+

Methods

+

get

+
def get(self, name)
+
+
+

RunnerRun

+
class RunnerRun()
+
+

Represents an abstract RESTful resource. Concrete resources should +extend from this class and expose methods for each supported HTTP +method. If a resource is invoked with an unsupported HTTP method, +the API will return a response with status 405 Method Not Allowed. +Otherwise the appropriate method is called and passed all arguments +from the url rule used when adding the resource to an Api instance. See +:meth:~flask_restful.Api.add_resource for details.

+
+

Base classes

+
    +
  • flask_restful.Resource
    • +
+
+

Methods

+

delete

+
def delete(self)
+
+
+

get

+
def get(self)
+
+
+

post

+
def post(self)
+
+
+

RunnerStatus

+
class RunnerStatus()
+
+

Represents an abstract RESTful resource. Concrete resources should +extend from this class and expose methods for each supported HTTP +method. If a resource is invoked with an unsupported HTTP method, +the API will return a response with status 405 Method Not Allowed. +Otherwise the appropriate method is called and passed all arguments +from the url rule used when adding the resource to an Api instance. See +:meth:~flask_restful.Api.add_resource for details.

+
+

Base classes

+
    +
  • flask_restful.Resource
    • +
+
+

Methods

+

get

+
def get(self)
+
+
+

post

+
def post(self)
+
+
+

Subscriptions

+
class Subscriptions()
+
+

Represents an abstract RESTful resource. Concrete resources should +extend from this class and expose methods for each supported HTTP +method. If a resource is invoked with an unsupported HTTP method, +the API will return a response with status 405 Method Not Allowed. +Otherwise the appropriate method is called and passed all arguments +from the url rule used when adding the resource to an Api instance. See +:meth:~flask_restful.Api.add_resource for details.

+
+

Base classes

+
    +
  • flask_restful.Resource
    • +
+
+

Methods

+

get

+
def get(self)
+
+
+

SystemInfo

+
class SystemInfo()
+
+

Represents an abstract RESTful resource. Concrete resources should +extend from this class and expose methods for each supported HTTP +method. If a resource is invoked with an unsupported HTTP method, +the API will return a response with status 405 Method Not Allowed. +Otherwise the appropriate method is called and passed all arguments +from the url rule used when adding the resource to an Api instance. See +:meth:~flask_restful.Api.add_resource for details.

+
+

Base classes

+
    +
  • flask_restful.Resource
    • +
+
+

Methods

+

get

+
def get(self)
+
+

Functions

+

index

+
def index(path)
+
+
+

run

+
def run()
+
+ + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/index.html b/api/index.html new file mode 100644 index 00000000..1673be10 --- /dev/null +++ b/api/index.html @@ -0,0 +1,558 @@ + + + + + + + + + + + + + + + + + + + + + + + helics - PyHELICS + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/observer-py/index.html b/api/observer-py/index.html new file mode 100644 index 00000000..b0932ae2 --- /dev/null +++ b/api/observer-py/index.html @@ -0,0 +1,551 @@ + + + + + + + + + + + + + + + + + + + helics.observer - PyHELICS + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + +

Module helics.observer

+

Classes

+

HelicsObserverFederate

+
class HelicsObserverFederate(self, folder=None, core_type="zmq")
+
+

HelicsObserverFederate

+

Initialize self. See help(type(self)) for accurate signature.

+
+

Instance attributes

+
    +
  • +

    brokers

    +
    • +
  • +

    federates

    +
    • +
  • +

    inputs

    +
    • +
  • +

    publications

    +
    • +
  • +

    subscriptions

    +
    • +
+
+

Methods

+

get_data

+
def get_data(self)
+
+
+

hook

+
def hook(self)
+
+
+

run

+
def run(self)
+
+
+

wait

+
def wait(self)
+
+ + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/profile-py/index.html b/api/profile-py/index.html new file mode 100644 index 00000000..f7858a26 --- /dev/null +++ b/api/profile-py/index.html @@ -0,0 +1,526 @@ + + + + + + + + + + + + + + + + + + + helics.profile - PyHELICS + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + +

Module helics.profile

+

Functions

+

plot

+
def plot(profile, save=None, kind="simulation", **kwargs)
+
+
+

profile

+
def profile(filename, invert=True)
+
+ + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/status_checker-py/index.html b/api/status_checker-py/index.html new file mode 100644 index 00000000..2ac7b6cc --- /dev/null +++ b/api/status_checker-py/index.html @@ -0,0 +1,594 @@ + + + + + + + + + + + + + + + + + + + helics.status_checker - PyHELICS + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + +

Module helics.status_checker

+

Classes

+

CheckStatusThread

+
class CheckStatusThread(self, process_list, should_kill, helics_server_available)
+
+

A class that represents a thread of control.

+

This class can be safely subclassed in a limited fashion. There are two ways +to specify the activity: by passing a callable object to the constructor, or +by overriding the run() method in a subclass.

+

This constructor should always be called with keyword arguments. Arguments are:

+

group should be None; reserved for future extension when a ThreadGroup +class is implemented.

+

target is the callable object to be invoked by the run() +method. Defaults to None, meaning nothing is called.

+

name is the thread name. By default, a unique name is constructed of +the form “Thread-N” where N is a small decimal number.

+

args is a list or tuple of arguments for the target invocation. Defaults to ().

+

kwargs is a dictionary of keyword arguments for the target +invocation. Defaults to {}.

+

If a subclass overrides the constructor, it must make sure to invoke +the base class constructor (Thread.init()) before doing anything +else to the thread.

+
+

Base classes

+
    +
  • threading.Thread
    • +
+
+

Instance attributes

+
    +
  • daemon A boolean value indicating whether this thread is a daemon thread.
    • +
+

This must be set before start() is called, otherwise RuntimeError is +raised. Its initial value is inherited from the creating thread; the +main thread is not a daemon thread and therefore all threads created in +the main thread default to daemon = False.

+

The entire Python program exits when only daemon threads are left.

+
    +
  • ident Thread identifier of this thread or None if it has not been started.
    • +
+

This is a nonzero integer. See the get_ident() function. Thread +identifiers may be recycled when a thread exits and another thread is +created. The identifier is available even after the thread has exited.

+
    +
  • name A string used for identification purposes only.
    • +
+

It has no semantics. Multiple threads may be given the same name. The +initial name is set by the constructor.

+
    +
  • native_id Native integral thread ID of this thread, or None if it has not been started.
    • +
+

This is a non-negative integer. See the get_native_id() function. +This represents the Thread ID as reported by the kernel.

+
+

Methods

+

run

+
def run(self)
+
+

Method representing the thread’s activity.

+

You may override this method in a subclass. The standard run() method +invokes the callable object passed to the object’s constructor as the +target argument, if any, with sequential and keyword arguments taken +from the args and kwargs arguments, respectively.

+
+

status

+
def status(self, p)
+
+
+

HELICSRuntimeError

+
class HELICSRuntimeError(self, *args, **kwargs)
+
+

Unspecified run-time error.

+
+

Base classes

+
    +
  • builtins.RuntimeError
    • +
+ + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/utils-py/index.html b/api/utils-py/index.html new file mode 100644 index 00000000..5aac7c35 --- /dev/null +++ b/api/utils-py/index.html @@ -0,0 +1,552 @@ + + + + + + + + + + + + + + + + + + + helics.utils - PyHELICS + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + +

Module helics.utils

+

Functions

+

echo

+
def echo(msg, fg="yellow", level="warn", blink=True)
+
+
+

error

+
def error(msg, blink=False)
+
+
+

info

+
def info(msg, blink=False)
+
+
+

warn

+
def warn(msg, blink=True)
+
+ + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/vcredist-py/index.html b/api/vcredist-py/index.html new file mode 100644 index 00000000..d2adaa78 --- /dev/null +++ b/api/vcredist-py/index.html @@ -0,0 +1,562 @@ + + + + + + + + + + + + + + + + + + + helics.vcredist - PyHELICS + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + +

Module helics.vcredist

+

Classes

+

VcRedist

+
class VcRedist(self, version="2015", arch="amd64")
+
+

Initialize self. See help(type(self)) for accurate signature.

+
+

Methods

+

download_and_run

+
def download_and_run(self)
+
+

Functions

+

download_file

+
def download_file(url, filepath)
+
+

Download the file from url and store it in the given filepath.

+
+

filename_from_url

+
def filename_from_url(url)
+
+

Return the filename from a given url.

+ + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/assets/images/favicon.png b/assets/images/favicon.png new file mode 100644 index 0000000000000000000000000000000000000000..1cf13b9f9d978896599290a74f77d5dbe7d1655c GIT binary patch literal 1870 zcmV-U2eJ5xP)Gc)JR9QMau)O=X#!i9;T z37kk-upj^(fsR36MHs_+1RCI)NNu9}lD0S{B^g8PN?Ww(5|~L#Ng*g{WsqleV}|#l zz8@ri&cTzw_h33bHI+12+kK6WN$h#n5cD8OQt`5kw6p~9H3()bUQ8OS4Q4HTQ=1Ol z_JAocz`fLbT2^{`8n~UAo=#AUOf=SOq4pYkt;XbC&f#7lb$*7=$na!mWCQ`dBQsO0 zLFBSPj*N?#u5&pf2t4XjEGH|=pPQ8xh7tpx;US5Cx_Ju;!O`ya-yF`)b%TEt5>eP1ZX~}sjjA%FJF?h7cX8=b!DZl<6%Cv z*G0uvvU+vmnpLZ2paivG-(cd*y3$hCIcsZcYOGh{$&)A6*XX&kXZd3G8m)G$Zz-LV z^GF3VAW^Mdv!)4OM8EgqRiz~*Cji;uzl2uC9^=8I84vNp;ltJ|q-*uQwGp2ma6cY7 z;`%`!9UXO@fr&Ebapfs34OmS9^u6$)bJxrucutf>`dKPKT%%*d3XlFVKunp9 zasduxjrjs>f8V=D|J=XNZp;_Zy^WgQ$9WDjgY=z@stwiEBm9u5*|34&1Na8BMjjgf3+SHcr`5~>oz1Y?SW^=K z^bTyO6>Gar#P_W2gEMwq)ot3; zREHn~U&Dp0l6YT0&k-wLwYjb?5zGK`W6S2v+K>AM(95m2C20L|3m~rN8dprPr@t)5lsk9Hu*W z?pS990s;Ez=+Rj{x7p``4>+c0G5^pYnB1^!TL=(?HLHZ+HicG{~4F1d^5Awl_2!1jICM-!9eoLhbbT^;yHcefyTAaqRcY zmuctDopPT!%k+}x%lZRKnzykr2}}XfG_ne?nRQO~?%hkzo;@RN{P6o`&mMUWBYMTe z6i8ChtjX&gXl`nvrU>jah)2iNM%JdjqoaeaU%yVn!^70x-flljp6Q5tK}5}&X8&&G zX3fpb3E(!rH=zVI_9Gjl45w@{(ITqngWFe7@9{mX;tO25Z_8 zQHEpI+FkTU#4xu>RkN>b3Tnc3UpWzPXWm#o55GKF09j^Mh~)K7{QqbO_~(@CVq! zS<8954|P8mXN2MRs86xZ&Q4EfM@JB94b=(YGuk)s&^jiSF=t3*oNK3`rD{H`yQ?d; ztE=laAUoZx5?RC8*WKOj`%LXEkgDd>&^Q4M^z`%u0rg-It=hLCVsq!Z%^6eB-OvOT zFZ28TN&cRmgU}Elrnk43)!>Z1FCPL2K$7}gwzIc48NX}#!A1BpJP?#v5wkNprhV** z?Cpalt1oH&{r!o3eSKc&ap)iz2BTn_VV`4>9M^b3;(YY}4>#ML6{~(4mH+?%07*qo IM6N<$f(jP3KmY&$ literal 0 HcmV?d00001 diff --git a/assets/javascripts/bundle.ad660dcc.min.js b/assets/javascripts/bundle.ad660dcc.min.js new file mode 100644 index 00000000..0ffc0460 --- /dev/null +++ b/assets/javascripts/bundle.ad660dcc.min.js @@ -0,0 +1,29 @@ +"use strict";(()=>{var Fi=Object.create;var gr=Object.defineProperty;var ji=Object.getOwnPropertyDescriptor;var Wi=Object.getOwnPropertyNames,Dt=Object.getOwnPropertySymbols,Ui=Object.getPrototypeOf,xr=Object.prototype.hasOwnProperty,no=Object.prototype.propertyIsEnumerable;var oo=(e,t,r)=>t in e?gr(e,t,{enumerable:!0,configurable:!0,writable:!0,value:r}):e[t]=r,R=(e,t)=>{for(var r in t||(t={}))xr.call(t,r)&&oo(e,r,t[r]);if(Dt)for(var r of Dt(t))no.call(t,r)&&oo(e,r,t[r]);return e};var io=(e,t)=>{var r={};for(var o in e)xr.call(e,o)&&t.indexOf(o)<0&&(r[o]=e[o]);if(e!=null&&Dt)for(var o of Dt(e))t.indexOf(o)<0&&no.call(e,o)&&(r[o]=e[o]);return r};var yr=(e,t)=>()=>(t||e((t={exports:{}}).exports,t),t.exports);var Di=(e,t,r,o)=>{if(t&&typeof t=="object"||typeof t=="function")for(let n of Wi(t))!xr.call(e,n)&&n!==r&&gr(e,n,{get:()=>t[n],enumerable:!(o=ji(t,n))||o.enumerable});return e};var Vt=(e,t,r)=>(r=e!=null?Fi(Ui(e)):{},Di(t||!e||!e.__esModule?gr(r,"default",{value:e,enumerable:!0}):r,e));var ao=(e,t,r)=>new Promise((o,n)=>{var i=p=>{try{s(r.next(p))}catch(c){n(c)}},a=p=>{try{s(r.throw(p))}catch(c){n(c)}},s=p=>p.done?o(p.value):Promise.resolve(p.value).then(i,a);s((r=r.apply(e,t)).next())});var co=yr((Er,so)=>{(function(e,t){typeof Er=="object"&&typeof so!="undefined"?t():typeof define=="function"&&define.amd?define(t):t()})(Er,function(){"use strict";function e(r){var o=!0,n=!1,i=null,a={text:!0,search:!0,url:!0,tel:!0,email:!0,password:!0,number:!0,date:!0,month:!0,week:!0,time:!0,datetime:!0,"datetime-local":!0};function s(H){return!!(H&&H!==document&&H.nodeName!=="HTML"&&H.nodeName!=="BODY"&&"classList"in H&&"contains"in H.classList)}function p(H){var mt=H.type,ze=H.tagName;return!!(ze==="INPUT"&&a[mt]&&!H.readOnly||ze==="TEXTAREA"&&!H.readOnly||H.isContentEditable)}function c(H){H.classList.contains("focus-visible")||(H.classList.add("focus-visible"),H.setAttribute("data-focus-visible-added",""))}function l(H){H.hasAttribute("data-focus-visible-added")&&(H.classList.remove("focus-visible"),H.removeAttribute("data-focus-visible-added"))}function f(H){H.metaKey||H.altKey||H.ctrlKey||(s(r.activeElement)&&c(r.activeElement),o=!0)}function u(H){o=!1}function h(H){s(H.target)&&(o||p(H.target))&&c(H.target)}function w(H){s(H.target)&&(H.target.classList.contains("focus-visible")||H.target.hasAttribute("data-focus-visible-added"))&&(n=!0,window.clearTimeout(i),i=window.setTimeout(function(){n=!1},100),l(H.target))}function A(H){document.visibilityState==="hidden"&&(n&&(o=!0),te())}function te(){document.addEventListener("mousemove",J),document.addEventListener("mousedown",J),document.addEventListener("mouseup",J),document.addEventListener("pointermove",J),document.addEventListener("pointerdown",J),document.addEventListener("pointerup",J),document.addEventListener("touchmove",J),document.addEventListener("touchstart",J),document.addEventListener("touchend",J)}function ie(){document.removeEventListener("mousemove",J),document.removeEventListener("mousedown",J),document.removeEventListener("mouseup",J),document.removeEventListener("pointermove",J),document.removeEventListener("pointerdown",J),document.removeEventListener("pointerup",J),document.removeEventListener("touchmove",J),document.removeEventListener("touchstart",J),document.removeEventListener("touchend",J)}function J(H){H.target.nodeName&&H.target.nodeName.toLowerCase()==="html"||(o=!1,ie())}document.addEventListener("keydown",f,!0),document.addEventListener("mousedown",u,!0),document.addEventListener("pointerdown",u,!0),document.addEventListener("touchstart",u,!0),document.addEventListener("visibilitychange",A,!0),te(),r.addEventListener("focus",h,!0),r.addEventListener("blur",w,!0),r.nodeType===Node.DOCUMENT_FRAGMENT_NODE&&r.host?r.host.setAttribute("data-js-focus-visible",""):r.nodeType===Node.DOCUMENT_NODE&&(document.documentElement.classList.add("js-focus-visible"),document.documentElement.setAttribute("data-js-focus-visible",""))}if(typeof window!="undefined"&&typeof document!="undefined"){window.applyFocusVisiblePolyfill=e;var t;try{t=new CustomEvent("focus-visible-polyfill-ready")}catch(r){t=document.createEvent("CustomEvent"),t.initCustomEvent("focus-visible-polyfill-ready",!1,!1,{})}window.dispatchEvent(t)}typeof document!="undefined"&&e(document)})});var Yr=yr((Rt,Kr)=>{/*! + * clipboard.js v2.0.11 + * https://clipboardjs.com/ + * + * Licensed MIT © Zeno Rocha + */(function(t,r){typeof Rt=="object"&&typeof Kr=="object"?Kr.exports=r():typeof define=="function"&&define.amd?define([],r):typeof Rt=="object"?Rt.ClipboardJS=r():t.ClipboardJS=r()})(Rt,function(){return function(){var e={686:function(o,n,i){"use strict";i.d(n,{default:function(){return Ii}});var a=i(279),s=i.n(a),p=i(370),c=i.n(p),l=i(817),f=i.n(l);function u(V){try{return document.execCommand(V)}catch(_){return!1}}var h=function(_){var O=f()(_);return u("cut"),O},w=h;function A(V){var _=document.documentElement.getAttribute("dir")==="rtl",O=document.createElement("textarea");O.style.fontSize="12pt",O.style.border="0",O.style.padding="0",O.style.margin="0",O.style.position="absolute",O.style[_?"right":"left"]="-9999px";var j=window.pageYOffset||document.documentElement.scrollTop;return O.style.top="".concat(j,"px"),O.setAttribute("readonly",""),O.value=V,O}var te=function(_,O){var j=A(_);O.container.appendChild(j);var D=f()(j);return u("copy"),j.remove(),D},ie=function(_){var O=arguments.length>1&&arguments[1]!==void 0?arguments[1]:{container:document.body},j="";return typeof _=="string"?j=te(_,O):_ instanceof HTMLInputElement&&!["text","search","url","tel","password"].includes(_==null?void 0:_.type)?j=te(_.value,O):(j=f()(_),u("copy")),j},J=ie;function H(V){"@babel/helpers - typeof";return typeof Symbol=="function"&&typeof Symbol.iterator=="symbol"?H=function(O){return typeof O}:H=function(O){return O&&typeof Symbol=="function"&&O.constructor===Symbol&&O!==Symbol.prototype?"symbol":typeof O},H(V)}var mt=function(){var _=arguments.length>0&&arguments[0]!==void 0?arguments[0]:{},O=_.action,j=O===void 0?"copy":O,D=_.container,Y=_.target,ke=_.text;if(j!=="copy"&&j!=="cut")throw new Error('Invalid "action" value, use either "copy" or "cut"');if(Y!==void 0)if(Y&&H(Y)==="object"&&Y.nodeType===1){if(j==="copy"&&Y.hasAttribute("disabled"))throw new Error('Invalid "target" attribute. Please use "readonly" instead of "disabled" attribute');if(j==="cut"&&(Y.hasAttribute("readonly")||Y.hasAttribute("disabled")))throw new Error(`Invalid "target" attribute. You can't cut text from elements with "readonly" or "disabled" attributes`)}else throw new Error('Invalid "target" value, use a valid Element');if(ke)return J(ke,{container:D});if(Y)return j==="cut"?w(Y):J(Y,{container:D})},ze=mt;function Ie(V){"@babel/helpers - typeof";return typeof Symbol=="function"&&typeof Symbol.iterator=="symbol"?Ie=function(O){return typeof O}:Ie=function(O){return O&&typeof Symbol=="function"&&O.constructor===Symbol&&O!==Symbol.prototype?"symbol":typeof O},Ie(V)}function _i(V,_){if(!(V instanceof _))throw new TypeError("Cannot call a class as a function")}function ro(V,_){for(var O=0;O<_.length;O++){var j=_[O];j.enumerable=j.enumerable||!1,j.configurable=!0,"value"in j&&(j.writable=!0),Object.defineProperty(V,j.key,j)}}function Ai(V,_,O){return _&&ro(V.prototype,_),O&&ro(V,O),V}function Ci(V,_){if(typeof _!="function"&&_!==null)throw new TypeError("Super expression must either be null or a function");V.prototype=Object.create(_&&_.prototype,{constructor:{value:V,writable:!0,configurable:!0}}),_&&br(V,_)}function br(V,_){return br=Object.setPrototypeOf||function(j,D){return j.__proto__=D,j},br(V,_)}function Hi(V){var _=Pi();return function(){var j=Wt(V),D;if(_){var Y=Wt(this).constructor;D=Reflect.construct(j,arguments,Y)}else D=j.apply(this,arguments);return ki(this,D)}}function ki(V,_){return _&&(Ie(_)==="object"||typeof _=="function")?_:$i(V)}function $i(V){if(V===void 0)throw new ReferenceError("this hasn't been initialised - super() hasn't been called");return V}function Pi(){if(typeof Reflect=="undefined"||!Reflect.construct||Reflect.construct.sham)return!1;if(typeof Proxy=="function")return!0;try{return Date.prototype.toString.call(Reflect.construct(Date,[],function(){})),!0}catch(V){return!1}}function Wt(V){return Wt=Object.setPrototypeOf?Object.getPrototypeOf:function(O){return O.__proto__||Object.getPrototypeOf(O)},Wt(V)}function vr(V,_){var O="data-clipboard-".concat(V);if(_.hasAttribute(O))return _.getAttribute(O)}var Ri=function(V){Ci(O,V);var _=Hi(O);function O(j,D){var Y;return _i(this,O),Y=_.call(this),Y.resolveOptions(D),Y.listenClick(j),Y}return Ai(O,[{key:"resolveOptions",value:function(){var D=arguments.length>0&&arguments[0]!==void 0?arguments[0]:{};this.action=typeof D.action=="function"?D.action:this.defaultAction,this.target=typeof D.target=="function"?D.target:this.defaultTarget,this.text=typeof D.text=="function"?D.text:this.defaultText,this.container=Ie(D.container)==="object"?D.container:document.body}},{key:"listenClick",value:function(D){var Y=this;this.listener=c()(D,"click",function(ke){return Y.onClick(ke)})}},{key:"onClick",value:function(D){var Y=D.delegateTarget||D.currentTarget,ke=this.action(Y)||"copy",Ut=ze({action:ke,container:this.container,target:this.target(Y),text:this.text(Y)});this.emit(Ut?"success":"error",{action:ke,text:Ut,trigger:Y,clearSelection:function(){Y&&Y.focus(),window.getSelection().removeAllRanges()}})}},{key:"defaultAction",value:function(D){return vr("action",D)}},{key:"defaultTarget",value:function(D){var Y=vr("target",D);if(Y)return document.querySelector(Y)}},{key:"defaultText",value:function(D){return vr("text",D)}},{key:"destroy",value:function(){this.listener.destroy()}}],[{key:"copy",value:function(D){var Y=arguments.length>1&&arguments[1]!==void 0?arguments[1]:{container:document.body};return J(D,Y)}},{key:"cut",value:function(D){return w(D)}},{key:"isSupported",value:function(){var D=arguments.length>0&&arguments[0]!==void 0?arguments[0]:["copy","cut"],Y=typeof D=="string"?[D]:D,ke=!!document.queryCommandSupported;return Y.forEach(function(Ut){ke=ke&&!!document.queryCommandSupported(Ut)}),ke}}]),O}(s()),Ii=Ri},828:function(o){var n=9;if(typeof Element!="undefined"&&!Element.prototype.matches){var i=Element.prototype;i.matches=i.matchesSelector||i.mozMatchesSelector||i.msMatchesSelector||i.oMatchesSelector||i.webkitMatchesSelector}function a(s,p){for(;s&&s.nodeType!==n;){if(typeof s.matches=="function"&&s.matches(p))return s;s=s.parentNode}}o.exports=a},438:function(o,n,i){var a=i(828);function s(l,f,u,h,w){var A=c.apply(this,arguments);return l.addEventListener(u,A,w),{destroy:function(){l.removeEventListener(u,A,w)}}}function p(l,f,u,h,w){return typeof l.addEventListener=="function"?s.apply(null,arguments):typeof u=="function"?s.bind(null,document).apply(null,arguments):(typeof l=="string"&&(l=document.querySelectorAll(l)),Array.prototype.map.call(l,function(A){return s(A,f,u,h,w)}))}function c(l,f,u,h){return function(w){w.delegateTarget=a(w.target,f),w.delegateTarget&&h.call(l,w)}}o.exports=p},879:function(o,n){n.node=function(i){return i!==void 0&&i instanceof HTMLElement&&i.nodeType===1},n.nodeList=function(i){var a=Object.prototype.toString.call(i);return i!==void 0&&(a==="[object NodeList]"||a==="[object HTMLCollection]")&&"length"in i&&(i.length===0||n.node(i[0]))},n.string=function(i){return typeof i=="string"||i instanceof String},n.fn=function(i){var a=Object.prototype.toString.call(i);return a==="[object Function]"}},370:function(o,n,i){var a=i(879),s=i(438);function p(u,h,w){if(!u&&!h&&!w)throw new Error("Missing required arguments");if(!a.string(h))throw new TypeError("Second argument must be a String");if(!a.fn(w))throw new TypeError("Third argument must be a Function");if(a.node(u))return c(u,h,w);if(a.nodeList(u))return l(u,h,w);if(a.string(u))return f(u,h,w);throw new TypeError("First argument must be a String, HTMLElement, HTMLCollection, or NodeList")}function c(u,h,w){return u.addEventListener(h,w),{destroy:function(){u.removeEventListener(h,w)}}}function l(u,h,w){return Array.prototype.forEach.call(u,function(A){A.addEventListener(h,w)}),{destroy:function(){Array.prototype.forEach.call(u,function(A){A.removeEventListener(h,w)})}}}function f(u,h,w){return s(document.body,u,h,w)}o.exports=p},817:function(o){function n(i){var a;if(i.nodeName==="SELECT")i.focus(),a=i.value;else if(i.nodeName==="INPUT"||i.nodeName==="TEXTAREA"){var s=i.hasAttribute("readonly");s||i.setAttribute("readonly",""),i.select(),i.setSelectionRange(0,i.value.length),s||i.removeAttribute("readonly"),a=i.value}else{i.hasAttribute("contenteditable")&&i.focus();var p=window.getSelection(),c=document.createRange();c.selectNodeContents(i),p.removeAllRanges(),p.addRange(c),a=p.toString()}return a}o.exports=n},279:function(o){function n(){}n.prototype={on:function(i,a,s){var p=this.e||(this.e={});return(p[i]||(p[i]=[])).push({fn:a,ctx:s}),this},once:function(i,a,s){var p=this;function c(){p.off(i,c),a.apply(s,arguments)}return c._=a,this.on(i,c,s)},emit:function(i){var a=[].slice.call(arguments,1),s=((this.e||(this.e={}))[i]||[]).slice(),p=0,c=s.length;for(p;p{"use strict";/*! + * escape-html + * Copyright(c) 2012-2013 TJ Holowaychuk + * Copyright(c) 2015 Andreas Lubbe + * Copyright(c) 2015 Tiancheng "Timothy" Gu + * MIT Licensed + */var ts=/["'&<>]/;ei.exports=rs;function rs(e){var t=""+e,r=ts.exec(t);if(!r)return t;var o,n="",i=0,a=0;for(i=r.index;i0&&i[i.length-1])&&(c[0]===6||c[0]===2)){r=0;continue}if(c[0]===3&&(!i||c[1]>i[0]&&c[1]=e.length&&(e=void 0),{value:e&&e[o++],done:!e}}};throw new TypeError(t?"Object is not iterable.":"Symbol.iterator is not defined.")}function N(e,t){var r=typeof Symbol=="function"&&e[Symbol.iterator];if(!r)return e;var o=r.call(e),n,i=[],a;try{for(;(t===void 0||t-- >0)&&!(n=o.next()).done;)i.push(n.value)}catch(s){a={error:s}}finally{try{n&&!n.done&&(r=o.return)&&r.call(o)}finally{if(a)throw a.error}}return i}function q(e,t,r){if(r||arguments.length===2)for(var o=0,n=t.length,i;o1||s(u,h)})})}function s(u,h){try{p(o[u](h))}catch(w){f(i[0][3],w)}}function p(u){u.value instanceof nt?Promise.resolve(u.value.v).then(c,l):f(i[0][2],u)}function c(u){s("next",u)}function l(u){s("throw",u)}function f(u,h){u(h),i.shift(),i.length&&s(i[0][0],i[0][1])}}function mo(e){if(!Symbol.asyncIterator)throw new TypeError("Symbol.asyncIterator is not defined.");var t=e[Symbol.asyncIterator],r;return t?t.call(e):(e=typeof de=="function"?de(e):e[Symbol.iterator](),r={},o("next"),o("throw"),o("return"),r[Symbol.asyncIterator]=function(){return this},r);function o(i){r[i]=e[i]&&function(a){return new Promise(function(s,p){a=e[i](a),n(s,p,a.done,a.value)})}}function n(i,a,s,p){Promise.resolve(p).then(function(c){i({value:c,done:s})},a)}}function k(e){return typeof e=="function"}function ft(e){var t=function(o){Error.call(o),o.stack=new Error().stack},r=e(t);return r.prototype=Object.create(Error.prototype),r.prototype.constructor=r,r}var zt=ft(function(e){return function(r){e(this),this.message=r?r.length+` errors occurred during unsubscription: +`+r.map(function(o,n){return n+1+") "+o.toString()}).join(` + `):"",this.name="UnsubscriptionError",this.errors=r}});function qe(e,t){if(e){var r=e.indexOf(t);0<=r&&e.splice(r,1)}}var Fe=function(){function e(t){this.initialTeardown=t,this.closed=!1,this._parentage=null,this._finalizers=null}return e.prototype.unsubscribe=function(){var t,r,o,n,i;if(!this.closed){this.closed=!0;var a=this._parentage;if(a)if(this._parentage=null,Array.isArray(a))try{for(var s=de(a),p=s.next();!p.done;p=s.next()){var c=p.value;c.remove(this)}}catch(A){t={error:A}}finally{try{p&&!p.done&&(r=s.return)&&r.call(s)}finally{if(t)throw t.error}}else a.remove(this);var l=this.initialTeardown;if(k(l))try{l()}catch(A){i=A instanceof zt?A.errors:[A]}var f=this._finalizers;if(f){this._finalizers=null;try{for(var u=de(f),h=u.next();!h.done;h=u.next()){var w=h.value;try{fo(w)}catch(A){i=i!=null?i:[],A instanceof zt?i=q(q([],N(i)),N(A.errors)):i.push(A)}}}catch(A){o={error:A}}finally{try{h&&!h.done&&(n=u.return)&&n.call(u)}finally{if(o)throw o.error}}}if(i)throw new zt(i)}},e.prototype.add=function(t){var r;if(t&&t!==this)if(this.closed)fo(t);else{if(t instanceof e){if(t.closed||t._hasParent(this))return;t._addParent(this)}(this._finalizers=(r=this._finalizers)!==null&&r!==void 0?r:[]).push(t)}},e.prototype._hasParent=function(t){var r=this._parentage;return r===t||Array.isArray(r)&&r.includes(t)},e.prototype._addParent=function(t){var r=this._parentage;this._parentage=Array.isArray(r)?(r.push(t),r):r?[r,t]:t},e.prototype._removeParent=function(t){var r=this._parentage;r===t?this._parentage=null:Array.isArray(r)&&qe(r,t)},e.prototype.remove=function(t){var r=this._finalizers;r&&qe(r,t),t instanceof e&&t._removeParent(this)},e.EMPTY=function(){var t=new e;return t.closed=!0,t}(),e}();var Tr=Fe.EMPTY;function qt(e){return e instanceof Fe||e&&"closed"in e&&k(e.remove)&&k(e.add)&&k(e.unsubscribe)}function fo(e){k(e)?e():e.unsubscribe()}var $e={onUnhandledError:null,onStoppedNotification:null,Promise:void 0,useDeprecatedSynchronousErrorHandling:!1,useDeprecatedNextContext:!1};var ut={setTimeout:function(e,t){for(var r=[],o=2;o0},enumerable:!1,configurable:!0}),t.prototype._trySubscribe=function(r){return this._throwIfClosed(),e.prototype._trySubscribe.call(this,r)},t.prototype._subscribe=function(r){return this._throwIfClosed(),this._checkFinalizedStatuses(r),this._innerSubscribe(r)},t.prototype._innerSubscribe=function(r){var o=this,n=this,i=n.hasError,a=n.isStopped,s=n.observers;return i||a?Tr:(this.currentObservers=null,s.push(r),new Fe(function(){o.currentObservers=null,qe(s,r)}))},t.prototype._checkFinalizedStatuses=function(r){var o=this,n=o.hasError,i=o.thrownError,a=o.isStopped;n?r.error(i):a&&r.complete()},t.prototype.asObservable=function(){var r=new F;return r.source=this,r},t.create=function(r,o){return new Eo(r,o)},t}(F);var Eo=function(e){re(t,e);function t(r,o){var n=e.call(this)||this;return n.destination=r,n.source=o,n}return t.prototype.next=function(r){var o,n;(n=(o=this.destination)===null||o===void 0?void 0:o.next)===null||n===void 0||n.call(o,r)},t.prototype.error=function(r){var o,n;(n=(o=this.destination)===null||o===void 0?void 0:o.error)===null||n===void 0||n.call(o,r)},t.prototype.complete=function(){var r,o;(o=(r=this.destination)===null||r===void 0?void 0:r.complete)===null||o===void 0||o.call(r)},t.prototype._subscribe=function(r){var o,n;return(n=(o=this.source)===null||o===void 0?void 0:o.subscribe(r))!==null&&n!==void 0?n:Tr},t}(g);var _r=function(e){re(t,e);function t(r){var o=e.call(this)||this;return o._value=r,o}return Object.defineProperty(t.prototype,"value",{get:function(){return this.getValue()},enumerable:!1,configurable:!0}),t.prototype._subscribe=function(r){var o=e.prototype._subscribe.call(this,r);return!o.closed&&r.next(this._value),o},t.prototype.getValue=function(){var r=this,o=r.hasError,n=r.thrownError,i=r._value;if(o)throw n;return this._throwIfClosed(),i},t.prototype.next=function(r){e.prototype.next.call(this,this._value=r)},t}(g);var Lt={now:function(){return(Lt.delegate||Date).now()},delegate:void 0};var _t=function(e){re(t,e);function t(r,o,n){r===void 0&&(r=1/0),o===void 0&&(o=1/0),n===void 0&&(n=Lt);var i=e.call(this)||this;return i._bufferSize=r,i._windowTime=o,i._timestampProvider=n,i._buffer=[],i._infiniteTimeWindow=!0,i._infiniteTimeWindow=o===1/0,i._bufferSize=Math.max(1,r),i._windowTime=Math.max(1,o),i}return t.prototype.next=function(r){var o=this,n=o.isStopped,i=o._buffer,a=o._infiniteTimeWindow,s=o._timestampProvider,p=o._windowTime;n||(i.push(r),!a&&i.push(s.now()+p)),this._trimBuffer(),e.prototype.next.call(this,r)},t.prototype._subscribe=function(r){this._throwIfClosed(),this._trimBuffer();for(var o=this._innerSubscribe(r),n=this,i=n._infiniteTimeWindow,a=n._buffer,s=a.slice(),p=0;p0?e.prototype.schedule.call(this,r,o):(this.delay=o,this.state=r,this.scheduler.flush(this),this)},t.prototype.execute=function(r,o){return o>0||this.closed?e.prototype.execute.call(this,r,o):this._execute(r,o)},t.prototype.requestAsyncId=function(r,o,n){return n===void 0&&(n=0),n!=null&&n>0||n==null&&this.delay>0?e.prototype.requestAsyncId.call(this,r,o,n):(r.flush(this),0)},t}(vt);var So=function(e){re(t,e);function t(){return e!==null&&e.apply(this,arguments)||this}return t}(gt);var Hr=new So(To);var Oo=function(e){re(t,e);function t(r,o){var n=e.call(this,r,o)||this;return n.scheduler=r,n.work=o,n}return t.prototype.requestAsyncId=function(r,o,n){return n===void 0&&(n=0),n!==null&&n>0?e.prototype.requestAsyncId.call(this,r,o,n):(r.actions.push(this),r._scheduled||(r._scheduled=bt.requestAnimationFrame(function(){return r.flush(void 0)})))},t.prototype.recycleAsyncId=function(r,o,n){var i;if(n===void 0&&(n=0),n!=null?n>0:this.delay>0)return e.prototype.recycleAsyncId.call(this,r,o,n);var a=r.actions;o!=null&&((i=a[a.length-1])===null||i===void 0?void 0:i.id)!==o&&(bt.cancelAnimationFrame(o),r._scheduled=void 0)},t}(vt);var Mo=function(e){re(t,e);function t(){return e!==null&&e.apply(this,arguments)||this}return t.prototype.flush=function(r){this._active=!0;var o=this._scheduled;this._scheduled=void 0;var n=this.actions,i;r=r||n.shift();do if(i=r.execute(r.state,r.delay))break;while((r=n[0])&&r.id===o&&n.shift());if(this._active=!1,i){for(;(r=n[0])&&r.id===o&&n.shift();)r.unsubscribe();throw i}},t}(gt);var me=new Mo(Oo);var M=new F(function(e){return e.complete()});function Yt(e){return e&&k(e.schedule)}function kr(e){return e[e.length-1]}function Xe(e){return k(kr(e))?e.pop():void 0}function He(e){return Yt(kr(e))?e.pop():void 0}function Bt(e,t){return typeof kr(e)=="number"?e.pop():t}var xt=function(e){return e&&typeof e.length=="number"&&typeof e!="function"};function Gt(e){return k(e==null?void 0:e.then)}function Jt(e){return k(e[ht])}function Xt(e){return Symbol.asyncIterator&&k(e==null?void 0:e[Symbol.asyncIterator])}function Zt(e){return new TypeError("You provided "+(e!==null&&typeof e=="object"?"an invalid object":"'"+e+"'")+" where a stream was expected. You can provide an Observable, Promise, ReadableStream, Array, AsyncIterable, or Iterable.")}function Gi(){return typeof Symbol!="function"||!Symbol.iterator?"@@iterator":Symbol.iterator}var er=Gi();function tr(e){return k(e==null?void 0:e[er])}function rr(e){return lo(this,arguments,function(){var r,o,n,i;return Nt(this,function(a){switch(a.label){case 0:r=e.getReader(),a.label=1;case 1:a.trys.push([1,,9,10]),a.label=2;case 2:return[4,nt(r.read())];case 3:return o=a.sent(),n=o.value,i=o.done,i?[4,nt(void 0)]:[3,5];case 4:return[2,a.sent()];case 5:return[4,nt(n)];case 6:return[4,a.sent()];case 7:return a.sent(),[3,2];case 8:return[3,10];case 9:return r.releaseLock(),[7];case 10:return[2]}})})}function or(e){return k(e==null?void 0:e.getReader)}function W(e){if(e instanceof F)return e;if(e!=null){if(Jt(e))return Ji(e);if(xt(e))return Xi(e);if(Gt(e))return Zi(e);if(Xt(e))return Lo(e);if(tr(e))return ea(e);if(or(e))return ta(e)}throw Zt(e)}function Ji(e){return new F(function(t){var r=e[ht]();if(k(r.subscribe))return r.subscribe(t);throw new TypeError("Provided object does not correctly implement Symbol.observable")})}function Xi(e){return new F(function(t){for(var r=0;r=2;return function(o){return o.pipe(e?b(function(n,i){return e(n,i,o)}):le,Te(1),r?Be(t):zo(function(){return new ir}))}}function Fr(e){return e<=0?function(){return M}:y(function(t,r){var o=[];t.subscribe(T(r,function(n){o.push(n),e=2,!0))}function pe(e){e===void 0&&(e={});var t=e.connector,r=t===void 0?function(){return new g}:t,o=e.resetOnError,n=o===void 0?!0:o,i=e.resetOnComplete,a=i===void 0?!0:i,s=e.resetOnRefCountZero,p=s===void 0?!0:s;return function(c){var l,f,u,h=0,w=!1,A=!1,te=function(){f==null||f.unsubscribe(),f=void 0},ie=function(){te(),l=u=void 0,w=A=!1},J=function(){var H=l;ie(),H==null||H.unsubscribe()};return y(function(H,mt){h++,!A&&!w&&te();var ze=u=u!=null?u:r();mt.add(function(){h--,h===0&&!A&&!w&&(f=Wr(J,p))}),ze.subscribe(mt),!l&&h>0&&(l=new at({next:function(Ie){return ze.next(Ie)},error:function(Ie){A=!0,te(),f=Wr(ie,n,Ie),ze.error(Ie)},complete:function(){w=!0,te(),f=Wr(ie,a),ze.complete()}}),W(H).subscribe(l))})(c)}}function Wr(e,t){for(var r=[],o=2;oe.next(document)),e}function $(e,t=document){return Array.from(t.querySelectorAll(e))}function P(e,t=document){let r=fe(e,t);if(typeof r=="undefined")throw new ReferenceError(`Missing element: expected "${e}" to be present`);return r}function fe(e,t=document){return t.querySelector(e)||void 0}function Re(){var e,t,r,o;return(o=(r=(t=(e=document.activeElement)==null?void 0:e.shadowRoot)==null?void 0:t.activeElement)!=null?r:document.activeElement)!=null?o:void 0}var xa=S(d(document.body,"focusin"),d(document.body,"focusout")).pipe(_e(1),Q(void 0),m(()=>Re()||document.body),B(1));function et(e){return xa.pipe(m(t=>e.contains(t)),K())}function kt(e,t){return C(()=>S(d(e,"mouseenter").pipe(m(()=>!0)),d(e,"mouseleave").pipe(m(()=>!1))).pipe(t?Ht(r=>Me(+!r*t)):le,Q(e.matches(":hover"))))}function Bo(e,t){if(typeof t=="string"||typeof t=="number")e.innerHTML+=t.toString();else if(t instanceof Node)e.appendChild(t);else if(Array.isArray(t))for(let r of t)Bo(e,r)}function x(e,t,...r){let o=document.createElement(e);if(t)for(let n of Object.keys(t))typeof t[n]!="undefined"&&(typeof t[n]!="boolean"?o.setAttribute(n,t[n]):o.setAttribute(n,""));for(let n of r)Bo(o,n);return o}function sr(e){if(e>999){let t=+((e-950)%1e3>99);return`${((e+1e-6)/1e3).toFixed(t)}k`}else return e.toString()}function wt(e){let t=x("script",{src:e});return C(()=>(document.head.appendChild(t),S(d(t,"load"),d(t,"error").pipe(v(()=>$r(()=>new ReferenceError(`Invalid script: ${e}`))))).pipe(m(()=>{}),L(()=>document.head.removeChild(t)),Te(1))))}var Go=new g,ya=C(()=>typeof ResizeObserver=="undefined"?wt("https://unpkg.com/resize-observer-polyfill"):I(void 0)).pipe(m(()=>new ResizeObserver(e=>e.forEach(t=>Go.next(t)))),v(e=>S(Ke,I(e)).pipe(L(()=>e.disconnect()))),B(1));function ce(e){return{width:e.offsetWidth,height:e.offsetHeight}}function ge(e){let t=e;for(;t.clientWidth===0&&t.parentElement;)t=t.parentElement;return ya.pipe(E(r=>r.observe(t)),v(r=>Go.pipe(b(o=>o.target===t),L(()=>r.unobserve(t)))),m(()=>ce(e)),Q(ce(e)))}function Tt(e){return{width:e.scrollWidth,height:e.scrollHeight}}function cr(e){let t=e.parentElement;for(;t&&(e.scrollWidth<=t.scrollWidth&&e.scrollHeight<=t.scrollHeight);)t=(e=t).parentElement;return t?e:void 0}function Jo(e){let t=[],r=e.parentElement;for(;r;)(e.clientWidth>r.clientWidth||e.clientHeight>r.clientHeight)&&t.push(r),r=(e=r).parentElement;return t.length===0&&t.push(document.documentElement),t}function Ue(e){return{x:e.offsetLeft,y:e.offsetTop}}function Xo(e){let t=e.getBoundingClientRect();return{x:t.x+window.scrollX,y:t.y+window.scrollY}}function Zo(e){return S(d(window,"load"),d(window,"resize")).pipe(Le(0,me),m(()=>Ue(e)),Q(Ue(e)))}function pr(e){return{x:e.scrollLeft,y:e.scrollTop}}function De(e){return S(d(e,"scroll"),d(window,"scroll"),d(window,"resize")).pipe(Le(0,me),m(()=>pr(e)),Q(pr(e)))}var en=new g,Ea=C(()=>I(new IntersectionObserver(e=>{for(let t of e)en.next(t)},{threshold:0}))).pipe(v(e=>S(Ke,I(e)).pipe(L(()=>e.disconnect()))),B(1));function tt(e){return Ea.pipe(E(t=>t.observe(e)),v(t=>en.pipe(b(({target:r})=>r===e),L(()=>t.unobserve(e)),m(({isIntersecting:r})=>r))))}function tn(e,t=16){return De(e).pipe(m(({y:r})=>{let o=ce(e),n=Tt(e);return r>=n.height-o.height-t}),K())}var lr={drawer:P("[data-md-toggle=drawer]"),search:P("[data-md-toggle=search]")};function rn(e){return lr[e].checked}function Je(e,t){lr[e].checked!==t&&lr[e].click()}function Ve(e){let t=lr[e];return d(t,"change").pipe(m(()=>t.checked),Q(t.checked))}function wa(e,t){switch(e.constructor){case HTMLInputElement:return e.type==="radio"?/^Arrow/.test(t):!0;case HTMLSelectElement:case HTMLTextAreaElement:return!0;default:return e.isContentEditable}}function Ta(){return S(d(window,"compositionstart").pipe(m(()=>!0)),d(window,"compositionend").pipe(m(()=>!1))).pipe(Q(!1))}function on(){let e=d(window,"keydown").pipe(b(t=>!(t.metaKey||t.ctrlKey)),m(t=>({mode:rn("search")?"search":"global",type:t.key,claim(){t.preventDefault(),t.stopPropagation()}})),b(({mode:t,type:r})=>{if(t==="global"){let o=Re();if(typeof o!="undefined")return!wa(o,r)}return!0}),pe());return Ta().pipe(v(t=>t?M:e))}function xe(){return new URL(location.href)}function pt(e,t=!1){if(G("navigation.instant")&&!t){let r=x("a",{href:e.href});document.body.appendChild(r),r.click(),r.remove()}else location.href=e.href}function nn(){return new g}function an(){return location.hash.slice(1)}function sn(e){let t=x("a",{href:e});t.addEventListener("click",r=>r.stopPropagation()),t.click()}function Sa(e){return S(d(window,"hashchange"),e).pipe(m(an),Q(an()),b(t=>t.length>0),B(1))}function cn(e){return Sa(e).pipe(m(t=>fe(`[id="${t}"]`)),b(t=>typeof t!="undefined"))}function $t(e){let t=matchMedia(e);return ar(r=>t.addListener(()=>r(t.matches))).pipe(Q(t.matches))}function pn(){let e=matchMedia("print");return S(d(window,"beforeprint").pipe(m(()=>!0)),d(window,"afterprint").pipe(m(()=>!1))).pipe(Q(e.matches))}function Nr(e,t){return e.pipe(v(r=>r?t():M))}function zr(e,t){return new F(r=>{let o=new XMLHttpRequest;return o.open("GET",`${e}`),o.responseType="blob",o.addEventListener("load",()=>{o.status>=200&&o.status<300?(r.next(o.response),r.complete()):r.error(new Error(o.statusText))}),o.addEventListener("error",()=>{r.error(new Error("Network error"))}),o.addEventListener("abort",()=>{r.complete()}),typeof(t==null?void 0:t.progress$)!="undefined"&&(o.addEventListener("progress",n=>{var i;if(n.lengthComputable)t.progress$.next(n.loaded/n.total*100);else{let a=(i=o.getResponseHeader("Content-Length"))!=null?i:0;t.progress$.next(n.loaded/+a*100)}}),t.progress$.next(5)),o.send(),()=>o.abort()})}function Ne(e,t){return zr(e,t).pipe(v(r=>r.text()),m(r=>JSON.parse(r)),B(1))}function ln(e,t){let r=new DOMParser;return zr(e,t).pipe(v(o=>o.text()),m(o=>r.parseFromString(o,"text/html")),B(1))}function mn(e,t){let r=new DOMParser;return zr(e,t).pipe(v(o=>o.text()),m(o=>r.parseFromString(o,"text/xml")),B(1))}function fn(){return{x:Math.max(0,scrollX),y:Math.max(0,scrollY)}}function un(){return S(d(window,"scroll",{passive:!0}),d(window,"resize",{passive:!0})).pipe(m(fn),Q(fn()))}function dn(){return{width:innerWidth,height:innerHeight}}function hn(){return d(window,"resize",{passive:!0}).pipe(m(dn),Q(dn()))}function bn(){return z([un(),hn()]).pipe(m(([e,t])=>({offset:e,size:t})),B(1))}function mr(e,{viewport$:t,header$:r}){let o=t.pipe(Z("size")),n=z([o,r]).pipe(m(()=>Ue(e)));return z([r,t,n]).pipe(m(([{height:i},{offset:a,size:s},{x:p,y:c}])=>({offset:{x:a.x-p,y:a.y-c+i},size:s})))}function Oa(e){return d(e,"message",t=>t.data)}function Ma(e){let t=new g;return t.subscribe(r=>e.postMessage(r)),t}function vn(e,t=new Worker(e)){let r=Oa(t),o=Ma(t),n=new g;n.subscribe(o);let i=o.pipe(X(),ne(!0));return n.pipe(X(),Pe(r.pipe(U(i))),pe())}var La=P("#__config"),St=JSON.parse(La.textContent);St.base=`${new URL(St.base,xe())}`;function ye(){return St}function G(e){return St.features.includes(e)}function Ee(e,t){return typeof t!="undefined"?St.translations[e].replace("#",t.toString()):St.translations[e]}function Se(e,t=document){return P(`[data-md-component=${e}]`,t)}function ae(e,t=document){return $(`[data-md-component=${e}]`,t)}function _a(e){let t=P(".md-typeset > :first-child",e);return d(t,"click",{once:!0}).pipe(m(()=>P(".md-typeset",e)),m(r=>({hash:__md_hash(r.innerHTML)})))}function gn(e){if(!G("announce.dismiss")||!e.childElementCount)return M;if(!e.hidden){let t=P(".md-typeset",e);__md_hash(t.innerHTML)===__md_get("__announce")&&(e.hidden=!0)}return C(()=>{let t=new g;return t.subscribe(({hash:r})=>{e.hidden=!0,__md_set("__announce",r)}),_a(e).pipe(E(r=>t.next(r)),L(()=>t.complete()),m(r=>R({ref:e},r)))})}function Aa(e,{target$:t}){return t.pipe(m(r=>({hidden:r!==e})))}function xn(e,t){let r=new g;return r.subscribe(({hidden:o})=>{e.hidden=o}),Aa(e,t).pipe(E(o=>r.next(o)),L(()=>r.complete()),m(o=>R({ref:e},o)))}function Pt(e,t){return t==="inline"?x("div",{class:"md-tooltip md-tooltip--inline",id:e,role:"tooltip"},x("div",{class:"md-tooltip__inner md-typeset"})):x("div",{class:"md-tooltip",id:e,role:"tooltip"},x("div",{class:"md-tooltip__inner md-typeset"}))}function yn(...e){return x("div",{class:"md-tooltip2",role:"tooltip"},x("div",{class:"md-tooltip2__inner md-typeset"},e))}function En(e,t){if(t=t?`${t}_annotation_${e}`:void 0,t){let r=t?`#${t}`:void 0;return x("aside",{class:"md-annotation",tabIndex:0},Pt(t),x("a",{href:r,class:"md-annotation__index",tabIndex:-1},x("span",{"data-md-annotation-id":e})))}else return x("aside",{class:"md-annotation",tabIndex:0},Pt(t),x("span",{class:"md-annotation__index",tabIndex:-1},x("span",{"data-md-annotation-id":e})))}function wn(e){return x("button",{class:"md-clipboard md-icon",title:Ee("clipboard.copy"),"data-clipboard-target":`#${e} > code`})}function qr(e,t){let r=t&2,o=t&1,n=Object.keys(e.terms).filter(p=>!e.terms[p]).reduce((p,c)=>[...p,x("del",null,c)," "],[]).slice(0,-1),i=ye(),a=new URL(e.location,i.base);G("search.highlight")&&a.searchParams.set("h",Object.entries(e.terms).filter(([,p])=>p).reduce((p,[c])=>`${p} ${c}`.trim(),""));let{tags:s}=ye();return x("a",{href:`${a}`,class:"md-search-result__link",tabIndex:-1},x("article",{class:"md-search-result__article md-typeset","data-md-score":e.score.toFixed(2)},r>0&&x("div",{class:"md-search-result__icon md-icon"}),r>0&&x("h1",null,e.title),r<=0&&x("h2",null,e.title),o>0&&e.text.length>0&&e.text,e.tags&&e.tags.map(p=>{let c=s?p in s?`md-tag-icon md-tag--${s[p]}`:"md-tag-icon":"";return x("span",{class:`md-tag ${c}`},p)}),o>0&&n.length>0&&x("p",{class:"md-search-result__terms"},Ee("search.result.term.missing"),": ",...n)))}function Tn(e){let t=e[0].score,r=[...e],o=ye(),n=r.findIndex(l=>!`${new URL(l.location,o.base)}`.includes("#")),[i]=r.splice(n,1),a=r.findIndex(l=>l.scoreqr(l,1)),...p.length?[x("details",{class:"md-search-result__more"},x("summary",{tabIndex:-1},x("div",null,p.length>0&&p.length===1?Ee("search.result.more.one"):Ee("search.result.more.other",p.length))),...p.map(l=>qr(l,1)))]:[]];return x("li",{class:"md-search-result__item"},c)}function Sn(e){return x("ul",{class:"md-source__facts"},Object.entries(e).map(([t,r])=>x("li",{class:`md-source__fact md-source__fact--${t}`},typeof r=="number"?sr(r):r)))}function Qr(e){let t=`tabbed-control tabbed-control--${e}`;return x("div",{class:t,hidden:!0},x("button",{class:"tabbed-button",tabIndex:-1,"aria-hidden":"true"}))}function On(e){return x("div",{class:"md-typeset__scrollwrap"},x("div",{class:"md-typeset__table"},e))}function Ca(e){var o;let t=ye(),r=new URL(`../${e.version}/`,t.base);return x("li",{class:"md-version__item"},x("a",{href:`${r}`,class:"md-version__link"},e.title,((o=t.version)==null?void 0:o.alias)&&e.aliases.length>0&&x("span",{class:"md-version__alias"},e.aliases[0])))}function Mn(e,t){var o;let r=ye();return e=e.filter(n=>{var i;return!((i=n.properties)!=null&&i.hidden)}),x("div",{class:"md-version"},x("button",{class:"md-version__current","aria-label":Ee("select.version")},t.title,((o=r.version)==null?void 0:o.alias)&&t.aliases.length>0&&x("span",{class:"md-version__alias"},t.aliases[0])),x("ul",{class:"md-version__list"},e.map(Ca)))}var Ha=0;function ka(e){let t=z([et(e),kt(e)]).pipe(m(([o,n])=>o||n),K()),r=C(()=>Jo(e)).pipe(oe(De),ct(1),m(()=>Xo(e)));return t.pipe(Ae(o=>o),v(()=>z([t,r])),m(([o,n])=>({active:o,offset:n})),pe())}function $a(e,t){let{content$:r,viewport$:o}=t,n=`__tooltip2_${Ha++}`;return C(()=>{let i=new g,a=new _r(!1);i.pipe(X(),ne(!1)).subscribe(a);let s=a.pipe(Ht(c=>Me(+!c*250,Hr)),K(),v(c=>c?r:M),E(c=>c.id=n),pe());z([i.pipe(m(({active:c})=>c)),s.pipe(v(c=>kt(c,250)),Q(!1))]).pipe(m(c=>c.some(l=>l))).subscribe(a);let p=a.pipe(b(c=>c),ee(s,o),m(([c,l,{size:f}])=>{let u=e.getBoundingClientRect(),h=u.width/2;if(l.role==="tooltip")return{x:h,y:8+u.height};if(u.y>=f.height/2){let{height:w}=ce(l);return{x:h,y:-16-w}}else return{x:h,y:16+u.height}}));return z([s,i,p]).subscribe(([c,{offset:l},f])=>{c.style.setProperty("--md-tooltip-host-x",`${l.x}px`),c.style.setProperty("--md-tooltip-host-y",`${l.y}px`),c.style.setProperty("--md-tooltip-x",`${f.x}px`),c.style.setProperty("--md-tooltip-y",`${f.y}px`),c.classList.toggle("md-tooltip2--top",f.y<0),c.classList.toggle("md-tooltip2--bottom",f.y>=0)}),a.pipe(b(c=>c),ee(s,(c,l)=>l),b(c=>c.role==="tooltip")).subscribe(c=>{let l=ce(P(":scope > *",c));c.style.setProperty("--md-tooltip-width",`${l.width}px`),c.style.setProperty("--md-tooltip-tail","0px")}),a.pipe(K(),be(me),ee(s)).subscribe(([c,l])=>{l.classList.toggle("md-tooltip2--active",c)}),z([a.pipe(b(c=>c)),s]).subscribe(([c,l])=>{l.role==="dialog"?(e.setAttribute("aria-controls",n),e.setAttribute("aria-haspopup","dialog")):e.setAttribute("aria-describedby",n)}),a.pipe(b(c=>!c)).subscribe(()=>{e.removeAttribute("aria-controls"),e.removeAttribute("aria-describedby"),e.removeAttribute("aria-haspopup")}),ka(e).pipe(E(c=>i.next(c)),L(()=>i.complete()),m(c=>R({ref:e},c)))})}function lt(e,{viewport$:t},r=document.body){return $a(e,{content$:new F(o=>{let n=e.title,i=yn(n);return o.next(i),e.removeAttribute("title"),r.append(i),()=>{i.remove(),e.setAttribute("title",n)}}),viewport$:t})}function Pa(e,t){let r=C(()=>z([Zo(e),De(t)])).pipe(m(([{x:o,y:n},i])=>{let{width:a,height:s}=ce(e);return{x:o-i.x+a/2,y:n-i.y+s/2}}));return et(e).pipe(v(o=>r.pipe(m(n=>({active:o,offset:n})),Te(+!o||1/0))))}function Ln(e,t,{target$:r}){let[o,n]=Array.from(e.children);return C(()=>{let i=new g,a=i.pipe(X(),ne(!0));return i.subscribe({next({offset:s}){e.style.setProperty("--md-tooltip-x",`${s.x}px`),e.style.setProperty("--md-tooltip-y",`${s.y}px`)},complete(){e.style.removeProperty("--md-tooltip-x"),e.style.removeProperty("--md-tooltip-y")}}),tt(e).pipe(U(a)).subscribe(s=>{e.toggleAttribute("data-md-visible",s)}),S(i.pipe(b(({active:s})=>s)),i.pipe(_e(250),b(({active:s})=>!s))).subscribe({next({active:s}){s?e.prepend(o):o.remove()},complete(){e.prepend(o)}}),i.pipe(Le(16,me)).subscribe(({active:s})=>{o.classList.toggle("md-tooltip--active",s)}),i.pipe(ct(125,me),b(()=>!!e.offsetParent),m(()=>e.offsetParent.getBoundingClientRect()),m(({x:s})=>s)).subscribe({next(s){s?e.style.setProperty("--md-tooltip-0",`${-s}px`):e.style.removeProperty("--md-tooltip-0")},complete(){e.style.removeProperty("--md-tooltip-0")}}),d(n,"click").pipe(U(a),b(s=>!(s.metaKey||s.ctrlKey))).subscribe(s=>{s.stopPropagation(),s.preventDefault()}),d(n,"mousedown").pipe(U(a),ee(i)).subscribe(([s,{active:p}])=>{var c;if(s.button!==0||s.metaKey||s.ctrlKey)s.preventDefault();else if(p){s.preventDefault();let l=e.parentElement.closest(".md-annotation");l instanceof HTMLElement?l.focus():(c=Re())==null||c.blur()}}),r.pipe(U(a),b(s=>s===o),Ge(125)).subscribe(()=>e.focus()),Pa(e,t).pipe(E(s=>i.next(s)),L(()=>i.complete()),m(s=>R({ref:e},s)))})}function Ra(e){return e.tagName==="CODE"?$(".c, .c1, .cm",e):[e]}function Ia(e){let t=[];for(let r of Ra(e)){let o=[],n=document.createNodeIterator(r,NodeFilter.SHOW_TEXT);for(let i=n.nextNode();i;i=n.nextNode())o.push(i);for(let i of o){let a;for(;a=/(\(\d+\))(!)?/.exec(i.textContent);){let[,s,p]=a;if(typeof p=="undefined"){let c=i.splitText(a.index);i=c.splitText(s.length),t.push(c)}else{i.textContent=s,t.push(i);break}}}}return t}function _n(e,t){t.append(...Array.from(e.childNodes))}function fr(e,t,{target$:r,print$:o}){let n=t.closest("[id]"),i=n==null?void 0:n.id,a=new Map;for(let s of Ia(t)){let[,p]=s.textContent.match(/\((\d+)\)/);fe(`:scope > li:nth-child(${p})`,e)&&(a.set(p,En(p,i)),s.replaceWith(a.get(p)))}return a.size===0?M:C(()=>{let s=new g,p=s.pipe(X(),ne(!0)),c=[];for(let[l,f]of a)c.push([P(".md-typeset",f),P(`:scope > li:nth-child(${l})`,e)]);return o.pipe(U(p)).subscribe(l=>{e.hidden=!l,e.classList.toggle("md-annotation-list",l);for(let[f,u]of c)l?_n(f,u):_n(u,f)}),S(...[...a].map(([,l])=>Ln(l,t,{target$:r}))).pipe(L(()=>s.complete()),pe())})}function An(e){if(e.nextElementSibling){let t=e.nextElementSibling;if(t.tagName==="OL")return t;if(t.tagName==="P"&&!t.children.length)return An(t)}}function Cn(e,t){return C(()=>{let r=An(e);return typeof r!="undefined"?fr(r,e,t):M})}var Hn=Vt(Yr());var Fa=0;function kn(e){if(e.nextElementSibling){let t=e.nextElementSibling;if(t.tagName==="OL")return t;if(t.tagName==="P"&&!t.children.length)return kn(t)}}function ja(e){return ge(e).pipe(m(({width:t})=>({scrollable:Tt(e).width>t})),Z("scrollable"))}function $n(e,t){let{matches:r}=matchMedia("(hover)"),o=C(()=>{let n=new g,i=n.pipe(Fr(1));n.subscribe(({scrollable:c})=>{c&&r?e.setAttribute("tabindex","0"):e.removeAttribute("tabindex")});let a=[];if(Hn.default.isSupported()&&(e.closest(".copy")||G("content.code.copy")&&!e.closest(".no-copy"))){let c=e.closest("pre");c.id=`__code_${Fa++}`;let l=wn(c.id);c.insertBefore(l,e),G("content.tooltips")&&a.push(lt(l,{viewport$}))}let s=e.closest(".highlight");if(s instanceof HTMLElement){let c=kn(s);if(typeof c!="undefined"&&(s.classList.contains("annotate")||G("content.code.annotate"))){let l=fr(c,e,t);a.push(ge(s).pipe(U(i),m(({width:f,height:u})=>f&&u),K(),v(f=>f?l:M)))}}return $(":scope > span[id]",e).length&&e.classList.add("md-code__content"),ja(e).pipe(E(c=>n.next(c)),L(()=>n.complete()),m(c=>R({ref:e},c)),Pe(...a))});return G("content.lazy")?tt(e).pipe(b(n=>n),Te(1),v(()=>o)):o}function Wa(e,{target$:t,print$:r}){let o=!0;return S(t.pipe(m(n=>n.closest("details:not([open])")),b(n=>e===n),m(()=>({action:"open",reveal:!0}))),r.pipe(b(n=>n||!o),E(()=>o=e.open),m(n=>({action:n?"open":"close"}))))}function Pn(e,t){return C(()=>{let r=new g;return r.subscribe(({action:o,reveal:n})=>{e.toggleAttribute("open",o==="open"),n&&e.scrollIntoView()}),Wa(e,t).pipe(E(o=>r.next(o)),L(()=>r.complete()),m(o=>R({ref:e},o)))})}var Rn=".node circle,.node ellipse,.node path,.node polygon,.node rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}marker{fill:var(--md-mermaid-edge-color)!important}.edgeLabel .label rect{fill:#0000}.label{color:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.label foreignObject{line-height:normal;overflow:visible}.label div .edgeLabel{color:var(--md-mermaid-label-fg-color)}.edgeLabel,.edgeLabel rect,.label div .edgeLabel{background-color:var(--md-mermaid-label-bg-color)}.edgeLabel,.edgeLabel rect{fill:var(--md-mermaid-label-bg-color);color:var(--md-mermaid-edge-color)}.edgePath .path,.flowchart-link{stroke:var(--md-mermaid-edge-color);stroke-width:.05rem}.edgePath .arrowheadPath{fill:var(--md-mermaid-edge-color);stroke:none}.cluster rect{fill:var(--md-default-fg-color--lightest);stroke:var(--md-default-fg-color--lighter)}.cluster span{color:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}g #flowchart-circleEnd,g #flowchart-circleStart,g #flowchart-crossEnd,g #flowchart-crossStart,g #flowchart-pointEnd,g #flowchart-pointStart{stroke:none}g.classGroup line,g.classGroup rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}g.classGroup text{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.classLabel .box{fill:var(--md-mermaid-label-bg-color);background-color:var(--md-mermaid-label-bg-color);opacity:1}.classLabel .label{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.node .divider{stroke:var(--md-mermaid-node-fg-color)}.relation{stroke:var(--md-mermaid-edge-color)}.cardinality{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.cardinality text{fill:inherit!important}defs #classDiagram-compositionEnd,defs #classDiagram-compositionStart,defs #classDiagram-dependencyEnd,defs #classDiagram-dependencyStart,defs #classDiagram-extensionEnd,defs #classDiagram-extensionStart{fill:var(--md-mermaid-edge-color)!important;stroke:var(--md-mermaid-edge-color)!important}defs #classDiagram-aggregationEnd,defs #classDiagram-aggregationStart{fill:var(--md-mermaid-label-bg-color)!important;stroke:var(--md-mermaid-edge-color)!important}g.stateGroup rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}g.stateGroup .state-title{fill:var(--md-mermaid-label-fg-color)!important;font-family:var(--md-mermaid-font-family)}g.stateGroup .composit{fill:var(--md-mermaid-label-bg-color)}.nodeLabel,.nodeLabel p{color:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}a .nodeLabel{text-decoration:underline}.node circle.state-end,.node circle.state-start,.start-state{fill:var(--md-mermaid-edge-color);stroke:none}.end-state-inner,.end-state-outer{fill:var(--md-mermaid-edge-color)}.end-state-inner,.node circle.state-end{stroke:var(--md-mermaid-label-bg-color)}.transition{stroke:var(--md-mermaid-edge-color)}[id^=state-fork] rect,[id^=state-join] rect{fill:var(--md-mermaid-edge-color)!important;stroke:none!important}.statediagram-cluster.statediagram-cluster .inner{fill:var(--md-default-bg-color)}.statediagram-cluster rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}.statediagram-state rect.divider{fill:var(--md-default-fg-color--lightest);stroke:var(--md-default-fg-color--lighter)}defs #statediagram-barbEnd{stroke:var(--md-mermaid-edge-color)}.attributeBoxEven,.attributeBoxOdd{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}.entityBox{fill:var(--md-mermaid-label-bg-color);stroke:var(--md-mermaid-node-fg-color)}.entityLabel{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.relationshipLabelBox{fill:var(--md-mermaid-label-bg-color);fill-opacity:1;background-color:var(--md-mermaid-label-bg-color);opacity:1}.relationshipLabel{fill:var(--md-mermaid-label-fg-color)}.relationshipLine{stroke:var(--md-mermaid-edge-color)}defs #ONE_OR_MORE_END *,defs #ONE_OR_MORE_START *,defs #ONLY_ONE_END *,defs #ONLY_ONE_START *,defs #ZERO_OR_MORE_END *,defs #ZERO_OR_MORE_START *,defs #ZERO_OR_ONE_END *,defs #ZERO_OR_ONE_START *{stroke:var(--md-mermaid-edge-color)!important}defs #ZERO_OR_MORE_END circle,defs #ZERO_OR_MORE_START circle{fill:var(--md-mermaid-label-bg-color)}.actor{fill:var(--md-mermaid-sequence-actor-bg-color);stroke:var(--md-mermaid-sequence-actor-border-color)}text.actor>tspan{fill:var(--md-mermaid-sequence-actor-fg-color);font-family:var(--md-mermaid-font-family)}line{stroke:var(--md-mermaid-sequence-actor-line-color)}.actor-man circle,.actor-man line{fill:var(--md-mermaid-sequence-actorman-bg-color);stroke:var(--md-mermaid-sequence-actorman-line-color)}.messageLine0,.messageLine1{stroke:var(--md-mermaid-sequence-message-line-color)}.note{fill:var(--md-mermaid-sequence-note-bg-color);stroke:var(--md-mermaid-sequence-note-border-color)}.loopText,.loopText>tspan,.messageText,.noteText>tspan{stroke:none;font-family:var(--md-mermaid-font-family)!important}.messageText{fill:var(--md-mermaid-sequence-message-fg-color)}.loopText,.loopText>tspan{fill:var(--md-mermaid-sequence-loop-fg-color)}.noteText>tspan{fill:var(--md-mermaid-sequence-note-fg-color)}#arrowhead path{fill:var(--md-mermaid-sequence-message-line-color);stroke:none}.loopLine{fill:var(--md-mermaid-sequence-loop-bg-color);stroke:var(--md-mermaid-sequence-loop-border-color)}.labelBox{fill:var(--md-mermaid-sequence-label-bg-color);stroke:none}.labelText,.labelText>span{fill:var(--md-mermaid-sequence-label-fg-color);font-family:var(--md-mermaid-font-family)}.sequenceNumber{fill:var(--md-mermaid-sequence-number-fg-color)}rect.rect{fill:var(--md-mermaid-sequence-box-bg-color);stroke:none}rect.rect+text.text{fill:var(--md-mermaid-sequence-box-fg-color)}defs #sequencenumber{fill:var(--md-mermaid-sequence-number-bg-color)!important}";var Br,Da=0;function Va(){return typeof mermaid=="undefined"||mermaid instanceof Element?wt("https://unpkg.com/mermaid@10/dist/mermaid.min.js"):I(void 0)}function In(e){return e.classList.remove("mermaid"),Br||(Br=Va().pipe(E(()=>mermaid.initialize({startOnLoad:!1,themeCSS:Rn,sequence:{actorFontSize:"16px",messageFontSize:"16px",noteFontSize:"16px"}})),m(()=>{}),B(1))),Br.subscribe(()=>ao(this,null,function*(){e.classList.add("mermaid");let t=`__mermaid_${Da++}`,r=x("div",{class:"mermaid"}),o=e.textContent,{svg:n,fn:i}=yield mermaid.render(t,o),a=r.attachShadow({mode:"closed"});a.innerHTML=n,e.replaceWith(r),i==null||i(a)})),Br.pipe(m(()=>({ref:e})))}var Fn=x("table");function jn(e){return e.replaceWith(Fn),Fn.replaceWith(On(e)),I({ref:e})}function Na(e){let t=e.find(r=>r.checked)||e[0];return S(...e.map(r=>d(r,"change").pipe(m(()=>P(`label[for="${r.id}"]`))))).pipe(Q(P(`label[for="${t.id}"]`)),m(r=>({active:r})))}function Wn(e,{viewport$:t,target$:r}){let o=P(".tabbed-labels",e),n=$(":scope > input",e),i=Qr("prev");e.append(i);let a=Qr("next");return e.append(a),C(()=>{let s=new g,p=s.pipe(X(),ne(!0));z([s,ge(e),tt(e)]).pipe(U(p),Le(1,me)).subscribe({next([{active:c},l]){let f=Ue(c),{width:u}=ce(c);e.style.setProperty("--md-indicator-x",`${f.x}px`),e.style.setProperty("--md-indicator-width",`${u}px`);let h=pr(o);(f.xh.x+l.width)&&o.scrollTo({left:Math.max(0,f.x-16),behavior:"smooth"})},complete(){e.style.removeProperty("--md-indicator-x"),e.style.removeProperty("--md-indicator-width")}}),z([De(o),ge(o)]).pipe(U(p)).subscribe(([c,l])=>{let f=Tt(o);i.hidden=c.x<16,a.hidden=c.x>f.width-l.width-16}),S(d(i,"click").pipe(m(()=>-1)),d(a,"click").pipe(m(()=>1))).pipe(U(p)).subscribe(c=>{let{width:l}=ce(o);o.scrollBy({left:l*c,behavior:"smooth"})}),r.pipe(U(p),b(c=>n.includes(c))).subscribe(c=>c.click()),o.classList.add("tabbed-labels--linked");for(let c of n){let l=P(`label[for="${c.id}"]`);l.replaceChildren(x("a",{href:`#${l.htmlFor}`,tabIndex:-1},...Array.from(l.childNodes))),d(l.firstElementChild,"click").pipe(U(p),b(f=>!(f.metaKey||f.ctrlKey)),E(f=>{f.preventDefault(),f.stopPropagation()})).subscribe(()=>{history.replaceState({},"",`#${l.htmlFor}`),l.click()})}return G("content.tabs.link")&&s.pipe(Ce(1),ee(t)).subscribe(([{active:c},{offset:l}])=>{let f=c.innerText.trim();if(c.hasAttribute("data-md-switching"))c.removeAttribute("data-md-switching");else{let u=e.offsetTop-l.y;for(let w of $("[data-tabs]"))for(let A of $(":scope > input",w)){let te=P(`label[for="${A.id}"]`);if(te!==c&&te.innerText.trim()===f){te.setAttribute("data-md-switching",""),A.click();break}}window.scrollTo({top:e.offsetTop-u});let h=__md_get("__tabs")||[];__md_set("__tabs",[...new Set([f,...h])])}}),s.pipe(U(p)).subscribe(()=>{for(let c of $("audio, video",e))c.pause()}),Na(n).pipe(E(c=>s.next(c)),L(()=>s.complete()),m(c=>R({ref:e},c)))}).pipe(Qe(se))}function Un(e,{viewport$:t,target$:r,print$:o}){return S(...$(".annotate:not(.highlight)",e).map(n=>Cn(n,{target$:r,print$:o})),...$("pre:not(.mermaid) > code",e).map(n=>$n(n,{target$:r,print$:o})),...$("pre.mermaid",e).map(n=>In(n)),...$("table:not([class])",e).map(n=>jn(n)),...$("details",e).map(n=>Pn(n,{target$:r,print$:o})),...$("[data-tabs]",e).map(n=>Wn(n,{viewport$:t,target$:r})),...$("[title]",e).filter(()=>G("content.tooltips")).map(n=>lt(n,{viewport$:t})))}function za(e,{alert$:t}){return t.pipe(v(r=>S(I(!0),I(!1).pipe(Ge(2e3))).pipe(m(o=>({message:r,active:o})))))}function Dn(e,t){let r=P(".md-typeset",e);return C(()=>{let o=new g;return o.subscribe(({message:n,active:i})=>{e.classList.toggle("md-dialog--active",i),r.textContent=n}),za(e,t).pipe(E(n=>o.next(n)),L(()=>o.complete()),m(n=>R({ref:e},n)))})}var qa=0;function Qa(e,t){document.body.append(e);let{width:r}=ce(e);e.style.setProperty("--md-tooltip-width",`${r}px`),e.remove();let o=cr(t),n=typeof o!="undefined"?De(o):I({x:0,y:0}),i=S(et(t),kt(t)).pipe(K());return z([i,n]).pipe(m(([a,s])=>{let{x:p,y:c}=Ue(t),l=ce(t),f=t.closest("table");return f&&t.parentElement&&(p+=f.offsetLeft+t.parentElement.offsetLeft,c+=f.offsetTop+t.parentElement.offsetTop),{active:a,offset:{x:p-s.x+l.width/2-r/2,y:c-s.y+l.height+8}}}))}function Vn(e){let t=e.title;if(!t.length)return M;let r=`__tooltip_${qa++}`,o=Pt(r,"inline"),n=P(".md-typeset",o);return n.innerHTML=t,C(()=>{let i=new g;return i.subscribe({next({offset:a}){o.style.setProperty("--md-tooltip-x",`${a.x}px`),o.style.setProperty("--md-tooltip-y",`${a.y}px`)},complete(){o.style.removeProperty("--md-tooltip-x"),o.style.removeProperty("--md-tooltip-y")}}),S(i.pipe(b(({active:a})=>a)),i.pipe(_e(250),b(({active:a})=>!a))).subscribe({next({active:a}){a?(e.insertAdjacentElement("afterend",o),e.setAttribute("aria-describedby",r),e.removeAttribute("title")):(o.remove(),e.removeAttribute("aria-describedby"),e.setAttribute("title",t))},complete(){o.remove(),e.removeAttribute("aria-describedby"),e.setAttribute("title",t)}}),i.pipe(Le(16,me)).subscribe(({active:a})=>{o.classList.toggle("md-tooltip--active",a)}),i.pipe(ct(125,me),b(()=>!!e.offsetParent),m(()=>e.offsetParent.getBoundingClientRect()),m(({x:a})=>a)).subscribe({next(a){a?o.style.setProperty("--md-tooltip-0",`${-a}px`):o.style.removeProperty("--md-tooltip-0")},complete(){o.style.removeProperty("--md-tooltip-0")}}),Qa(o,e).pipe(E(a=>i.next(a)),L(()=>i.complete()),m(a=>R({ref:e},a)))}).pipe(Qe(se))}function Ka({viewport$:e}){if(!G("header.autohide"))return I(!1);let t=e.pipe(m(({offset:{y:n}})=>n),Ye(2,1),m(([n,i])=>[nMath.abs(i-n.y)>100),m(([,[n]])=>n),K()),o=Ve("search");return z([e,o]).pipe(m(([{offset:n},i])=>n.y>400&&!i),K(),v(n=>n?r:I(!1)),Q(!1))}function Nn(e,t){return C(()=>z([ge(e),Ka(t)])).pipe(m(([{height:r},o])=>({height:r,hidden:o})),K((r,o)=>r.height===o.height&&r.hidden===o.hidden),B(1))}function zn(e,{header$:t,main$:r}){return C(()=>{let o=new g,n=o.pipe(X(),ne(!0));o.pipe(Z("active"),We(t)).subscribe(([{active:a},{hidden:s}])=>{e.classList.toggle("md-header--shadow",a&&!s),e.hidden=s});let i=ue($("[title]",e)).pipe(b(()=>G("content.tooltips")),oe(a=>Vn(a)));return r.subscribe(o),t.pipe(U(n),m(a=>R({ref:e},a)),Pe(i.pipe(U(n))))})}function Ya(e,{viewport$:t,header$:r}){return mr(e,{viewport$:t,header$:r}).pipe(m(({offset:{y:o}})=>{let{height:n}=ce(e);return{active:o>=n}}),Z("active"))}function qn(e,t){return C(()=>{let r=new g;r.subscribe({next({active:n}){e.classList.toggle("md-header__title--active",n)},complete(){e.classList.remove("md-header__title--active")}});let o=fe(".md-content h1");return typeof o=="undefined"?M:Ya(o,t).pipe(E(n=>r.next(n)),L(()=>r.complete()),m(n=>R({ref:e},n)))})}function Qn(e,{viewport$:t,header$:r}){let o=r.pipe(m(({height:i})=>i),K()),n=o.pipe(v(()=>ge(e).pipe(m(({height:i})=>({top:e.offsetTop,bottom:e.offsetTop+i})),Z("bottom"))));return z([o,n,t]).pipe(m(([i,{top:a,bottom:s},{offset:{y:p},size:{height:c}}])=>(c=Math.max(0,c-Math.max(0,a-p,i)-Math.max(0,c+p-s)),{offset:a-i,height:c,active:a-i<=p})),K((i,a)=>i.offset===a.offset&&i.height===a.height&&i.active===a.active))}function Ba(e){let t=__md_get("__palette")||{index:e.findIndex(o=>matchMedia(o.getAttribute("data-md-color-media")).matches)},r=Math.max(0,Math.min(t.index,e.length-1));return I(...e).pipe(oe(o=>d(o,"change").pipe(m(()=>o))),Q(e[r]),m(o=>({index:e.indexOf(o),color:{media:o.getAttribute("data-md-color-media"),scheme:o.getAttribute("data-md-color-scheme"),primary:o.getAttribute("data-md-color-primary"),accent:o.getAttribute("data-md-color-accent")}})),B(1))}function Kn(e){let t=$("input",e),r=x("meta",{name:"theme-color"});document.head.appendChild(r);let o=x("meta",{name:"color-scheme"});document.head.appendChild(o);let n=$t("(prefers-color-scheme: light)");return C(()=>{let i=new g;return i.subscribe(a=>{if(document.body.setAttribute("data-md-color-switching",""),a.color.media==="(prefers-color-scheme)"){let s=matchMedia("(prefers-color-scheme: light)"),p=document.querySelector(s.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");a.color.scheme=p.getAttribute("data-md-color-scheme"),a.color.primary=p.getAttribute("data-md-color-primary"),a.color.accent=p.getAttribute("data-md-color-accent")}for(let[s,p]of Object.entries(a.color))document.body.setAttribute(`data-md-color-${s}`,p);for(let s=0;sa.key==="Enter"),ee(i,(a,s)=>s)).subscribe(({index:a})=>{a=(a+1)%t.length,t[a].click(),t[a].focus()}),i.pipe(m(()=>{let a=Se("header"),s=window.getComputedStyle(a);return o.content=s.colorScheme,s.backgroundColor.match(/\d+/g).map(p=>(+p).toString(16).padStart(2,"0")).join("")})).subscribe(a=>r.content=`#${a}`),i.pipe(be(se)).subscribe(()=>{document.body.removeAttribute("data-md-color-switching")}),Ba(t).pipe(U(n.pipe(Ce(1))),st(),E(a=>i.next(a)),L(()=>i.complete()),m(a=>R({ref:e},a)))})}function Yn(e,{progress$:t}){return C(()=>{let r=new g;return r.subscribe(({value:o})=>{e.style.setProperty("--md-progress-value",`${o}`)}),t.pipe(E(o=>r.next({value:o})),L(()=>r.complete()),m(o=>({ref:e,value:o})))})}var Gr=Vt(Yr());function Ga(e){e.setAttribute("data-md-copying","");let t=e.closest("[data-copy]"),r=t?t.getAttribute("data-copy"):e.innerText;return e.removeAttribute("data-md-copying"),r.trimEnd()}function Bn({alert$:e}){Gr.default.isSupported()&&new F(t=>{new Gr.default("[data-clipboard-target], [data-clipboard-text]",{text:r=>r.getAttribute("data-clipboard-text")||Ga(P(r.getAttribute("data-clipboard-target")))}).on("success",r=>t.next(r))}).pipe(E(t=>{t.trigger.focus()}),m(()=>Ee("clipboard.copied"))).subscribe(e)}function Gn(e,t){return e.protocol=t.protocol,e.hostname=t.hostname,e}function Ja(e,t){let r=new Map;for(let o of $("url",e)){let n=P("loc",o),i=[Gn(new URL(n.textContent),t)];r.set(`${i[0]}`,i);for(let a of $("[rel=alternate]",o)){let s=a.getAttribute("href");s!=null&&i.push(Gn(new URL(s),t))}}return r}function ur(e){return mn(new URL("sitemap.xml",e)).pipe(m(t=>Ja(t,new URL(e))),ve(()=>I(new Map)))}function Xa(e,t){if(!(e.target instanceof Element))return M;let r=e.target.closest("a");if(r===null)return M;if(r.target||e.metaKey||e.ctrlKey)return M;let o=new URL(r.href);return o.search=o.hash="",t.has(`${o}`)?(e.preventDefault(),I(new URL(r.href))):M}function Jn(e){let t=new Map;for(let r of $(":scope > *",e.head))t.set(r.outerHTML,r);return t}function Xn(e){for(let t of $("[href], [src]",e))for(let r of["href","src"]){let o=t.getAttribute(r);if(o&&!/^(?:[a-z]+:)?\/\//i.test(o)){t[r]=t[r];break}}return I(e)}function Za(e){for(let o of["[data-md-component=announce]","[data-md-component=container]","[data-md-component=header-topic]","[data-md-component=outdated]","[data-md-component=logo]","[data-md-component=skip]",...G("navigation.tabs.sticky")?["[data-md-component=tabs]"]:[]]){let n=fe(o),i=fe(o,e);typeof n!="undefined"&&typeof i!="undefined"&&n.replaceWith(i)}let t=Jn(document);for(let[o,n]of Jn(e))t.has(o)?t.delete(o):document.head.appendChild(n);for(let o of t.values()){let n=o.getAttribute("name");n!=="theme-color"&&n!=="color-scheme"&&o.remove()}let r=Se("container");return je($("script",r)).pipe(v(o=>{let n=e.createElement("script");if(o.src){for(let i of o.getAttributeNames())n.setAttribute(i,o.getAttribute(i));return o.replaceWith(n),new F(i=>{n.onload=()=>i.complete()})}else return n.textContent=o.textContent,o.replaceWith(n),M}),X(),ne(document))}function Zn({location$:e,viewport$:t,progress$:r}){let o=ye();if(location.protocol==="file:")return M;let n=ur(o.base);I(document).subscribe(Xn);let i=d(document.body,"click").pipe(We(n),v(([p,c])=>Xa(p,c)),pe()),a=d(window,"popstate").pipe(m(xe),pe());i.pipe(ee(t)).subscribe(([p,{offset:c}])=>{history.replaceState(c,""),history.pushState(null,"",p)}),S(i,a).subscribe(e);let s=e.pipe(Z("pathname"),v(p=>ln(p,{progress$:r}).pipe(ve(()=>(pt(p,!0),M)))),v(Xn),v(Za),pe());return S(s.pipe(ee(e,(p,c)=>c)),s.pipe(v(()=>e),Z("pathname"),v(()=>e),Z("hash")),e.pipe(K((p,c)=>p.pathname===c.pathname&&p.hash===c.hash),v(()=>i),E(()=>history.back()))).subscribe(p=>{var c,l;history.state!==null||!p.hash?window.scrollTo(0,(l=(c=history.state)==null?void 0:c.y)!=null?l:0):(history.scrollRestoration="auto",sn(p.hash),history.scrollRestoration="manual")}),e.subscribe(()=>{history.scrollRestoration="manual"}),d(window,"beforeunload").subscribe(()=>{history.scrollRestoration="auto"}),t.pipe(Z("offset"),_e(100)).subscribe(({offset:p})=>{history.replaceState(p,"")}),s}var ri=Vt(ti());function oi(e){let t=e.separator.split("|").map(n=>n.replace(/(\(\?[!=<][^)]+\))/g,"").length===0?"\uFFFD":n).join("|"),r=new RegExp(t,"img"),o=(n,i,a)=>`${i}${a}`;return n=>{n=n.replace(/[\s*+\-:~^]+/g," ").trim();let i=new RegExp(`(^|${e.separator}|)(${n.replace(/[|\\{}()[\]^$+*?.-]/g,"\\$&").replace(r,"|")})`,"img");return a=>(0,ri.default)(a).replace(i,o).replace(/<\/mark>(\s+)]*>/img,"$1")}}function It(e){return e.type===1}function dr(e){return e.type===3}function ni(e,t){let r=vn(e);return S(I(location.protocol!=="file:"),Ve("search")).pipe(Ae(o=>o),v(()=>t)).subscribe(({config:o,docs:n})=>r.next({type:0,data:{config:o,docs:n,options:{suggest:G("search.suggest")}}})),r}function ii({document$:e}){let t=ye(),r=Ne(new URL("../versions.json",t.base)).pipe(ve(()=>M)),o=r.pipe(m(n=>{let[,i]=t.base.match(/([^/]+)\/?$/);return n.find(({version:a,aliases:s})=>a===i||s.includes(i))||n[0]}));r.pipe(m(n=>new Map(n.map(i=>[`${new URL(`../${i.version}/`,t.base)}`,i]))),v(n=>d(document.body,"click").pipe(b(i=>!i.metaKey&&!i.ctrlKey),ee(o),v(([i,a])=>{if(i.target instanceof Element){let s=i.target.closest("a");if(s&&!s.target&&n.has(s.href)){let p=s.href;return!i.target.closest(".md-version")&&n.get(p)===a?M:(i.preventDefault(),I(p))}}return M}),v(i=>ur(new URL(i)).pipe(m(a=>{let p=xe().href.replace(t.base,i);return a.has(p.split("#")[0])?new URL(p):new URL(i)})))))).subscribe(n=>pt(n,!0)),z([r,o]).subscribe(([n,i])=>{P(".md-header__topic").appendChild(Mn(n,i))}),e.pipe(v(()=>o)).subscribe(n=>{var a;let i=__md_get("__outdated",sessionStorage);if(i===null){i=!0;let s=((a=t.version)==null?void 0:a.default)||"latest";Array.isArray(s)||(s=[s]);e:for(let p of s)for(let c of n.aliases.concat(n.version))if(new RegExp(p,"i").test(c)){i=!1;break e}__md_set("__outdated",i,sessionStorage)}if(i)for(let s of ae("outdated"))s.hidden=!1})}function ns(e,{worker$:t}){let{searchParams:r}=xe();r.has("q")&&(Je("search",!0),e.value=r.get("q"),e.focus(),Ve("search").pipe(Ae(i=>!i)).subscribe(()=>{let i=xe();i.searchParams.delete("q"),history.replaceState({},"",`${i}`)}));let o=et(e),n=S(t.pipe(Ae(It)),d(e,"keyup"),o).pipe(m(()=>e.value),K());return z([n,o]).pipe(m(([i,a])=>({value:i,focus:a})),B(1))}function ai(e,{worker$:t}){let r=new g,o=r.pipe(X(),ne(!0));z([t.pipe(Ae(It)),r],(i,a)=>a).pipe(Z("value")).subscribe(({value:i})=>t.next({type:2,data:i})),r.pipe(Z("focus")).subscribe(({focus:i})=>{i&&Je("search",i)}),d(e.form,"reset").pipe(U(o)).subscribe(()=>e.focus());let n=P("header [for=__search]");return d(n,"click").subscribe(()=>e.focus()),ns(e,{worker$:t}).pipe(E(i=>r.next(i)),L(()=>r.complete()),m(i=>R({ref:e},i)),B(1))}function si(e,{worker$:t,query$:r}){let o=new g,n=tn(e.parentElement).pipe(b(Boolean)),i=e.parentElement,a=P(":scope > :first-child",e),s=P(":scope > :last-child",e);Ve("search").subscribe(l=>s.setAttribute("role",l?"list":"presentation")),o.pipe(ee(r),Ur(t.pipe(Ae(It)))).subscribe(([{items:l},{value:f}])=>{switch(l.length){case 0:a.textContent=f.length?Ee("search.result.none"):Ee("search.result.placeholder");break;case 1:a.textContent=Ee("search.result.one");break;default:let u=sr(l.length);a.textContent=Ee("search.result.other",u)}});let p=o.pipe(E(()=>s.innerHTML=""),v(({items:l})=>S(I(...l.slice(0,10)),I(...l.slice(10)).pipe(Ye(4),Vr(n),v(([f])=>f)))),m(Tn),pe());return p.subscribe(l=>s.appendChild(l)),p.pipe(oe(l=>{let f=fe("details",l);return typeof f=="undefined"?M:d(f,"toggle").pipe(U(o),m(()=>f))})).subscribe(l=>{l.open===!1&&l.offsetTop<=i.scrollTop&&i.scrollTo({top:l.offsetTop})}),t.pipe(b(dr),m(({data:l})=>l)).pipe(E(l=>o.next(l)),L(()=>o.complete()),m(l=>R({ref:e},l)))}function is(e,{query$:t}){return t.pipe(m(({value:r})=>{let o=xe();return o.hash="",r=r.replace(/\s+/g,"+").replace(/&/g,"%26").replace(/=/g,"%3D"),o.search=`q=${r}`,{url:o}}))}function ci(e,t){let r=new g,o=r.pipe(X(),ne(!0));return r.subscribe(({url:n})=>{e.setAttribute("data-clipboard-text",e.href),e.href=`${n}`}),d(e,"click").pipe(U(o)).subscribe(n=>n.preventDefault()),is(e,t).pipe(E(n=>r.next(n)),L(()=>r.complete()),m(n=>R({ref:e},n)))}function pi(e,{worker$:t,keyboard$:r}){let o=new g,n=Se("search-query"),i=S(d(n,"keydown"),d(n,"focus")).pipe(be(se),m(()=>n.value),K());return o.pipe(We(i),m(([{suggest:s},p])=>{let c=p.split(/([\s-]+)/);if(s!=null&&s.length&&c[c.length-1]){let l=s[s.length-1];l.startsWith(c[c.length-1])&&(c[c.length-1]=l)}else c.length=0;return c})).subscribe(s=>e.innerHTML=s.join("").replace(/\s/g," ")),r.pipe(b(({mode:s})=>s==="search")).subscribe(s=>{switch(s.type){case"ArrowRight":e.innerText.length&&n.selectionStart===n.value.length&&(n.value=e.innerText);break}}),t.pipe(b(dr),m(({data:s})=>s)).pipe(E(s=>o.next(s)),L(()=>o.complete()),m(()=>({ref:e})))}function li(e,{index$:t,keyboard$:r}){let o=ye();try{let n=ni(o.search,t),i=Se("search-query",e),a=Se("search-result",e);d(e,"click").pipe(b(({target:p})=>p instanceof Element&&!!p.closest("a"))).subscribe(()=>Je("search",!1)),r.pipe(b(({mode:p})=>p==="search")).subscribe(p=>{let c=Re();switch(p.type){case"Enter":if(c===i){let l=new Map;for(let f of $(":first-child [href]",a)){let u=f.firstElementChild;l.set(f,parseFloat(u.getAttribute("data-md-score")))}if(l.size){let[[f]]=[...l].sort(([,u],[,h])=>h-u);f.click()}p.claim()}break;case"Escape":case"Tab":Je("search",!1),i.blur();break;case"ArrowUp":case"ArrowDown":if(typeof c=="undefined")i.focus();else{let l=[i,...$(":not(details) > [href], summary, details[open] [href]",a)],f=Math.max(0,(Math.max(0,l.indexOf(c))+l.length+(p.type==="ArrowUp"?-1:1))%l.length);l[f].focus()}p.claim();break;default:i!==Re()&&i.focus()}}),r.pipe(b(({mode:p})=>p==="global")).subscribe(p=>{switch(p.type){case"f":case"s":case"/":i.focus(),i.select(),p.claim();break}});let s=ai(i,{worker$:n});return S(s,si(a,{worker$:n,query$:s})).pipe(Pe(...ae("search-share",e).map(p=>ci(p,{query$:s})),...ae("search-suggest",e).map(p=>pi(p,{worker$:n,keyboard$:r}))))}catch(n){return e.hidden=!0,Ke}}function mi(e,{index$:t,location$:r}){return z([t,r.pipe(Q(xe()),b(o=>!!o.searchParams.get("h")))]).pipe(m(([o,n])=>oi(o.config)(n.searchParams.get("h"))),m(o=>{var a;let n=new Map,i=document.createNodeIterator(e,NodeFilter.SHOW_TEXT);for(let s=i.nextNode();s;s=i.nextNode())if((a=s.parentElement)!=null&&a.offsetHeight){let p=s.textContent,c=o(p);c.length>p.length&&n.set(s,c)}for(let[s,p]of n){let{childNodes:c}=x("span",null,p);s.replaceWith(...Array.from(c))}return{ref:e,nodes:n}}))}function as(e,{viewport$:t,main$:r}){let o=e.closest(".md-grid"),n=o.offsetTop-o.parentElement.offsetTop;return z([r,t]).pipe(m(([{offset:i,height:a},{offset:{y:s}}])=>(a=a+Math.min(n,Math.max(0,s-i))-n,{height:a,locked:s>=i+n})),K((i,a)=>i.height===a.height&&i.locked===a.locked))}function Jr(e,o){var n=o,{header$:t}=n,r=io(n,["header$"]);let i=P(".md-sidebar__scrollwrap",e),{y:a}=Ue(i);return C(()=>{let s=new g,p=s.pipe(X(),ne(!0)),c=s.pipe(Le(0,me));return c.pipe(ee(t)).subscribe({next([{height:l},{height:f}]){i.style.height=`${l-2*a}px`,e.style.top=`${f}px`},complete(){i.style.height="",e.style.top=""}}),c.pipe(Ae()).subscribe(()=>{for(let l of $(".md-nav__link--active[href]",e)){if(!l.clientHeight)continue;let f=l.closest(".md-sidebar__scrollwrap");if(typeof f!="undefined"){let u=l.offsetTop-f.offsetTop,{height:h}=ce(f);f.scrollTo({top:u-h/2})}}}),ue($("label[tabindex]",e)).pipe(oe(l=>d(l,"click").pipe(be(se),m(()=>l),U(p)))).subscribe(l=>{let f=P(`[id="${l.htmlFor}"]`);P(`[aria-labelledby="${l.id}"]`).setAttribute("aria-expanded",`${f.checked}`)}),as(e,r).pipe(E(l=>s.next(l)),L(()=>s.complete()),m(l=>R({ref:e},l)))})}function fi(e,t){if(typeof t!="undefined"){let r=`https://api.github.com/repos/${e}/${t}`;return Ct(Ne(`${r}/releases/latest`).pipe(ve(()=>M),m(o=>({version:o.tag_name})),Be({})),Ne(r).pipe(ve(()=>M),m(o=>({stars:o.stargazers_count,forks:o.forks_count})),Be({}))).pipe(m(([o,n])=>R(R({},o),n)))}else{let r=`https://api.github.com/users/${e}`;return Ne(r).pipe(m(o=>({repositories:o.public_repos})),Be({}))}}function ui(e,t){let r=`https://${e}/api/v4/projects/${encodeURIComponent(t)}`;return Ne(r).pipe(ve(()=>M),m(({star_count:o,forks_count:n})=>({stars:o,forks:n})),Be({}))}function di(e){let t=e.match(/^.+github\.com\/([^/]+)\/?([^/]+)?/i);if(t){let[,r,o]=t;return fi(r,o)}if(t=e.match(/^.+?([^/]*gitlab[^/]+)\/(.+?)\/?$/i),t){let[,r,o]=t;return ui(r,o)}return M}var ss;function cs(e){return ss||(ss=C(()=>{let t=__md_get("__source",sessionStorage);if(t)return I(t);if(ae("consent").length){let o=__md_get("__consent");if(!(o&&o.github))return M}return di(e.href).pipe(E(o=>__md_set("__source",o,sessionStorage)))}).pipe(ve(()=>M),b(t=>Object.keys(t).length>0),m(t=>({facts:t})),B(1)))}function hi(e){let t=P(":scope > :last-child",e);return C(()=>{let r=new g;return r.subscribe(({facts:o})=>{t.appendChild(Sn(o)),t.classList.add("md-source__repository--active")}),cs(e).pipe(E(o=>r.next(o)),L(()=>r.complete()),m(o=>R({ref:e},o)))})}function ps(e,{viewport$:t,header$:r}){return ge(document.body).pipe(v(()=>mr(e,{header$:r,viewport$:t})),m(({offset:{y:o}})=>({hidden:o>=10})),Z("hidden"))}function bi(e,t){return C(()=>{let r=new g;return r.subscribe({next({hidden:o}){e.hidden=o},complete(){e.hidden=!1}}),(G("navigation.tabs.sticky")?I({hidden:!1}):ps(e,t)).pipe(E(o=>r.next(o)),L(()=>r.complete()),m(o=>R({ref:e},o)))})}function ls(e,{viewport$:t,header$:r}){let o=new Map,n=$(".md-nav__link",e);for(let s of n){let p=decodeURIComponent(s.hash.substring(1)),c=fe(`[id="${p}"]`);typeof c!="undefined"&&o.set(s,c)}let i=r.pipe(Z("height"),m(({height:s})=>{let p=Se("main"),c=P(":scope > :first-child",p);return s+.8*(c.offsetTop-p.offsetTop)}),pe());return ge(document.body).pipe(Z("height"),v(s=>C(()=>{let p=[];return I([...o].reduce((c,[l,f])=>{for(;p.length&&o.get(p[p.length-1]).tagName>=f.tagName;)p.pop();let u=f.offsetTop;for(;!u&&f.parentElement;)f=f.parentElement,u=f.offsetTop;let h=f.offsetParent;for(;h;h=h.offsetParent)u+=h.offsetTop;return c.set([...p=[...p,l]].reverse(),u)},new Map))}).pipe(m(p=>new Map([...p].sort(([,c],[,l])=>c-l))),We(i),v(([p,c])=>t.pipe(jr(([l,f],{offset:{y:u},size:h})=>{let w=u+h.height>=Math.floor(s.height);for(;f.length;){let[,A]=f[0];if(A-c=u&&!w)f=[l.pop(),...f];else break}return[l,f]},[[],[...p]]),K((l,f)=>l[0]===f[0]&&l[1]===f[1])))))).pipe(m(([s,p])=>({prev:s.map(([c])=>c),next:p.map(([c])=>c)})),Q({prev:[],next:[]}),Ye(2,1),m(([s,p])=>s.prev.length{let i=new g,a=i.pipe(X(),ne(!0));if(i.subscribe(({prev:s,next:p})=>{for(let[c]of p)c.classList.remove("md-nav__link--passed"),c.classList.remove("md-nav__link--active");for(let[c,[l]]of s.entries())l.classList.add("md-nav__link--passed"),l.classList.toggle("md-nav__link--active",c===s.length-1)}),G("toc.follow")){let s=S(t.pipe(_e(1),m(()=>{})),t.pipe(_e(250),m(()=>"smooth")));i.pipe(b(({prev:p})=>p.length>0),We(o.pipe(be(se))),ee(s)).subscribe(([[{prev:p}],c])=>{let[l]=p[p.length-1];if(l.offsetHeight){let f=cr(l);if(typeof f!="undefined"){let u=l.offsetTop-f.offsetTop,{height:h}=ce(f);f.scrollTo({top:u-h/2,behavior:c})}}})}return G("navigation.tracking")&&t.pipe(U(a),Z("offset"),_e(250),Ce(1),U(n.pipe(Ce(1))),st({delay:250}),ee(i)).subscribe(([,{prev:s}])=>{let p=xe(),c=s[s.length-1];if(c&&c.length){let[l]=c,{hash:f}=new URL(l.href);p.hash!==f&&(p.hash=f,history.replaceState({},"",`${p}`))}else p.hash="",history.replaceState({},"",`${p}`)}),ls(e,{viewport$:t,header$:r}).pipe(E(s=>i.next(s)),L(()=>i.complete()),m(s=>R({ref:e},s)))})}function ms(e,{viewport$:t,main$:r,target$:o}){let n=t.pipe(m(({offset:{y:a}})=>a),Ye(2,1),m(([a,s])=>a>s&&s>0),K()),i=r.pipe(m(({active:a})=>a));return z([i,n]).pipe(m(([a,s])=>!(a&&s)),K(),U(o.pipe(Ce(1))),ne(!0),st({delay:250}),m(a=>({hidden:a})))}function gi(e,{viewport$:t,header$:r,main$:o,target$:n}){let i=new g,a=i.pipe(X(),ne(!0));return i.subscribe({next({hidden:s}){e.hidden=s,s?(e.setAttribute("tabindex","-1"),e.blur()):e.removeAttribute("tabindex")},complete(){e.style.top="",e.hidden=!0,e.removeAttribute("tabindex")}}),r.pipe(U(a),Z("height")).subscribe(({height:s})=>{e.style.top=`${s+16}px`}),d(e,"click").subscribe(s=>{s.preventDefault(),window.scrollTo({top:0})}),ms(e,{viewport$:t,main$:o,target$:n}).pipe(E(s=>i.next(s)),L(()=>i.complete()),m(s=>R({ref:e},s)))}function xi({document$:e,viewport$:t}){e.pipe(v(()=>$(".md-ellipsis")),oe(r=>tt(r).pipe(U(e.pipe(Ce(1))),b(o=>o),m(()=>r),Te(1))),b(r=>r.offsetWidth{let o=r.innerText,n=r.closest("a")||r;return n.title=o,lt(n,{viewport$:t}).pipe(U(e.pipe(Ce(1))),L(()=>n.removeAttribute("title")))})).subscribe(),e.pipe(v(()=>$(".md-status")),oe(r=>lt(r,{viewport$:t}))).subscribe()}function yi({document$:e,tablet$:t}){e.pipe(v(()=>$(".md-toggle--indeterminate")),E(r=>{r.indeterminate=!0,r.checked=!1}),oe(r=>d(r,"change").pipe(Dr(()=>r.classList.contains("md-toggle--indeterminate")),m(()=>r))),ee(t)).subscribe(([r,o])=>{r.classList.remove("md-toggle--indeterminate"),o&&(r.checked=!1)})}function fs(){return/(iPad|iPhone|iPod)/.test(navigator.userAgent)}function Ei({document$:e}){e.pipe(v(()=>$("[data-md-scrollfix]")),E(t=>t.removeAttribute("data-md-scrollfix")),b(fs),oe(t=>d(t,"touchstart").pipe(m(()=>t)))).subscribe(t=>{let r=t.scrollTop;r===0?t.scrollTop=1:r+t.offsetHeight===t.scrollHeight&&(t.scrollTop=r-1)})}function wi({viewport$:e,tablet$:t}){z([Ve("search"),t]).pipe(m(([r,o])=>r&&!o),v(r=>I(r).pipe(Ge(r?400:100))),ee(e)).subscribe(([r,{offset:{y:o}}])=>{if(r)document.body.setAttribute("data-md-scrolllock",""),document.body.style.top=`-${o}px`;else{let n=-1*parseInt(document.body.style.top,10);document.body.removeAttribute("data-md-scrolllock"),document.body.style.top="",n&&window.scrollTo(0,n)}})}Object.entries||(Object.entries=function(e){let t=[];for(let r of Object.keys(e))t.push([r,e[r]]);return t});Object.values||(Object.values=function(e){let t=[];for(let r of Object.keys(e))t.push(e[r]);return t});typeof Element!="undefined"&&(Element.prototype.scrollTo||(Element.prototype.scrollTo=function(e,t){typeof e=="object"?(this.scrollLeft=e.left,this.scrollTop=e.top):(this.scrollLeft=e,this.scrollTop=t)}),Element.prototype.replaceWith||(Element.prototype.replaceWith=function(...e){let t=this.parentNode;if(t){e.length===0&&t.removeChild(this);for(let r=e.length-1;r>=0;r--){let o=e[r];typeof o=="string"?o=document.createTextNode(o):o.parentNode&&o.parentNode.removeChild(o),r?t.insertBefore(this.previousSibling,o):t.replaceChild(o,this)}}}));function us(){return location.protocol==="file:"?wt(`${new URL("search/search_index.js",Xr.base)}`).pipe(m(()=>__index),B(1)):Ne(new URL("search/search_index.json",Xr.base))}document.documentElement.classList.remove("no-js");document.documentElement.classList.add("js");var ot=Yo(),jt=nn(),Ot=cn(jt),Zr=on(),Oe=bn(),hr=$t("(min-width: 960px)"),Si=$t("(min-width: 1220px)"),Oi=pn(),Xr=ye(),Mi=document.forms.namedItem("search")?us():Ke,eo=new g;Bn({alert$:eo});var to=new g;G("navigation.instant")&&Zn({location$:jt,viewport$:Oe,progress$:to}).subscribe(ot);var Ti;((Ti=Xr.version)==null?void 0:Ti.provider)==="mike"&&ii({document$:ot});S(jt,Ot).pipe(Ge(125)).subscribe(()=>{Je("drawer",!1),Je("search",!1)});Zr.pipe(b(({mode:e})=>e==="global")).subscribe(e=>{switch(e.type){case"p":case",":let t=fe("link[rel=prev]");typeof t!="undefined"&&pt(t);break;case"n":case".":let r=fe("link[rel=next]");typeof r!="undefined"&&pt(r);break;case"Enter":let o=Re();o instanceof HTMLLabelElement&&o.click()}});xi({viewport$:Oe,document$:ot});yi({document$:ot,tablet$:hr});Ei({document$:ot});wi({viewport$:Oe,tablet$:hr});var rt=Nn(Se("header"),{viewport$:Oe}),Ft=ot.pipe(m(()=>Se("main")),v(e=>Qn(e,{viewport$:Oe,header$:rt})),B(1)),ds=S(...ae("consent").map(e=>xn(e,{target$:Ot})),...ae("dialog").map(e=>Dn(e,{alert$:eo})),...ae("header").map(e=>zn(e,{viewport$:Oe,header$:rt,main$:Ft})),...ae("palette").map(e=>Kn(e)),...ae("progress").map(e=>Yn(e,{progress$:to})),...ae("search").map(e=>li(e,{index$:Mi,keyboard$:Zr})),...ae("source").map(e=>hi(e))),hs=C(()=>S(...ae("announce").map(e=>gn(e)),...ae("content").map(e=>Un(e,{viewport$:Oe,target$:Ot,print$:Oi})),...ae("content").map(e=>G("search.highlight")?mi(e,{index$:Mi,location$:jt}):M),...ae("header-title").map(e=>qn(e,{viewport$:Oe,header$:rt})),...ae("sidebar").map(e=>e.getAttribute("data-md-type")==="navigation"?Nr(Si,()=>Jr(e,{viewport$:Oe,header$:rt,main$:Ft})):Nr(hr,()=>Jr(e,{viewport$:Oe,header$:rt,main$:Ft}))),...ae("tabs").map(e=>bi(e,{viewport$:Oe,header$:rt})),...ae("toc").map(e=>vi(e,{viewport$:Oe,header$:rt,main$:Ft,target$:Ot})),...ae("top").map(e=>gi(e,{viewport$:Oe,header$:rt,main$:Ft,target$:Ot})))),Li=ot.pipe(v(()=>hs),Pe(ds),B(1));Li.subscribe();window.document$=ot;window.location$=jt;window.target$=Ot;window.keyboard$=Zr;window.viewport$=Oe;window.tablet$=hr;window.screen$=Si;window.print$=Oi;window.alert$=eo;window.progress$=to;window.component$=Li;})(); +//# sourceMappingURL=bundle.ad660dcc.min.js.map + diff --git a/assets/javascripts/bundle.ad660dcc.min.js.map b/assets/javascripts/bundle.ad660dcc.min.js.map new file mode 100644 index 00000000..6d61170f --- /dev/null +++ b/assets/javascripts/bundle.ad660dcc.min.js.map @@ -0,0 +1,7 @@ +{ + "version": 3, + "sources": ["node_modules/focus-visible/dist/focus-visible.js", "node_modules/clipboard/dist/clipboard.js", "node_modules/escape-html/index.js", "src/templates/assets/javascripts/bundle.ts", "node_modules/rxjs/node_modules/tslib/tslib.es6.js", "node_modules/rxjs/src/internal/util/isFunction.ts", "node_modules/rxjs/src/internal/util/createErrorClass.ts", "node_modules/rxjs/src/internal/util/UnsubscriptionError.ts", "node_modules/rxjs/src/internal/util/arrRemove.ts", "node_modules/rxjs/src/internal/Subscription.ts", "node_modules/rxjs/src/internal/config.ts", "node_modules/rxjs/src/internal/scheduler/timeoutProvider.ts", "node_modules/rxjs/src/internal/util/reportUnhandledError.ts", "node_modules/rxjs/src/internal/util/noop.ts", "node_modules/rxjs/src/internal/NotificationFactories.ts", "node_modules/rxjs/src/internal/util/errorContext.ts", "node_modules/rxjs/src/internal/Subscriber.ts", "node_modules/rxjs/src/internal/symbol/observable.ts", "node_modules/rxjs/src/internal/util/identity.ts", "node_modules/rxjs/src/internal/util/pipe.ts", "node_modules/rxjs/src/internal/Observable.ts", "node_modules/rxjs/src/internal/util/lift.ts", "node_modules/rxjs/src/internal/operators/OperatorSubscriber.ts", "node_modules/rxjs/src/internal/scheduler/animationFrameProvider.ts", "node_modules/rxjs/src/internal/util/ObjectUnsubscribedError.ts", "node_modules/rxjs/src/internal/Subject.ts", "node_modules/rxjs/src/internal/BehaviorSubject.ts", "node_modules/rxjs/src/internal/scheduler/dateTimestampProvider.ts", "node_modules/rxjs/src/internal/ReplaySubject.ts", "node_modules/rxjs/src/internal/scheduler/Action.ts", "node_modules/rxjs/src/internal/scheduler/intervalProvider.ts", "node_modules/rxjs/src/internal/scheduler/AsyncAction.ts", "node_modules/rxjs/src/internal/Scheduler.ts", "node_modules/rxjs/src/internal/scheduler/AsyncScheduler.ts", "node_modules/rxjs/src/internal/scheduler/async.ts", "node_modules/rxjs/src/internal/scheduler/QueueAction.ts", "node_modules/rxjs/src/internal/scheduler/QueueScheduler.ts", "node_modules/rxjs/src/internal/scheduler/queue.ts", "node_modules/rxjs/src/internal/scheduler/AnimationFrameAction.ts", "node_modules/rxjs/src/internal/scheduler/AnimationFrameScheduler.ts", "node_modules/rxjs/src/internal/scheduler/animationFrame.ts", "node_modules/rxjs/src/internal/observable/empty.ts", "node_modules/rxjs/src/internal/util/isScheduler.ts", "node_modules/rxjs/src/internal/util/args.ts", "node_modules/rxjs/src/internal/util/isArrayLike.ts", "node_modules/rxjs/src/internal/util/isPromise.ts", "node_modules/rxjs/src/internal/util/isInteropObservable.ts", "node_modules/rxjs/src/internal/util/isAsyncIterable.ts", "node_modules/rxjs/src/internal/util/throwUnobservableError.ts", "node_modules/rxjs/src/internal/symbol/iterator.ts", "node_modules/rxjs/src/internal/util/isIterable.ts", "node_modules/rxjs/src/internal/util/isReadableStreamLike.ts", "node_modules/rxjs/src/internal/observable/innerFrom.ts", "node_modules/rxjs/src/internal/util/executeSchedule.ts", "node_modules/rxjs/src/internal/operators/observeOn.ts", "node_modules/rxjs/src/internal/operators/subscribeOn.ts", "node_modules/rxjs/src/internal/scheduled/scheduleObservable.ts", "node_modules/rxjs/src/internal/scheduled/schedulePromise.ts", "node_modules/rxjs/src/internal/scheduled/scheduleArray.ts", "node_modules/rxjs/src/internal/scheduled/scheduleIterable.ts", "node_modules/rxjs/src/internal/scheduled/scheduleAsyncIterable.ts", "node_modules/rxjs/src/internal/scheduled/scheduleReadableStreamLike.ts", "node_modules/rxjs/src/internal/scheduled/scheduled.ts", "node_modules/rxjs/src/internal/observable/from.ts", "node_modules/rxjs/src/internal/observable/of.ts", "node_modules/rxjs/src/internal/observable/throwError.ts", "node_modules/rxjs/src/internal/util/EmptyError.ts", "node_modules/rxjs/src/internal/util/isDate.ts", "node_modules/rxjs/src/internal/operators/map.ts", "node_modules/rxjs/src/internal/util/mapOneOrManyArgs.ts", "node_modules/rxjs/src/internal/util/argsArgArrayOrObject.ts", "node_modules/rxjs/src/internal/util/createObject.ts", "node_modules/rxjs/src/internal/observable/combineLatest.ts", "node_modules/rxjs/src/internal/operators/mergeInternals.ts", "node_modules/rxjs/src/internal/operators/mergeMap.ts", "node_modules/rxjs/src/internal/operators/mergeAll.ts", "node_modules/rxjs/src/internal/operators/concatAll.ts", "node_modules/rxjs/src/internal/observable/concat.ts", "node_modules/rxjs/src/internal/observable/defer.ts", "node_modules/rxjs/src/internal/observable/fromEvent.ts", "node_modules/rxjs/src/internal/observable/fromEventPattern.ts", "node_modules/rxjs/src/internal/observable/timer.ts", "node_modules/rxjs/src/internal/observable/merge.ts", "node_modules/rxjs/src/internal/observable/never.ts", "node_modules/rxjs/src/internal/util/argsOrArgArray.ts", "node_modules/rxjs/src/internal/operators/filter.ts", "node_modules/rxjs/src/internal/observable/zip.ts", "node_modules/rxjs/src/internal/operators/audit.ts", "node_modules/rxjs/src/internal/operators/auditTime.ts", "node_modules/rxjs/src/internal/operators/bufferCount.ts", "node_modules/rxjs/src/internal/operators/catchError.ts", "node_modules/rxjs/src/internal/operators/scanInternals.ts", "node_modules/rxjs/src/internal/operators/combineLatest.ts", "node_modules/rxjs/src/internal/operators/combineLatestWith.ts", "node_modules/rxjs/src/internal/operators/debounce.ts", "node_modules/rxjs/src/internal/operators/debounceTime.ts", "node_modules/rxjs/src/internal/operators/defaultIfEmpty.ts", "node_modules/rxjs/src/internal/operators/take.ts", "node_modules/rxjs/src/internal/operators/ignoreElements.ts", "node_modules/rxjs/src/internal/operators/mapTo.ts", "node_modules/rxjs/src/internal/operators/delayWhen.ts", "node_modules/rxjs/src/internal/operators/delay.ts", "node_modules/rxjs/src/internal/operators/distinctUntilChanged.ts", "node_modules/rxjs/src/internal/operators/distinctUntilKeyChanged.ts", "node_modules/rxjs/src/internal/operators/throwIfEmpty.ts", "node_modules/rxjs/src/internal/operators/endWith.ts", "node_modules/rxjs/src/internal/operators/finalize.ts", "node_modules/rxjs/src/internal/operators/first.ts", "node_modules/rxjs/src/internal/operators/takeLast.ts", "node_modules/rxjs/src/internal/operators/merge.ts", "node_modules/rxjs/src/internal/operators/mergeWith.ts", "node_modules/rxjs/src/internal/operators/repeat.ts", "node_modules/rxjs/src/internal/operators/scan.ts", "node_modules/rxjs/src/internal/operators/share.ts", "node_modules/rxjs/src/internal/operators/shareReplay.ts", "node_modules/rxjs/src/internal/operators/skip.ts", "node_modules/rxjs/src/internal/operators/skipUntil.ts", "node_modules/rxjs/src/internal/operators/startWith.ts", "node_modules/rxjs/src/internal/operators/switchMap.ts", "node_modules/rxjs/src/internal/operators/takeUntil.ts", "node_modules/rxjs/src/internal/operators/takeWhile.ts", "node_modules/rxjs/src/internal/operators/tap.ts", "node_modules/rxjs/src/internal/operators/throttle.ts", "node_modules/rxjs/src/internal/operators/throttleTime.ts", "node_modules/rxjs/src/internal/operators/withLatestFrom.ts", "node_modules/rxjs/src/internal/operators/zip.ts", "node_modules/rxjs/src/internal/operators/zipWith.ts", "src/templates/assets/javascripts/browser/document/index.ts", "src/templates/assets/javascripts/browser/element/_/index.ts", "src/templates/assets/javascripts/browser/element/focus/index.ts", "src/templates/assets/javascripts/browser/element/hover/index.ts", "src/templates/assets/javascripts/utilities/h/index.ts", "src/templates/assets/javascripts/utilities/round/index.ts", "src/templates/assets/javascripts/browser/script/index.ts", "src/templates/assets/javascripts/browser/element/size/_/index.ts", "src/templates/assets/javascripts/browser/element/size/content/index.ts", "src/templates/assets/javascripts/browser/element/offset/_/index.ts", "src/templates/assets/javascripts/browser/element/offset/content/index.ts", "src/templates/assets/javascripts/browser/element/visibility/index.ts", "src/templates/assets/javascripts/browser/toggle/index.ts", "src/templates/assets/javascripts/browser/keyboard/index.ts", "src/templates/assets/javascripts/browser/location/_/index.ts", "src/templates/assets/javascripts/browser/location/hash/index.ts", "src/templates/assets/javascripts/browser/media/index.ts", "src/templates/assets/javascripts/browser/request/index.ts", "src/templates/assets/javascripts/browser/viewport/offset/index.ts", "src/templates/assets/javascripts/browser/viewport/size/index.ts", "src/templates/assets/javascripts/browser/viewport/_/index.ts", "src/templates/assets/javascripts/browser/viewport/at/index.ts", "src/templates/assets/javascripts/browser/worker/index.ts", "src/templates/assets/javascripts/_/index.ts", "src/templates/assets/javascripts/components/_/index.ts", "src/templates/assets/javascripts/components/announce/index.ts", "src/templates/assets/javascripts/components/consent/index.ts", "src/templates/assets/javascripts/templates/tooltip/index.tsx", "src/templates/assets/javascripts/templates/annotation/index.tsx", "src/templates/assets/javascripts/templates/clipboard/index.tsx", "src/templates/assets/javascripts/templates/search/index.tsx", "src/templates/assets/javascripts/templates/source/index.tsx", "src/templates/assets/javascripts/templates/tabbed/index.tsx", "src/templates/assets/javascripts/templates/table/index.tsx", "src/templates/assets/javascripts/templates/version/index.tsx", "src/templates/assets/javascripts/components/tooltip2/index.ts", "src/templates/assets/javascripts/components/content/annotation/_/index.ts", "src/templates/assets/javascripts/components/content/annotation/list/index.ts", "src/templates/assets/javascripts/components/content/annotation/block/index.ts", "src/templates/assets/javascripts/components/content/code/_/index.ts", "src/templates/assets/javascripts/components/content/details/index.ts", "src/templates/assets/javascripts/components/content/mermaid/index.css", "src/templates/assets/javascripts/components/content/mermaid/index.ts", "src/templates/assets/javascripts/components/content/table/index.ts", "src/templates/assets/javascripts/components/content/tabs/index.ts", "src/templates/assets/javascripts/components/content/_/index.ts", "src/templates/assets/javascripts/components/dialog/index.ts", "src/templates/assets/javascripts/components/tooltip/index.ts", "src/templates/assets/javascripts/components/header/_/index.ts", "src/templates/assets/javascripts/components/header/title/index.ts", "src/templates/assets/javascripts/components/main/index.ts", "src/templates/assets/javascripts/components/palette/index.ts", "src/templates/assets/javascripts/components/progress/index.ts", "src/templates/assets/javascripts/integrations/clipboard/index.ts", "src/templates/assets/javascripts/integrations/sitemap/index.ts", "src/templates/assets/javascripts/integrations/instant/index.ts", "src/templates/assets/javascripts/integrations/search/highlighter/index.ts", "src/templates/assets/javascripts/integrations/search/worker/message/index.ts", "src/templates/assets/javascripts/integrations/search/worker/_/index.ts", "src/templates/assets/javascripts/integrations/version/index.ts", "src/templates/assets/javascripts/components/search/query/index.ts", "src/templates/assets/javascripts/components/search/result/index.ts", "src/templates/assets/javascripts/components/search/share/index.ts", "src/templates/assets/javascripts/components/search/suggest/index.ts", "src/templates/assets/javascripts/components/search/_/index.ts", "src/templates/assets/javascripts/components/search/highlight/index.ts", "src/templates/assets/javascripts/components/sidebar/index.ts", "src/templates/assets/javascripts/components/source/facts/github/index.ts", "src/templates/assets/javascripts/components/source/facts/gitlab/index.ts", "src/templates/assets/javascripts/components/source/facts/_/index.ts", "src/templates/assets/javascripts/components/source/_/index.ts", "src/templates/assets/javascripts/components/tabs/index.ts", "src/templates/assets/javascripts/components/toc/index.ts", "src/templates/assets/javascripts/components/top/index.ts", "src/templates/assets/javascripts/patches/ellipsis/index.ts", "src/templates/assets/javascripts/patches/indeterminate/index.ts", "src/templates/assets/javascripts/patches/scrollfix/index.ts", "src/templates/assets/javascripts/patches/scrolllock/index.ts", "src/templates/assets/javascripts/polyfills/index.ts"], + "sourcesContent": ["(function (global, factory) {\n typeof exports === 'object' && typeof module !== 'undefined' ? factory() :\n typeof define === 'function' && define.amd ? define(factory) :\n (factory());\n}(this, (function () { 'use strict';\n\n /**\n * Applies the :focus-visible polyfill at the given scope.\n * A scope in this case is either the top-level Document or a Shadow Root.\n *\n * @param {(Document|ShadowRoot)} scope\n * @see https://github.com/WICG/focus-visible\n */\n function applyFocusVisiblePolyfill(scope) {\n var hadKeyboardEvent = true;\n var hadFocusVisibleRecently = false;\n var hadFocusVisibleRecentlyTimeout = null;\n\n var inputTypesAllowlist = {\n text: true,\n search: true,\n url: true,\n tel: true,\n email: true,\n password: true,\n number: true,\n date: true,\n month: true,\n week: true,\n time: true,\n datetime: true,\n 'datetime-local': true\n };\n\n /**\n * Helper function for legacy browsers and iframes which sometimes focus\n * elements like document, body, and non-interactive SVG.\n * @param {Element} el\n */\n function isValidFocusTarget(el) {\n if (\n el &&\n el !== document &&\n el.nodeName !== 'HTML' &&\n el.nodeName !== 'BODY' &&\n 'classList' in el &&\n 'contains' in el.classList\n ) {\n return true;\n }\n return false;\n }\n\n /**\n * Computes whether the given element should automatically trigger the\n * `focus-visible` class being added, i.e. whether it should always match\n * `:focus-visible` when focused.\n * @param {Element} el\n * @return {boolean}\n */\n function focusTriggersKeyboardModality(el) {\n var type = el.type;\n var tagName = el.tagName;\n\n if (tagName === 'INPUT' && inputTypesAllowlist[type] && !el.readOnly) {\n return true;\n }\n\n if (tagName === 'TEXTAREA' && !el.readOnly) {\n return true;\n }\n\n if (el.isContentEditable) {\n return true;\n }\n\n return false;\n }\n\n /**\n * Add the `focus-visible` class to the given element if it was not added by\n * the author.\n * @param {Element} el\n */\n function addFocusVisibleClass(el) {\n if (el.classList.contains('focus-visible')) {\n return;\n }\n el.classList.add('focus-visible');\n el.setAttribute('data-focus-visible-added', '');\n }\n\n /**\n * Remove the `focus-visible` class from the given element if it was not\n * originally added by the author.\n * @param {Element} el\n */\n function removeFocusVisibleClass(el) {\n if (!el.hasAttribute('data-focus-visible-added')) {\n return;\n }\n el.classList.remove('focus-visible');\n el.removeAttribute('data-focus-visible-added');\n }\n\n /**\n * If the most recent user interaction was via the keyboard;\n * and the key press did not include a meta, alt/option, or control key;\n * then the modality is keyboard. Otherwise, the modality is not keyboard.\n * Apply `focus-visible` to any current active element and keep track\n * of our keyboard modality state with `hadKeyboardEvent`.\n * @param {KeyboardEvent} e\n */\n function onKeyDown(e) {\n if (e.metaKey || e.altKey || e.ctrlKey) {\n return;\n }\n\n if (isValidFocusTarget(scope.activeElement)) {\n addFocusVisibleClass(scope.activeElement);\n }\n\n hadKeyboardEvent = true;\n }\n\n /**\n * If at any point a user clicks with a pointing device, ensure that we change\n * the modality away from keyboard.\n * This avoids the situation where a user presses a key on an already focused\n * element, and then clicks on a different element, focusing it with a\n * pointing device, while we still think we're in keyboard modality.\n * @param {Event} e\n */\n function onPointerDown(e) {\n hadKeyboardEvent = false;\n }\n\n /**\n * On `focus`, add the `focus-visible` class to the target if:\n * - the target received focus as a result of keyboard navigation, or\n * - the event target is an element that will likely require interaction\n * via the keyboard (e.g. a text box)\n * @param {Event} e\n */\n function onFocus(e) {\n // Prevent IE from focusing the document or HTML element.\n if (!isValidFocusTarget(e.target)) {\n return;\n }\n\n if (hadKeyboardEvent || focusTriggersKeyboardModality(e.target)) {\n addFocusVisibleClass(e.target);\n }\n }\n\n /**\n * On `blur`, remove the `focus-visible` class from the target.\n * @param {Event} e\n */\n function onBlur(e) {\n if (!isValidFocusTarget(e.target)) {\n return;\n }\n\n if (\n e.target.classList.contains('focus-visible') ||\n e.target.hasAttribute('data-focus-visible-added')\n ) {\n // To detect a tab/window switch, we look for a blur event followed\n // rapidly by a visibility change.\n // If we don't see a visibility change within 100ms, it's probably a\n // regular focus change.\n hadFocusVisibleRecently = true;\n window.clearTimeout(hadFocusVisibleRecentlyTimeout);\n hadFocusVisibleRecentlyTimeout = window.setTimeout(function() {\n hadFocusVisibleRecently = false;\n }, 100);\n removeFocusVisibleClass(e.target);\n }\n }\n\n /**\n * If the user changes tabs, keep track of whether or not the previously\n * focused element had .focus-visible.\n * @param {Event} e\n */\n function onVisibilityChange(e) {\n if (document.visibilityState === 'hidden') {\n // If the tab becomes active again, the browser will handle calling focus\n // on the element (Safari actually calls it twice).\n // If this tab change caused a blur on an element with focus-visible,\n // re-apply the class when the user switches back to the tab.\n if (hadFocusVisibleRecently) {\n hadKeyboardEvent = true;\n }\n addInitialPointerMoveListeners();\n }\n }\n\n /**\n * Add a group of listeners to detect usage of any pointing devices.\n * These listeners will be added when the polyfill first loads, and anytime\n * the window is blurred, so that they are active when the window regains\n * focus.\n */\n function addInitialPointerMoveListeners() {\n document.addEventListener('mousemove', onInitialPointerMove);\n document.addEventListener('mousedown', onInitialPointerMove);\n document.addEventListener('mouseup', onInitialPointerMove);\n document.addEventListener('pointermove', onInitialPointerMove);\n document.addEventListener('pointerdown', onInitialPointerMove);\n document.addEventListener('pointerup', onInitialPointerMove);\n document.addEventListener('touchmove', onInitialPointerMove);\n document.addEventListener('touchstart', onInitialPointerMove);\n document.addEventListener('touchend', onInitialPointerMove);\n }\n\n function removeInitialPointerMoveListeners() {\n document.removeEventListener('mousemove', onInitialPointerMove);\n document.removeEventListener('mousedown', onInitialPointerMove);\n document.removeEventListener('mouseup', onInitialPointerMove);\n document.removeEventListener('pointermove', onInitialPointerMove);\n document.removeEventListener('pointerdown', onInitialPointerMove);\n document.removeEventListener('pointerup', onInitialPointerMove);\n document.removeEventListener('touchmove', onInitialPointerMove);\n document.removeEventListener('touchstart', onInitialPointerMove);\n document.removeEventListener('touchend', onInitialPointerMove);\n }\n\n /**\n * When the polfyill first loads, assume the user is in keyboard modality.\n * If any event is received from a pointing device (e.g. mouse, pointer,\n * touch), turn off keyboard modality.\n * This accounts for situations where focus enters the page from the URL bar.\n * @param {Event} e\n */\n function onInitialPointerMove(e) {\n // Work around a Safari quirk that fires a mousemove on whenever the\n // window blurs, even if you're tabbing out of the page. \u00AF\\_(\u30C4)_/\u00AF\n if (e.target.nodeName && e.target.nodeName.toLowerCase() === 'html') {\n return;\n }\n\n hadKeyboardEvent = false;\n removeInitialPointerMoveListeners();\n }\n\n // For some kinds of state, we are interested in changes at the global scope\n // only. For example, global pointer input, global key presses and global\n // visibility change should affect the state at every scope:\n document.addEventListener('keydown', onKeyDown, true);\n document.addEventListener('mousedown', onPointerDown, true);\n document.addEventListener('pointerdown', onPointerDown, true);\n document.addEventListener('touchstart', onPointerDown, true);\n document.addEventListener('visibilitychange', onVisibilityChange, true);\n\n addInitialPointerMoveListeners();\n\n // For focus and blur, we specifically care about state changes in the local\n // scope. This is because focus / blur events that originate from within a\n // shadow root are not re-dispatched from the host element if it was already\n // the active element in its own scope:\n scope.addEventListener('focus', onFocus, true);\n scope.addEventListener('blur', onBlur, true);\n\n // We detect that a node is a ShadowRoot by ensuring that it is a\n // DocumentFragment and also has a host property. This check covers native\n // implementation and polyfill implementation transparently. If we only cared\n // about the native implementation, we could just check if the scope was\n // an instance of a ShadowRoot.\n if (scope.nodeType === Node.DOCUMENT_FRAGMENT_NODE && scope.host) {\n // Since a ShadowRoot is a special kind of DocumentFragment, it does not\n // have a root element to add a class to. So, we add this attribute to the\n // host element instead:\n scope.host.setAttribute('data-js-focus-visible', '');\n } else if (scope.nodeType === Node.DOCUMENT_NODE) {\n document.documentElement.classList.add('js-focus-visible');\n document.documentElement.setAttribute('data-js-focus-visible', '');\n }\n }\n\n // It is important to wrap all references to global window and document in\n // these checks to support server-side rendering use cases\n // @see https://github.com/WICG/focus-visible/issues/199\n if (typeof window !== 'undefined' && typeof document !== 'undefined') {\n // Make the polyfill helper globally available. This can be used as a signal\n // to interested libraries that wish to coordinate with the polyfill for e.g.,\n // applying the polyfill to a shadow root:\n window.applyFocusVisiblePolyfill = applyFocusVisiblePolyfill;\n\n // Notify interested libraries of the polyfill's presence, in case the\n // polyfill was loaded lazily:\n var event;\n\n try {\n event = new CustomEvent('focus-visible-polyfill-ready');\n } catch (error) {\n // IE11 does not support using CustomEvent as a constructor directly:\n event = document.createEvent('CustomEvent');\n event.initCustomEvent('focus-visible-polyfill-ready', false, false, {});\n }\n\n window.dispatchEvent(event);\n }\n\n if (typeof document !== 'undefined') {\n // Apply the polyfill to the global document, so that no JavaScript\n // coordination is required to use the polyfill in the top-level document:\n applyFocusVisiblePolyfill(document);\n }\n\n})));\n", "/*!\n * clipboard.js v2.0.11\n * https://clipboardjs.com/\n *\n * Licensed MIT \u00A9 Zeno Rocha\n */\n(function webpackUniversalModuleDefinition(root, factory) {\n\tif(typeof exports === 'object' && typeof module === 'object')\n\t\tmodule.exports = factory();\n\telse if(typeof define === 'function' && define.amd)\n\t\tdefine([], factory);\n\telse if(typeof exports === 'object')\n\t\texports[\"ClipboardJS\"] = factory();\n\telse\n\t\troot[\"ClipboardJS\"] = factory();\n})(this, function() {\nreturn /******/ (function() { // webpackBootstrap\n/******/ \tvar __webpack_modules__ = ({\n\n/***/ 686:\n/***/ (function(__unused_webpack_module, __webpack_exports__, __webpack_require__) {\n\n\"use strict\";\n\n// EXPORTS\n__webpack_require__.d(__webpack_exports__, {\n \"default\": function() { return /* binding */ clipboard; }\n});\n\n// EXTERNAL MODULE: ./node_modules/tiny-emitter/index.js\nvar tiny_emitter = __webpack_require__(279);\nvar tiny_emitter_default = /*#__PURE__*/__webpack_require__.n(tiny_emitter);\n// EXTERNAL MODULE: ./node_modules/good-listener/src/listen.js\nvar listen = __webpack_require__(370);\nvar listen_default = /*#__PURE__*/__webpack_require__.n(listen);\n// EXTERNAL MODULE: ./node_modules/select/src/select.js\nvar src_select = __webpack_require__(817);\nvar select_default = /*#__PURE__*/__webpack_require__.n(src_select);\n;// CONCATENATED MODULE: ./src/common/command.js\n/**\n * Executes a given operation type.\n * @param {String} type\n * @return {Boolean}\n */\nfunction command(type) {\n try {\n return document.execCommand(type);\n } catch (err) {\n return false;\n }\n}\n;// CONCATENATED MODULE: ./src/actions/cut.js\n\n\n/**\n * Cut action wrapper.\n * @param {String|HTMLElement} target\n * @return {String}\n */\n\nvar ClipboardActionCut = function ClipboardActionCut(target) {\n var selectedText = select_default()(target);\n command('cut');\n return selectedText;\n};\n\n/* harmony default export */ var actions_cut = (ClipboardActionCut);\n;// CONCATENATED MODULE: ./src/common/create-fake-element.js\n/**\n * Creates a fake textarea element with a value.\n * @param {String} value\n * @return {HTMLElement}\n */\nfunction createFakeElement(value) {\n var isRTL = document.documentElement.getAttribute('dir') === 'rtl';\n var fakeElement = document.createElement('textarea'); // Prevent zooming on iOS\n\n fakeElement.style.fontSize = '12pt'; // Reset box model\n\n fakeElement.style.border = '0';\n fakeElement.style.padding = '0';\n fakeElement.style.margin = '0'; // Move element out of screen horizontally\n\n fakeElement.style.position = 'absolute';\n fakeElement.style[isRTL ? 'right' : 'left'] = '-9999px'; // Move element to the same position vertically\n\n var yPosition = window.pageYOffset || document.documentElement.scrollTop;\n fakeElement.style.top = \"\".concat(yPosition, \"px\");\n fakeElement.setAttribute('readonly', '');\n fakeElement.value = value;\n return fakeElement;\n}\n;// CONCATENATED MODULE: ./src/actions/copy.js\n\n\n\n/**\n * Create fake copy action wrapper using a fake element.\n * @param {String} target\n * @param {Object} options\n * @return {String}\n */\n\nvar fakeCopyAction = function fakeCopyAction(value, options) {\n var fakeElement = createFakeElement(value);\n options.container.appendChild(fakeElement);\n var selectedText = select_default()(fakeElement);\n command('copy');\n fakeElement.remove();\n return selectedText;\n};\n/**\n * Copy action wrapper.\n * @param {String|HTMLElement} target\n * @param {Object} options\n * @return {String}\n */\n\n\nvar ClipboardActionCopy = function ClipboardActionCopy(target) {\n var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {\n container: document.body\n };\n var selectedText = '';\n\n if (typeof target === 'string') {\n selectedText = fakeCopyAction(target, options);\n } else if (target instanceof HTMLInputElement && !['text', 'search', 'url', 'tel', 'password'].includes(target === null || target === void 0 ? void 0 : target.type)) {\n // If input type doesn't support `setSelectionRange`. Simulate it. https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/setSelectionRange\n selectedText = fakeCopyAction(target.value, options);\n } else {\n selectedText = select_default()(target);\n command('copy');\n }\n\n return selectedText;\n};\n\n/* harmony default export */ var actions_copy = (ClipboardActionCopy);\n;// CONCATENATED MODULE: ./src/actions/default.js\nfunction _typeof(obj) { \"@babel/helpers - typeof\"; if (typeof Symbol === \"function\" && typeof Symbol.iterator === \"symbol\") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === \"function\" && obj.constructor === Symbol && obj !== Symbol.prototype ? \"symbol\" : typeof obj; }; } return _typeof(obj); }\n\n\n\n/**\n * Inner function which performs selection from either `text` or `target`\n * properties and then executes copy or cut operations.\n * @param {Object} options\n */\n\nvar ClipboardActionDefault = function ClipboardActionDefault() {\n var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};\n // Defines base properties passed from constructor.\n var _options$action = options.action,\n action = _options$action === void 0 ? 'copy' : _options$action,\n container = options.container,\n target = options.target,\n text = options.text; // Sets the `action` to be performed which can be either 'copy' or 'cut'.\n\n if (action !== 'copy' && action !== 'cut') {\n throw new Error('Invalid \"action\" value, use either \"copy\" or \"cut\"');\n } // Sets the `target` property using an element that will be have its content copied.\n\n\n if (target !== undefined) {\n if (target && _typeof(target) === 'object' && target.nodeType === 1) {\n if (action === 'copy' && target.hasAttribute('disabled')) {\n throw new Error('Invalid \"target\" attribute. Please use \"readonly\" instead of \"disabled\" attribute');\n }\n\n if (action === 'cut' && (target.hasAttribute('readonly') || target.hasAttribute('disabled'))) {\n throw new Error('Invalid \"target\" attribute. You can\\'t cut text from elements with \"readonly\" or \"disabled\" attributes');\n }\n } else {\n throw new Error('Invalid \"target\" value, use a valid Element');\n }\n } // Define selection strategy based on `text` property.\n\n\n if (text) {\n return actions_copy(text, {\n container: container\n });\n } // Defines which selection strategy based on `target` property.\n\n\n if (target) {\n return action === 'cut' ? actions_cut(target) : actions_copy(target, {\n container: container\n });\n }\n};\n\n/* harmony default export */ var actions_default = (ClipboardActionDefault);\n;// CONCATENATED MODULE: ./src/clipboard.js\nfunction clipboard_typeof(obj) { \"@babel/helpers - typeof\"; if (typeof Symbol === \"function\" && typeof Symbol.iterator === \"symbol\") { clipboard_typeof = function _typeof(obj) { return typeof obj; }; } else { clipboard_typeof = function _typeof(obj) { return obj && typeof Symbol === \"function\" && obj.constructor === Symbol && obj !== Symbol.prototype ? \"symbol\" : typeof obj; }; } return clipboard_typeof(obj); }\n\nfunction _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError(\"Cannot call a class as a function\"); } }\n\nfunction _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if (\"value\" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }\n\nfunction _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }\n\nfunction _inherits(subClass, superClass) { if (typeof superClass !== \"function\" && superClass !== null) { throw new TypeError(\"Super expression must either be null or a function\"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); if (superClass) _setPrototypeOf(subClass, superClass); }\n\nfunction _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf || function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }\n\nfunction _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }\n\nfunction _possibleConstructorReturn(self, call) { if (call && (clipboard_typeof(call) === \"object\" || typeof call === \"function\")) { return call; } return _assertThisInitialized(self); }\n\nfunction _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError(\"this hasn't been initialised - super() hasn't been called\"); } return self; }\n\nfunction _isNativeReflectConstruct() { if (typeof Reflect === \"undefined\" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === \"function\") return true; try { Date.prototype.toString.call(Reflect.construct(Date, [], function () {})); return true; } catch (e) { return false; } }\n\nfunction _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }\n\n\n\n\n\n\n/**\n * Helper function to retrieve attribute value.\n * @param {String} suffix\n * @param {Element} element\n */\n\nfunction getAttributeValue(suffix, element) {\n var attribute = \"data-clipboard-\".concat(suffix);\n\n if (!element.hasAttribute(attribute)) {\n return;\n }\n\n return element.getAttribute(attribute);\n}\n/**\n * Base class which takes one or more elements, adds event listeners to them,\n * and instantiates a new `ClipboardAction` on each click.\n */\n\n\nvar Clipboard = /*#__PURE__*/function (_Emitter) {\n _inherits(Clipboard, _Emitter);\n\n var _super = _createSuper(Clipboard);\n\n /**\n * @param {String|HTMLElement|HTMLCollection|NodeList} trigger\n * @param {Object} options\n */\n function Clipboard(trigger, options) {\n var _this;\n\n _classCallCheck(this, Clipboard);\n\n _this = _super.call(this);\n\n _this.resolveOptions(options);\n\n _this.listenClick(trigger);\n\n return _this;\n }\n /**\n * Defines if attributes would be resolved using internal setter functions\n * or custom functions that were passed in the constructor.\n * @param {Object} options\n */\n\n\n _createClass(Clipboard, [{\n key: \"resolveOptions\",\n value: function resolveOptions() {\n var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};\n this.action = typeof options.action === 'function' ? options.action : this.defaultAction;\n this.target = typeof options.target === 'function' ? options.target : this.defaultTarget;\n this.text = typeof options.text === 'function' ? options.text : this.defaultText;\n this.container = clipboard_typeof(options.container) === 'object' ? options.container : document.body;\n }\n /**\n * Adds a click event listener to the passed trigger.\n * @param {String|HTMLElement|HTMLCollection|NodeList} trigger\n */\n\n }, {\n key: \"listenClick\",\n value: function listenClick(trigger) {\n var _this2 = this;\n\n this.listener = listen_default()(trigger, 'click', function (e) {\n return _this2.onClick(e);\n });\n }\n /**\n * Defines a new `ClipboardAction` on each click event.\n * @param {Event} e\n */\n\n }, {\n key: \"onClick\",\n value: function onClick(e) {\n var trigger = e.delegateTarget || e.currentTarget;\n var action = this.action(trigger) || 'copy';\n var text = actions_default({\n action: action,\n container: this.container,\n target: this.target(trigger),\n text: this.text(trigger)\n }); // Fires an event based on the copy operation result.\n\n this.emit(text ? 'success' : 'error', {\n action: action,\n text: text,\n trigger: trigger,\n clearSelection: function clearSelection() {\n if (trigger) {\n trigger.focus();\n }\n\n window.getSelection().removeAllRanges();\n }\n });\n }\n /**\n * Default `action` lookup function.\n * @param {Element} trigger\n */\n\n }, {\n key: \"defaultAction\",\n value: function defaultAction(trigger) {\n return getAttributeValue('action', trigger);\n }\n /**\n * Default `target` lookup function.\n * @param {Element} trigger\n */\n\n }, {\n key: \"defaultTarget\",\n value: function defaultTarget(trigger) {\n var selector = getAttributeValue('target', trigger);\n\n if (selector) {\n return document.querySelector(selector);\n }\n }\n /**\n * Allow fire programmatically a copy action\n * @param {String|HTMLElement} target\n * @param {Object} options\n * @returns Text copied.\n */\n\n }, {\n key: \"defaultText\",\n\n /**\n * Default `text` lookup function.\n * @param {Element} trigger\n */\n value: function defaultText(trigger) {\n return getAttributeValue('text', trigger);\n }\n /**\n * Destroy lifecycle.\n */\n\n }, {\n key: \"destroy\",\n value: function destroy() {\n this.listener.destroy();\n }\n }], [{\n key: \"copy\",\n value: function copy(target) {\n var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {\n container: document.body\n };\n return actions_copy(target, options);\n }\n /**\n * Allow fire programmatically a cut action\n * @param {String|HTMLElement} target\n * @returns Text cutted.\n */\n\n }, {\n key: \"cut\",\n value: function cut(target) {\n return actions_cut(target);\n }\n /**\n * Returns the support of the given action, or all actions if no action is\n * given.\n * @param {String} [action]\n */\n\n }, {\n key: \"isSupported\",\n value: function isSupported() {\n var action = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : ['copy', 'cut'];\n var actions = typeof action === 'string' ? [action] : action;\n var support = !!document.queryCommandSupported;\n actions.forEach(function (action) {\n support = support && !!document.queryCommandSupported(action);\n });\n return support;\n }\n }]);\n\n return Clipboard;\n}((tiny_emitter_default()));\n\n/* harmony default export */ var clipboard = (Clipboard);\n\n/***/ }),\n\n/***/ 828:\n/***/ (function(module) {\n\nvar DOCUMENT_NODE_TYPE = 9;\n\n/**\n * A polyfill for Element.matches()\n */\nif (typeof Element !== 'undefined' && !Element.prototype.matches) {\n var proto = Element.prototype;\n\n proto.matches = proto.matchesSelector ||\n proto.mozMatchesSelector ||\n proto.msMatchesSelector ||\n proto.oMatchesSelector ||\n proto.webkitMatchesSelector;\n}\n\n/**\n * Finds the closest parent that matches a selector.\n *\n * @param {Element} element\n * @param {String} selector\n * @return {Function}\n */\nfunction closest (element, selector) {\n while (element && element.nodeType !== DOCUMENT_NODE_TYPE) {\n if (typeof element.matches === 'function' &&\n element.matches(selector)) {\n return element;\n }\n element = element.parentNode;\n }\n}\n\nmodule.exports = closest;\n\n\n/***/ }),\n\n/***/ 438:\n/***/ (function(module, __unused_webpack_exports, __webpack_require__) {\n\nvar closest = __webpack_require__(828);\n\n/**\n * Delegates event to a selector.\n *\n * @param {Element} element\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @param {Boolean} useCapture\n * @return {Object}\n */\nfunction _delegate(element, selector, type, callback, useCapture) {\n var listenerFn = listener.apply(this, arguments);\n\n element.addEventListener(type, listenerFn, useCapture);\n\n return {\n destroy: function() {\n element.removeEventListener(type, listenerFn, useCapture);\n }\n }\n}\n\n/**\n * Delegates event to a selector.\n *\n * @param {Element|String|Array} [elements]\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @param {Boolean} useCapture\n * @return {Object}\n */\nfunction delegate(elements, selector, type, callback, useCapture) {\n // Handle the regular Element usage\n if (typeof elements.addEventListener === 'function') {\n return _delegate.apply(null, arguments);\n }\n\n // Handle Element-less usage, it defaults to global delegation\n if (typeof type === 'function') {\n // Use `document` as the first parameter, then apply arguments\n // This is a short way to .unshift `arguments` without running into deoptimizations\n return _delegate.bind(null, document).apply(null, arguments);\n }\n\n // Handle Selector-based usage\n if (typeof elements === 'string') {\n elements = document.querySelectorAll(elements);\n }\n\n // Handle Array-like based usage\n return Array.prototype.map.call(elements, function (element) {\n return _delegate(element, selector, type, callback, useCapture);\n });\n}\n\n/**\n * Finds closest match and invokes callback.\n *\n * @param {Element} element\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @return {Function}\n */\nfunction listener(element, selector, type, callback) {\n return function(e) {\n e.delegateTarget = closest(e.target, selector);\n\n if (e.delegateTarget) {\n callback.call(element, e);\n }\n }\n}\n\nmodule.exports = delegate;\n\n\n/***/ }),\n\n/***/ 879:\n/***/ (function(__unused_webpack_module, exports) {\n\n/**\n * Check if argument is a HTML element.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.node = function(value) {\n return value !== undefined\n && value instanceof HTMLElement\n && value.nodeType === 1;\n};\n\n/**\n * Check if argument is a list of HTML elements.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.nodeList = function(value) {\n var type = Object.prototype.toString.call(value);\n\n return value !== undefined\n && (type === '[object NodeList]' || type === '[object HTMLCollection]')\n && ('length' in value)\n && (value.length === 0 || exports.node(value[0]));\n};\n\n/**\n * Check if argument is a string.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.string = function(value) {\n return typeof value === 'string'\n || value instanceof String;\n};\n\n/**\n * Check if argument is a function.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.fn = function(value) {\n var type = Object.prototype.toString.call(value);\n\n return type === '[object Function]';\n};\n\n\n/***/ }),\n\n/***/ 370:\n/***/ (function(module, __unused_webpack_exports, __webpack_require__) {\n\nvar is = __webpack_require__(879);\nvar delegate = __webpack_require__(438);\n\n/**\n * Validates all params and calls the right\n * listener function based on its target type.\n *\n * @param {String|HTMLElement|HTMLCollection|NodeList} target\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listen(target, type, callback) {\n if (!target && !type && !callback) {\n throw new Error('Missing required arguments');\n }\n\n if (!is.string(type)) {\n throw new TypeError('Second argument must be a String');\n }\n\n if (!is.fn(callback)) {\n throw new TypeError('Third argument must be a Function');\n }\n\n if (is.node(target)) {\n return listenNode(target, type, callback);\n }\n else if (is.nodeList(target)) {\n return listenNodeList(target, type, callback);\n }\n else if (is.string(target)) {\n return listenSelector(target, type, callback);\n }\n else {\n throw new TypeError('First argument must be a String, HTMLElement, HTMLCollection, or NodeList');\n }\n}\n\n/**\n * Adds an event listener to a HTML element\n * and returns a remove listener function.\n *\n * @param {HTMLElement} node\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listenNode(node, type, callback) {\n node.addEventListener(type, callback);\n\n return {\n destroy: function() {\n node.removeEventListener(type, callback);\n }\n }\n}\n\n/**\n * Add an event listener to a list of HTML elements\n * and returns a remove listener function.\n *\n * @param {NodeList|HTMLCollection} nodeList\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listenNodeList(nodeList, type, callback) {\n Array.prototype.forEach.call(nodeList, function(node) {\n node.addEventListener(type, callback);\n });\n\n return {\n destroy: function() {\n Array.prototype.forEach.call(nodeList, function(node) {\n node.removeEventListener(type, callback);\n });\n }\n }\n}\n\n/**\n * Add an event listener to a selector\n * and returns a remove listener function.\n *\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listenSelector(selector, type, callback) {\n return delegate(document.body, selector, type, callback);\n}\n\nmodule.exports = listen;\n\n\n/***/ }),\n\n/***/ 817:\n/***/ (function(module) {\n\nfunction select(element) {\n var selectedText;\n\n if (element.nodeName === 'SELECT') {\n element.focus();\n\n selectedText = element.value;\n }\n else if (element.nodeName === 'INPUT' || element.nodeName === 'TEXTAREA') {\n var isReadOnly = element.hasAttribute('readonly');\n\n if (!isReadOnly) {\n element.setAttribute('readonly', '');\n }\n\n element.select();\n element.setSelectionRange(0, element.value.length);\n\n if (!isReadOnly) {\n element.removeAttribute('readonly');\n }\n\n selectedText = element.value;\n }\n else {\n if (element.hasAttribute('contenteditable')) {\n element.focus();\n }\n\n var selection = window.getSelection();\n var range = document.createRange();\n\n range.selectNodeContents(element);\n selection.removeAllRanges();\n selection.addRange(range);\n\n selectedText = selection.toString();\n }\n\n return selectedText;\n}\n\nmodule.exports = select;\n\n\n/***/ }),\n\n/***/ 279:\n/***/ (function(module) {\n\nfunction E () {\n // Keep this empty so it's easier to inherit from\n // (via https://github.com/lipsmack from https://github.com/scottcorgan/tiny-emitter/issues/3)\n}\n\nE.prototype = {\n on: function (name, callback, ctx) {\n var e = this.e || (this.e = {});\n\n (e[name] || (e[name] = [])).push({\n fn: callback,\n ctx: ctx\n });\n\n return this;\n },\n\n once: function (name, callback, ctx) {\n var self = this;\n function listener () {\n self.off(name, listener);\n callback.apply(ctx, arguments);\n };\n\n listener._ = callback\n return this.on(name, listener, ctx);\n },\n\n emit: function (name) {\n var data = [].slice.call(arguments, 1);\n var evtArr = ((this.e || (this.e = {}))[name] || []).slice();\n var i = 0;\n var len = evtArr.length;\n\n for (i; i < len; i++) {\n evtArr[i].fn.apply(evtArr[i].ctx, data);\n }\n\n return this;\n },\n\n off: function (name, callback) {\n var e = this.e || (this.e = {});\n var evts = e[name];\n var liveEvents = [];\n\n if (evts && callback) {\n for (var i = 0, len = evts.length; i < len; i++) {\n if (evts[i].fn !== callback && evts[i].fn._ !== callback)\n liveEvents.push(evts[i]);\n }\n }\n\n // Remove event from queue to prevent memory leak\n // Suggested by https://github.com/lazd\n // Ref: https://github.com/scottcorgan/tiny-emitter/commit/c6ebfaa9bc973b33d110a84a307742b7cf94c953#commitcomment-5024910\n\n (liveEvents.length)\n ? e[name] = liveEvents\n : delete e[name];\n\n return this;\n }\n};\n\nmodule.exports = E;\nmodule.exports.TinyEmitter = E;\n\n\n/***/ })\n\n/******/ \t});\n/************************************************************************/\n/******/ \t// The module cache\n/******/ \tvar __webpack_module_cache__ = {};\n/******/ \t\n/******/ \t// The require function\n/******/ \tfunction __webpack_require__(moduleId) {\n/******/ \t\t// Check if module is in cache\n/******/ \t\tif(__webpack_module_cache__[moduleId]) {\n/******/ \t\t\treturn __webpack_module_cache__[moduleId].exports;\n/******/ \t\t}\n/******/ \t\t// Create a new module (and put it into the cache)\n/******/ \t\tvar module = __webpack_module_cache__[moduleId] = {\n/******/ \t\t\t// no module.id needed\n/******/ \t\t\t// no module.loaded needed\n/******/ \t\t\texports: {}\n/******/ \t\t};\n/******/ \t\n/******/ \t\t// Execute the module function\n/******/ \t\t__webpack_modules__[moduleId](module, module.exports, __webpack_require__);\n/******/ \t\n/******/ \t\t// Return the exports of the module\n/******/ \t\treturn module.exports;\n/******/ \t}\n/******/ \t\n/************************************************************************/\n/******/ \t/* webpack/runtime/compat get default export */\n/******/ \t!function() {\n/******/ \t\t// getDefaultExport function for compatibility with non-harmony modules\n/******/ \t\t__webpack_require__.n = function(module) {\n/******/ \t\t\tvar getter = module && module.__esModule ?\n/******/ \t\t\t\tfunction() { return module['default']; } :\n/******/ \t\t\t\tfunction() { return module; };\n/******/ \t\t\t__webpack_require__.d(getter, { a: getter });\n/******/ \t\t\treturn getter;\n/******/ \t\t};\n/******/ \t}();\n/******/ \t\n/******/ \t/* webpack/runtime/define property getters */\n/******/ \t!function() {\n/******/ \t\t// define getter functions for harmony exports\n/******/ \t\t__webpack_require__.d = function(exports, definition) {\n/******/ \t\t\tfor(var key in definition) {\n/******/ \t\t\t\tif(__webpack_require__.o(definition, key) && !__webpack_require__.o(exports, key)) {\n/******/ \t\t\t\t\tObject.defineProperty(exports, key, { enumerable: true, get: definition[key] });\n/******/ \t\t\t\t}\n/******/ \t\t\t}\n/******/ \t\t};\n/******/ \t}();\n/******/ \t\n/******/ \t/* webpack/runtime/hasOwnProperty shorthand */\n/******/ \t!function() {\n/******/ \t\t__webpack_require__.o = function(obj, prop) { return Object.prototype.hasOwnProperty.call(obj, prop); }\n/******/ \t}();\n/******/ \t\n/************************************************************************/\n/******/ \t// module exports must be returned from runtime so entry inlining is disabled\n/******/ \t// startup\n/******/ \t// Load entry module and return exports\n/******/ \treturn __webpack_require__(686);\n/******/ })()\n.default;\n});", "/*!\n * escape-html\n * Copyright(c) 2012-2013 TJ Holowaychuk\n * Copyright(c) 2015 Andreas Lubbe\n * Copyright(c) 2015 Tiancheng \"Timothy\" Gu\n * MIT Licensed\n */\n\n'use strict';\n\n/**\n * Module variables.\n * @private\n */\n\nvar matchHtmlRegExp = /[\"'&<>]/;\n\n/**\n * Module exports.\n * @public\n */\n\nmodule.exports = escapeHtml;\n\n/**\n * Escape special characters in the given string of html.\n *\n * @param {string} string The string to escape for inserting into HTML\n * @return {string}\n * @public\n */\n\nfunction escapeHtml(string) {\n var str = '' + string;\n var match = matchHtmlRegExp.exec(str);\n\n if (!match) {\n return str;\n }\n\n var escape;\n var html = '';\n var index = 0;\n var lastIndex = 0;\n\n for (index = match.index; index < str.length; index++) {\n switch (str.charCodeAt(index)) {\n case 34: // \"\n escape = '"';\n break;\n case 38: // &\n escape = '&';\n break;\n case 39: // '\n escape = ''';\n break;\n case 60: // <\n escape = '<';\n break;\n case 62: // >\n escape = '>';\n break;\n default:\n continue;\n }\n\n if (lastIndex !== index) {\n html += str.substring(lastIndex, index);\n }\n\n lastIndex = index + 1;\n html += escape;\n }\n\n return lastIndex !== index\n ? html + str.substring(lastIndex, index)\n : html;\n}\n", "/*\n * Copyright (c) 2016-2024 Martin Donath \n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to\n * deal in the Software without restriction, including without limitation the\n * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or\n * sell copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in\n * all copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING\n * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS\n * IN THE SOFTWARE.\n */\n\nimport \"focus-visible\"\n\nimport {\n EMPTY,\n NEVER,\n Observable,\n Subject,\n defer,\n delay,\n filter,\n map,\n merge,\n mergeWith,\n shareReplay,\n switchMap\n} from \"rxjs\"\n\nimport { configuration, feature } from \"./_\"\nimport {\n at,\n getActiveElement,\n getOptionalElement,\n requestJSON,\n setLocation,\n setToggle,\n watchDocument,\n watchKeyboard,\n watchLocation,\n watchLocationTarget,\n watchMedia,\n watchPrint,\n watchScript,\n watchViewport\n} from \"./browser\"\nimport {\n getComponentElement,\n getComponentElements,\n mountAnnounce,\n mountBackToTop,\n mountConsent,\n mountContent,\n mountDialog,\n mountHeader,\n mountHeaderTitle,\n mountPalette,\n mountProgress,\n mountSearch,\n mountSearchHiglight,\n mountSidebar,\n mountSource,\n mountTableOfContents,\n mountTabs,\n watchHeader,\n watchMain\n} from \"./components\"\nimport {\n SearchIndex,\n setupClipboardJS,\n setupInstantNavigation,\n setupVersionSelector\n} from \"./integrations\"\nimport {\n patchEllipsis,\n patchIndeterminate,\n patchScrollfix,\n patchScrolllock\n} from \"./patches\"\nimport \"./polyfills\"\n\n/* ----------------------------------------------------------------------------\n * Functions - @todo refactor\n * ------------------------------------------------------------------------- */\n\n/**\n * Fetch search index\n *\n * @returns Search index observable\n */\nfunction fetchSearchIndex(): Observable {\n if (location.protocol === \"file:\") {\n return watchScript(\n `${new URL(\"search/search_index.js\", config.base)}`\n )\n .pipe(\n // @ts-ignore - @todo fix typings\n map(() => __index),\n shareReplay(1)\n )\n } else {\n return requestJSON(\n new URL(\"search/search_index.json\", config.base)\n )\n }\n}\n\n/* ----------------------------------------------------------------------------\n * Application\n * ------------------------------------------------------------------------- */\n\n/* Yay, JavaScript is available */\ndocument.documentElement.classList.remove(\"no-js\")\ndocument.documentElement.classList.add(\"js\")\n\n/* Set up navigation observables and subjects */\nconst document$ = watchDocument()\nconst location$ = watchLocation()\nconst target$ = watchLocationTarget(location$)\nconst keyboard$ = watchKeyboard()\n\n/* Set up media observables */\nconst viewport$ = watchViewport()\nconst tablet$ = watchMedia(\"(min-width: 960px)\")\nconst screen$ = watchMedia(\"(min-width: 1220px)\")\nconst print$ = watchPrint()\n\n/* Retrieve search index, if search is enabled */\nconst config = configuration()\nconst index$ = document.forms.namedItem(\"search\")\n ? fetchSearchIndex()\n : NEVER\n\n/* Set up Clipboard.js integration */\nconst alert$ = new Subject()\nsetupClipboardJS({ alert$ })\n\n/* Set up progress indicator */\nconst progress$ = new Subject()\n\n/* Set up instant navigation, if enabled */\nif (feature(\"navigation.instant\"))\n setupInstantNavigation({ location$, viewport$, progress$ })\n .subscribe(document$)\n\n/* Set up version selector */\nif (config.version?.provider === \"mike\")\n setupVersionSelector({ document$ })\n\n/* Always close drawer and search on navigation */\nmerge(location$, target$)\n .pipe(\n delay(125)\n )\n .subscribe(() => {\n setToggle(\"drawer\", false)\n setToggle(\"search\", false)\n })\n\n/* Set up global keyboard handlers */\nkeyboard$\n .pipe(\n filter(({ mode }) => mode === \"global\")\n )\n .subscribe(key => {\n switch (key.type) {\n\n /* Go to previous page */\n case \"p\":\n case \",\":\n const prev = getOptionalElement(\"link[rel=prev]\")\n if (typeof prev !== \"undefined\")\n setLocation(prev)\n break\n\n /* Go to next page */\n case \"n\":\n case \".\":\n const next = getOptionalElement(\"link[rel=next]\")\n if (typeof next !== \"undefined\")\n setLocation(next)\n break\n\n /* Expand navigation, see https://bit.ly/3ZjG5io */\n case \"Enter\":\n const active = getActiveElement()\n if (active instanceof HTMLLabelElement)\n active.click()\n }\n })\n\n/* Set up patches */\npatchEllipsis({ viewport$, document$ })\npatchIndeterminate({ document$, tablet$ })\npatchScrollfix({ document$ })\npatchScrolllock({ viewport$, tablet$ })\n\n/* Set up header and main area observable */\nconst header$ = watchHeader(getComponentElement(\"header\"), { viewport$ })\nconst main$ = document$\n .pipe(\n map(() => getComponentElement(\"main\")),\n switchMap(el => watchMain(el, { viewport$, header$ })),\n shareReplay(1)\n )\n\n/* Set up control component observables */\nconst control$ = merge(\n\n /* Consent */\n ...getComponentElements(\"consent\")\n .map(el => mountConsent(el, { target$ })),\n\n /* Dialog */\n ...getComponentElements(\"dialog\")\n .map(el => mountDialog(el, { alert$ })),\n\n /* Header */\n ...getComponentElements(\"header\")\n .map(el => mountHeader(el, { viewport$, header$, main$ })),\n\n /* Color palette */\n ...getComponentElements(\"palette\")\n .map(el => mountPalette(el)),\n\n /* Progress bar */\n ...getComponentElements(\"progress\")\n .map(el => mountProgress(el, { progress$ })),\n\n /* Search */\n ...getComponentElements(\"search\")\n .map(el => mountSearch(el, { index$, keyboard$ })),\n\n /* Repository information */\n ...getComponentElements(\"source\")\n .map(el => mountSource(el))\n)\n\n/* Set up content component observables */\nconst content$ = defer(() => merge(\n\n /* Announcement bar */\n ...getComponentElements(\"announce\")\n .map(el => mountAnnounce(el)),\n\n /* Content */\n ...getComponentElements(\"content\")\n .map(el => mountContent(el, { viewport$, target$, print$ })),\n\n /* Search highlighting */\n ...getComponentElements(\"content\")\n .map(el => feature(\"search.highlight\")\n ? mountSearchHiglight(el, { index$, location$ })\n : EMPTY\n ),\n\n /* Header title */\n ...getComponentElements(\"header-title\")\n .map(el => mountHeaderTitle(el, { viewport$, header$ })),\n\n /* Sidebar */\n ...getComponentElements(\"sidebar\")\n .map(el => el.getAttribute(\"data-md-type\") === \"navigation\"\n ? at(screen$, () => mountSidebar(el, { viewport$, header$, main$ }))\n : at(tablet$, () => mountSidebar(el, { viewport$, header$, main$ }))\n ),\n\n /* Navigation tabs */\n ...getComponentElements(\"tabs\")\n .map(el => mountTabs(el, { viewport$, header$ })),\n\n /* Table of contents */\n ...getComponentElements(\"toc\")\n .map(el => mountTableOfContents(el, {\n viewport$, header$, main$, target$\n })),\n\n /* Back-to-top button */\n ...getComponentElements(\"top\")\n .map(el => mountBackToTop(el, { viewport$, header$, main$, target$ }))\n))\n\n/* Set up component observables */\nconst component$ = document$\n .pipe(\n switchMap(() => content$),\n mergeWith(control$),\n shareReplay(1)\n )\n\n/* Subscribe to all components */\ncomponent$.subscribe()\n\n/* ----------------------------------------------------------------------------\n * Exports\n * ------------------------------------------------------------------------- */\n\nwindow.document$ = document$ /* Document observable */\nwindow.location$ = location$ /* Location subject */\nwindow.target$ = target$ /* Location target observable */\nwindow.keyboard$ = keyboard$ /* Keyboard observable */\nwindow.viewport$ = viewport$ /* Viewport observable */\nwindow.tablet$ = tablet$ /* Media tablet observable */\nwindow.screen$ = screen$ /* Media screen observable */\nwindow.print$ = print$ /* Media print observable */\nwindow.alert$ = alert$ /* Alert subject */\nwindow.progress$ = progress$ /* Progress indicator subject */\nwindow.component$ = component$ /* Component observable */\n", "/*! *****************************************************************************\r\nCopyright (c) Microsoft Corporation.\r\n\r\nPermission to use, copy, modify, and/or distribute this software for any\r\npurpose with or without fee is hereby granted.\r\n\r\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\r\nREGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY\r\nAND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\r\nINDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\r\nLOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR\r\nOTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\r\nPERFORMANCE OF THIS SOFTWARE.\r\n***************************************************************************** */\r\n/* global Reflect, Promise */\r\n\r\nvar extendStatics = function(d, b) {\r\n extendStatics = Object.setPrototypeOf ||\r\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\r\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\r\n return extendStatics(d, b);\r\n};\r\n\r\nexport function __extends(d, b) {\r\n if (typeof b !== \"function\" && b !== null)\r\n throw new TypeError(\"Class extends value \" + String(b) + \" is not a constructor or null\");\r\n extendStatics(d, b);\r\n function __() { this.constructor = d; }\r\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\r\n}\r\n\r\nexport var __assign = function() {\r\n __assign = Object.assign || function __assign(t) {\r\n for (var s, i = 1, n = arguments.length; i < n; i++) {\r\n s = arguments[i];\r\n for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p)) t[p] = s[p];\r\n }\r\n return t;\r\n }\r\n return __assign.apply(this, arguments);\r\n}\r\n\r\nexport function __rest(s, e) {\r\n var t = {};\r\n for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)\r\n t[p] = s[p];\r\n if (s != null && typeof Object.getOwnPropertySymbols === \"function\")\r\n for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {\r\n if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))\r\n t[p[i]] = s[p[i]];\r\n }\r\n return t;\r\n}\r\n\r\nexport function __decorate(decorators, target, key, desc) {\r\n var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;\r\n if (typeof Reflect === \"object\" && typeof Reflect.decorate === \"function\") r = Reflect.decorate(decorators, target, key, desc);\r\n else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;\r\n return c > 3 && r && Object.defineProperty(target, key, r), r;\r\n}\r\n\r\nexport function __param(paramIndex, decorator) {\r\n return function (target, key) { decorator(target, key, paramIndex); }\r\n}\r\n\r\nexport function __metadata(metadataKey, metadataValue) {\r\n if (typeof Reflect === \"object\" && typeof Reflect.metadata === \"function\") return Reflect.metadata(metadataKey, metadataValue);\r\n}\r\n\r\nexport function __awaiter(thisArg, _arguments, P, generator) {\r\n function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }\r\n return new (P || (P = Promise))(function (resolve, reject) {\r\n function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }\r\n function rejected(value) { try { step(generator[\"throw\"](value)); } catch (e) { reject(e); } }\r\n function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }\r\n step((generator = generator.apply(thisArg, _arguments || [])).next());\r\n });\r\n}\r\n\r\nexport function __generator(thisArg, body) {\r\n var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;\r\n return g = { next: verb(0), \"throw\": verb(1), \"return\": verb(2) }, typeof Symbol === \"function\" && (g[Symbol.iterator] = function() { return this; }), g;\r\n function verb(n) { return function (v) { return step([n, v]); }; }\r\n function step(op) {\r\n if (f) throw new TypeError(\"Generator is already executing.\");\r\n while (_) try {\r\n if (f = 1, y && (t = op[0] & 2 ? y[\"return\"] : op[0] ? y[\"throw\"] || ((t = y[\"return\"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;\r\n if (y = 0, t) op = [op[0] & 2, t.value];\r\n switch (op[0]) {\r\n case 0: case 1: t = op; break;\r\n case 4: _.label++; return { value: op[1], done: false };\r\n case 5: _.label++; y = op[1]; op = [0]; continue;\r\n case 7: op = _.ops.pop(); _.trys.pop(); continue;\r\n default:\r\n if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }\r\n if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }\r\n if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }\r\n if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }\r\n if (t[2]) _.ops.pop();\r\n _.trys.pop(); continue;\r\n }\r\n op = body.call(thisArg, _);\r\n } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }\r\n if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };\r\n }\r\n}\r\n\r\nexport var __createBinding = Object.create ? (function(o, m, k, k2) {\r\n if (k2 === undefined) k2 = k;\r\n Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });\r\n}) : (function(o, m, k, k2) {\r\n if (k2 === undefined) k2 = k;\r\n o[k2] = m[k];\r\n});\r\n\r\nexport function __exportStar(m, o) {\r\n for (var p in m) if (p !== \"default\" && !Object.prototype.hasOwnProperty.call(o, p)) __createBinding(o, m, p);\r\n}\r\n\r\nexport function __values(o) {\r\n var s = typeof Symbol === \"function\" && Symbol.iterator, m = s && o[s], i = 0;\r\n if (m) return m.call(o);\r\n if (o && typeof o.length === \"number\") return {\r\n next: function () {\r\n if (o && i >= o.length) o = void 0;\r\n return { value: o && o[i++], done: !o };\r\n }\r\n };\r\n throw new TypeError(s ? \"Object is not iterable.\" : \"Symbol.iterator is not defined.\");\r\n}\r\n\r\nexport function __read(o, n) {\r\n var m = typeof Symbol === \"function\" && o[Symbol.iterator];\r\n if (!m) return o;\r\n var i = m.call(o), r, ar = [], e;\r\n try {\r\n while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);\r\n }\r\n catch (error) { e = { error: error }; }\r\n finally {\r\n try {\r\n if (r && !r.done && (m = i[\"return\"])) m.call(i);\r\n }\r\n finally { if (e) throw e.error; }\r\n }\r\n return ar;\r\n}\r\n\r\n/** @deprecated */\r\nexport function __spread() {\r\n for (var ar = [], i = 0; i < arguments.length; i++)\r\n ar = ar.concat(__read(arguments[i]));\r\n return ar;\r\n}\r\n\r\n/** @deprecated */\r\nexport function __spreadArrays() {\r\n for (var s = 0, i = 0, il = arguments.length; i < il; i++) s += arguments[i].length;\r\n for (var r = Array(s), k = 0, i = 0; i < il; i++)\r\n for (var a = arguments[i], j = 0, jl = a.length; j < jl; j++, k++)\r\n r[k] = a[j];\r\n return r;\r\n}\r\n\r\nexport function __spreadArray(to, from, pack) {\r\n if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {\r\n if (ar || !(i in from)) {\r\n if (!ar) ar = Array.prototype.slice.call(from, 0, i);\r\n ar[i] = from[i];\r\n }\r\n }\r\n return to.concat(ar || Array.prototype.slice.call(from));\r\n}\r\n\r\nexport function __await(v) {\r\n return this instanceof __await ? (this.v = v, this) : new __await(v);\r\n}\r\n\r\nexport function __asyncGenerator(thisArg, _arguments, generator) {\r\n if (!Symbol.asyncIterator) throw new TypeError(\"Symbol.asyncIterator is not defined.\");\r\n var g = generator.apply(thisArg, _arguments || []), i, q = [];\r\n return i = {}, verb(\"next\"), verb(\"throw\"), verb(\"return\"), i[Symbol.asyncIterator] = function () { return this; }, i;\r\n function verb(n) { if (g[n]) i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; }\r\n function resume(n, v) { try { step(g[n](v)); } catch (e) { settle(q[0][3], e); } }\r\n function step(r) { r.value instanceof __await ? Promise.resolve(r.value.v).then(fulfill, reject) : settle(q[0][2], r); }\r\n function fulfill(value) { resume(\"next\", value); }\r\n function reject(value) { resume(\"throw\", value); }\r\n function settle(f, v) { if (f(v), q.shift(), q.length) resume(q[0][0], q[0][1]); }\r\n}\r\n\r\nexport function __asyncDelegator(o) {\r\n var i, p;\r\n return i = {}, verb(\"next\"), verb(\"throw\", function (e) { throw e; }), verb(\"return\"), i[Symbol.iterator] = function () { return this; }, i;\r\n function verb(n, f) { i[n] = o[n] ? function (v) { return (p = !p) ? { value: __await(o[n](v)), done: n === \"return\" } : f ? f(v) : v; } : f; }\r\n}\r\n\r\nexport function __asyncValues(o) {\r\n if (!Symbol.asyncIterator) throw new TypeError(\"Symbol.asyncIterator is not defined.\");\r\n var m = o[Symbol.asyncIterator], i;\r\n return m ? m.call(o) : (o = typeof __values === \"function\" ? __values(o) : o[Symbol.iterator](), i = {}, verb(\"next\"), verb(\"throw\"), verb(\"return\"), i[Symbol.asyncIterator] = function () { return this; }, i);\r\n function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }\r\n function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }\r\n}\r\n\r\nexport function __makeTemplateObject(cooked, raw) {\r\n if (Object.defineProperty) { Object.defineProperty(cooked, \"raw\", { value: raw }); } else { cooked.raw = raw; }\r\n return cooked;\r\n};\r\n\r\nvar __setModuleDefault = Object.create ? (function(o, v) {\r\n Object.defineProperty(o, \"default\", { enumerable: true, value: v });\r\n}) : function(o, v) {\r\n o[\"default\"] = v;\r\n};\r\n\r\nexport function __importStar(mod) {\r\n if (mod && mod.__esModule) return mod;\r\n var result = {};\r\n if (mod != null) for (var k in mod) if (k !== \"default\" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);\r\n __setModuleDefault(result, mod);\r\n return result;\r\n}\r\n\r\nexport function __importDefault(mod) {\r\n return (mod && mod.__esModule) ? mod : { default: mod };\r\n}\r\n\r\nexport function __classPrivateFieldGet(receiver, state, kind, f) {\r\n if (kind === \"a\" && !f) throw new TypeError(\"Private accessor was defined without a getter\");\r\n if (typeof state === \"function\" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError(\"Cannot read private member from an object whose class did not declare it\");\r\n return kind === \"m\" ? f : kind === \"a\" ? f.call(receiver) : f ? f.value : state.get(receiver);\r\n}\r\n\r\nexport function __classPrivateFieldSet(receiver, state, value, kind, f) {\r\n if (kind === \"m\") throw new TypeError(\"Private method is not writable\");\r\n if (kind === \"a\" && !f) throw new TypeError(\"Private accessor was defined without a setter\");\r\n if (typeof state === \"function\" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError(\"Cannot write private member to an object whose class did not declare it\");\r\n return (kind === \"a\" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;\r\n}\r\n", "/**\n * Returns true if the object is a function.\n * @param value The value to check\n */\nexport function isFunction(value: any): value is (...args: any[]) => any {\n return typeof value === 'function';\n}\n", "/**\n * Used to create Error subclasses until the community moves away from ES5.\n *\n * This is because compiling from TypeScript down to ES5 has issues with subclassing Errors\n * as well as other built-in types: https://github.com/Microsoft/TypeScript/issues/12123\n *\n * @param createImpl A factory function to create the actual constructor implementation. The returned\n * function should be a named function that calls `_super` internally.\n */\nexport function createErrorClass(createImpl: (_super: any) => any): T {\n const _super = (instance: any) => {\n Error.call(instance);\n instance.stack = new Error().stack;\n };\n\n const ctorFunc = createImpl(_super);\n ctorFunc.prototype = Object.create(Error.prototype);\n ctorFunc.prototype.constructor = ctorFunc;\n return ctorFunc;\n}\n", "import { createErrorClass } from './createErrorClass';\n\nexport interface UnsubscriptionError extends Error {\n readonly errors: any[];\n}\n\nexport interface UnsubscriptionErrorCtor {\n /**\n * @deprecated Internal implementation detail. Do not construct error instances.\n * Cannot be tagged as internal: https://github.com/ReactiveX/rxjs/issues/6269\n */\n new (errors: any[]): UnsubscriptionError;\n}\n\n/**\n * An error thrown when one or more errors have occurred during the\n * `unsubscribe` of a {@link Subscription}.\n */\nexport const UnsubscriptionError: UnsubscriptionErrorCtor = createErrorClass(\n (_super) =>\n function UnsubscriptionErrorImpl(this: any, errors: (Error | string)[]) {\n _super(this);\n this.message = errors\n ? `${errors.length} errors occurred during unsubscription:\n${errors.map((err, i) => `${i + 1}) ${err.toString()}`).join('\\n ')}`\n : '';\n this.name = 'UnsubscriptionError';\n this.errors = errors;\n }\n);\n", "/**\n * Removes an item from an array, mutating it.\n * @param arr The array to remove the item from\n * @param item The item to remove\n */\nexport function arrRemove(arr: T[] | undefined | null, item: T) {\n if (arr) {\n const index = arr.indexOf(item);\n 0 <= index && arr.splice(index, 1);\n }\n}\n", "import { isFunction } from './util/isFunction';\nimport { UnsubscriptionError } from './util/UnsubscriptionError';\nimport { SubscriptionLike, TeardownLogic, Unsubscribable } from './types';\nimport { arrRemove } from './util/arrRemove';\n\n/**\n * Represents a disposable resource, such as the execution of an Observable. A\n * Subscription has one important method, `unsubscribe`, that takes no argument\n * and just disposes the resource held by the subscription.\n *\n * Additionally, subscriptions may be grouped together through the `add()`\n * method, which will attach a child Subscription to the current Subscription.\n * When a Subscription is unsubscribed, all its children (and its grandchildren)\n * will be unsubscribed as well.\n *\n * @class Subscription\n */\nexport class Subscription implements SubscriptionLike {\n /** @nocollapse */\n public static EMPTY = (() => {\n const empty = new Subscription();\n empty.closed = true;\n return empty;\n })();\n\n /**\n * A flag to indicate whether this Subscription has already been unsubscribed.\n */\n public closed = false;\n\n private _parentage: Subscription[] | Subscription | null = null;\n\n /**\n * The list of registered finalizers to execute upon unsubscription. Adding and removing from this\n * list occurs in the {@link #add} and {@link #remove} methods.\n */\n private _finalizers: Exclude[] | null = null;\n\n /**\n * @param initialTeardown A function executed first as part of the finalization\n * process that is kicked off when {@link #unsubscribe} is called.\n */\n constructor(private initialTeardown?: () => void) {}\n\n /**\n * Disposes the resources held by the subscription. May, for instance, cancel\n * an ongoing Observable execution or cancel any other type of work that\n * started when the Subscription was created.\n * @return {void}\n */\n unsubscribe(): void {\n let errors: any[] | undefined;\n\n if (!this.closed) {\n this.closed = true;\n\n // Remove this from it's parents.\n const { _parentage } = this;\n if (_parentage) {\n this._parentage = null;\n if (Array.isArray(_parentage)) {\n for (const parent of _parentage) {\n parent.remove(this);\n }\n } else {\n _parentage.remove(this);\n }\n }\n\n const { initialTeardown: initialFinalizer } = this;\n if (isFunction(initialFinalizer)) {\n try {\n initialFinalizer();\n } catch (e) {\n errors = e instanceof UnsubscriptionError ? e.errors : [e];\n }\n }\n\n const { _finalizers } = this;\n if (_finalizers) {\n this._finalizers = null;\n for (const finalizer of _finalizers) {\n try {\n execFinalizer(finalizer);\n } catch (err) {\n errors = errors ?? [];\n if (err instanceof UnsubscriptionError) {\n errors = [...errors, ...err.errors];\n } else {\n errors.push(err);\n }\n }\n }\n }\n\n if (errors) {\n throw new UnsubscriptionError(errors);\n }\n }\n }\n\n /**\n * Adds a finalizer to this subscription, so that finalization will be unsubscribed/called\n * when this subscription is unsubscribed. If this subscription is already {@link #closed},\n * because it has already been unsubscribed, then whatever finalizer is passed to it\n * will automatically be executed (unless the finalizer itself is also a closed subscription).\n *\n * Closed Subscriptions cannot be added as finalizers to any subscription. Adding a closed\n * subscription to a any subscription will result in no operation. (A noop).\n *\n * Adding a subscription to itself, or adding `null` or `undefined` will not perform any\n * operation at all. (A noop).\n *\n * `Subscription` instances that are added to this instance will automatically remove themselves\n * if they are unsubscribed. Functions and {@link Unsubscribable} objects that you wish to remove\n * will need to be removed manually with {@link #remove}\n *\n * @param teardown The finalization logic to add to this subscription.\n */\n add(teardown: TeardownLogic): void {\n // Only add the finalizer if it's not undefined\n // and don't add a subscription to itself.\n if (teardown && teardown !== this) {\n if (this.closed) {\n // If this subscription is already closed,\n // execute whatever finalizer is handed to it automatically.\n execFinalizer(teardown);\n } else {\n if (teardown instanceof Subscription) {\n // We don't add closed subscriptions, and we don't add the same subscription\n // twice. Subscription unsubscribe is idempotent.\n if (teardown.closed || teardown._hasParent(this)) {\n return;\n }\n teardown._addParent(this);\n }\n (this._finalizers = this._finalizers ?? []).push(teardown);\n }\n }\n }\n\n /**\n * Checks to see if a this subscription already has a particular parent.\n * This will signal that this subscription has already been added to the parent in question.\n * @param parent the parent to check for\n */\n private _hasParent(parent: Subscription) {\n const { _parentage } = this;\n return _parentage === parent || (Array.isArray(_parentage) && _parentage.includes(parent));\n }\n\n /**\n * Adds a parent to this subscription so it can be removed from the parent if it\n * unsubscribes on it's own.\n *\n * NOTE: THIS ASSUMES THAT {@link _hasParent} HAS ALREADY BEEN CHECKED.\n * @param parent The parent subscription to add\n */\n private _addParent(parent: Subscription) {\n const { _parentage } = this;\n this._parentage = Array.isArray(_parentage) ? (_parentage.push(parent), _parentage) : _parentage ? [_parentage, parent] : parent;\n }\n\n /**\n * Called on a child when it is removed via {@link #remove}.\n * @param parent The parent to remove\n */\n private _removeParent(parent: Subscription) {\n const { _parentage } = this;\n if (_parentage === parent) {\n this._parentage = null;\n } else if (Array.isArray(_parentage)) {\n arrRemove(_parentage, parent);\n }\n }\n\n /**\n * Removes a finalizer from this subscription that was previously added with the {@link #add} method.\n *\n * Note that `Subscription` instances, when unsubscribed, will automatically remove themselves\n * from every other `Subscription` they have been added to. This means that using the `remove` method\n * is not a common thing and should be used thoughtfully.\n *\n * If you add the same finalizer instance of a function or an unsubscribable object to a `Subscription` instance\n * more than once, you will need to call `remove` the same number of times to remove all instances.\n *\n * All finalizer instances are removed to free up memory upon unsubscription.\n *\n * @param teardown The finalizer to remove from this subscription\n */\n remove(teardown: Exclude): void {\n const { _finalizers } = this;\n _finalizers && arrRemove(_finalizers, teardown);\n\n if (teardown instanceof Subscription) {\n teardown._removeParent(this);\n }\n }\n}\n\nexport const EMPTY_SUBSCRIPTION = Subscription.EMPTY;\n\nexport function isSubscription(value: any): value is Subscription {\n return (\n value instanceof Subscription ||\n (value && 'closed' in value && isFunction(value.remove) && isFunction(value.add) && isFunction(value.unsubscribe))\n );\n}\n\nfunction execFinalizer(finalizer: Unsubscribable | (() => void)) {\n if (isFunction(finalizer)) {\n finalizer();\n } else {\n finalizer.unsubscribe();\n }\n}\n", "import { Subscriber } from './Subscriber';\nimport { ObservableNotification } from './types';\n\n/**\n * The {@link GlobalConfig} object for RxJS. It is used to configure things\n * like how to react on unhandled errors.\n */\nexport const config: GlobalConfig = {\n onUnhandledError: null,\n onStoppedNotification: null,\n Promise: undefined,\n useDeprecatedSynchronousErrorHandling: false,\n useDeprecatedNextContext: false,\n};\n\n/**\n * The global configuration object for RxJS, used to configure things\n * like how to react on unhandled errors. Accessible via {@link config}\n * object.\n */\nexport interface GlobalConfig {\n /**\n * A registration point for unhandled errors from RxJS. These are errors that\n * cannot were not handled by consuming code in the usual subscription path. For\n * example, if you have this configured, and you subscribe to an observable without\n * providing an error handler, errors from that subscription will end up here. This\n * will _always_ be called asynchronously on another job in the runtime. This is because\n * we do not want errors thrown in this user-configured handler to interfere with the\n * behavior of the library.\n */\n onUnhandledError: ((err: any) => void) | null;\n\n /**\n * A registration point for notifications that cannot be sent to subscribers because they\n * have completed, errored or have been explicitly unsubscribed. By default, next, complete\n * and error notifications sent to stopped subscribers are noops. However, sometimes callers\n * might want a different behavior. For example, with sources that attempt to report errors\n * to stopped subscribers, a caller can configure RxJS to throw an unhandled error instead.\n * This will _always_ be called asynchronously on another job in the runtime. This is because\n * we do not want errors thrown in this user-configured handler to interfere with the\n * behavior of the library.\n */\n onStoppedNotification: ((notification: ObservableNotification, subscriber: Subscriber) => void) | null;\n\n /**\n * The promise constructor used by default for {@link Observable#toPromise toPromise} and {@link Observable#forEach forEach}\n * methods.\n *\n * @deprecated As of version 8, RxJS will no longer support this sort of injection of a\n * Promise constructor. If you need a Promise implementation other than native promises,\n * please polyfill/patch Promise as you see appropriate. Will be removed in v8.\n */\n Promise?: PromiseConstructorLike;\n\n /**\n * If true, turns on synchronous error rethrowing, which is a deprecated behavior\n * in v6 and higher. This behavior enables bad patterns like wrapping a subscribe\n * call in a try/catch block. It also enables producer interference, a nasty bug\n * where a multicast can be broken for all observers by a downstream consumer with\n * an unhandled error. DO NOT USE THIS FLAG UNLESS IT'S NEEDED TO BUY TIME\n * FOR MIGRATION REASONS.\n *\n * @deprecated As of version 8, RxJS will no longer support synchronous throwing\n * of unhandled errors. All errors will be thrown on a separate call stack to prevent bad\n * behaviors described above. Will be removed in v8.\n */\n useDeprecatedSynchronousErrorHandling: boolean;\n\n /**\n * If true, enables an as-of-yet undocumented feature from v5: The ability to access\n * `unsubscribe()` via `this` context in `next` functions created in observers passed\n * to `subscribe`.\n *\n * This is being removed because the performance was severely problematic, and it could also cause\n * issues when types other than POJOs are passed to subscribe as subscribers, as they will likely have\n * their `this` context overwritten.\n *\n * @deprecated As of version 8, RxJS will no longer support altering the\n * context of next functions provided as part of an observer to Subscribe. Instead,\n * you will have access to a subscription or a signal or token that will allow you to do things like\n * unsubscribe and test closed status. Will be removed in v8.\n */\n useDeprecatedNextContext: boolean;\n}\n", "import type { TimerHandle } from './timerHandle';\ntype SetTimeoutFunction = (handler: () => void, timeout?: number, ...args: any[]) => TimerHandle;\ntype ClearTimeoutFunction = (handle: TimerHandle) => void;\n\ninterface TimeoutProvider {\n setTimeout: SetTimeoutFunction;\n clearTimeout: ClearTimeoutFunction;\n delegate:\n | {\n setTimeout: SetTimeoutFunction;\n clearTimeout: ClearTimeoutFunction;\n }\n | undefined;\n}\n\nexport const timeoutProvider: TimeoutProvider = {\n // When accessing the delegate, use the variable rather than `this` so that\n // the functions can be called without being bound to the provider.\n setTimeout(handler: () => void, timeout?: number, ...args) {\n const { delegate } = timeoutProvider;\n if (delegate?.setTimeout) {\n return delegate.setTimeout(handler, timeout, ...args);\n }\n return setTimeout(handler, timeout, ...args);\n },\n clearTimeout(handle) {\n const { delegate } = timeoutProvider;\n return (delegate?.clearTimeout || clearTimeout)(handle as any);\n },\n delegate: undefined,\n};\n", "import { config } from '../config';\nimport { timeoutProvider } from '../scheduler/timeoutProvider';\n\n/**\n * Handles an error on another job either with the user-configured {@link onUnhandledError},\n * or by throwing it on that new job so it can be picked up by `window.onerror`, `process.on('error')`, etc.\n *\n * This should be called whenever there is an error that is out-of-band with the subscription\n * or when an error hits a terminal boundary of the subscription and no error handler was provided.\n *\n * @param err the error to report\n */\nexport function reportUnhandledError(err: any) {\n timeoutProvider.setTimeout(() => {\n const { onUnhandledError } = config;\n if (onUnhandledError) {\n // Execute the user-configured error handler.\n onUnhandledError(err);\n } else {\n // Throw so it is picked up by the runtime's uncaught error mechanism.\n throw err;\n }\n });\n}\n", "/* tslint:disable:no-empty */\nexport function noop() { }\n", "import { CompleteNotification, NextNotification, ErrorNotification } from './types';\n\n/**\n * A completion object optimized for memory use and created to be the\n * same \"shape\" as other notifications in v8.\n * @internal\n */\nexport const COMPLETE_NOTIFICATION = (() => createNotification('C', undefined, undefined) as CompleteNotification)();\n\n/**\n * Internal use only. Creates an optimized error notification that is the same \"shape\"\n * as other notifications.\n * @internal\n */\nexport function errorNotification(error: any): ErrorNotification {\n return createNotification('E', undefined, error) as any;\n}\n\n/**\n * Internal use only. Creates an optimized next notification that is the same \"shape\"\n * as other notifications.\n * @internal\n */\nexport function nextNotification(value: T) {\n return createNotification('N', value, undefined) as NextNotification;\n}\n\n/**\n * Ensures that all notifications created internally have the same \"shape\" in v8.\n *\n * TODO: This is only exported to support a crazy legacy test in `groupBy`.\n * @internal\n */\nexport function createNotification(kind: 'N' | 'E' | 'C', value: any, error: any) {\n return {\n kind,\n value,\n error,\n };\n}\n", "import { config } from '../config';\n\nlet context: { errorThrown: boolean; error: any } | null = null;\n\n/**\n * Handles dealing with errors for super-gross mode. Creates a context, in which\n * any synchronously thrown errors will be passed to {@link captureError}. Which\n * will record the error such that it will be rethrown after the call back is complete.\n * TODO: Remove in v8\n * @param cb An immediately executed function.\n */\nexport function errorContext(cb: () => void) {\n if (config.useDeprecatedSynchronousErrorHandling) {\n const isRoot = !context;\n if (isRoot) {\n context = { errorThrown: false, error: null };\n }\n cb();\n if (isRoot) {\n const { errorThrown, error } = context!;\n context = null;\n if (errorThrown) {\n throw error;\n }\n }\n } else {\n // This is the general non-deprecated path for everyone that\n // isn't crazy enough to use super-gross mode (useDeprecatedSynchronousErrorHandling)\n cb();\n }\n}\n\n/**\n * Captures errors only in super-gross mode.\n * @param err the error to capture\n */\nexport function captureError(err: any) {\n if (config.useDeprecatedSynchronousErrorHandling && context) {\n context.errorThrown = true;\n context.error = err;\n }\n}\n", "import { isFunction } from './util/isFunction';\nimport { Observer, ObservableNotification } from './types';\nimport { isSubscription, Subscription } from './Subscription';\nimport { config } from './config';\nimport { reportUnhandledError } from './util/reportUnhandledError';\nimport { noop } from './util/noop';\nimport { nextNotification, errorNotification, COMPLETE_NOTIFICATION } from './NotificationFactories';\nimport { timeoutProvider } from './scheduler/timeoutProvider';\nimport { captureError } from './util/errorContext';\n\n/**\n * Implements the {@link Observer} interface and extends the\n * {@link Subscription} class. While the {@link Observer} is the public API for\n * consuming the values of an {@link Observable}, all Observers get converted to\n * a Subscriber, in order to provide Subscription-like capabilities such as\n * `unsubscribe`. Subscriber is a common type in RxJS, and crucial for\n * implementing operators, but it is rarely used as a public API.\n *\n * @class Subscriber\n */\nexport class Subscriber extends Subscription implements Observer {\n /**\n * A static factory for a Subscriber, given a (potentially partial) definition\n * of an Observer.\n * @param next The `next` callback of an Observer.\n * @param error The `error` callback of an\n * Observer.\n * @param complete The `complete` callback of an\n * Observer.\n * @return A Subscriber wrapping the (partially defined)\n * Observer represented by the given arguments.\n * @nocollapse\n * @deprecated Do not use. Will be removed in v8. There is no replacement for this\n * method, and there is no reason to be creating instances of `Subscriber` directly.\n * If you have a specific use case, please file an issue.\n */\n static create(next?: (x?: T) => void, error?: (e?: any) => void, complete?: () => void): Subscriber {\n return new SafeSubscriber(next, error, complete);\n }\n\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n protected isStopped: boolean = false;\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n protected destination: Subscriber | Observer; // this `any` is the escape hatch to erase extra type param (e.g. R)\n\n /**\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n * There is no reason to directly create an instance of Subscriber. This type is exported for typings reasons.\n */\n constructor(destination?: Subscriber | Observer) {\n super();\n if (destination) {\n this.destination = destination;\n // Automatically chain subscriptions together here.\n // if destination is a Subscription, then it is a Subscriber.\n if (isSubscription(destination)) {\n destination.add(this);\n }\n } else {\n this.destination = EMPTY_OBSERVER;\n }\n }\n\n /**\n * The {@link Observer} callback to receive notifications of type `next` from\n * the Observable, with a value. The Observable may call this method 0 or more\n * times.\n * @param {T} [value] The `next` value.\n * @return {void}\n */\n next(value?: T): void {\n if (this.isStopped) {\n handleStoppedNotification(nextNotification(value), this);\n } else {\n this._next(value!);\n }\n }\n\n /**\n * The {@link Observer} callback to receive notifications of type `error` from\n * the Observable, with an attached `Error`. Notifies the Observer that\n * the Observable has experienced an error condition.\n * @param {any} [err] The `error` exception.\n * @return {void}\n */\n error(err?: any): void {\n if (this.isStopped) {\n handleStoppedNotification(errorNotification(err), this);\n } else {\n this.isStopped = true;\n this._error(err);\n }\n }\n\n /**\n * The {@link Observer} callback to receive a valueless notification of type\n * `complete` from the Observable. Notifies the Observer that the Observable\n * has finished sending push-based notifications.\n * @return {void}\n */\n complete(): void {\n if (this.isStopped) {\n handleStoppedNotification(COMPLETE_NOTIFICATION, this);\n } else {\n this.isStopped = true;\n this._complete();\n }\n }\n\n unsubscribe(): void {\n if (!this.closed) {\n this.isStopped = true;\n super.unsubscribe();\n this.destination = null!;\n }\n }\n\n protected _next(value: T): void {\n this.destination.next(value);\n }\n\n protected _error(err: any): void {\n try {\n this.destination.error(err);\n } finally {\n this.unsubscribe();\n }\n }\n\n protected _complete(): void {\n try {\n this.destination.complete();\n } finally {\n this.unsubscribe();\n }\n }\n}\n\n/**\n * This bind is captured here because we want to be able to have\n * compatibility with monoid libraries that tend to use a method named\n * `bind`. In particular, a library called Monio requires this.\n */\nconst _bind = Function.prototype.bind;\n\nfunction bind any>(fn: Fn, thisArg: any): Fn {\n return _bind.call(fn, thisArg);\n}\n\n/**\n * Internal optimization only, DO NOT EXPOSE.\n * @internal\n */\nclass ConsumerObserver implements Observer {\n constructor(private partialObserver: Partial>) {}\n\n next(value: T): void {\n const { partialObserver } = this;\n if (partialObserver.next) {\n try {\n partialObserver.next(value);\n } catch (error) {\n handleUnhandledError(error);\n }\n }\n }\n\n error(err: any): void {\n const { partialObserver } = this;\n if (partialObserver.error) {\n try {\n partialObserver.error(err);\n } catch (error) {\n handleUnhandledError(error);\n }\n } else {\n handleUnhandledError(err);\n }\n }\n\n complete(): void {\n const { partialObserver } = this;\n if (partialObserver.complete) {\n try {\n partialObserver.complete();\n } catch (error) {\n handleUnhandledError(error);\n }\n }\n }\n}\n\nexport class SafeSubscriber extends Subscriber {\n constructor(\n observerOrNext?: Partial> | ((value: T) => void) | null,\n error?: ((e?: any) => void) | null,\n complete?: (() => void) | null\n ) {\n super();\n\n let partialObserver: Partial>;\n if (isFunction(observerOrNext) || !observerOrNext) {\n // The first argument is a function, not an observer. The next\n // two arguments *could* be observers, or they could be empty.\n partialObserver = {\n next: (observerOrNext ?? undefined) as (((value: T) => void) | undefined),\n error: error ?? undefined,\n complete: complete ?? undefined,\n };\n } else {\n // The first argument is a partial observer.\n let context: any;\n if (this && config.useDeprecatedNextContext) {\n // This is a deprecated path that made `this.unsubscribe()` available in\n // next handler functions passed to subscribe. This only exists behind a flag\n // now, as it is *very* slow.\n context = Object.create(observerOrNext);\n context.unsubscribe = () => this.unsubscribe();\n partialObserver = {\n next: observerOrNext.next && bind(observerOrNext.next, context),\n error: observerOrNext.error && bind(observerOrNext.error, context),\n complete: observerOrNext.complete && bind(observerOrNext.complete, context),\n };\n } else {\n // The \"normal\" path. Just use the partial observer directly.\n partialObserver = observerOrNext;\n }\n }\n\n // Wrap the partial observer to ensure it's a full observer, and\n // make sure proper error handling is accounted for.\n this.destination = new ConsumerObserver(partialObserver);\n }\n}\n\nfunction handleUnhandledError(error: any) {\n if (config.useDeprecatedSynchronousErrorHandling) {\n captureError(error);\n } else {\n // Ideal path, we report this as an unhandled error,\n // which is thrown on a new call stack.\n reportUnhandledError(error);\n }\n}\n\n/**\n * An error handler used when no error handler was supplied\n * to the SafeSubscriber -- meaning no error handler was supplied\n * do the `subscribe` call on our observable.\n * @param err The error to handle\n */\nfunction defaultErrorHandler(err: any) {\n throw err;\n}\n\n/**\n * A handler for notifications that cannot be sent to a stopped subscriber.\n * @param notification The notification being sent\n * @param subscriber The stopped subscriber\n */\nfunction handleStoppedNotification(notification: ObservableNotification, subscriber: Subscriber) {\n const { onStoppedNotification } = config;\n onStoppedNotification && timeoutProvider.setTimeout(() => onStoppedNotification(notification, subscriber));\n}\n\n/**\n * The observer used as a stub for subscriptions where the user did not\n * pass any arguments to `subscribe`. Comes with the default error handling\n * behavior.\n */\nexport const EMPTY_OBSERVER: Readonly> & { closed: true } = {\n closed: true,\n next: noop,\n error: defaultErrorHandler,\n complete: noop,\n};\n", "/**\n * Symbol.observable or a string \"@@observable\". Used for interop\n *\n * @deprecated We will no longer be exporting this symbol in upcoming versions of RxJS.\n * Instead polyfill and use Symbol.observable directly *or* use https://www.npmjs.com/package/symbol-observable\n */\nexport const observable: string | symbol = (() => (typeof Symbol === 'function' && Symbol.observable) || '@@observable')();\n", "/**\n * This function takes one parameter and just returns it. Simply put,\n * this is like `(x: T): T => x`.\n *\n * ## Examples\n *\n * This is useful in some cases when using things like `mergeMap`\n *\n * ```ts\n * import { interval, take, map, range, mergeMap, identity } from 'rxjs';\n *\n * const source$ = interval(1000).pipe(take(5));\n *\n * const result$ = source$.pipe(\n * map(i => range(i)),\n * mergeMap(identity) // same as mergeMap(x => x)\n * );\n *\n * result$.subscribe({\n * next: console.log\n * });\n * ```\n *\n * Or when you want to selectively apply an operator\n *\n * ```ts\n * import { interval, take, identity } from 'rxjs';\n *\n * const shouldLimit = () => Math.random() < 0.5;\n *\n * const source$ = interval(1000);\n *\n * const result$ = source$.pipe(shouldLimit() ? take(5) : identity);\n *\n * result$.subscribe({\n * next: console.log\n * });\n * ```\n *\n * @param x Any value that is returned by this function\n * @returns The value passed as the first parameter to this function\n */\nexport function identity(x: T): T {\n return x;\n}\n", "import { identity } from './identity';\nimport { UnaryFunction } from '../types';\n\nexport function pipe(): typeof identity;\nexport function pipe(fn1: UnaryFunction): UnaryFunction;\nexport function pipe(fn1: UnaryFunction, fn2: UnaryFunction): UnaryFunction;\nexport function pipe(fn1: UnaryFunction, fn2: UnaryFunction, fn3: UnaryFunction): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction,\n fn8: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction,\n fn8: UnaryFunction,\n fn9: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction,\n fn8: UnaryFunction,\n fn9: UnaryFunction,\n ...fns: UnaryFunction[]\n): UnaryFunction;\n\n/**\n * pipe() can be called on one or more functions, each of which can take one argument (\"UnaryFunction\")\n * and uses it to return a value.\n * It returns a function that takes one argument, passes it to the first UnaryFunction, and then\n * passes the result to the next one, passes that result to the next one, and so on. \n */\nexport function pipe(...fns: Array>): UnaryFunction {\n return pipeFromArray(fns);\n}\n\n/** @internal */\nexport function pipeFromArray(fns: Array>): UnaryFunction {\n if (fns.length === 0) {\n return identity as UnaryFunction;\n }\n\n if (fns.length === 1) {\n return fns[0];\n }\n\n return function piped(input: T): R {\n return fns.reduce((prev: any, fn: UnaryFunction) => fn(prev), input as any);\n };\n}\n", "import { Operator } from './Operator';\nimport { SafeSubscriber, Subscriber } from './Subscriber';\nimport { isSubscription, Subscription } from './Subscription';\nimport { TeardownLogic, OperatorFunction, Subscribable, Observer } from './types';\nimport { observable as Symbol_observable } from './symbol/observable';\nimport { pipeFromArray } from './util/pipe';\nimport { config } from './config';\nimport { isFunction } from './util/isFunction';\nimport { errorContext } from './util/errorContext';\n\n/**\n * A representation of any set of values over any amount of time. This is the most basic building block\n * of RxJS.\n *\n * @class Observable\n */\nexport class Observable implements Subscribable {\n /**\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n */\n source: Observable | undefined;\n\n /**\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n */\n operator: Operator | undefined;\n\n /**\n * @constructor\n * @param {Function} subscribe the function that is called when the Observable is\n * initially subscribed to. This function is given a Subscriber, to which new values\n * can be `next`ed, or an `error` method can be called to raise an error, or\n * `complete` can be called to notify of a successful completion.\n */\n constructor(subscribe?: (this: Observable, subscriber: Subscriber) => TeardownLogic) {\n if (subscribe) {\n this._subscribe = subscribe;\n }\n }\n\n // HACK: Since TypeScript inherits static properties too, we have to\n // fight against TypeScript here so Subject can have a different static create signature\n /**\n * Creates a new Observable by calling the Observable constructor\n * @owner Observable\n * @method create\n * @param {Function} subscribe? the subscriber function to be passed to the Observable constructor\n * @return {Observable} a new observable\n * @nocollapse\n * @deprecated Use `new Observable()` instead. Will be removed in v8.\n */\n static create: (...args: any[]) => any = (subscribe?: (subscriber: Subscriber) => TeardownLogic) => {\n return new Observable(subscribe);\n };\n\n /**\n * Creates a new Observable, with this Observable instance as the source, and the passed\n * operator defined as the new observable's operator.\n * @method lift\n * @param operator the operator defining the operation to take on the observable\n * @return a new observable with the Operator applied\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n * If you have implemented an operator using `lift`, it is recommended that you create an\n * operator by simply returning `new Observable()` directly. See \"Creating new operators from\n * scratch\" section here: https://rxjs.dev/guide/operators\n */\n lift(operator?: Operator): Observable {\n const observable = new Observable();\n observable.source = this;\n observable.operator = operator;\n return observable;\n }\n\n subscribe(observerOrNext?: Partial> | ((value: T) => void)): Subscription;\n /** @deprecated Instead of passing separate callback arguments, use an observer argument. Signatures taking separate callback arguments will be removed in v8. Details: https://rxjs.dev/deprecations/subscribe-arguments */\n subscribe(next?: ((value: T) => void) | null, error?: ((error: any) => void) | null, complete?: (() => void) | null): Subscription;\n /**\n * Invokes an execution of an Observable and registers Observer handlers for notifications it will emit.\n *\n * Use it when you have all these Observables, but still nothing is happening.\n *\n * `subscribe` is not a regular operator, but a method that calls Observable's internal `subscribe` function. It\n * might be for example a function that you passed to Observable's constructor, but most of the time it is\n * a library implementation, which defines what will be emitted by an Observable, and when it be will emitted. This means\n * that calling `subscribe` is actually the moment when Observable starts its work, not when it is created, as it is often\n * the thought.\n *\n * Apart from starting the execution of an Observable, this method allows you to listen for values\n * that an Observable emits, as well as for when it completes or errors. You can achieve this in two\n * of the following ways.\n *\n * The first way is creating an object that implements {@link Observer} interface. It should have methods\n * defined by that interface, but note that it should be just a regular JavaScript object, which you can create\n * yourself in any way you want (ES6 class, classic function constructor, object literal etc.). In particular, do\n * not attempt to use any RxJS implementation details to create Observers - you don't need them. Remember also\n * that your object does not have to implement all methods. If you find yourself creating a method that doesn't\n * do anything, you can simply omit it. Note however, if the `error` method is not provided and an error happens,\n * it will be thrown asynchronously. Errors thrown asynchronously cannot be caught using `try`/`catch`. Instead,\n * use the {@link onUnhandledError} configuration option or use a runtime handler (like `window.onerror` or\n * `process.on('error)`) to be notified of unhandled errors. Because of this, it's recommended that you provide\n * an `error` method to avoid missing thrown errors.\n *\n * The second way is to give up on Observer object altogether and simply provide callback functions in place of its methods.\n * This means you can provide three functions as arguments to `subscribe`, where the first function is equivalent\n * of a `next` method, the second of an `error` method and the third of a `complete` method. Just as in case of an Observer,\n * if you do not need to listen for something, you can omit a function by passing `undefined` or `null`,\n * since `subscribe` recognizes these functions by where they were placed in function call. When it comes\n * to the `error` function, as with an Observer, if not provided, errors emitted by an Observable will be thrown asynchronously.\n *\n * You can, however, subscribe with no parameters at all. This may be the case where you're not interested in terminal events\n * and you also handled emissions internally by using operators (e.g. using `tap`).\n *\n * Whichever style of calling `subscribe` you use, in both cases it returns a Subscription object.\n * This object allows you to call `unsubscribe` on it, which in turn will stop the work that an Observable does and will clean\n * up all resources that an Observable used. Note that cancelling a subscription will not call `complete` callback\n * provided to `subscribe` function, which is reserved for a regular completion signal that comes from an Observable.\n *\n * Remember that callbacks provided to `subscribe` are not guaranteed to be called asynchronously.\n * It is an Observable itself that decides when these functions will be called. For example {@link of}\n * by default emits all its values synchronously. Always check documentation for how given Observable\n * will behave when subscribed and if its default behavior can be modified with a `scheduler`.\n *\n * #### Examples\n *\n * Subscribe with an {@link guide/observer Observer}\n *\n * ```ts\n * import { of } from 'rxjs';\n *\n * const sumObserver = {\n * sum: 0,\n * next(value) {\n * console.log('Adding: ' + value);\n * this.sum = this.sum + value;\n * },\n * error() {\n * // We actually could just remove this method,\n * // since we do not really care about errors right now.\n * },\n * complete() {\n * console.log('Sum equals: ' + this.sum);\n * }\n * };\n *\n * of(1, 2, 3) // Synchronously emits 1, 2, 3 and then completes.\n * .subscribe(sumObserver);\n *\n * // Logs:\n * // 'Adding: 1'\n * // 'Adding: 2'\n * // 'Adding: 3'\n * // 'Sum equals: 6'\n * ```\n *\n * Subscribe with functions ({@link deprecations/subscribe-arguments deprecated})\n *\n * ```ts\n * import { of } from 'rxjs'\n *\n * let sum = 0;\n *\n * of(1, 2, 3).subscribe(\n * value => {\n * console.log('Adding: ' + value);\n * sum = sum + value;\n * },\n * undefined,\n * () => console.log('Sum equals: ' + sum)\n * );\n *\n * // Logs:\n * // 'Adding: 1'\n * // 'Adding: 2'\n * // 'Adding: 3'\n * // 'Sum equals: 6'\n * ```\n *\n * Cancel a subscription\n *\n * ```ts\n * import { interval } from 'rxjs';\n *\n * const subscription = interval(1000).subscribe({\n * next(num) {\n * console.log(num)\n * },\n * complete() {\n * // Will not be called, even when cancelling subscription.\n * console.log('completed!');\n * }\n * });\n *\n * setTimeout(() => {\n * subscription.unsubscribe();\n * console.log('unsubscribed!');\n * }, 2500);\n *\n * // Logs:\n * // 0 after 1s\n * // 1 after 2s\n * // 'unsubscribed!' after 2.5s\n * ```\n *\n * @param {Observer|Function} observerOrNext (optional) Either an observer with methods to be called,\n * or the first of three possible handlers, which is the handler for each value emitted from the subscribed\n * Observable.\n * @param {Function} error (optional) A handler for a terminal event resulting from an error. If no error handler is provided,\n * the error will be thrown asynchronously as unhandled.\n * @param {Function} complete (optional) A handler for a terminal event resulting from successful completion.\n * @return {Subscription} a subscription reference to the registered handlers\n * @method subscribe\n */\n subscribe(\n observerOrNext?: Partial> | ((value: T) => void) | null,\n error?: ((error: any) => void) | null,\n complete?: (() => void) | null\n ): Subscription {\n const subscriber = isSubscriber(observerOrNext) ? observerOrNext : new SafeSubscriber(observerOrNext, error, complete);\n\n errorContext(() => {\n const { operator, source } = this;\n subscriber.add(\n operator\n ? // We're dealing with a subscription in the\n // operator chain to one of our lifted operators.\n operator.call(subscriber, source)\n : source\n ? // If `source` has a value, but `operator` does not, something that\n // had intimate knowledge of our API, like our `Subject`, must have\n // set it. We're going to just call `_subscribe` directly.\n this._subscribe(subscriber)\n : // In all other cases, we're likely wrapping a user-provided initializer\n // function, so we need to catch errors and handle them appropriately.\n this._trySubscribe(subscriber)\n );\n });\n\n return subscriber;\n }\n\n /** @internal */\n protected _trySubscribe(sink: Subscriber): TeardownLogic {\n try {\n return this._subscribe(sink);\n } catch (err) {\n // We don't need to return anything in this case,\n // because it's just going to try to `add()` to a subscription\n // above.\n sink.error(err);\n }\n }\n\n /**\n * Used as a NON-CANCELLABLE means of subscribing to an observable, for use with\n * APIs that expect promises, like `async/await`. You cannot unsubscribe from this.\n *\n * **WARNING**: Only use this with observables you *know* will complete. If the source\n * observable does not complete, you will end up with a promise that is hung up, and\n * potentially all of the state of an async function hanging out in memory. To avoid\n * this situation, look into adding something like {@link timeout}, {@link take},\n * {@link takeWhile}, or {@link takeUntil} amongst others.\n *\n * #### Example\n *\n * ```ts\n * import { interval, take } from 'rxjs';\n *\n * const source$ = interval(1000).pipe(take(4));\n *\n * async function getTotal() {\n * let total = 0;\n *\n * await source$.forEach(value => {\n * total += value;\n * console.log('observable -> ' + value);\n * });\n *\n * return total;\n * }\n *\n * getTotal().then(\n * total => console.log('Total: ' + total)\n * );\n *\n * // Expected:\n * // 'observable -> 0'\n * // 'observable -> 1'\n * // 'observable -> 2'\n * // 'observable -> 3'\n * // 'Total: 6'\n * ```\n *\n * @param next a handler for each value emitted by the observable\n * @return a promise that either resolves on observable completion or\n * rejects with the handled error\n */\n forEach(next: (value: T) => void): Promise;\n\n /**\n * @param next a handler for each value emitted by the observable\n * @param promiseCtor a constructor function used to instantiate the Promise\n * @return a promise that either resolves on observable completion or\n * rejects with the handled error\n * @deprecated Passing a Promise constructor will no longer be available\n * in upcoming versions of RxJS. This is because it adds weight to the library, for very\n * little benefit. If you need this functionality, it is recommended that you either\n * polyfill Promise, or you create an adapter to convert the returned native promise\n * to whatever promise implementation you wanted. Will be removed in v8.\n */\n forEach(next: (value: T) => void, promiseCtor: PromiseConstructorLike): Promise;\n\n forEach(next: (value: T) => void, promiseCtor?: PromiseConstructorLike): Promise {\n promiseCtor = getPromiseCtor(promiseCtor);\n\n return new promiseCtor((resolve, reject) => {\n const subscriber = new SafeSubscriber({\n next: (value) => {\n try {\n next(value);\n } catch (err) {\n reject(err);\n subscriber.unsubscribe();\n }\n },\n error: reject,\n complete: resolve,\n });\n this.subscribe(subscriber);\n }) as Promise;\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): TeardownLogic {\n return this.source?.subscribe(subscriber);\n }\n\n /**\n * An interop point defined by the es7-observable spec https://github.com/zenparsing/es-observable\n * @method Symbol.observable\n * @return {Observable} this instance of the observable\n */\n [Symbol_observable]() {\n return this;\n }\n\n /* tslint:disable:max-line-length */\n pipe(): Observable;\n pipe(op1: OperatorFunction): Observable;\n pipe(op1: OperatorFunction, op2: OperatorFunction): Observable;\n pipe(op1: OperatorFunction, op2: OperatorFunction, op3: OperatorFunction): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction,\n op8: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction,\n op8: OperatorFunction,\n op9: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction,\n op8: OperatorFunction,\n op9: OperatorFunction,\n ...operations: OperatorFunction[]\n ): Observable;\n /* tslint:enable:max-line-length */\n\n /**\n * Used to stitch together functional operators into a chain.\n * @method pipe\n * @return {Observable} the Observable result of all of the operators having\n * been called in the order they were passed in.\n *\n * ## Example\n *\n * ```ts\n * import { interval, filter, map, scan } from 'rxjs';\n *\n * interval(1000)\n * .pipe(\n * filter(x => x % 2 === 0),\n * map(x => x + x),\n * scan((acc, x) => acc + x)\n * )\n * .subscribe(x => console.log(x));\n * ```\n */\n pipe(...operations: OperatorFunction[]): Observable {\n return pipeFromArray(operations)(this);\n }\n\n /* tslint:disable:max-line-length */\n /** @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise */\n toPromise(): Promise;\n /** @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise */\n toPromise(PromiseCtor: typeof Promise): Promise;\n /** @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise */\n toPromise(PromiseCtor: PromiseConstructorLike): Promise;\n /* tslint:enable:max-line-length */\n\n /**\n * Subscribe to this Observable and get a Promise resolving on\n * `complete` with the last emission (if any).\n *\n * **WARNING**: Only use this with observables you *know* will complete. If the source\n * observable does not complete, you will end up with a promise that is hung up, and\n * potentially all of the state of an async function hanging out in memory. To avoid\n * this situation, look into adding something like {@link timeout}, {@link take},\n * {@link takeWhile}, or {@link takeUntil} amongst others.\n *\n * @method toPromise\n * @param [promiseCtor] a constructor function used to instantiate\n * the Promise\n * @return A Promise that resolves with the last value emit, or\n * rejects on an error. If there were no emissions, Promise\n * resolves with undefined.\n * @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise\n */\n toPromise(promiseCtor?: PromiseConstructorLike): Promise {\n promiseCtor = getPromiseCtor(promiseCtor);\n\n return new promiseCtor((resolve, reject) => {\n let value: T | undefined;\n this.subscribe(\n (x: T) => (value = x),\n (err: any) => reject(err),\n () => resolve(value)\n );\n }) as Promise;\n }\n}\n\n/**\n * Decides between a passed promise constructor from consuming code,\n * A default configured promise constructor, and the native promise\n * constructor and returns it. If nothing can be found, it will throw\n * an error.\n * @param promiseCtor The optional promise constructor to passed by consuming code\n */\nfunction getPromiseCtor(promiseCtor: PromiseConstructorLike | undefined) {\n return promiseCtor ?? config.Promise ?? Promise;\n}\n\nfunction isObserver(value: any): value is Observer {\n return value && isFunction(value.next) && isFunction(value.error) && isFunction(value.complete);\n}\n\nfunction isSubscriber(value: any): value is Subscriber {\n return (value && value instanceof Subscriber) || (isObserver(value) && isSubscription(value));\n}\n", "import { Observable } from '../Observable';\nimport { Subscriber } from '../Subscriber';\nimport { OperatorFunction } from '../types';\nimport { isFunction } from './isFunction';\n\n/**\n * Used to determine if an object is an Observable with a lift function.\n */\nexport function hasLift(source: any): source is { lift: InstanceType['lift'] } {\n return isFunction(source?.lift);\n}\n\n/**\n * Creates an `OperatorFunction`. Used to define operators throughout the library in a concise way.\n * @param init The logic to connect the liftedSource to the subscriber at the moment of subscription.\n */\nexport function operate(\n init: (liftedSource: Observable, subscriber: Subscriber) => (() => void) | void\n): OperatorFunction {\n return (source: Observable) => {\n if (hasLift(source)) {\n return source.lift(function (this: Subscriber, liftedSource: Observable) {\n try {\n return init(liftedSource, this);\n } catch (err) {\n this.error(err);\n }\n });\n }\n throw new TypeError('Unable to lift unknown Observable type');\n };\n}\n", "import { Subscriber } from '../Subscriber';\n\n/**\n * Creates an instance of an `OperatorSubscriber`.\n * @param destination The downstream subscriber.\n * @param onNext Handles next values, only called if this subscriber is not stopped or closed. Any\n * error that occurs in this function is caught and sent to the `error` method of this subscriber.\n * @param onError Handles errors from the subscription, any errors that occur in this handler are caught\n * and send to the `destination` error handler.\n * @param onComplete Handles completion notification from the subscription. Any errors that occur in\n * this handler are sent to the `destination` error handler.\n * @param onFinalize Additional teardown logic here. This will only be called on teardown if the\n * subscriber itself is not already closed. This is called after all other teardown logic is executed.\n */\nexport function createOperatorSubscriber(\n destination: Subscriber,\n onNext?: (value: T) => void,\n onComplete?: () => void,\n onError?: (err: any) => void,\n onFinalize?: () => void\n): Subscriber {\n return new OperatorSubscriber(destination, onNext, onComplete, onError, onFinalize);\n}\n\n/**\n * A generic helper for allowing operators to be created with a Subscriber and\n * use closures to capture necessary state from the operator function itself.\n */\nexport class OperatorSubscriber extends Subscriber {\n /**\n * Creates an instance of an `OperatorSubscriber`.\n * @param destination The downstream subscriber.\n * @param onNext Handles next values, only called if this subscriber is not stopped or closed. Any\n * error that occurs in this function is caught and sent to the `error` method of this subscriber.\n * @param onError Handles errors from the subscription, any errors that occur in this handler are caught\n * and send to the `destination` error handler.\n * @param onComplete Handles completion notification from the subscription. Any errors that occur in\n * this handler are sent to the `destination` error handler.\n * @param onFinalize Additional finalization logic here. This will only be called on finalization if the\n * subscriber itself is not already closed. This is called after all other finalization logic is executed.\n * @param shouldUnsubscribe An optional check to see if an unsubscribe call should truly unsubscribe.\n * NOTE: This currently **ONLY** exists to support the strange behavior of {@link groupBy}, where unsubscription\n * to the resulting observable does not actually disconnect from the source if there are active subscriptions\n * to any grouped observable. (DO NOT EXPOSE OR USE EXTERNALLY!!!)\n */\n constructor(\n destination: Subscriber,\n onNext?: (value: T) => void,\n onComplete?: () => void,\n onError?: (err: any) => void,\n private onFinalize?: () => void,\n private shouldUnsubscribe?: () => boolean\n ) {\n // It's important - for performance reasons - that all of this class's\n // members are initialized and that they are always initialized in the same\n // order. This will ensure that all OperatorSubscriber instances have the\n // same hidden class in V8. This, in turn, will help keep the number of\n // hidden classes involved in property accesses within the base class as\n // low as possible. If the number of hidden classes involved exceeds four,\n // the property accesses will become megamorphic and performance penalties\n // will be incurred - i.e. inline caches won't be used.\n //\n // The reasons for ensuring all instances have the same hidden class are\n // further discussed in this blog post from Benedikt Meurer:\n // https://benediktmeurer.de/2018/03/23/impact-of-polymorphism-on-component-based-frameworks-like-react/\n super(destination);\n this._next = onNext\n ? function (this: OperatorSubscriber, value: T) {\n try {\n onNext(value);\n } catch (err) {\n destination.error(err);\n }\n }\n : super._next;\n this._error = onError\n ? function (this: OperatorSubscriber, err: any) {\n try {\n onError(err);\n } catch (err) {\n // Send any errors that occur down stream.\n destination.error(err);\n } finally {\n // Ensure finalization.\n this.unsubscribe();\n }\n }\n : super._error;\n this._complete = onComplete\n ? function (this: OperatorSubscriber) {\n try {\n onComplete();\n } catch (err) {\n // Send any errors that occur down stream.\n destination.error(err);\n } finally {\n // Ensure finalization.\n this.unsubscribe();\n }\n }\n : super._complete;\n }\n\n unsubscribe() {\n if (!this.shouldUnsubscribe || this.shouldUnsubscribe()) {\n const { closed } = this;\n super.unsubscribe();\n // Execute additional teardown if we have any and we didn't already do so.\n !closed && this.onFinalize?.();\n }\n }\n}\n", "import { Subscription } from '../Subscription';\n\ninterface AnimationFrameProvider {\n schedule(callback: FrameRequestCallback): Subscription;\n requestAnimationFrame: typeof requestAnimationFrame;\n cancelAnimationFrame: typeof cancelAnimationFrame;\n delegate:\n | {\n requestAnimationFrame: typeof requestAnimationFrame;\n cancelAnimationFrame: typeof cancelAnimationFrame;\n }\n | undefined;\n}\n\nexport const animationFrameProvider: AnimationFrameProvider = {\n // When accessing the delegate, use the variable rather than `this` so that\n // the functions can be called without being bound to the provider.\n schedule(callback) {\n let request = requestAnimationFrame;\n let cancel: typeof cancelAnimationFrame | undefined = cancelAnimationFrame;\n const { delegate } = animationFrameProvider;\n if (delegate) {\n request = delegate.requestAnimationFrame;\n cancel = delegate.cancelAnimationFrame;\n }\n const handle = request((timestamp) => {\n // Clear the cancel function. The request has been fulfilled, so\n // attempting to cancel the request upon unsubscription would be\n // pointless.\n cancel = undefined;\n callback(timestamp);\n });\n return new Subscription(() => cancel?.(handle));\n },\n requestAnimationFrame(...args) {\n const { delegate } = animationFrameProvider;\n return (delegate?.requestAnimationFrame || requestAnimationFrame)(...args);\n },\n cancelAnimationFrame(...args) {\n const { delegate } = animationFrameProvider;\n return (delegate?.cancelAnimationFrame || cancelAnimationFrame)(...args);\n },\n delegate: undefined,\n};\n", "import { createErrorClass } from './createErrorClass';\n\nexport interface ObjectUnsubscribedError extends Error {}\n\nexport interface ObjectUnsubscribedErrorCtor {\n /**\n * @deprecated Internal implementation detail. Do not construct error instances.\n * Cannot be tagged as internal: https://github.com/ReactiveX/rxjs/issues/6269\n */\n new (): ObjectUnsubscribedError;\n}\n\n/**\n * An error thrown when an action is invalid because the object has been\n * unsubscribed.\n *\n * @see {@link Subject}\n * @see {@link BehaviorSubject}\n *\n * @class ObjectUnsubscribedError\n */\nexport const ObjectUnsubscribedError: ObjectUnsubscribedErrorCtor = createErrorClass(\n (_super) =>\n function ObjectUnsubscribedErrorImpl(this: any) {\n _super(this);\n this.name = 'ObjectUnsubscribedError';\n this.message = 'object unsubscribed';\n }\n);\n", "import { Operator } from './Operator';\nimport { Observable } from './Observable';\nimport { Subscriber } from './Subscriber';\nimport { Subscription, EMPTY_SUBSCRIPTION } from './Subscription';\nimport { Observer, SubscriptionLike, TeardownLogic } from './types';\nimport { ObjectUnsubscribedError } from './util/ObjectUnsubscribedError';\nimport { arrRemove } from './util/arrRemove';\nimport { errorContext } from './util/errorContext';\n\n/**\n * A Subject is a special type of Observable that allows values to be\n * multicasted to many Observers. Subjects are like EventEmitters.\n *\n * Every Subject is an Observable and an Observer. You can subscribe to a\n * Subject, and you can call next to feed values as well as error and complete.\n */\nexport class Subject extends Observable implements SubscriptionLike {\n closed = false;\n\n private currentObservers: Observer[] | null = null;\n\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n observers: Observer[] = [];\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n isStopped = false;\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n hasError = false;\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n thrownError: any = null;\n\n /**\n * Creates a \"subject\" by basically gluing an observer to an observable.\n *\n * @nocollapse\n * @deprecated Recommended you do not use. Will be removed at some point in the future. Plans for replacement still under discussion.\n */\n static create: (...args: any[]) => any = (destination: Observer, source: Observable): AnonymousSubject => {\n return new AnonymousSubject(destination, source);\n };\n\n constructor() {\n // NOTE: This must be here to obscure Observable's constructor.\n super();\n }\n\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n lift(operator: Operator): Observable {\n const subject = new AnonymousSubject(this, this);\n subject.operator = operator as any;\n return subject as any;\n }\n\n /** @internal */\n protected _throwIfClosed() {\n if (this.closed) {\n throw new ObjectUnsubscribedError();\n }\n }\n\n next(value: T) {\n errorContext(() => {\n this._throwIfClosed();\n if (!this.isStopped) {\n if (!this.currentObservers) {\n this.currentObservers = Array.from(this.observers);\n }\n for (const observer of this.currentObservers) {\n observer.next(value);\n }\n }\n });\n }\n\n error(err: any) {\n errorContext(() => {\n this._throwIfClosed();\n if (!this.isStopped) {\n this.hasError = this.isStopped = true;\n this.thrownError = err;\n const { observers } = this;\n while (observers.length) {\n observers.shift()!.error(err);\n }\n }\n });\n }\n\n complete() {\n errorContext(() => {\n this._throwIfClosed();\n if (!this.isStopped) {\n this.isStopped = true;\n const { observers } = this;\n while (observers.length) {\n observers.shift()!.complete();\n }\n }\n });\n }\n\n unsubscribe() {\n this.isStopped = this.closed = true;\n this.observers = this.currentObservers = null!;\n }\n\n get observed() {\n return this.observers?.length > 0;\n }\n\n /** @internal */\n protected _trySubscribe(subscriber: Subscriber): TeardownLogic {\n this._throwIfClosed();\n return super._trySubscribe(subscriber);\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): Subscription {\n this._throwIfClosed();\n this._checkFinalizedStatuses(subscriber);\n return this._innerSubscribe(subscriber);\n }\n\n /** @internal */\n protected _innerSubscribe(subscriber: Subscriber) {\n const { hasError, isStopped, observers } = this;\n if (hasError || isStopped) {\n return EMPTY_SUBSCRIPTION;\n }\n this.currentObservers = null;\n observers.push(subscriber);\n return new Subscription(() => {\n this.currentObservers = null;\n arrRemove(observers, subscriber);\n });\n }\n\n /** @internal */\n protected _checkFinalizedStatuses(subscriber: Subscriber) {\n const { hasError, thrownError, isStopped } = this;\n if (hasError) {\n subscriber.error(thrownError);\n } else if (isStopped) {\n subscriber.complete();\n }\n }\n\n /**\n * Creates a new Observable with this Subject as the source. You can do this\n * to create custom Observer-side logic of the Subject and conceal it from\n * code that uses the Observable.\n * @return {Observable} Observable that the Subject casts to\n */\n asObservable(): Observable {\n const observable: any = new Observable();\n observable.source = this;\n return observable;\n }\n}\n\n/**\n * @class AnonymousSubject\n */\nexport class AnonymousSubject extends Subject {\n constructor(\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n public destination?: Observer,\n source?: Observable\n ) {\n super();\n this.source = source;\n }\n\n next(value: T) {\n this.destination?.next?.(value);\n }\n\n error(err: any) {\n this.destination?.error?.(err);\n }\n\n complete() {\n this.destination?.complete?.();\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): Subscription {\n return this.source?.subscribe(subscriber) ?? EMPTY_SUBSCRIPTION;\n }\n}\n", "import { Subject } from './Subject';\nimport { Subscriber } from './Subscriber';\nimport { Subscription } from './Subscription';\n\n/**\n * A variant of Subject that requires an initial value and emits its current\n * value whenever it is subscribed to.\n *\n * @class BehaviorSubject\n */\nexport class BehaviorSubject extends Subject {\n constructor(private _value: T) {\n super();\n }\n\n get value(): T {\n return this.getValue();\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): Subscription {\n const subscription = super._subscribe(subscriber);\n !subscription.closed && subscriber.next(this._value);\n return subscription;\n }\n\n getValue(): T {\n const { hasError, thrownError, _value } = this;\n if (hasError) {\n throw thrownError;\n }\n this._throwIfClosed();\n return _value;\n }\n\n next(value: T): void {\n super.next((this._value = value));\n }\n}\n", "import { TimestampProvider } from '../types';\n\ninterface DateTimestampProvider extends TimestampProvider {\n delegate: TimestampProvider | undefined;\n}\n\nexport const dateTimestampProvider: DateTimestampProvider = {\n now() {\n // Use the variable rather than `this` so that the function can be called\n // without being bound to the provider.\n return (dateTimestampProvider.delegate || Date).now();\n },\n delegate: undefined,\n};\n", "import { Subject } from './Subject';\nimport { TimestampProvider } from './types';\nimport { Subscriber } from './Subscriber';\nimport { Subscription } from './Subscription';\nimport { dateTimestampProvider } from './scheduler/dateTimestampProvider';\n\n/**\n * A variant of {@link Subject} that \"replays\" old values to new subscribers by emitting them when they first subscribe.\n *\n * `ReplaySubject` has an internal buffer that will store a specified number of values that it has observed. Like `Subject`,\n * `ReplaySubject` \"observes\" values by having them passed to its `next` method. When it observes a value, it will store that\n * value for a time determined by the configuration of the `ReplaySubject`, as passed to its constructor.\n *\n * When a new subscriber subscribes to the `ReplaySubject` instance, it will synchronously emit all values in its buffer in\n * a First-In-First-Out (FIFO) manner. The `ReplaySubject` will also complete, if it has observed completion; and it will\n * error if it has observed an error.\n *\n * There are two main configuration items to be concerned with:\n *\n * 1. `bufferSize` - This will determine how many items are stored in the buffer, defaults to infinite.\n * 2. `windowTime` - The amount of time to hold a value in the buffer before removing it from the buffer.\n *\n * Both configurations may exist simultaneously. So if you would like to buffer a maximum of 3 values, as long as the values\n * are less than 2 seconds old, you could do so with a `new ReplaySubject(3, 2000)`.\n *\n * ### Differences with BehaviorSubject\n *\n * `BehaviorSubject` is similar to `new ReplaySubject(1)`, with a couple of exceptions:\n *\n * 1. `BehaviorSubject` comes \"primed\" with a single value upon construction.\n * 2. `ReplaySubject` will replay values, even after observing an error, where `BehaviorSubject` will not.\n *\n * @see {@link Subject}\n * @see {@link BehaviorSubject}\n * @see {@link shareReplay}\n */\nexport class ReplaySubject extends Subject {\n private _buffer: (T | number)[] = [];\n private _infiniteTimeWindow = true;\n\n /**\n * @param bufferSize The size of the buffer to replay on subscription\n * @param windowTime The amount of time the buffered items will stay buffered\n * @param timestampProvider An object with a `now()` method that provides the current timestamp. This is used to\n * calculate the amount of time something has been buffered.\n */\n constructor(\n private _bufferSize = Infinity,\n private _windowTime = Infinity,\n private _timestampProvider: TimestampProvider = dateTimestampProvider\n ) {\n super();\n this._infiniteTimeWindow = _windowTime === Infinity;\n this._bufferSize = Math.max(1, _bufferSize);\n this._windowTime = Math.max(1, _windowTime);\n }\n\n next(value: T): void {\n const { isStopped, _buffer, _infiniteTimeWindow, _timestampProvider, _windowTime } = this;\n if (!isStopped) {\n _buffer.push(value);\n !_infiniteTimeWindow && _buffer.push(_timestampProvider.now() + _windowTime);\n }\n this._trimBuffer();\n super.next(value);\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): Subscription {\n this._throwIfClosed();\n this._trimBuffer();\n\n const subscription = this._innerSubscribe(subscriber);\n\n const { _infiniteTimeWindow, _buffer } = this;\n // We use a copy here, so reentrant code does not mutate our array while we're\n // emitting it to a new subscriber.\n const copy = _buffer.slice();\n for (let i = 0; i < copy.length && !subscriber.closed; i += _infiniteTimeWindow ? 1 : 2) {\n subscriber.next(copy[i] as T);\n }\n\n this._checkFinalizedStatuses(subscriber);\n\n return subscription;\n }\n\n private _trimBuffer() {\n const { _bufferSize, _timestampProvider, _buffer, _infiniteTimeWindow } = this;\n // If we don't have an infinite buffer size, and we're over the length,\n // use splice to truncate the old buffer values off. Note that we have to\n // double the size for instances where we're not using an infinite time window\n // because we're storing the values and the timestamps in the same array.\n const adjustedBufferSize = (_infiniteTimeWindow ? 1 : 2) * _bufferSize;\n _bufferSize < Infinity && adjustedBufferSize < _buffer.length && _buffer.splice(0, _buffer.length - adjustedBufferSize);\n\n // Now, if we're not in an infinite time window, remove all values where the time is\n // older than what is allowed.\n if (!_infiniteTimeWindow) {\n const now = _timestampProvider.now();\n let last = 0;\n // Search the array for the first timestamp that isn't expired and\n // truncate the buffer up to that point.\n for (let i = 1; i < _buffer.length && (_buffer[i] as number) <= now; i += 2) {\n last = i;\n }\n last && _buffer.splice(0, last + 1);\n }\n }\n}\n", "import { Scheduler } from '../Scheduler';\nimport { Subscription } from '../Subscription';\nimport { SchedulerAction } from '../types';\n\n/**\n * A unit of work to be executed in a `scheduler`. An action is typically\n * created from within a {@link SchedulerLike} and an RxJS user does not need to concern\n * themselves about creating and manipulating an Action.\n *\n * ```ts\n * class Action extends Subscription {\n * new (scheduler: Scheduler, work: (state?: T) => void);\n * schedule(state?: T, delay: number = 0): Subscription;\n * }\n * ```\n *\n * @class Action\n */\nexport class Action extends Subscription {\n constructor(scheduler: Scheduler, work: (this: SchedulerAction, state?: T) => void) {\n super();\n }\n /**\n * Schedules this action on its parent {@link SchedulerLike} for execution. May be passed\n * some context object, `state`. May happen at some point in the future,\n * according to the `delay` parameter, if specified.\n * @param {T} [state] Some contextual data that the `work` function uses when\n * called by the Scheduler.\n * @param {number} [delay] Time to wait before executing the work, where the\n * time unit is implicit and defined by the Scheduler.\n * @return {void}\n */\n public schedule(state?: T, delay: number = 0): Subscription {\n return this;\n }\n}\n", "import type { TimerHandle } from './timerHandle';\ntype SetIntervalFunction = (handler: () => void, timeout?: number, ...args: any[]) => TimerHandle;\ntype ClearIntervalFunction = (handle: TimerHandle) => void;\n\ninterface IntervalProvider {\n setInterval: SetIntervalFunction;\n clearInterval: ClearIntervalFunction;\n delegate:\n | {\n setInterval: SetIntervalFunction;\n clearInterval: ClearIntervalFunction;\n }\n | undefined;\n}\n\nexport const intervalProvider: IntervalProvider = {\n // When accessing the delegate, use the variable rather than `this` so that\n // the functions can be called without being bound to the provider.\n setInterval(handler: () => void, timeout?: number, ...args) {\n const { delegate } = intervalProvider;\n if (delegate?.setInterval) {\n return delegate.setInterval(handler, timeout, ...args);\n }\n return setInterval(handler, timeout, ...args);\n },\n clearInterval(handle) {\n const { delegate } = intervalProvider;\n return (delegate?.clearInterval || clearInterval)(handle as any);\n },\n delegate: undefined,\n};\n", "import { Action } from './Action';\nimport { SchedulerAction } from '../types';\nimport { Subscription } from '../Subscription';\nimport { AsyncScheduler } from './AsyncScheduler';\nimport { intervalProvider } from './intervalProvider';\nimport { arrRemove } from '../util/arrRemove';\nimport { TimerHandle } from './timerHandle';\n\nexport class AsyncAction extends Action {\n public id: TimerHandle | undefined;\n public state?: T;\n // @ts-ignore: Property has no initializer and is not definitely assigned\n public delay: number;\n protected pending: boolean = false;\n\n constructor(protected scheduler: AsyncScheduler, protected work: (this: SchedulerAction, state?: T) => void) {\n super(scheduler, work);\n }\n\n public schedule(state?: T, delay: number = 0): Subscription {\n if (this.closed) {\n return this;\n }\n\n // Always replace the current state with the new state.\n this.state = state;\n\n const id = this.id;\n const scheduler = this.scheduler;\n\n //\n // Important implementation note:\n //\n // Actions only execute once by default, unless rescheduled from within the\n // scheduled callback. This allows us to implement single and repeat\n // actions via the same code path, without adding API surface area, as well\n // as mimic traditional recursion but across asynchronous boundaries.\n //\n // However, JS runtimes and timers distinguish between intervals achieved by\n // serial `setTimeout` calls vs. a single `setInterval` call. An interval of\n // serial `setTimeout` calls can be individually delayed, which delays\n // scheduling the next `setTimeout`, and so on. `setInterval` attempts to\n // guarantee the interval callback will be invoked more precisely to the\n // interval period, regardless of load.\n //\n // Therefore, we use `setInterval` to schedule single and repeat actions.\n // If the action reschedules itself with the same delay, the interval is not\n // canceled. If the action doesn't reschedule, or reschedules with a\n // different delay, the interval will be canceled after scheduled callback\n // execution.\n //\n if (id != null) {\n this.id = this.recycleAsyncId(scheduler, id, delay);\n }\n\n // Set the pending flag indicating that this action has been scheduled, or\n // has recursively rescheduled itself.\n this.pending = true;\n\n this.delay = delay;\n // If this action has already an async Id, don't request a new one.\n this.id = this.id ?? this.requestAsyncId(scheduler, this.id, delay);\n\n return this;\n }\n\n protected requestAsyncId(scheduler: AsyncScheduler, _id?: TimerHandle, delay: number = 0): TimerHandle {\n return intervalProvider.setInterval(scheduler.flush.bind(scheduler, this), delay);\n }\n\n protected recycleAsyncId(_scheduler: AsyncScheduler, id?: TimerHandle, delay: number | null = 0): TimerHandle | undefined {\n // If this action is rescheduled with the same delay time, don't clear the interval id.\n if (delay != null && this.delay === delay && this.pending === false) {\n return id;\n }\n // Otherwise, if the action's delay time is different from the current delay,\n // or the action has been rescheduled before it's executed, clear the interval id\n if (id != null) {\n intervalProvider.clearInterval(id);\n }\n\n return undefined;\n }\n\n /**\n * Immediately executes this action and the `work` it contains.\n * @return {any}\n */\n public execute(state: T, delay: number): any {\n if (this.closed) {\n return new Error('executing a cancelled action');\n }\n\n this.pending = false;\n const error = this._execute(state, delay);\n if (error) {\n return error;\n } else if (this.pending === false && this.id != null) {\n // Dequeue if the action didn't reschedule itself. Don't call\n // unsubscribe(), because the action could reschedule later.\n // For example:\n // ```\n // scheduler.schedule(function doWork(counter) {\n // /* ... I'm a busy worker bee ... */\n // var originalAction = this;\n // /* wait 100ms before rescheduling the action */\n // setTimeout(function () {\n // originalAction.schedule(counter + 1);\n // }, 100);\n // }, 1000);\n // ```\n this.id = this.recycleAsyncId(this.scheduler, this.id, null);\n }\n }\n\n protected _execute(state: T, _delay: number): any {\n let errored: boolean = false;\n let errorValue: any;\n try {\n this.work(state);\n } catch (e) {\n errored = true;\n // HACK: Since code elsewhere is relying on the \"truthiness\" of the\n // return here, we can't have it return \"\" or 0 or false.\n // TODO: Clean this up when we refactor schedulers mid-version-8 or so.\n errorValue = e ? e : new Error('Scheduled action threw falsy error');\n }\n if (errored) {\n this.unsubscribe();\n return errorValue;\n }\n }\n\n unsubscribe() {\n if (!this.closed) {\n const { id, scheduler } = this;\n const { actions } = scheduler;\n\n this.work = this.state = this.scheduler = null!;\n this.pending = false;\n\n arrRemove(actions, this);\n if (id != null) {\n this.id = this.recycleAsyncId(scheduler, id, null);\n }\n\n this.delay = null!;\n super.unsubscribe();\n }\n }\n}\n", "import { Action } from './scheduler/Action';\nimport { Subscription } from './Subscription';\nimport { SchedulerLike, SchedulerAction } from './types';\nimport { dateTimestampProvider } from './scheduler/dateTimestampProvider';\n\n/**\n * An execution context and a data structure to order tasks and schedule their\n * execution. Provides a notion of (potentially virtual) time, through the\n * `now()` getter method.\n *\n * Each unit of work in a Scheduler is called an `Action`.\n *\n * ```ts\n * class Scheduler {\n * now(): number;\n * schedule(work, delay?, state?): Subscription;\n * }\n * ```\n *\n * @class Scheduler\n * @deprecated Scheduler is an internal implementation detail of RxJS, and\n * should not be used directly. Rather, create your own class and implement\n * {@link SchedulerLike}. Will be made internal in v8.\n */\nexport class Scheduler implements SchedulerLike {\n public static now: () => number = dateTimestampProvider.now;\n\n constructor(private schedulerActionCtor: typeof Action, now: () => number = Scheduler.now) {\n this.now = now;\n }\n\n /**\n * A getter method that returns a number representing the current time\n * (at the time this function was called) according to the scheduler's own\n * internal clock.\n * @return {number} A number that represents the current time. May or may not\n * have a relation to wall-clock time. May or may not refer to a time unit\n * (e.g. milliseconds).\n */\n public now: () => number;\n\n /**\n * Schedules a function, `work`, for execution. May happen at some point in\n * the future, according to the `delay` parameter, if specified. May be passed\n * some context object, `state`, which will be passed to the `work` function.\n *\n * The given arguments will be processed an stored as an Action object in a\n * queue of actions.\n *\n * @param {function(state: ?T): ?Subscription} work A function representing a\n * task, or some unit of work to be executed by the Scheduler.\n * @param {number} [delay] Time to wait before executing the work, where the\n * time unit is implicit and defined by the Scheduler itself.\n * @param {T} [state] Some contextual data that the `work` function uses when\n * called by the Scheduler.\n * @return {Subscription} A subscription in order to be able to unsubscribe\n * the scheduled work.\n */\n public schedule(work: (this: SchedulerAction, state?: T) => void, delay: number = 0, state?: T): Subscription {\n return new this.schedulerActionCtor(this, work).schedule(state, delay);\n }\n}\n", "import { Scheduler } from '../Scheduler';\nimport { Action } from './Action';\nimport { AsyncAction } from './AsyncAction';\nimport { TimerHandle } from './timerHandle';\n\nexport class AsyncScheduler extends Scheduler {\n public actions: Array> = [];\n /**\n * A flag to indicate whether the Scheduler is currently executing a batch of\n * queued actions.\n * @type {boolean}\n * @internal\n */\n public _active: boolean = false;\n /**\n * An internal ID used to track the latest asynchronous task such as those\n * coming from `setTimeout`, `setInterval`, `requestAnimationFrame`, and\n * others.\n * @type {any}\n * @internal\n */\n public _scheduled: TimerHandle | undefined;\n\n constructor(SchedulerAction: typeof Action, now: () => number = Scheduler.now) {\n super(SchedulerAction, now);\n }\n\n public flush(action: AsyncAction): void {\n const { actions } = this;\n\n if (this._active) {\n actions.push(action);\n return;\n }\n\n let error: any;\n this._active = true;\n\n do {\n if ((error = action.execute(action.state, action.delay))) {\n break;\n }\n } while ((action = actions.shift()!)); // exhaust the scheduler queue\n\n this._active = false;\n\n if (error) {\n while ((action = actions.shift()!)) {\n action.unsubscribe();\n }\n throw error;\n }\n }\n}\n", "import { AsyncAction } from './AsyncAction';\nimport { AsyncScheduler } from './AsyncScheduler';\n\n/**\n *\n * Async Scheduler\n *\n * Schedule task as if you used setTimeout(task, duration)\n *\n * `async` scheduler schedules tasks asynchronously, by putting them on the JavaScript\n * event loop queue. It is best used to delay tasks in time or to schedule tasks repeating\n * in intervals.\n *\n * If you just want to \"defer\" task, that is to perform it right after currently\n * executing synchronous code ends (commonly achieved by `setTimeout(deferredTask, 0)`),\n * better choice will be the {@link asapScheduler} scheduler.\n *\n * ## Examples\n * Use async scheduler to delay task\n * ```ts\n * import { asyncScheduler } from 'rxjs';\n *\n * const task = () => console.log('it works!');\n *\n * asyncScheduler.schedule(task, 2000);\n *\n * // After 2 seconds logs:\n * // \"it works!\"\n * ```\n *\n * Use async scheduler to repeat task in intervals\n * ```ts\n * import { asyncScheduler } from 'rxjs';\n *\n * function task(state) {\n * console.log(state);\n * this.schedule(state + 1, 1000); // `this` references currently executing Action,\n * // which we reschedule with new state and delay\n * }\n *\n * asyncScheduler.schedule(task, 3000, 0);\n *\n * // Logs:\n * // 0 after 3s\n * // 1 after 4s\n * // 2 after 5s\n * // 3 after 6s\n * ```\n */\n\nexport const asyncScheduler = new AsyncScheduler(AsyncAction);\n\n/**\n * @deprecated Renamed to {@link asyncScheduler}. Will be removed in v8.\n */\nexport const async = asyncScheduler;\n", "import { AsyncAction } from './AsyncAction';\nimport { Subscription } from '../Subscription';\nimport { QueueScheduler } from './QueueScheduler';\nimport { SchedulerAction } from '../types';\nimport { TimerHandle } from './timerHandle';\n\nexport class QueueAction extends AsyncAction {\n constructor(protected scheduler: QueueScheduler, protected work: (this: SchedulerAction, state?: T) => void) {\n super(scheduler, work);\n }\n\n public schedule(state?: T, delay: number = 0): Subscription {\n if (delay > 0) {\n return super.schedule(state, delay);\n }\n this.delay = delay;\n this.state = state;\n this.scheduler.flush(this);\n return this;\n }\n\n public execute(state: T, delay: number): any {\n return delay > 0 || this.closed ? super.execute(state, delay) : this._execute(state, delay);\n }\n\n protected requestAsyncId(scheduler: QueueScheduler, id?: TimerHandle, delay: number = 0): TimerHandle {\n // If delay exists and is greater than 0, or if the delay is null (the\n // action wasn't rescheduled) but was originally scheduled as an async\n // action, then recycle as an async action.\n\n if ((delay != null && delay > 0) || (delay == null && this.delay > 0)) {\n return super.requestAsyncId(scheduler, id, delay);\n }\n\n // Otherwise flush the scheduler starting with this action.\n scheduler.flush(this);\n\n // HACK: In the past, this was returning `void`. However, `void` isn't a valid\n // `TimerHandle`, and generally the return value here isn't really used. So the\n // compromise is to return `0` which is both \"falsy\" and a valid `TimerHandle`,\n // as opposed to refactoring every other instanceo of `requestAsyncId`.\n return 0;\n }\n}\n", "import { AsyncScheduler } from './AsyncScheduler';\n\nexport class QueueScheduler extends AsyncScheduler {\n}\n", "import { QueueAction } from './QueueAction';\nimport { QueueScheduler } from './QueueScheduler';\n\n/**\n *\n * Queue Scheduler\n *\n * Put every next task on a queue, instead of executing it immediately\n *\n * `queue` scheduler, when used with delay, behaves the same as {@link asyncScheduler} scheduler.\n *\n * When used without delay, it schedules given task synchronously - executes it right when\n * it is scheduled. However when called recursively, that is when inside the scheduled task,\n * another task is scheduled with queue scheduler, instead of executing immediately as well,\n * that task will be put on a queue and wait for current one to finish.\n *\n * This means that when you execute task with `queue` scheduler, you are sure it will end\n * before any other task scheduled with that scheduler will start.\n *\n * ## Examples\n * Schedule recursively first, then do something\n * ```ts\n * import { queueScheduler } from 'rxjs';\n *\n * queueScheduler.schedule(() => {\n * queueScheduler.schedule(() => console.log('second')); // will not happen now, but will be put on a queue\n *\n * console.log('first');\n * });\n *\n * // Logs:\n * // \"first\"\n * // \"second\"\n * ```\n *\n * Reschedule itself recursively\n * ```ts\n * import { queueScheduler } from 'rxjs';\n *\n * queueScheduler.schedule(function(state) {\n * if (state !== 0) {\n * console.log('before', state);\n * this.schedule(state - 1); // `this` references currently executing Action,\n * // which we reschedule with new state\n * console.log('after', state);\n * }\n * }, 0, 3);\n *\n * // In scheduler that runs recursively, you would expect:\n * // \"before\", 3\n * // \"before\", 2\n * // \"before\", 1\n * // \"after\", 1\n * // \"after\", 2\n * // \"after\", 3\n *\n * // But with queue it logs:\n * // \"before\", 3\n * // \"after\", 3\n * // \"before\", 2\n * // \"after\", 2\n * // \"before\", 1\n * // \"after\", 1\n * ```\n */\n\nexport const queueScheduler = new QueueScheduler(QueueAction);\n\n/**\n * @deprecated Renamed to {@link queueScheduler}. Will be removed in v8.\n */\nexport const queue = queueScheduler;\n", "import { AsyncAction } from './AsyncAction';\nimport { AnimationFrameScheduler } from './AnimationFrameScheduler';\nimport { SchedulerAction } from '../types';\nimport { animationFrameProvider } from './animationFrameProvider';\nimport { TimerHandle } from './timerHandle';\n\nexport class AnimationFrameAction extends AsyncAction {\n constructor(protected scheduler: AnimationFrameScheduler, protected work: (this: SchedulerAction, state?: T) => void) {\n super(scheduler, work);\n }\n\n protected requestAsyncId(scheduler: AnimationFrameScheduler, id?: TimerHandle, delay: number = 0): TimerHandle {\n // If delay is greater than 0, request as an async action.\n if (delay !== null && delay > 0) {\n return super.requestAsyncId(scheduler, id, delay);\n }\n // Push the action to the end of the scheduler queue.\n scheduler.actions.push(this);\n // If an animation frame has already been requested, don't request another\n // one. If an animation frame hasn't been requested yet, request one. Return\n // the current animation frame request id.\n return scheduler._scheduled || (scheduler._scheduled = animationFrameProvider.requestAnimationFrame(() => scheduler.flush(undefined)));\n }\n\n protected recycleAsyncId(scheduler: AnimationFrameScheduler, id?: TimerHandle, delay: number = 0): TimerHandle | undefined {\n // If delay exists and is greater than 0, or if the delay is null (the\n // action wasn't rescheduled) but was originally scheduled as an async\n // action, then recycle as an async action.\n if (delay != null ? delay > 0 : this.delay > 0) {\n return super.recycleAsyncId(scheduler, id, delay);\n }\n // If the scheduler queue has no remaining actions with the same async id,\n // cancel the requested animation frame and set the scheduled flag to\n // undefined so the next AnimationFrameAction will request its own.\n const { actions } = scheduler;\n if (id != null && actions[actions.length - 1]?.id !== id) {\n animationFrameProvider.cancelAnimationFrame(id as number);\n scheduler._scheduled = undefined;\n }\n // Return undefined so the action knows to request a new async id if it's rescheduled.\n return undefined;\n }\n}\n", "import { AsyncAction } from './AsyncAction';\nimport { AsyncScheduler } from './AsyncScheduler';\n\nexport class AnimationFrameScheduler extends AsyncScheduler {\n public flush(action?: AsyncAction): void {\n this._active = true;\n // The async id that effects a call to flush is stored in _scheduled.\n // Before executing an action, it's necessary to check the action's async\n // id to determine whether it's supposed to be executed in the current\n // flush.\n // Previous implementations of this method used a count to determine this,\n // but that was unsound, as actions that are unsubscribed - i.e. cancelled -\n // are removed from the actions array and that can shift actions that are\n // scheduled to be executed in a subsequent flush into positions at which\n // they are executed within the current flush.\n const flushId = this._scheduled;\n this._scheduled = undefined;\n\n const { actions } = this;\n let error: any;\n action = action || actions.shift()!;\n\n do {\n if ((error = action.execute(action.state, action.delay))) {\n break;\n }\n } while ((action = actions[0]) && action.id === flushId && actions.shift());\n\n this._active = false;\n\n if (error) {\n while ((action = actions[0]) && action.id === flushId && actions.shift()) {\n action.unsubscribe();\n }\n throw error;\n }\n }\n}\n", "import { AnimationFrameAction } from './AnimationFrameAction';\nimport { AnimationFrameScheduler } from './AnimationFrameScheduler';\n\n/**\n *\n * Animation Frame Scheduler\n *\n * Perform task when `window.requestAnimationFrame` would fire\n *\n * When `animationFrame` scheduler is used with delay, it will fall back to {@link asyncScheduler} scheduler\n * behaviour.\n *\n * Without delay, `animationFrame` scheduler can be used to create smooth browser animations.\n * It makes sure scheduled task will happen just before next browser content repaint,\n * thus performing animations as efficiently as possible.\n *\n * ## Example\n * Schedule div height animation\n * ```ts\n * // html:
\n * import { animationFrameScheduler } from 'rxjs';\n *\n * const div = document.querySelector('div');\n *\n * animationFrameScheduler.schedule(function(height) {\n * div.style.height = height + \"px\";\n *\n * this.schedule(height + 1); // `this` references currently executing Action,\n * // which we reschedule with new state\n * }, 0, 0);\n *\n * // You will see a div element growing in height\n * ```\n */\n\nexport const animationFrameScheduler = new AnimationFrameScheduler(AnimationFrameAction);\n\n/**\n * @deprecated Renamed to {@link animationFrameScheduler}. Will be removed in v8.\n */\nexport const animationFrame = animationFrameScheduler;\n", "import { Observable } from '../Observable';\nimport { SchedulerLike } from '../types';\n\n/**\n * A simple Observable that emits no items to the Observer and immediately\n * emits a complete notification.\n *\n * Just emits 'complete', and nothing else.\n *\n * ![](empty.png)\n *\n * A simple Observable that only emits the complete notification. It can be used\n * for composing with other Observables, such as in a {@link mergeMap}.\n *\n * ## Examples\n *\n * Log complete notification\n *\n * ```ts\n * import { EMPTY } from 'rxjs';\n *\n * EMPTY.subscribe({\n * next: () => console.log('Next'),\n * complete: () => console.log('Complete!')\n * });\n *\n * // Outputs\n * // Complete!\n * ```\n *\n * Emit the number 7, then complete\n *\n * ```ts\n * import { EMPTY, startWith } from 'rxjs';\n *\n * const result = EMPTY.pipe(startWith(7));\n * result.subscribe(x => console.log(x));\n *\n * // Outputs\n * // 7\n * ```\n *\n * Map and flatten only odd numbers to the sequence `'a'`, `'b'`, `'c'`\n *\n * ```ts\n * import { interval, mergeMap, of, EMPTY } from 'rxjs';\n *\n * const interval$ = interval(1000);\n * const result = interval$.pipe(\n * mergeMap(x => x % 2 === 1 ? of('a', 'b', 'c') : EMPTY),\n * );\n * result.subscribe(x => console.log(x));\n *\n * // Results in the following to the console:\n * // x is equal to the count on the interval, e.g. (0, 1, 2, 3, ...)\n * // x will occur every 1000ms\n * // if x % 2 is equal to 1, print a, b, c (each on its own)\n * // if x % 2 is not equal to 1, nothing will be output\n * ```\n *\n * @see {@link Observable}\n * @see {@link NEVER}\n * @see {@link of}\n * @see {@link throwError}\n */\nexport const EMPTY = new Observable((subscriber) => subscriber.complete());\n\n/**\n * @param scheduler A {@link SchedulerLike} to use for scheduling\n * the emission of the complete notification.\n * @deprecated Replaced with the {@link EMPTY} constant or {@link scheduled} (e.g. `scheduled([], scheduler)`). Will be removed in v8.\n */\nexport function empty(scheduler?: SchedulerLike) {\n return scheduler ? emptyScheduled(scheduler) : EMPTY;\n}\n\nfunction emptyScheduled(scheduler: SchedulerLike) {\n return new Observable((subscriber) => scheduler.schedule(() => subscriber.complete()));\n}\n", "import { SchedulerLike } from '../types';\nimport { isFunction } from './isFunction';\n\nexport function isScheduler(value: any): value is SchedulerLike {\n return value && isFunction(value.schedule);\n}\n", "import { SchedulerLike } from '../types';\nimport { isFunction } from './isFunction';\nimport { isScheduler } from './isScheduler';\n\nfunction last(arr: T[]): T | undefined {\n return arr[arr.length - 1];\n}\n\nexport function popResultSelector(args: any[]): ((...args: unknown[]) => unknown) | undefined {\n return isFunction(last(args)) ? args.pop() : undefined;\n}\n\nexport function popScheduler(args: any[]): SchedulerLike | undefined {\n return isScheduler(last(args)) ? args.pop() : undefined;\n}\n\nexport function popNumber(args: any[], defaultValue: number): number {\n return typeof last(args) === 'number' ? args.pop()! : defaultValue;\n}\n", "export const isArrayLike = ((x: any): x is ArrayLike => x && typeof x.length === 'number' && typeof x !== 'function');", "import { isFunction } from \"./isFunction\";\n\n/**\n * Tests to see if the object is \"thennable\".\n * @param value the object to test\n */\nexport function isPromise(value: any): value is PromiseLike {\n return isFunction(value?.then);\n}\n", "import { InteropObservable } from '../types';\nimport { observable as Symbol_observable } from '../symbol/observable';\nimport { isFunction } from './isFunction';\n\n/** Identifies an input as being Observable (but not necessary an Rx Observable) */\nexport function isInteropObservable(input: any): input is InteropObservable {\n return isFunction(input[Symbol_observable]);\n}\n", "import { isFunction } from './isFunction';\n\nexport function isAsyncIterable(obj: any): obj is AsyncIterable {\n return Symbol.asyncIterator && isFunction(obj?.[Symbol.asyncIterator]);\n}\n", "/**\n * Creates the TypeError to throw if an invalid object is passed to `from` or `scheduled`.\n * @param input The object that was passed.\n */\nexport function createInvalidObservableTypeError(input: any) {\n // TODO: We should create error codes that can be looked up, so this can be less verbose.\n return new TypeError(\n `You provided ${\n input !== null && typeof input === 'object' ? 'an invalid object' : `'${input}'`\n } where a stream was expected. You can provide an Observable, Promise, ReadableStream, Array, AsyncIterable, or Iterable.`\n );\n}\n", "export function getSymbolIterator(): symbol {\n if (typeof Symbol !== 'function' || !Symbol.iterator) {\n return '@@iterator' as any;\n }\n\n return Symbol.iterator;\n}\n\nexport const iterator = getSymbolIterator();\n", "import { iterator as Symbol_iterator } from '../symbol/iterator';\nimport { isFunction } from './isFunction';\n\n/** Identifies an input as being an Iterable */\nexport function isIterable(input: any): input is Iterable {\n return isFunction(input?.[Symbol_iterator]);\n}\n", "import { ReadableStreamLike } from '../types';\nimport { isFunction } from './isFunction';\n\nexport async function* readableStreamLikeToAsyncGenerator(readableStream: ReadableStreamLike): AsyncGenerator {\n const reader = readableStream.getReader();\n try {\n while (true) {\n const { value, done } = await reader.read();\n if (done) {\n return;\n }\n yield value!;\n }\n } finally {\n reader.releaseLock();\n }\n}\n\nexport function isReadableStreamLike(obj: any): obj is ReadableStreamLike {\n // We don't want to use instanceof checks because they would return\n // false for instances from another Realm, like an