DAL

Data Abstraction Layer

The Data Abstraction Layer or "DAL" object loads in an stores all app data. The DAL is populated in init.js after Config load. The constructor has just one parameter, the current event ID. This parameter is used to determine which event data to pull from localStorage.

Data Organization

Data read from localStorage is stored in one of 4 data structures.

meta
- Descriptions of each item in teams
teams
- meta
  - TBA team data
    - name
    - city
    - state_prov
    - country
- rank
  - TBA team ranking data
    - wins
    - losses
    - ties
    - ranking_points
    - ranking_score
    - tie_breaker
- matches
  - Summary TBA match data for team's matches
    - key
    - comp_level
    - set_number
    - match_number
    - alliance
- pictures
  - Unused
- pit
  - Team pit results
- results
  - List of team match results including smart_stats
- stats
  - mean, median, mode, min, max, low, high, total, std_dev computed for each stat across all match results
matches
- TBA match data for all matches
  - match_name
  - short_match_name
  - comp_level
  - set_number
  - match_number
  - scheduled_time
  - predicted_time
  - started_time
  - display_time
  - red_alliance
  - blue_alliance
  - complete
  - red_score
  - blue_score
  - score_str
  - videos
  - score_breakdown
  - winner
picklists
- all picklists

Provided Functions

load_config(mode)

Load in configuration metadata for a given scouting mode. Called by build_teams() for each mode.

mode
- String mode type: pit/match.

get_keys(include_stats=true, include_pit=true, include_ranking=true, include_meta=true, types=[])

Returns an array of team keys with several filters.

include_stats
- Boolean representation of whether or not to include the stats section.
include_pit
- Boolean representation of whether or not to include the pit section.
include_ranking
- Boolean representation of whether or not to include the rank section.
include_meta
- Boolean representation of whether or not to include the meta section.
types
- Array of input types to filter keys by.

get_placeholder_keys()

Return an array of all single team keys with placeholders.

get_result_keys(cycle=true, types=[])

Returns an array of result keys.

cycle
- Either a boolean representation of whether or not to include cycle or a string representing which cycle to include.
types
- Array of input types to filter by.

find_matches(alliance_a, alliance_b=[])

Finds all matches where the given teams are in the alliances.

alliance_a
- A required array of team numbers in the same alliance.
alliance_b
- An opional array of team numbers in the opposing alliance to a.

get_results(teams=[], sort=true)

Returns all match results sorted by match then position.

get_result_names(teams=[], sort=true)

Returns all match results name in key-team format sorted by match then position.

teams
- List of team numbers to filter by.
sort
- Boolean representing whether to sort.

get_pits(teams=[], sort=true)

Returns all scouted pits sorted by teams number.

teams
- List of team numbers to filter by.
sort
- Boolean representing whether to sort.

get_match_teams(match_key)

Returns a map of position keys to team numbers for a given match.

match_key
- String match key for result.

get_team_keys()

Returns a map of position keys to position names.

build_teams(debug=false)

Populates the data structures, primarily teams, from localStorage.

debug
- Whether or not to print debug timing data when complete.

build_matches()

Populates the matches data structure from localStorage. Called by build_teams().

add_smart_stats(result, stats)

Computes and adds a given set of smart stats to a result.

result
- Result to pull stats from and add stats to.
stats
- Array of smart stat configurations to compute.

build_relative_alliances(team_num, match_id)

Builds an object with opponent and partner alliance team numbers.

team_num
- String team number.
match_id
- String match id.

num_complete_matches()

Determines how many matches have been completely scouted.

num_quali_matches()

Replaces opponentX and partnerX with the appropriate team number.

text
- String to replace placeholders in.
alliances
- Object with properties opponents and partners with lists of team numbers.

fill_team_numbers(text, alliances)

Determines how many qualification matches are at the event.

get_name(id, stat='mean')

Determines the name for a given stat.

id
- String key of stat.
stat
- String stat name.

get_rank_str(team_num)

Builds and returns a string in the format "#rank (score, wins-losses-ties)" for a given team.

team
- String team number.

is_pit_scouted(team)

Return boolean representing if a given team pit is scouted.

team
- String team number for result.

is_match_scouted(match_id, team)

Return boolean representing if a given match-team is scouted.

match_id
- String match key for result.
team
- String team number for result.

get_match_value(match_id, id)

Fetch a given data point for a match.

match_id
- String match key for result.
id
- String key to pull.

get_result_value(team, match_id, id, map=false)

Extract a single stat from the DAL.

id
- String key of stat to pull.
map
- Boolean representing whether to make the value more human readable.

get_value(team, id, stat='mean', map=false)