automata

v0.1.0

automata v0.1.0 Automaton.Types.BT.Behavior behaviour

An Automaton.Types.BT.Behavior is an abstract interface for composites and components that can be activated, run, and deactivated. Actions(Execution Nodes) provide specific implementations of this interface. Branches in the tree can be thought of as high level behaviors, heirarchically combining smaller behaviors to provide more complex and interesting behaviors.

Note: there is a bunch of placeholder stuff in here right now and needs thought and cleanup. The specs for the callbacks are not accurate, just needed something that compiled and ran. Needs more thought and attention as the design process continues.

Link to this section Summary

Types

status()

All nodes start with a statuses of :bh_fresh. A BT node can be in one of five statuses

Callbacks

abort()
aborted?()
on_init(term)
on_terminate(term)
reset()
running?()
status()
terminated?()
update(any)

Link to this section Types

Link to this type

status()

Specs

status() :: :bh_aborted | :bh_failure | :bh_fresh | :bh_running | :bh_success

All nodes start with a statuses of :bh_fresh. A BT node can be in one of five statuses:

  1. :bh_fresh (when never run, or when reset)
  2. :bh_running (when running an async user action)
  3. :bh_failure
  4. :bh_success
  5. :bh_aborted (when aborted due to exits & exceptions)

Link to this section Callbacks

Link to this callback

abort()

Specs

abort() :: atom()
Link to this callback

aborted?()

Specs

aborted?() :: bool() | nil
Link to this callback

on_init(term)

Specs

on_init(term()) :: term() | {:error, String.t()}
Link to this callback

on_terminate(term)

Specs

on_terminate(term()) :: status()
Link to this callback

reset()

Specs

reset() :: atom()
Link to this callback

running?()

Specs

running?() :: bool() | nil
Link to this callback

status()

Specs

status() :: status()
Link to this callback

terminated?()

Specs

terminated?() :: bool() | nil
Link to this callback

update(any)

Specs

update(any()) :: {:ok, Module.t()}