Class Real

A real number profile; a function from time to real numbers.

Most real profiles are piecewise-linear, but some can be piecewise-constant if the underlying datatype is an integer. More general function types are currently unsupported.

Hierarchy

  • Real

Methods

assignGaps changes equal greaterThan greaterThanOrEqual isWithin lessThan lessThanOrEqual minus negate notEqual plus rate shiftBy times valueAt Resource Value

Methods

assignGaps

  • Replaces all gaps in this profile with default segments taken from the argument

    Parameters

    • defaultProfile: number | Real

      number or real profile to take default values from.

    Returns Real

changes

  • Produce an instantaneous window whenever this profile changes.

    Returns Windows

equal

  • Produce a window whenever this profile is equal to another real profile.

    Parameters

    • other: number | Real

    Returns Windows

greaterThan

  • Produce a window whenever this profile is greater than to another real profile.

    Parameters

    • other: number | Real

    Returns Windows

greaterThanOrEqual

  • Produce a window whenever this profile is greater than or equal to another real profile.

    Parameters

    • other: number | Real

    Returns Windows

isWithin

  • Produce a window whenever this profile is equal to another real profile plus or minus the tolerance

    Parameters

    • other: number | Real
    • tolerance: number | Real

    Returns Windows

lessThan

  • Produce a window whenever this profile is less than another real profile.

    Parameters

    • other: number | Real

    Returns Windows

lessThanOrEqual

  • Produce a window whenever this profile is less than or equal to another real profile.

    Parameters

    • other: number | Real

    Returns Windows

minus

  • Create a real profile by subtracting another real profile from this.

    Parameters

    • other: number | Real

    Returns Real

negate

  • Create a real profile where all segments are negated.

    Returns Real

notEqual

  • Produce a window whenever this profile is not equal to another real profile.

    Parameters

    • other: number | Real

    Returns Windows

plus

  • Create a real profile by adding this and another real profile together.

    Parameters

    • other: number | Real

    Returns Real

rate

  • Create a real profile from this profile's derivative.

    Returns Real

shiftBy

  • Shifts the profile forward or backward in time.

    Parameters

    • duration: Duration

      duration shift each segment (can be negative)

    Returns Real

times

  • Create a real profile by multiplying this profile by a constant

    Parameters

    • multiplier: number

    Returns Real

valueAt

  • Will use the start of the first span in the spans

    Parameters

    Returns Discrete<number>

Static Resource

  • Reference the real profile associated with a resource.

    Parameters

    • name: "my real resource"

    Returns Real

Static Value

  • Create a constant real profile.

    Parameters

    • value: number
    • Optional rate: number
    • Optional interval: Interval

    Returns Real

Settings

Member Visibility

Theme

Generated using TypeDoc