One track section A/B's simplified layout knows about. More...

#include <ab_gp_db.h>

Data Fields
uint16_t	id
uint16_t	start_signal
uint16_t	end_signal
bool	occupied
ab_gp_db_route_il_status_t	il_status
uint32_t	route_type
bool	used_in_ma
uint8_t	train_id
uint32_t	route_fsm_state

Detailed Description

One track section A/B's simplified layout knows about.

Definition at line 65 of file ab_gp_db.h.

Field Documentation

◆ id

uint16_t ab_gp_db_route_t::id

This route's own identity - 0 = unused table slot.

Definition at line 67 of file ab_gp_db.h.

◆ start_signal

uint16_t ab_gp_db_route_t::start_signal

Signal identity this route starts at.

Definition at line 68 of file ab_gp_db.h.

◆ end_signal

uint16_t ab_gp_db_route_t::end_signal

Signal identity this route ends at.

Definition at line 69 of file ab_gp_db.h.

◆ occupied

bool ab_gp_db_route_t::occupied

Physical track occupancy (track-circuit state) - independent of il_status below: a route can be physically occupied without IL having locked it for anyone yet, or vice versa.

Definition at line 70 of file ab_gp_db.h.

◆ il_status

ab_gp_db_route_il_status_t ab_gp_db_route_t::il_status

IL's own last-reported status for this route.

Definition at line 74 of file ab_gp_db.h.

◆ route_type

uint32_t ab_gp_db_route_t::route_type

IL's own last-reported rbc_route_type_t (RBC_ROUTE_TYPE_FS/ _OS/_SH, rbc_wire_types.h) for this route - raw uint32_t storage, same convention as that enum's own on-the-wire representation (not dispatched on by this module, so no need for the real enum type here). 0 (=RBC_ROUTE_TYPE_FS) until a ROUTE_ADD reports otherwise.

Definition at line 75 of file ab_gp_db.h.

◆ used_in_ma

bool ab_gp_db_route_t::used_in_ma

True while this route is currently part of an active Movement Authority.

Definition at line 81 of file ab_gp_db.h.

◆ train_id

uint8_t ab_gp_db_route_t::train_id

Which train (1..RTE_EXAMPLE_MAX_TRAINS) currently uses this route, 0 if none - only meaningful while used_in_ma is true.

Definition at line 83 of file ab_gp_db.h.

◆ route_fsm_state

uint32_t ab_gp_db_route_t::route_fsm_state

ab_ga_route_state_t (safeAPIRBC2oo2GA/src/AB/il/ ab_ga_route_fsm.h) - the per-route state machine's current state, driven by IL route commands. Raw uint32_t storage, same convention as route_type above; GA owns the transitions, GP just persists it here. 0 (= AB_GA_ROUTE_STATE_NO_ROUTE) until an IL command moves it.

Definition at line 86 of file ab_gp_db.h.

The documentation for this struct was generated from the following file:

src/application/AB/GP/db/ab_gp_db.h

Data Fields