View Source WeatherForecast (Vela v1.1.0)

The example of Vela implementation, demontrating the real-life module using Vela for timeseries control.

The full code of this file follows.

defmodule WeatherForecast do
  alias WeatherForecast, as: Me
  use Vela,
    __globals__: [validator: Me],
    tomorrow: [limit: 5, errors: 1],
    two_days: [limit: 3],
    week: [limit: 2, sorter: &Me.sort/2]

  @behaviour Vela.Validator

  @impl Vela.Validator
  def valid?(_serie, value), do: value > 0

  @doc "Sort function to be used as `:sorter` in series"
  def sort(v1, v2), do: v1 <= v2
end

Summary

Types

serie_slice()

The possibly type of members of the result of call to Vela.slice/1

slice()

The result of call to Vela.slice/1

t()

The type of this particular Vela implementation

Functions

average(vela, averager)

Implementation of Vela.average/2.

delta(vela, comparator \\ nil)

Implementation of Vela.delta/2.

empty!(vela)

Empties the Vela given as an argument, preserving all the internal information (__meta__, __errors__ etc.)

empty?(vela)

Returns true if there are no values in all series, false otherwise. More performant implementation of slice(vela) == [].

equal?(v1, v2)

Implementation of Vela.equal?/2.

merge(v1, v2, resolver)

Merges two Velas, using resolver/3 given as the third argument in a case of ambiguity.

purge(vela, validator \\ nil)

Implementation of Vela.purge/2.

series()

Returns the list of series declared on WeatherForecast

slice(vela)

Implementation of Vela.slice/1.

sort(v1, v2)

Sort function to be used as :sorter in series

state(vela)

Returns the initial state of WeatherForecast, custom options etc

update_state(vela, fun)

Updates the internal state of WeatherForecast

vela_config()

Returns the config WeatherForecast was declared with

Types

serie_slice()

@type serie_slice() ::
  {:tomorrow, [Vela.value()]}
  | {:two_days, [Vela.value()]}
  | {:week, [Vela.value()]}

The possibly type of members of the result of call to Vela.slice/1

slice()

@type slice() :: [serie_slice()]

The result of call to Vela.slice/1

t()

@type t() :: %WeatherForecast{
  __errors__: [Vela.kv()],
  __meta__: Access.t(),
  tomorrow: [Vela.value()],
  two_days: [Vela.value()],
  week: [Vela.value()]
}

The type of this particular Vela implementation

Functions

average(vela, averager)

Implementation of Vela.average/2.

Returns a slice of all series as keyword() in format {Vela.serie(), Vela.value()}, when the value is a calculated average of all serie values.

The second parameter might be either a function of arity 1, accepting a serie (a list of values), or a module, exporting average/1 function.

The result is similar to what slice/1 returns, but with average values.

delta(vela, comparator \\ nil)

Implementation of Vela.delta/2.

Delegates to Vela.δ/2.

empty!(vela)

Empties the Vela given as an argument, preserving all the internal information (__meta__, __errors__ etc.)

See: Vela.empty!/1.

empty?(vela)

Returns true if there are no values in all series, false otherwise. More performant implementation of slice(vela) == [].

See: Vela.empty?/1.

equal?(v1, v2)

Implementation of Vela.equal?/2.

Delegates to Vela.equal?/2.

merge(v1, v2, resolver)

Merges two Velas, using resolver/3 given as the third argument in a case of ambiguity.

See: Vela.merge/3.

purge(vela, validator \\ nil)

Implementation of Vela.purge/2.

Purges values which are not passing validator given as a second parameter.

series()

Returns the list of series declared on WeatherForecast

slice(vela)

Implementation of Vela.slice/1.

Returns a slice of all series as keyword() in format {Vela.serie(), Vela.value()}, if the series has no values, it’s not included into result.

sort(v1, v2)

Sort function to be used as :sorter in series

state(vela)

@spec state(Vela.t()) :: Vela.state()

Returns the initial state of WeatherForecast, custom options etc

update_state(vela, fun)

@spec update_state(Vela.t(), (Vela.state() -> Vela.state())) :: Vela.t()

Updates the internal state of WeatherForecast

vela_config()

@spec vela_config() :: [{atom(), Vela.options()}]

Returns the config WeatherForecast was declared with