ab_gp_event.h

Go to the documentation of this file.

 
#ifndef AB_GP_EVENT_H
#define AB_GP_EVENT_H
 
#ifdef __cplusplus
extern "C" {
#endif

typedef enum ab_gp_event_e
{
    /* --- Session lifecycle (ab_gp_session_fsm.c) --------------------- */
    AB_GP_SESSION_EVENT_SESSION_INITIATION_REQUESTED = 0, 
    AB_GP_SESSION_EVENT_SESSION_ESTABLISHED_CONFIRMED,    
    AB_GP_SESSION_EVENT_TRAIN_DATA_VALIDATED,              
    AB_GP_SESSION_EVENT_MA_GRANTED,                        
    AB_GP_SESSION_EVENT_MA_REVOKED,                        
    AB_GP_SESSION_EVENT_SHUNTING_AUTHORIZED,               
    AB_GP_SESSION_EVENT_SHUNTING_DEAUTHORIZED,             
    AB_GP_SESSION_EVENT_EMERGENCY_STOP_ISSUED,             
    AB_GP_SESSION_EVENT_EMERGENCY_STOP_REVOKED_TO_FS,      
    AB_GP_SESSION_EVENT_EMERGENCY_STOP_REVOKED_TO_STANDBY, 
    AB_GP_SESSION_EVENT_EMERGENCY_STOP_REVOKED_TO_ESTABLISHED, 
    AB_GP_SESSION_EVENT_SESSION_TERMINATED,                
    AB_GP_SESSION_EVENT_COUNT,                             
 
    /* --- Validated Train Data (ab_gp_train_data_fsm.c) --------------- */
    AB_GP_EVENT_TRAIN_DATA_RECEIVED = AB_GP_SESSION_EVENT_COUNT, 
    AB_GP_EVENT_TRAIN_DATA_REJECTED,                      
    /* AB_GP_SESSION_EVENT_TRAIN_DATA_VALIDATED (above) is the "accepted"
     * event - the train-data FSM subscribes to that same event the
     * session FSM already reacts to, rather than a second near-duplicate. */
 
    /* --- The following events fan out to STUB per-entity FSMs
     *     (ab_gp_fsm_stub.h) - dispatch wiring is complete, behaviour
     *     is not built as an FSM yet. Some also reach the session FSM
     *     (MA_GRANTED etc. in the session block above). ------------- */
 
    /* Movement Authority (ab_gp_ma_fsm.c - STUB; + session FSM for
     * AB_GP_SESSION_EVENT_MA_GRANTED / _MA_REVOKED above). */
    AB_GP_EVENT_MA_REQUESTED,                             
    AB_GP_EVENT_MA_ACKNOWLEDGED,                          
 
    /* Supervised position (ab_gp_position_fsm.c - STUB). */
    AB_GP_EVENT_POSITION_REPORTED,                        
 
    /* End of Mission (ab_gp_eom_fsm.c - STUB). */
    AB_GP_EVENT_END_OF_MISSION,                           
 
    /* RBC-to-RBC handover (ab_gp_handover_fsm.c - STUB) - no wire flow
     * raises these yet. */
    AB_GP_EVENT_HANDOVER_ANNOUNCED,
    AB_GP_EVENT_HANDOVER_CONFIRMED,
 
    /* Temporary Speed Restriction (ab_gp_tsr_fsm.c - STUB) - no wire
     * flow raises these yet. */
    AB_GP_EVENT_TSR_IMPOSED,
    AB_GP_EVENT_TSR_REVOKED,
 
    /* Driver text message (ab_gp_text_message_fsm.c - STUB) - no wire
     * flow raises these yet. */
    AB_GP_EVENT_TEXT_MESSAGE_SENT,
    AB_GP_EVENT_TEXT_MESSAGE_ACKNOWLEDGED,
 
    AB_GP_EVENT_COUNT                                     
} ab_gp_event_t;
 
#ifdef __cplusplus
}
#endif
 
#endif /* AB_GP_EVENT_H */