ab_ga_il.h

Go to the documentation of this file.

#ifndef SAFEAPI_EXAMPLE_AB_GA_IL_H
#define SAFEAPI_EXAMPLE_AB_GA_IL_H
 
#include <stdbool.h>
#include <stdint.h>
 
#include "safeapi/utils/status/sapi_status.h"
 
#include "rbc_wire_types.h" /* RBC_ENVELOPE_WIRE_SIZE, for ab_ga_il_apply_envelope() below */
#include "site_config.h"    /* sapi_example_site_t, for ab_ga_il_apply_envelope() below */
#include "ga_interface.h" /* ab_gp_db_t/ab_gp_train_session_t (opaque), route+session
                                                   * getters/setters, GP registration - see that
                                                   * file's own doc; the ONLY GP header this module
                                                   * (or any GA module) ever includes */
#include "ab_siteGA.h" /* ab_site_ga_route_layout_t - SA's reduced GA-owned view, see
                                     * ga_interface.h's own doc for why this stays a direct include */

void ab_ga_il_on_route_context_changed(ab_gp_train_session_t *sessions, ab_gp_db_t *db,
                                        const ab_gp_route_context_t *ctx, ab_gp_route_update_type_t update_type);

bool ab_ga_il_site_has_route(uint16_t route_id, const ab_site_ga_route_layout_t **out_layout);

bool ab_ga_il_site_has_route_by_signals(uint16_t start_signal, uint16_t end_signal,
                                          const ab_site_ga_route_layout_t **out_layout);

bool ab_ga_il_route_verify(uint16_t route_id, uint16_t start_signal, uint16_t end_signal);

bool ab_ga_il_route_add(ab_gp_db_t *db, uint16_t route_id, uint16_t start_signal, uint16_t end_signal);

bool ab_ga_il_route_remove(ab_gp_db_t *db, uint16_t route_id);

bool ab_ga_il_route_set_status(ab_gp_db_t *db, uint16_t route_id, ab_gp_db_route_il_status_t status);

bool ab_ga_il_route_set_type(ab_gp_db_t *db, uint16_t route_id, uint32_t route_type);

bool ab_ga_il_route_assign_train(ab_gp_db_t *db, uint16_t route_id, uint8_t train_id);

bool ab_ga_il_route_unassign_train(ab_gp_db_t *db, uint16_t route_id);

bool ab_ga_il_handle_route_add(ab_gp_db_t *db, uint8_t train_id);

bool ab_ga_il_apply_envelope(const void *context, ab_gp_train_session_t *sessions, ab_gp_db_t *db,
                              const uint8_t env_bytes[RBC_ENVELOPE_WIRE_SIZE], uint32_t cycle,
                              sapi_example_site_t site, const char *role_tag);


uint8_t ab_ga_il_build_outputs(ab_gp_il_pending_output_t out[AB_GP_IL_MAX_PENDING_OUTPUTS]);
 
#endif /* SAFEAPI_EXAMPLE_AB_GA_IL_H */