ab_gp_ertms_engine.h

Go to the documentation of this file.

 
#ifndef RTE_EXAMPLE_AB_GP_ERTMS_ENGINE_H
#define RTE_EXAMPLE_AB_GP_ERTMS_ENGINE_H
 
#include "ab_gp_ertms_types.h"
#include "ab_gp_proc_session.h"
#include "ab_gp_proc_train_data.h"
#include "ab_gp_proc_ma.h"
#include "ab_gp_proc_position.h"
#include "ab_gp_proc_emergency_stop.h"
#include "ab_gp_proc_shunting.h"
#include "ab_gp_proc_eom.h"
#include "ab_gp_proc_tsr.h"
#include "ab_gp_proc_text_message.h"
#include "ab_gp_proc_handover.h"
#include "../db/ab_gp_db.h"
 
#ifdef __cplusplus
extern "C" {
#endif

void ab_gp_ertms_engine_init(ab_gp_db_t *db);

ab_gp_ertms_train_context_t *ab_gp_ertms_engine_get_train_context(uint8_t train_id);

void ab_gp_ertms_engine_step(ab_gp_db_t *db, uint32_t cycle, uint32_t timestamp_ms, uint32_t elapsed_ms);
 
/* ========================================================================= */
/* GP ERTMS Calculation Services (Invoked in Cooperation with GA)            */
/* ========================================================================= */

bool ab_gp_ertms_calc_ma_for_route(uint8_t train_id, uint16_t route_id, uint32_t ma_seq);

bool ab_gp_ertms_extend_ma_for_route(uint8_t train_id, uint16_t route_id);

bool ab_gp_ertms_validate_train_data(uint8_t train_id,
                                     uint32_t l_train_m,
                                     uint32_t v_maxtrain_kmh,
                                     uint8_t m_axleload,
                                     uint8_t m_loadinggauge,
                                     bool m_airtight,
                                     uint32_t timestamp_ms);

bool ab_gp_ertms_update_train_position(uint8_t train_id,
                                       uint32_t nid_lrbg,
                                       uint32_t d_lrbg_m,
                                       rbc_q_dirlrbg_t q_dirlrbg,
                                       uint32_t v_train_kmh,
                                       uint32_t m_mode,
                                       uint32_t m_level,
                                       uint32_t cycle,
                                       uint32_t timestamp_ms);

bool ab_gp_ertms_trigger_emergency_stop(uint8_t train_id,
                                        bool is_conditional,
                                        uint8_t nid_em,
                                        uint32_t d_ref_m,
                                        uint32_t d_es_m);

bool ab_gp_ertms_revoke_emergency_stop(uint8_t train_id, uint8_t nid_em);

bool ab_gp_ertms_request_shunting(uint8_t train_id);

bool ab_gp_ertms_authorize_shunting(uint8_t train_id, bool authorized);

bool ab_gp_ertms_terminate_mission(uint8_t train_id, ab_gp_db_t *db);

bool ab_gp_ertms_add_tsr(uint8_t train_id,
                         uint8_t nid_tsr,
                         uint32_t v_tsr_kmh,
                         uint32_t d_start_m,
                         uint32_t d_end_m);

bool ab_gp_ertms_remove_tsr(uint8_t train_id, uint8_t nid_tsr);

bool ab_gp_ertms_send_text_message(uint8_t train_id,
                                   uint8_t nid_textmessage,
                                   uint8_t q_textclass,
                                   uint8_t q_textconfirm,
                                   uint32_t duration_s,
                                   const char *text,
                                   rbc_packet_72_text_message_t *out_p72);

bool ab_gp_ertms_handle_text_ack(uint8_t train_id,
                                 uint8_t nid_textmessage,
                                 uint32_t timestamp_ms);

bool ab_gp_ertms_announce_handover(uint8_t train_id,
                                   uint16_t target_nid_c,
                                   uint16_t target_nid_rbc,
                                   uint64_t target_nid_radio,
                                   uint32_t d_rbctr_m);

bool ab_gp_ertms_complete_handover(uint8_t train_id);
 
#ifdef __cplusplus
}
#endif
 
 
#endif /* RTE_EXAMPLE_AB_GP_ERTMS_ENGINE_H */