ab_gp_proc_emergency_stop.h File Reference

ERTMS Subset-026 §5.7 Emergency Stop Management Procedure. More...

#include "ab_gp_ertms_types.h"

Include dependency graph for ab_gp_proc_emergency_stop.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
bool	ab_gp_proc_emergency_stop_issue_ues (ab_gp_ertms_train_context_t *ctx, uint8_t nid_em)
	Issues an Unconditional Emergency Stop (UES - Msg 16) to the train.
bool	ab_gp_proc_emergency_stop_issue_ces (ab_gp_ertms_train_context_t *ctx, uint8_t nid_em, uint32_t d_ref_m, uint32_t d_emergencystop_m)
	Issues a Conditional Emergency Stop (CES - Msg 15) to the train.
bool	ab_gp_proc_emergency_stop_handle_ack (ab_gp_ertms_train_context_t *ctx, uint8_t nid_em, uint32_t timestamp_ms)
	Handles inbound Emergency Stop Acknowledgement (Msg 147).
bool	ab_gp_proc_emergency_stop_revoke (ab_gp_ertms_train_context_t *ctx, uint8_t nid_em)
	Revokes an active Emergency Stop (Msg 18) once hazard is cleared.

Detailed Description

ERTMS Subset-026 §5.7 Emergency Stop Management Procedure.

Implements SIL 4 C99 Unconditional Emergency Stop (UES - Msg 16), Conditional Emergency Stop (CES - Msg 15), Acknowledgement (Msg 147), and Revocation (Msg 18).

Definition in file ab_gp_proc_emergency_stop.h.

Function Documentation

ab_gp_proc_emergency_stop_issue_ues()

bool ab_gp_proc_emergency_stop_issue_ues	(	ab_gp_ertms_train_context_t *	ctx,
		uint8_t	nid_em )

Issues an Unconditional Emergency Stop (UES - Msg 16) to the train.

Parameters

[in,out]	ctx	Train ERTMS context.
[in]	nid_em	Emergency Stop identifier (1..255).

Returns

true if command registered, false otherwise.

Definition at line 9 of file ab_gp_proc_emergency_stop.c.

ab_gp_proc_emergency_stop_issue_ces()

bool ab_gp_proc_emergency_stop_issue_ces	(	ab_gp_ertms_train_context_t *	ctx,
		uint8_t	nid_em,
		uint32_t	d_ref_m,
		uint32_t	d_emergencystop_m )

Issues a Conditional Emergency Stop (CES - Msg 15) to the train.

Parameters

[in,out]	ctx	Train ERTMS context.
[in]	nid_em	Emergency Stop identifier (1..255).
[in]	d_ref_m	Reference balise/distance point.
[in]	d_emergencystop_m	Distance threshold from reference point.

Returns

true if command registered, false otherwise.

Definition at line 31 of file ab_gp_proc_emergency_stop.c.

ab_gp_proc_emergency_stop_handle_ack()

bool ab_gp_proc_emergency_stop_handle_ack	(	ab_gp_ertms_train_context_t *	ctx,
		uint8_t	nid_em,
		uint32_t	timestamp_ms )

Handles inbound Emergency Stop Acknowledgement (Msg 147).

Parameters

[in,out]	ctx	Train ERTMS context.
[in]	nid_em	Echoed emergency stop identifier.
[in]	timestamp_ms	Timestamp from train message.

Returns

true if ack matches active emergency stop, false otherwise.

Definition at line 56 of file ab_gp_proc_emergency_stop.c.

ab_gp_proc_emergency_stop_revoke()

bool ab_gp_proc_emergency_stop_revoke	(	ab_gp_ertms_train_context_t *	ctx,
		uint8_t	nid_em )

Revokes an active Emergency Stop (Msg 18) once hazard is cleared.

Parameters

[in,out]	ctx	Train ERTMS context.
[in]	nid_em	Emergency Stop identifier to revoke.

Returns

true if revoked and state restored, false otherwise.

Definition at line 75 of file ab_gp_proc_emergency_stop.c.