ab_gp_ertms_train_messages.h

Go to the documentation of this file.

 
#ifndef AB_GP_ERTMS_TRAIN_MESSAGES_H
#define AB_GP_ERTMS_TRAIN_MESSAGES_H
 
#include "../ab_gp_ertms_types.h"
#include "ab_gp_ertms_train_packets.h"
 
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================= */
/* Standard Track-to-Train Message IDs (NID_MESSAGE) - Subset-026 Ch. 8      */
/* ========================================================================= */
#define RBC_MSG_TRACK_TO_TRAIN_SR_AUTHORISATION          2U
#define RBC_MSG_TRACK_TO_TRAIN_MOVEMENT_AUTHORITY        3U
#define RBC_MSG_TRACK_TO_TRAIN_RECOGNITION_EXIT_SR       6U
#define RBC_MSG_TRACK_TO_TRAIN_ACK_TRAIN_DATA            8U
#define RBC_MSG_TRACK_TO_TRAIN_REQUEST_SHORTEN_MA        9U
#define RBC_MSG_TRACK_TO_TRAIN_CONDITIONAL_EMERGENCY_STOP 15U
#define RBC_MSG_TRACK_TO_TRAIN_UNCONDITIONAL_EMERGENCY_STOP 16U
#define RBC_MSG_TRACK_TO_TRAIN_REVOCATION_EMERGENCY_STOP 18U
#define RBC_MSG_TRACK_TO_TRAIN_GENERAL_MESSAGE           24U
#define RBC_MSG_TRACK_TO_TRAIN_SH_REFUSED                27U
#define RBC_MSG_TRACK_TO_TRAIN_SH_AUTHORISED             28U
#define RBC_MSG_TRACK_TO_TRAIN_RBC_TRANSITION_ORDER      33U
#define RBC_MSG_TRACK_TO_TRAIN_TRACK_AHEAD_FREE_REQUEST  34U
#define RBC_MSG_TRACK_TO_TRAIN_SESSION_TERMINATION_ORDER 41U
 
/* ========================================================================= */
/* Standard Train-to-Track Message IDs (NID_MESSAGE) - Subset-026 Ch. 8      */
/* ========================================================================= */
#define RBC_MSG_TRAIN_TO_TRACK_VALIDATED_TRAIN_DATA      129U
#define RBC_MSG_TRAIN_TO_TRACK_REQUEST_FOR_SHUNTING      130U
#define RBC_MSG_TRAIN_TO_TRACK_MA_REQUEST                132U
#define RBC_MSG_TRAIN_TO_TRACK_POSITION_REPORT           136U
#define RBC_MSG_TRAIN_TO_TRACK_ACKNOWLEDGEMENT           146U
#define RBC_MSG_TRAIN_TO_TRACK_ACK_EMERGENCY_STOP        147U
#define RBC_MSG_TRAIN_TO_TRACK_END_OF_MISSION            150U
#define RBC_MSG_TRAIN_TO_TRACK_INIT_SESSION              155U
#define RBC_MSG_TRAIN_TO_TRACK_TERMINATE_SESSION         156U
#define RBC_MSG_TRAIN_TO_TRACK_SESSION_ESTABLISHED       159U
 
/* ========================================================================= */
/* Common Track-to-Train Radio Header (Subset-026 Section 8.4.1)             */
/* ========================================================================= */
typedef struct rbc_track_to_train_header_s
{
    uint8_t        nid_message; 
    uint16_t       l_message;   
    rbc_timestamp_ms_t t_train; 
    rbc_m_ack_t    m_ack;       
    rbc_nid_lrbg_t nid_lrbg;    
} rbc_track_to_train_header_t;
 
/* ========================================================================= */
/* Common Train-to-Track Radio Header (Subset-026 Section 8.4.2)             */
/* ========================================================================= */
typedef struct rbc_train_to_track_header_s
{
    uint8_t          nid_message; 
    uint16_t         l_message;   
    rbc_timestamp_ms_t t_train;   
    rbc_nid_engine_t nid_engine;  
} rbc_train_to_track_header_t;
 
/* ========================================================================= */
/* MESSAGES: TRACK TO TRAIN (RBC -> Train)                                   */
/* ========================================================================= */

typedef struct rbc_msg_2_sr_authorisation_s
{
    rbc_track_to_train_header_t header;
    rbc_q_scale_t               q_scale;
    rbc_distance_m_t            d_sr;             
    bool                        d_sr_unlimited;    
} rbc_msg_2_sr_authorisation_t;

typedef struct rbc_msg_3_movement_authority_s
{
    rbc_track_to_train_header_t header;
    rbc_packet_15_ma_t          ma;
    bool                        has_gradient;
    rbc_packet_21_gradient_profile_t gradient;
    bool                        has_ssp;
    rbc_packet_27_ssp_t         ssp;
    bool                        has_linking;
    rbc_packet_5_linking_t      linking;
} rbc_msg_3_movement_authority_t;

typedef struct rbc_msg_6_recognition_exit_trip_s
{
    rbc_track_to_train_header_t header;
} rbc_msg_6_recognition_exit_trip_t;

typedef struct rbc_msg_8_ack_train_data_s
{
    rbc_track_to_train_header_t header;
    rbc_timestamp_ms_t          t_train_ref;      
} rbc_msg_8_ack_train_data_t;

typedef struct rbc_msg_9_request_shorten_ma_s
{
    rbc_track_to_train_header_t header;
    rbc_packet_15_ma_t          ma;
} rbc_msg_9_request_shorten_ma_t;

typedef struct rbc_msg_15_ces_s
{
    rbc_track_to_train_header_t header;
    rbc_nid_em_t                nid_em;           
    rbc_q_scale_t               q_scale;
    rbc_distance_m_t            d_ref;            
    rbc_q_dir_t                 q_dir;            
    rbc_distance_m_t            d_emergencystop;  
} rbc_msg_15_ces_t;

typedef struct rbc_msg_16_ues_s
{
    rbc_track_to_train_header_t header;
    rbc_nid_em_t                nid_em;           
} rbc_msg_16_ues_t;

typedef struct rbc_msg_18_ces_revocation_s
{
    rbc_track_to_train_header_t header;
    rbc_nid_em_t                nid_em;           
} rbc_msg_18_ces_revocation_t;

typedef struct rbc_msg_24_general_message_s
{
    rbc_track_to_train_header_t header;
    bool                        has_national_values;
    rbc_packet_3_national_values_t national_values;
    bool                        has_ma_request_params;
    rbc_packet_57_ma_request_params_t ma_request_params;
    bool                        has_pr_params;
    rbc_packet_58_pr_params_t   pr_params;
    bool                        has_tsr;
    rbc_packet_65_tsr_t         tsr;
    bool                        has_tsr_revoke;
    rbc_packet_66_tsr_revoke_t  tsr_revoke;
    bool                        has_text_message;
    rbc_packet_72_text_message_t text_message;
} rbc_msg_24_general_message_t;

typedef struct rbc_msg_27_sh_refused_s
{
    rbc_track_to_train_header_t header;
    rbc_timestamp_ms_t          t_train_ref;      
} rbc_msg_27_sh_refused_t;

typedef struct rbc_msg_28_sh_authorised_s
{
    rbc_track_to_train_header_t header;
    rbc_timestamp_ms_t          t_train_ref;      
} rbc_msg_28_sh_authorised_t;

typedef struct rbc_msg_33_transition_order_s
{
    rbc_track_to_train_header_t header;
    rbc_nid_rbc_t               nid_rbc;          
    rbc_nid_c_t                 nid_c;            
    uint64_t                    nid_radio;        
    rbc_distance_m_t            d_rbctr;          
} rbc_msg_33_transition_order_t;

typedef struct rbc_msg_34_track_ahead_free_request_s
{
    rbc_track_to_train_header_t header;
    rbc_q_scale_t               q_scale;
    rbc_distance_m_t            d_ref;            
    rbc_q_dir_t                 q_dir;            
    rbc_distance_m_t            d_tafdisplay;     
    rbc_distance_m_t            l_tafdisplay;     
} rbc_msg_34_track_ahead_free_request_t;

typedef struct rbc_msg_41_session_termination_order_s
{
    rbc_track_to_train_header_t header;
} rbc_msg_41_session_termination_order_t;
 
/* ========================================================================= */
/* MESSAGES: TRAIN TO TRACK (Train -> RBC)                                   */
/* ========================================================================= */

typedef struct rbc_msg_129_validated_train_data_s
{
    rbc_train_to_track_header_t    header;
    rbc_packet_0_position_report_t position_report;
    rbc_distance_m_t               l_train;        
    rbc_speed_kmh_t                v_maxtrain;     
    uint8_t                        m_loadinggauge; 
    uint8_t                        m_axleload;     
    bool                           m_airtight;     
} rbc_msg_129_validated_train_data_t;

typedef struct rbc_msg_130_request_for_shunting_s
{
    rbc_train_to_track_header_t    header;
    rbc_packet_0_position_report_t position_report;
} rbc_msg_130_request_for_shunting_t;

typedef struct rbc_msg_132_ma_request_s
{
    rbc_train_to_track_header_t    header;
    rbc_q_marqstreason_t           q_marqstreason;
    rbc_packet_0_position_report_t position_report;
} rbc_msg_132_ma_request_t;

typedef struct rbc_msg_136_position_report_s
{
    rbc_train_to_track_header_t        header;
    rbc_packet_0_position_report_t     position_report;
    bool                                has_packet1;
    rbc_packet_1_position_report_2bg_t packet1;
} rbc_msg_136_position_report_t;

typedef struct rbc_msg_146_ack_s
{
    rbc_train_to_track_header_t header;
    rbc_timestamp_ms_t          t_train_ack;      
} rbc_msg_146_ack_t;

typedef struct rbc_msg_147_ack_emergency_stop_s
{
    rbc_train_to_track_header_t header;
    rbc_nid_em_t                nid_em;
    bool                        ces_accepted;
} rbc_msg_147_ack_emergency_stop_t;

typedef struct rbc_msg_150_end_of_mission_s
{
    rbc_train_to_track_header_t    header;
    bool                            desk_open;     
    rbc_packet_0_position_report_t position_report;
} rbc_msg_150_end_of_mission_t;

typedef struct rbc_msg_155_init_session_s
{
    rbc_train_to_track_header_t header;
} rbc_msg_155_init_session_t;

typedef struct rbc_msg_156_terminate_session_s
{
    rbc_train_to_track_header_t header;
} rbc_msg_156_terminate_session_t;

typedef struct rbc_msg_159_session_established_s
{
    rbc_train_to_track_header_t header;
    uint8_t                     m_version;        
} rbc_msg_159_session_established_t;
 
#ifdef __cplusplus
}
#endif
 
#endif /* RBC_TRAIN_MESSAGES_H */