Switching the Rail Map Dataset

PC*Miler Rail-Connect provides three APIs that enable users to identify which datasets are available and to switch between them. The new APIs are described below.

PCRSSwitchDataSet (int DataSetID)

The PCRSSwitchDataSet() API allows you to dynamically switch to a different dataset any time after your PCRSInitSrv() call and before you call PCRSCleanupSrv(). Before making this API call, you should call PCRSIsUpdateAvailable(DataSetID) to verify that the dataset has previously been downloaded and is available (see below).

The names of the four datasets that are expected to be available throughout the year for the Version 25 release are listed in Table 1 below, along with the DataSetID integer to use. The names below are also the names of the subfolders containing rail data updates under your RAILNET install folder.

Table 1: Dataset IDs

The user must pass in a valid dataset ID (see Table 1). For example, to switch to the 25.2 update, the dataset ID is the integer value of 2.

Note: The dynamic switch of rail data is only good for the Connect session. Once the session closes, the use of the new dataset is lost. When you restart your Connect session, the default dataset (defined in the user interface) is loaded again. Also, once you dynamically switch datasets, any existing trips you established earlier are deleted within this API call. For example, if you try to add a stop to a previous open trip, you will receive an error.

Table 2: Return Values

PCRSIsUpdateAvailable (int DataSetID)

This API enables the user to check if a dataset is available. The user must pass in a valid dataset ID. Before you switch datasets within a Connect Session, you should make this API call to ensure that the set is available.

Table 1: Valid Dataset IDs

Table 2: Return Values

PCRSGetAvailableUpdates (int *dataSet_1, int *dataset_2, int *dataset_3)

This API enables the user to find out which updates are available. It is similar to the PCRSIsUpdateAvailable() API call that queries whether a specific dataset is available.

Since there are three potential updates over the duration of a PC*Miler Rail yearly release, there are three values coming back from this API. If the value coming back within the pointer to the arg is 1, the dataset is available; otherwise 0 (zero). Using one call, this API lets you know which data updates have been downloaded.

Table 1: Dataset Arguments

Table 2: Return Values