PC*MILER|Rail Web Services
Namespaces | Classes | Enumerations
ALK.PCMRail.Model Namespace Reference

Namespaces

Classes

class  GeocodeOptions
 Geocode options object. More...
 
class  RouteOptions
 Route options object. More...
 
class  Station
 Station object. More...
 

Enumerations

enum  StationFormat { StationState = GeoLookupType.Geo_LookupType_Station, SPLC = GeoLookupType.Geo_LookupType_Splc, ERPC = GeoLookupType.Geo_LookupType_Erpc, FSAC = GeoLookupType.Geo_LookupType_Fsac, R260 = GeoLookupType.Geo_LookupType_R260 }
 Format for rail freight stations. More...
 
enum  RoutePreference { Practical = RouteFormula.Practical, Intermodal = RouteFormula.Intermodal, Shortest = RouteFormula.Shortest, CoalBulk = RouteFormula.CoalBulk, AutoRacks = RouteFormula.AutoRacks, FuelSurcharge = RouteFormula.FuelSurcharge }
 Route calculation heuristic. More...
 
enum  ReportType { Detailed = RailRptType.RRT_DETAILED, KeyStation = RailRptType.RRT_KEYCITY, DetailedGeocode = RailRptType.RRT_GEO, State = RailRptType.RRT_STATE, Railroad = RailRptType.RRT_RR }
 Report to generate. More...
 
enum  DistanceUnit { Miles = Interop.RailTrip.DistUnit.Miles, Kilometers = Interop.RailTrip.DistUnit.Kilometers }
 Specifies the unit system when displaying distance results. More...
 

Enumeration Type Documentation

◆ StationFormat

enum StationFormat
strong

Format for rail freight stations.

Acceptable StationFormats are:

Enumerator
StationState 

There are three parts that make up the StationState.
Station name, space, and State abbreviation.
StationState is not case sensitive.

        Examples for Oakland, California:
           Oakland CA
           OAKLAND             ca
           oAkLaNd Ca
SPLC 

Standard Point Location Code.
9 digit geographic code used by North American transportation industries.
PC*MILER|Rail will only use the first 6 digits.

        Example for Boston, Massachusetts:
           142000
ERPC 

Eastern Railroad President's Conference Codes also referred to as 3-3-3.
There are three parts that make up the ERPC.
Station name, space, and State abbreviation.
ERPC is not case sensitive.

        Examples for Cabazon, California:
           Cabazon CA
           CABAZON                  ca
           cabaZON ca
FSAC 

Freight Station Accounting Code.
FSAC is a 5 digit code with leading zeros.

        Examples:
           11121
           74600
           10000
R260 

Rule 260 Junction Code.
R260 is 5 characters long and is not case sensitive.

        Examples:
           PACIF
           dalas

◆ RoutePreference

enum RoutePreference
strong

Route calculation heuristic.

Enumerator
Practical 

Practical routing is the optimal for general merchandise traffic.

Intermodal 

Intermodal routing is specific to intermodal trains.
Only locations with intermodal service can be entered as origin/destinations.

Shortest 

Shortest routing will route to the shortest path.

CoalBulk 

Coal/Bulk Routing is specific to Coal/Bulk unit trains.

AutoRacks 

AutoRack routing is specific to multi-levels.

FuelSurcharge 

Fuel Surcharge routing is practical or shortest routing depending on the railroad.

◆ ReportType

enum ReportType
strong

Report to generate.

The following report types are currently supported:

Enumerator
Detailed 

For information on the Detailed report, please refer to DetailedReport

KeyStation 

For information on the Key Station report, please refer to KeyStationReport

DetailedGeocode 

For information on the Detailed Geocode report, please refer to DetailedGeocodeReport

State 

For information on the State report, please refer to StateReport

Railroad 

For information on the Railroad report, please refer to RailroadReport

◆ DistanceUnit

enum DistanceUnit
strong

Specifies the unit system when displaying distance results.

Enumerator
Miles 

Indicates miles should be used.

Kilometers 

Indicates kilometers should be used.