ab_gp_proc_train_data.h File Reference

ERTMS Subset-026 §5.4 & §5.2 Validated Train Data and Start of Mission Procedure. More...

#include "ab_gp_ertms_types.h"

Include dependency graph for ab_gp_proc_train_data.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_train_data_validate (ab_gp_ertms_train_context_t *ctx, 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)
	Validates inbound Train Data (Msg 129 + Packet 11) against site topology limits.
bool	ab_gp_proc_train_data_is_valid (const ab_gp_ertms_train_context_t *ctx)
	Checks if train data has been successfully validated.
bool	ab_gp_proc_train_data_get_ack_timestamp (const ab_gp_ertms_train_context_t *ctx, uint32_t *out_t_train_ack)
	Retrieves the timestamp for Msg 8 (Ack of Train Data) generation.

Detailed Description

ERTMS Subset-026 §5.4 & §5.2 Validated Train Data and Start of Mission Procedure.

Implements SIL 4 C99 train data validation against RailML static site characteristics and generates Msg 8 (Acknowledgement of Train Data).

Definition in file ab_gp_proc_train_data.h.

Function Documentation

ab_gp_proc_train_data_validate()

bool ab_gp_proc_train_data_validate	(	ab_gp_ertms_train_context_t *	ctx,
		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 )

Validates inbound Train Data (Msg 129 + Packet 11) against site topology limits.

Parameters

[in,out]	ctx	Train ERTMS context.
[in]	l_train_m	Train length in meters.
[in]	v_maxtrain_kmh	Maximum train speed in km/h.
[in]	m_axleload	Axle load category.
[in]	m_loadinggauge	Loading gauge category.
[in]	m_airtight	Airtight capability flag.
[in]	timestamp_ms	Timestamp from train message.

Returns

true if parameters are compatible and validated, false otherwise.

Definition at line 12 of file ab_gp_proc_train_data.c.

ab_gp_proc_train_data_is_valid()

bool ab_gp_proc_train_data_is_valid

(

const ab_gp_ertms_train_context_t *

ctx

)

Checks if train data has been successfully validated.

Parameters

[in]

ctx

Train ERTMS context.

Returns

true if valid train data is stored, false otherwise.

Definition at line 65 of file ab_gp_proc_train_data.c.

ab_gp_proc_train_data_get_ack_timestamp()

bool ab_gp_proc_train_data_get_ack_timestamp	(	const ab_gp_ertms_train_context_t *	ctx,
		uint32_t *	out_t_train_ack )

Retrieves the timestamp for Msg 8 (Ack of Train Data) generation.

Parameters

[in]	ctx	Train ERTMS context.
[out]	out_t_train_ack	Echoed timestamp to place in Msg 8.

Returns

true if train data was validated and timestamp populated.

Definition at line 74 of file ab_gp_proc_train_data.c.