.. _module-splice-schedule-45837:

Splice.Schedule
===============

Data Types
----------

.. _type-splice-schedule-schedule-35504:

**data** `Schedule <type-splice-schedule-schedule-35504_>`_ t a

  A schedule of values that change over time\.

  .. _constr-splice-schedule-schedule-12101:

  `Schedule <constr-splice-schedule-schedule-12101_>`_

    .. list-table::
       :widths: 15 10 30
       :header-rows: 1

       * - Field
         - Type
         - Description
       * - initialValue
         - a
         - Initial value to use until the future values come into effect\.
       * - futureValues
         - \[(t, a)\]
         - sorted in ascending order

  **instance** `Functor <https://docs.daml.com/daml/stdlib/Prelude.html#class-ghc-base-functor-31205>`_ (`Schedule <type-splice-schedule-schedule-35504_>`_ t)

  **instance** (`Eq <https://docs.daml.com/daml/stdlib/Prelude.html#class-ghc-classes-eq-22713>`_ a, `Eq <https://docs.daml.com/daml/stdlib/Prelude.html#class-ghc-classes-eq-22713>`_ t) \=\> `Eq <https://docs.daml.com/daml/stdlib/Prelude.html#class-ghc-classes-eq-22713>`_ (`Schedule <type-splice-schedule-schedule-35504_>`_ t a)

  **instance** (`Show <https://docs.daml.com/daml/stdlib/Prelude.html#class-ghc-show-show-65360>`_ a, `Show <https://docs.daml.com/daml/stdlib/Prelude.html#class-ghc-show-show-65360>`_ t) \=\> `Show <https://docs.daml.com/daml/stdlib/Prelude.html#class-ghc-show-show-65360>`_ (`Schedule <type-splice-schedule-schedule-35504_>`_ t a)

  **instance** `GetField <https://docs.daml.com/daml/stdlib/DA-Record.html#class-da-internal-record-getfield-53979>`_ \"configSchedule\" :ref:`AmuletRules <type-splice-amuletrules-amuletrules-32426>` (`Schedule <type-splice-schedule-schedule-35504_>`_ `Time <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-time-63886>`_ (:ref:`AmuletConfig <type-splice-amuletconfig-amuletconfig-37414>` :ref:`USD <type-splice-amuletconfig-usd-42527>`))

  **instance** `GetField <https://docs.daml.com/daml/stdlib/DA-Record.html#class-da-internal-record-getfield-53979>`_ \"futureValues\" (`Schedule <type-splice-schedule-schedule-35504_>`_ t a) \[(t, a)\]

  **instance** `GetField <https://docs.daml.com/daml/stdlib/DA-Record.html#class-da-internal-record-getfield-53979>`_ \"initialValue\" (`Schedule <type-splice-schedule-schedule-35504_>`_ t a) a

  **instance** `GetField <https://docs.daml.com/daml/stdlib/DA-Record.html#class-da-internal-record-getfield-53979>`_ \"issuanceCurve\" (:ref:`AmuletConfig <type-splice-amuletconfig-amuletconfig-37414>` unit) (`Schedule <type-splice-schedule-schedule-35504_>`_ `RelTime <https://docs.daml.com/daml/stdlib/DA-Time.html#type-da-time-types-reltime-23082>`_ :ref:`IssuanceConfig <type-splice-issuance-issuanceconfig-93012>`)

  **instance** `SetField <https://docs.daml.com/daml/stdlib/DA-Record.html#class-da-internal-record-setfield-4311>`_ \"configSchedule\" :ref:`AmuletRules <type-splice-amuletrules-amuletrules-32426>` (`Schedule <type-splice-schedule-schedule-35504_>`_ `Time <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-time-63886>`_ (:ref:`AmuletConfig <type-splice-amuletconfig-amuletconfig-37414>` :ref:`USD <type-splice-amuletconfig-usd-42527>`))

  **instance** `SetField <https://docs.daml.com/daml/stdlib/DA-Record.html#class-da-internal-record-setfield-4311>`_ \"futureValues\" (`Schedule <type-splice-schedule-schedule-35504_>`_ t a) \[(t, a)\]

  **instance** `SetField <https://docs.daml.com/daml/stdlib/DA-Record.html#class-da-internal-record-setfield-4311>`_ \"initialValue\" (`Schedule <type-splice-schedule-schedule-35504_>`_ t a) a

  **instance** `SetField <https://docs.daml.com/daml/stdlib/DA-Record.html#class-da-internal-record-setfield-4311>`_ \"issuanceCurve\" (:ref:`AmuletConfig <type-splice-amuletconfig-amuletconfig-37414>` unit) (`Schedule <type-splice-schedule-schedule-35504_>`_ `RelTime <https://docs.daml.com/daml/stdlib/DA-Time.html#type-da-time-types-reltime-23082>`_ :ref:`IssuanceConfig <type-splice-issuance-issuanceconfig-93012>`)

Functions
---------

.. _function-splice-schedule-getvalueasof-1611:

`getValueAsOf <function-splice-schedule-getvalueasof-1611_>`_
  \: `Ord <https://docs.daml.com/daml/stdlib/Prelude.html#class-ghc-classes-ord-6395>`_ t \=\> t \-\> `Schedule <type-splice-schedule-schedule-35504_>`_ t a \-\> a

  Get the value as of a specific time

.. _function-splice-schedule-validschedule-3679:

`validSchedule <function-splice-schedule-validschedule-3679_>`_
  \: `Ord <https://docs.daml.com/daml/stdlib/Prelude.html#class-ghc-classes-ord-6395>`_ t \=\> `Schedule <type-splice-schedule-schedule-35504_>`_ t a \-\> (a \-\> `Bool <https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-bool-66265>`_) \-\> `Bool <https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-bool-66265>`_

  Check the validity of a schedule given a function to check the validity of its values

.. _function-splice-schedule-allvalues-28049:

`allValues <function-splice-schedule-allvalues-28049_>`_
  \: `Schedule <type-splice-schedule-schedule-35504_>`_ t a \-\> \[a\]

.. _function-splice-schedule-nextchangescheduledat-43849:

`nextChangeScheduledAt <function-splice-schedule-nextchangescheduledat-43849_>`_
  \: `Schedule <type-splice-schedule-schedule-35504_>`_ t a \-\> `Optional <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-prelude-optional-37153>`_ t

.. _function-splice-schedule-prune-18462:

`prune <function-splice-schedule-prune-18462_>`_
  \: `Ord <https://docs.daml.com/daml/stdlib/Prelude.html#class-ghc-classes-ord-6395>`_ t \=\> t \-\> `Schedule <type-splice-schedule-schedule-35504_>`_ t a \-\> `Schedule <type-splice-schedule-schedule-35504_>`_ t a

.. _function-splice-schedule-splitattime-35540:

`splitAtTime <function-splice-schedule-splitattime-35540_>`_
  \: `Ord <https://docs.daml.com/daml/stdlib/Prelude.html#class-ghc-classes-ord-6395>`_ t \=\> \[(t, a)\] \-\> t \-\> (\[(t, a)\], `Optional <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-prelude-optional-37153>`_ (t, a), \[(t, a)\])

.. _function-splice-schedule-insert-53714:

`insert <function-splice-schedule-insert-53714_>`_
  \: `Ord <https://docs.daml.com/daml/stdlib/Prelude.html#class-ghc-classes-ord-6395>`_ t \=\> (t, a) \-\> `Schedule <type-splice-schedule-schedule-35504_>`_ t a \-\> `Schedule <type-splice-schedule-schedule-35504_>`_ t a

.. _function-splice-schedule-remove-70441:

`remove <function-splice-schedule-remove-70441_>`_
  \: `Ord <https://docs.daml.com/daml/stdlib/Prelude.html#class-ghc-classes-ord-6395>`_ t \=\> t \-\> `Schedule <type-splice-schedule-schedule-35504_>`_ t a \-\> `Schedule <type-splice-schedule-schedule-35504_>`_ t a

.. _function-splice-schedule-update-39134:

`update <function-splice-schedule-update-39134_>`_
  \: `Ord <https://docs.daml.com/daml/stdlib/Prelude.html#class-ghc-classes-ord-6395>`_ t \=\> (t, a) \-\> `Schedule <type-splice-schedule-schedule-35504_>`_ t a \-\> `Schedule <type-splice-schedule-schedule-35504_>`_ t a