shift_num_nr_mileage¶

pyrcs.utils.shift_num_nr_mileage(nr_mileage, shift_yards)[source]¶

Shift Network Rail mileage by given yards.

Parameters

nr_mileage (float or int or str) – Network Rail mileage
shift_yards (int or float) – yards by which the given nr_mileage is shifted

Returns

shifted numerical Network Rail mileage

Return type

float

Examples:

>>> from pyrcs.utils import shift_num_nr_mileage

>>> num_mileage_dat = shift_num_nr_mileage(nr_mileage='0.0396', shift_yards=220)
>>> print(num_mileage_dat)
0.0616

>>> shift_num_nr_mileage(nr_mileage='0.0396', shift_yards=220.99)
>>> print(num_mileage_dat)
0.0617

>>> shift_num_nr_mileage(nr_mileage=10, shift_yards=220)
>>> print(num_mileage_dat)
10.022