BACnet.Protocol.PriorityArray (bacstack v0.0.1)

Summary

Types

t()

Base type for the BACnet Priority Array.

t(subtype)

Represents the BACnet Priority Array with 16 priorities. The lowest priority number has the highest priority.

Functions

fetch(array, key)

Fetches the value for a specific key in the given array.

from_array(array)

Create a Priority Array from a BACnetArray.

from_list(list)

Create a Priority Array from a list (or any other enumerable).

get_and_update(array, key, fun)

Gets the value from key and updates it, all in one pass.

get_value(array)

Get the highest active priority value. If none is active, nil is returned.

pop(array, key)

Resets the value associated with key in array to nil and returns the value and the updated array.

to_array(array)

Create a BACnetArray from a Priority Array.

to_list(array)

Create a list from a Priority Array.

valid?(t, type \\ :any)

Validates whether the given priority array is in form valid.

Types

t()

@type t() :: t(term())

Base type for the BACnet Priority Array.

t(subtype)

@type t(subtype) :: %BACnet.Protocol.PriorityArray{
  priority_1: subtype | nil,
  priority_10: subtype | nil,
  priority_11: subtype | nil,
  priority_12: subtype | nil,
  priority_13: subtype | nil,
  priority_14: subtype | nil,
  priority_15: subtype | nil,
  priority_16: subtype | nil,
  priority_2: subtype | nil,
  priority_3: subtype | nil,
  priority_4: subtype | nil,
  priority_5: subtype | nil,
  priority_6: subtype | nil,
  priority_7: subtype | nil,
  priority_8: subtype | nil,
  priority_9: subtype | nil
}

Represents the BACnet Priority Array with 16 priorities. The lowest priority number has the highest priority.

If a priority is nil, the priority is unset.

Functions

fetch(array, key)

@spec fetch(t(subtype), 1..16 | atom()) :: {:ok, subtype | nil} when subtype: var

Fetches the value for a specific key in the given array.

key is the priority number or the struct field name.

This function is implemented for the Access behaviour and allows to access the fields using the priority number (or the atom key).

This function will raise for an invalid atom key.

from_array(array)

@spec from_array(BACnet.Protocol.BACnetArray.t(subtype)) :: t(subtype)

Create a Priority Array from a BACnetArray.

The types of the array values are not checked. However, they should all be the same. The size of the array must be 16 or smaller (lower priorities will be nil).

from_list(list)

@spec from_list(Enumerable.t(subtype)) :: t(subtype)

Create a Priority Array from a list (or any other enumerable).

The types of the list values are not checked. However, they should all be the same. The length of the list must be 16 or smaller (lower priorities will be nil).

When using a key-value based enumerable, if the key is a priority number, then it will be used as such.

get_and_update(array, key, fun)

@spec get_and_update(
  t(subtype),
  1..16 | atom(),
  (subtype | nil ->
     {current_value :: subtype | nil, new_value :: subtype | nil} | :pop)
) :: {current_value :: subtype | nil, new_struct :: t(subtype)}
when subtype: var

Gets the value from key and updates it, all in one pass.

key is the priority number or the struct field name.

fun is called with the current value under key in array and must return a two-element tuple: the current value (the retrieved value, which can be operated on before being returned) and the new value to be stored under key in the resulting new array. fun may also return :pop, which means the current value will be set to nil.

This function is implemented for the Access behaviour.

get_value(array)

@spec get_value(t(subtype)) :: {priority :: 1..16, value :: subtype} | nil

Get the highest active priority value. If none is active, nil is returned.

pop(array, key)

@spec pop(t(subtype), 1..16 | atom()) ::
  {value :: subtype | nil, updated_array :: t(subtype)}

Resets the value associated with key in array to nil and returns the value and the updated array.

key is the priority number or the struct field name.

It returns {value, updated_array} where value is the value of the key and updated_map is the result of setting key to nil.

This function is implemented for the Access behaviour.

to_array(array)

@spec to_array(t(subtype)) :: BACnet.Protocol.BACnetArray.t(subtype | nil)

Create a BACnetArray from a Priority Array.

to_list(array)

@spec to_list(t(subtype)) :: [subtype | nil] when subtype: var

Create a list from a Priority Array.

valid?(t, type \\ :any)

@spec valid?(t(), BACnet.Internal.typechecker_types()) :: boolean()

Validates whether the given priority array is in form valid.

It only validates the struct is valid as per type specification.

Optionally, a type can be given to be verified, so that each priority is either nil or of that type (see Internal.check_type/2).