ALK.Common.Model Namespace Reference

Classes

class   AddGeofence
  Object used to add a Geofence. More...
 
class   AddGeofenceSet
  Class that models a Geofence Set More...
 
class   AddPlace
  Represents a new place for creation. More...
 
class   AddPlaceCategory
  Represents a place category. More...
 
class   AddPlaceSet
 
class   Address
  Represents the information associated with an address. More...
 
class   AFExtensions
  Extension method for AFs to test if it has PLIDs
 
class   AFExtraInfo
  Represents the extra info associated with an AF Link. More...
 
class   AFGridLink
  Represents an avoid/favor to be created from a Grid and Link More...
 
class   AFGroup
  Represents a list of avoid/favors that are considered part of the same group. More...
 
class   AFGroupBase
  Represents the basic attributes associated with an Avoid/Favor Group. More...
 
class   AFLink
  Represents the avoid/favor snapped points used in ALK core dll More...
 
class   AFMapPoint
  Represents avoid/favor coordinates on the map More...
 
class   AFSet
  Represents an avoid/favor set More...
 
class   AlternateHosLocation
  The AlternateHosLocation structure is used to represent alternate HOS Rest Stops More...
 
class   AvoidFavorMapLink
  Represents avoid/favor coordinates on the map More...
 
class   Coordinates
  Represents geographic coordinates, i.e. latitude and longitude. More...
 
class   Geofence
  Class that represents a Geofence. More...
 
class   GeofenceSet
  Class that models a Geofence Set More...
 
class   LanguageDefault
 
class   Location
  Represents a real world location made up of an address and/or latitude/longitude coordinates. More...
 
class   Place
 
class   PlaceCategory
  Represents a place category. More...
 
class   PlaceSet
 

Enumerations

enum   FPCGeocodes { NTBasic = 0x1, NTPremium = 0x2, OSNI = 0x4 }
  WPWS-2085 - Add Licensing Support for FPC - Geocode calls this indicates where the full postal code is from NT Basic means this is not a special full postal code and anybody can use it NT Premium is a full postal code from NT Premium files OSNI is a full postal code from OSNI More...
 
enum   GeofenceShape : byte { Circle = 1, Polygon = 5 }
  Specifies the Geofence shape type More...
 
enum   GeofenceState : byte { Off = 0, Warn = 1, Avoid = 2 }
  Specifies the active state of the Geofence More...
 
enum   PostCodeType { US, Mexico, Both }
  Specifies the country code filter for US and Mexican zip code. More...
 
enum   CountryAbbreviationType { FIPS, ISO2, ISO3, GENC2, GENC3 }
  Specifies the abbreviation format for countries. More...
 
enum   DataRegion { Unknown = 0, AF, AS, EU, NA, OC, SA, ME, MX }
  Represents the data region to use when geocoding or reverse geocoding or when specifying locations in general. More...
 
enum   VolumeUnits { Gallons, Liters }
  Specifies whether gallons or liters are used for fuel volumes. More...
 
enum   VehicleDimUnits { English, Metric }
  Specifies whether English or metric units describe vehicle dimensions. More...
 
enum   DistanceUnits { Miles, Kilometers }
  Represents the units used for distances. More...
 
enum   AFType { Avoid = 1, Favor = 2 }
  Represents the type of an ALK.PCM.Model.BusinessModels.AvoidFavor. More...
 
enum   MapsureVisibilityStatus { Public = 0, Private = 1 }
  Represents VisibilityStatus for Mapsure, Public/Private. More...
 
enum   StopStatus { Open = 1, Arrived = 2, Completed = 3, Canceled = 4, NotViable = 5 }
 
enum   ArrivalStatus { OnTime = 1, AtRisk = 2, Late = 3, Early = 4, NotViable = 5, TooEarly = 6 }
 
enum   UpdateTrigger { CoPilot = 0, Manual = 1 }
 
enum   DriverFeedbackIssueType { MissingAddress = 0, AddressLocationError = 1, HeightRestriction = 2, WeightRestriction = 3, TruckRestriction = 4, HazmatRestriction = 5, MissingStreet = 6, ExitSignpostCorrection = 7, OneWayStreetError = 8, SpeedLimitError = 9, RoadClosure = 10, TurnRestriction = 11, RoadNameError = 12, Other = 13 }
  The type of issue that can be reported when drivers send feedback to MapSure. More...
 
enum   StopType { Origin = 1, Work = 2, Waypoint = 3, FuelStop = 4, RestStopShort = 5, RestStopLong = 6, RestStopCycleReset = 7, Destination = 9, Delivery = 10, Pickup = 11, RendezVous = 12, RestStopFullDay = 13, RestStopDriverSwitch = 14, BorderCrossing = 15, Break = 16, RestStopShortSplittable = 17, RestStopBiWeekly = 18 }
 
enum   MapSureStatus { SUBMITTED = 0, PENDING, ACCEPTED, REJECTED, DELETED }
 
enum   RoadType { InterStateRural = 1, DividedRural = 3, PrimaryRural = 4, FerriesRural = 5, SecondaryRural = 6, RampRural = 7, LocalRural = 8, InterStateUrban = 10, DividedUrban = 12, PrimaryUrban = 13, FerriesUrban = 14, SecondaryUrban = 15, RampUrban = 16, LocalUrban = 17 }
  Represents the type of roads for road speeds. More...
 
enum   RoadTypeTransition40 { InterStateRural = 1, DividedRural = 3, PrimaryRural = 4, FerriesRural = 5, SecondaryRural = 6, RampRural = 7, LocalRural = 8, InterStateUrban = 11, DividedUrban = 13, PrimaryUrban = 14, FerriesUrban = 15, SecondaryUrban = 16, RampUrban = 17, LocalUrban = 18 }
  Represents the type of roads for road speeds. More...
 
enum   Country {
  AD = 5, AM = 10, AT = 13, AZ = 14, BY = 21, BE = 19, BA = 26, BG = 31, HR = 51, CY = 53, CZ = 54, DK = 55, EE = 65, FO = 67, FI = 70, FR = 71, GE = 77, DE = 78, GI = 80, GR = 81,
  HU = 93, IS = 94, IE = 99, IM = 100, IT = 102, JE = 244, KZ = 107, XK = 240, KG = 114, LV = 116, LI = 121, LT = 122, LU = 123, MK = 125, MT = 131, MD = 140, MC = 141, ME = 143, NL = 151, NO = 161,
  PL = 172, PT = 173, RO = 178, RU = 179, SM = 186, RS = 237, SK = 193, SI = 194, ES = 198, SJ = 202, SE = 204, CH = 205, TJ = 208, TR = 216, TM = 217, UA = 221, GB = 223, UZ = 227, VA = 229
}
 
enum   HazMatType { None, General, Caustic, Explosives, Flammable, Inhalants, Radioactive, HarmfulToWater, Tunnel }
  Represents the hazardous material type. More...
 
enum   TunnelCategory { None, TunnelBCDE, TunnelCDE, TunnelDE, TunnelE }
  Represents the EU Tunnel categories. Applicable for EU region only. More...
 
enum   LanguageType { ENUS, ENGB, DE, FR, ES, IT }
  Represents the language to use. More...
 
enum   DiagnosticsType { TripFileLog = 0, TripTraceLog = 1, TimeWindowInputLog = 2 }
  Represents the Diagnostics Type More...
 

Enumeration Type Documentation

◆ FPCGeocodes

enum FPCGeocodes
strong

WPWS-2085 - Add Licensing Support for FPC - Geocode calls this indicates where the full postal code is from NT Basic means this is not a special full postal code and anybody can use it NT Premium is a full postal code from NT Premium files OSNI is a full postal code from OSNI

Enumerator
NTBasic 

default - Full postal code

NTPremium 

full postal code from NT Premium files

OSNI 

OSNI is a full postal code from OSNI

◆ GeofenceShape

enum GeofenceShape : byte
strong

Specifies the Geofence shape type

Enumerator
Circle 

Geofence shape is Circle

Polygon 

Geofence shape is a polygon (includes rectangles)

◆ GeofenceState

enum GeofenceState : byte
strong

Specifies the active state of the Geofence

Enumerator
Off 

Geofence is off and won't be used in routing/reporting

Warn 

Geofence won't be used for routing, but warnings will be produced when entering it

Avoid 

Geofence will be avoided when routing.

◆ PostCodeType

enum PostCodeType
strong

Specifies the country code filter for US and Mexican zip code.

The default is us.

Enumerator
US 

Indicates the country code filter to be the United States.

Mexico 

Indicates the country code filter to be Mexico.

Both 

Indicates the country code filter to be both United States and Mexico.

◆ CountryAbbreviationType

Specifies the abbreviation format for countries.

The default is FIPS

Enumerator
FIPS 

Indicates the country abbreviation type to FIPS.

ISO2 

Indicates the country abbreviation type to ISO2.

ISO3 

Indicates the country abbreviation type to ISO3.

GENC2 

Two-letter code format for Geopolitical Entities and Codes.

GENC3 

Three-letter code format for Geopolitical Entities and Codes.

◆ DataRegion

enum DataRegion
strong

Represents the data region to use when geocoding or reverse geocoding or when specifying locations in general.

Enumerator
Unknown 

Indicates an unspecified continent region. This value is for internal use should not be used by the user.

AF 

Indicates Africa.

AS 

Indicates Asia.

EU 

Indicates Europe.

NA 

Indicates North America.

OC 

Indicates the Australian continent.

SA 

Indicates South America.

ME 

Indicates Middle East.

MX 

Indicates Middle East.

◆ VolumeUnits

enum VolumeUnits
strong

Specifies whether gallons or liters are used for fuel volumes.

Enumerator
Gallons 

Indicates U.S. gallons should be used.

Liters 

Indicates liters should be used.

◆ VehicleDimUnits

enum VehicleDimUnits
strong

Specifies whether English or metric units describe vehicle dimensions.

Enumerator
English 

Indicates that vehicle dimension units should be English, e.g., 13'6".

Metric 

Indicates that vehicle dimension units should be metric.

◆ DistanceUnits

enum DistanceUnits
strong

Represents the units used for distances.

Enumerator
Miles 

Indicates miles should be used.

Kilometers 

Indicates kilometers should be used.

◆ AFType

enum AFType
strong

Represents the type of an ALK.PCM.Model.BusinessModels.AvoidFavor.

Note that this enumeration is flagged, meaning that both values can be set at once as might be used when request avoid and favors.

Enumerator
Avoid 

Indicates an avoid.

Favor 

Indicates a favor.

◆ MapsureVisibilityStatus

Represents VisibilityStatus for Mapsure, Public/Private.

Enumerator
Public 

public

Private 

private

◆ DriverFeedbackIssueType

The type of issue that can be reported when drivers send feedback to MapSure.

◆ RoadType

enum RoadType
strong

Represents the type of roads for road speeds.

Enumerator
InterStateRural 

Indicates a rural interstate road type.

DividedRural 

Indicates rural divided road type.

PrimaryRural 

Indicates a rural primary road type.

FerriesRural 

Indicates a rural ferry road type.

SecondaryRural 

Indicates a rural secondary road type.

RampRural 

Indicates a rural ramp road type.

LocalRural 

Indicates a rural local road type.

InterStateUrban 

Indicates an urban interstate road type.

DividedUrban 

Indicates an urban divided road type.

PrimaryUrban 

Indicates an urban primary road type.

FerriesUrban 

Indicates an urban ferry road type.

SecondaryUrban 

Indicates an urban secondary road type.

RampUrban 

Indicates an urban ramp road type.

LocalUrban 

Indicates an urban local road type.

◆ RoadTypeTransition40

enum RoadTypeTransition40
strong

Represents the type of roads for road speeds.

Enumerator
InterStateRural 

Indicates a rural interstate road type.

DividedRural 

Indicates rural divided road type.

PrimaryRural 

Indicates a rural primary road type.

FerriesRural 

Indicates a rural ferry road type.

SecondaryRural 

Indicates a rural secondary road type.

RampRural 

Indicates a rural ramp road type.

LocalRural 

Indicates a rural local road type.

InterStateUrban 

Indicates an urban interstate road type.

DividedUrban 

Indicates an urban divided road type.

PrimaryUrban 

Indicates an urban primary road type.

FerriesUrban 

Indicates an urban ferry road type.

SecondaryUrban 

Indicates an urban secondary road type.

RampUrban 

Indicates an urban ramp road type.

LocalUrban 

Indicates an urban local road type.

◆ HazMatType

enum HazMatType
strong

Represents the hazardous material type.

Enumerator
None 

Indicates that there is no hazardous material.

General 

Indicates a general hazardous materials.

Caustic 

Indicates caustic hazardous materials.

Explosives 

Indicates explosive hazardous materials.

Flammable 

Indicates flammable hazardous materials.

Inhalants 

Indicates that the hazardous materials are inhalants.

Radioactive 

Indicates radioactive hazardous materials.

HarmfulToWater 

Indicates hazardous material harm ful to water.

Tunnel 

Indicates a generic tunnel restriction

◆ TunnelCategory

enum TunnelCategory
strong

Represents the EU Tunnel categories. Applicable for EU region only.

Enumerator
None 

Indicates that there is no Tunnel category.

TunnelBCDE 

Indicates EU Tunnel category BCDE.

TunnelCDE 

Indicates EU Tunnel category CDE.

TunnelDE 

Indicates EU Tunnel category DE..

TunnelE 

Indicates EU Tunnel category E.

◆ LanguageType

enum LanguageType
strong

Represents the language to use.

Enumerator
ENUS 

Indicates English - United States.

ENGB 

Indicates English - Great Britain.

DE 

Indicates German.

FR 

Indicates French.

ES 

Indicates Spanish.

IT 

Indicates Italian.

◆ DiagnosticsType

enum DiagnosticsType
strong

Represents the Diagnostics Type

Enumerator
TripFileLog 

the trip file log, the json representation of a trip

TripTraceLog 

The trip trace log

TimeWindowInputLog 

Time window input information log