MarsExplorer.ExplorationsController (SWAP - Mars Explorer v0.1.0) View Source

Module responsible for managing multiple explorations state

Link to this section Summary

Functions

Add a exploration to the concluded explorations list

Returns a specification to start this module under a supervisor.

Cleans the concluded explorations list

Get the concluded explorations list

Get the explorations grid

Get the running exploration

Set the explorations grid

Set the running exploration

Updates the running exploration

Link to this section Functions

Link to this function

add_exploration_to_explorations_list(exploration)

View Source

Specs

add_exploration_to_explorations_list(MarsExplorer.Exploration.t()) :: :ok

Add a exploration to the concluded explorations list

Returns a specification to start this module under a supervisor.

See Supervisor.

Cleans the concluded explorations list

Specs

get_explorations() :: [MarsExplorer.Exploration.t()]

Get the concluded explorations list

Specs

get_grid() :: MarsExplorer.HighlandGrid.t()

Get the explorations grid

Link to this function

get_running_exploration()

View Source

Specs

get_running_exploration() :: MarsExplorer.Exploration.t()

Get the running exploration

Specs

set_grid(MarsExplorer.HighlandGrid.t()) :: :ok

Set the explorations grid

Link to this function

set_running_exploration(exploration)

View Source

Specs

set_running_exploration(MarsExplorer.Exploration.t()) :: :ok

Set the running exploration

Link to this function

update_running_exploration(new_exploration)

View Source

Specs

update_running_exploration(MarsExplorer.Exploration.t()) :: :ok

Updates the running exploration