CartoType .NET API 7.8.2, 2022-03-25
for development in C#, Visual Basic and other .NET languages
|
Classes | |
class | Address |
A structured address. Any field may be empty or null, but at least one field should be non-empty for address searching to return any results. More... | |
class | BlendStyle |
A rule to modify a certain style or styles. The colors are blended with colors in a style, using their alpha values as the blend fraction. More... | |
class | BlendStyleSet |
A set of rules for modifying style sheet colors, for example to add contrast, lighten or darken. The rules are applied in order. Only the first rule matching a style is applied. More... | |
class | Color |
A color> More... | |
class | ExtendedNoticePosition |
Positions for notices like the legend or scale bar. More... | |
class | FindNearbyParam |
Parameters for finding nearby places. More... | |
class | FindParam |
Parameters for the general Find function. More... | |
class | Framework |
The Framework class provides a high-level API for CartoType, through which map data can be loaded, maps can be created and viewed, and routing and navigation can be performed. More... | |
class | FrameworkParam |
Parameters for creating a Framework object when more detailed control is needed. For example, file buffer size and the maximum number of buffers can be set. More... | |
class | Geometry |
A geometry class for creating map objects and specifying view areas. There are also functions for the determining distance and intersection type between a geometry object and map objects. More... | |
class | GeometryList |
A type for lists of geometry objects returned by Geometry functions. More... | |
class | Legend |
The Legend class is used to specify legends, scales, copyright notices and turn instructions. More... | |
class | LocationMatchParam |
Parameters used when matching a road or other feature to a location. More... | |
class | LocationRef |
Parameters used for a location reference when writing traffic information. More... | |
class | MapMetaData |
Metadata describing a CTM1 map file. More... | |
class | MapObject |
A map object: a point, linear object, polygon object, or array (texture). More... | |
class | MapObjectGroup |
A group of map objects with the same name, as used in a list of found objects. More... | |
class | MapObjectGroupList |
A type for lists of map object groups returned by search functions. More... | |
class | MapObjectList |
A type for lists of map objects returned by search functions. More... | |
class | MapRenderer |
A class to draw a map using OpenGL ES. More... | |
class | NavigatorParam |
Parameters governing navigation behaviour. More... | |
class | NearestRoadInfo |
Information about the nearest road to a certain point. More... | |
class | NearestSegmentInfo |
Information about the nearest route segment to a point. More... | |
interface | Path |
A path defining a set of open and closed curves. More... | |
class | PathIntersectionInfo |
Information about the intersection of two paths and their distance apart. For functions involving map objects, distances are meters and positions are latitude and longitude. More... | |
class | PathIntersectionInfoList |
A type for lists of path intersection information objects returned by Geometry functions. More... | |
class | PathIntersectionTypeList |
A type for lists of path intersection types returned by Geometry functions. More... | |
class | PathPoint |
An on-curve or off-curve point for use in paths. More... | |
class | PerspectiveParam |
Parameters giving detailed control of the perspective view. More... | |
class | Point |
A 2D point using floating-point coordinates. More... | |
struct | PointValue |
class | PositionedBitmap |
A bitmap and a position to draw it. Used when drawing notices on the map. More... | |
class | Rect |
A grid-aligned rectangle with double-precision coordinates suitable for map points. More... | |
class | Route |
Information about an entire route. More... | |
class | RouteCoordSet |
A set of points for creating a route, with optional heading and accuracy information. More... | |
class | RoutePoint |
A point on a route, with its heading and location match parameters. More... | |
class | RoutePointList |
A type for lists of route points: see RouteCoordSet. More... | |
class | RouteProfile |
A routing profile: parameters determining the type of route, including road speeds, bonuses and penalties, and vehicle type. A road type will not be used if its speed plus bonus is equal to or less than zero. More... | |
class | RouteSegment |
Part of a route, consisting of a turn and the section of the route from that turn to the next one. More... | |
class | TimeAndDistanceMatrix |
A matrix of route times and distances between sets of points. More... | |
class | TrafficInfo |
Traffic information. This information is normally used in combination with a location reference. More... | |
class | Turn |
Information about a turn through a junction. More... | |
class | Util |
General utility functions More... | |
class | ViewState |
The view state, which can be retrieved or set so that maps can be recreated. More... | |
Enumerations | |
enum class | Result { Success = 0 , ErrorNone = 0 , ErrorGeneral = 1 , ErrorNoMemory = 2 , ErrorEndOfData = 3 , ErrorTextUnmodifiable = 4 , ErrorTextTruncated = 5 , ErrorNotFound = 6 , ErrorUnimplemented = 7 , ErrorInvalidOutline = 8 , ErrorIo = 9 , ErrorCorrupt = 10 , ErrorUnknownDataFormat = 11 , ErrorNoInverse = 12 , ErrorProjectionOverflow = 13 , ErrorCancel = 14 , ErrorInvalidArgument = 15 , ErrorUnknownVersion = 16 , ErrorOverflow = 17 , ErrorParallelLines = 19 , ErrorNoPalette = 22 , ErrorDuplicate = 23 , ErrorNoProjection = 24 , ErrorPaletteFull = 25 , ErrorInvalidDashArray = 26 , ErrorCentralPath = 27 , ErrorNoRoute = 28 , ErrorZoomLimitReached = 29 , ErrorAlreadyProjected = 30 , ErrorConditionsTooDeeplyNested = 31 , ErrorNullFont = 32 , ErrorInternetIo = 33 , ErrorDivideByZero = 34 , ErrorTransformFailed = 35 , ErrorPngRead = 36 , ErrorJpgRead = 37 , ErrorNoIntersection = 38 , ErrorInterrupt = 39 , ErrorMapDataBaseFormatMismatch = 40 , ErrorEncryptionKeyTooShort = 41 , ErrorNoEncryptionKey = 42 , ErrorEmergencyMessage = 43 , ErrorAlertMessage = 44 , ErrorCriticalMessage = 45 , ErrorErrorMessage = 46 , ErrorWarningMessage = 47 , ErrorNoticeMessage = 48 , ErrorInfoMessage = 49 , ErrorDebugMessage = 50 , ErrorNotNavigating = 51 , ErrorNoFramework = 52 , ErrorFrameworkAlreadyExists = 53 , ErrorUntransliterable = 54 , ErrorPngWrite = 55 , ErrorReadOnlyMapDataBase = 56 , ErrorProj4 = 57 , ErrorUnlicensed = 58 , ErrorNoRoadsNearStartOfRoute = 59 , ErrorNoRoadsNearEndOfRoute = 60 , ErrorNoRouteConnectivity = 61 , ErrorXmlFeatureNotSupported = 62 , ErrorMapNotFound = 63 , ErrorFontNotFound = 64 , ErrorStyleSheetNotFound = 65 , StandardErrorCodeCount = 66 , ErrorXmlRangeStart = 0x10000000 , ErrorXmlRangeEnd = 0x2AFFFFFF , ErrorSQLite = 0x30000000 } |
Result codes returned by CartoType API functions. More... | |
enum class | MapObjectType { Point , Line , Polygon , Array , TypeCount } |
An enumerated type for map objects. More... | |
enum class | StringMatchMethod { PrefixFlag = 1 , IgnoreSymbolsFlag = 2 , FoldAccentsFlag = 4 , FuzzyFlag = 8 , FoldCaseFlag = 16 , IgnoreWhitespaceFlag = 32 , Exact = 0 , FoldCase = FoldCaseFlag , Prefix = PrefixFlag , IgnoreNonAlphanumerics = IgnoreSymbolsFlag | IgnoreWhitespaceFlag , Loose = IgnoreNonAlphanumerics | FoldAccentsFlag | FoldCaseFlag , Fuzzy = IgnoreNonAlphanumerics | FoldAccentsFlag | FuzzyFlag | FoldCaseFlag } |
Flags and constants used when finding text. More... | |
enum class | LetterCase { None , Lower , Upper , Title } |
enum class | PointOfInterestType { None , Airport , Bar , Beach , BusStation , Cafe , Camping , FastFood , Fuel , GolfCourse , Hospital , Hotel , Pharmacy , Police , Restaurant , Shops , SportsCenter , Supermarket , SwimmingPool , Tourism , TrainStation } |
Types of place to search for in the 'find nearby' parameters. More... | |
enum class | FollowFlag { Location = 1 , Heading = 2 , Zoom = 4 } |
Bit flags used by the FollowMode constants. More... | |
enum class | FollowMode { None = 0 , Location = (int)FollowFlag::Location , LocationHeading = (int)FollowFlag::Location | (int)FollowFlag::Heading , LocationZoom = (int)FollowFlag::Location | (int)FollowFlag::Zoom , LocationHeadingZoom = (int)FollowFlag::Location | (int)FollowFlag::Heading | (int)FollowFlag::Zoom } |
Flags controlling the way the map follows the user location and heading and automatically zooms. More... | |
enum class | ValidityFlag { Time = 1 , Position = 2 , Speed = 4 , Course = 8 , Height = 16 } |
Bit flags used in Framework.Navigate to indicate which information is valid. More... | |
enum class | NavigationState { None , NoPosition , Turn , OffRoute , ReRouteNeeded , ReRouteDone , TurnRound , Arrival } |
States of the navigation system. More... | |
enum class | RouterType { Default , StandardAStar , TurnExpandedAStar , StandardContractionHierarchy , TECH } |
Types of router; used when selecting a router type. More... | |
enum class | TurnType { None , Ahead , BearRight , Right , SharpRight , Around , SharpLeft , Left , BearLeft } |
Turn types on a route. Turns at junctions are classified by dividing the full circle into 45-degree segments, except for sharp turns left and right, which encompass everything up to an actual U-turn. More... | |
enum class | RoundaboutState { None , Enter , Continue , Exit } |
Turns involving roundabouts are marked as such so that exit numbers can be counted More... | |
enum class | RouteProfileType { Car , Walk , Walking = Walk , Cycle , Bicycle = Cycle , Hike , Hiking = Hike } |
Constants used to select frequently-used profiles. More... | |
enum class | RoadType : unsigned { RoutingMask = 0x3E , RoadTypeMask = 0xFC0 , MajorRoadTypeMask = 0xF00 , RoadLevelMask = 0xF000 , TunnelFlag = 1 , BridgeFlag = 0x10000 , RoadLevelShift = 12 , RampFlag = 64 , LinkFlag = RampFlag , LowerGradeFlag = 128 , UnknownMajorRoadType = 0 , PrimaryLimitedAccessRoadType = 0x100 , PrimaryUnlimitedAccessRoadType = 0x200 , SecondaryRoadType = 0x300 , MinorRoadType = 0x400 , BywayRoadType = 0x500 , AccessRampRoadType = 0x600 , ServiceRoadType = 0x700 , VehicularFerryRoadType = 0x800 , PassengerFerryRoadType = 0x900 , PathRoadType = 0xA00 , StairwayRoadType = 0xB00 , CyclePathRoadType = 0xC00 , FootPathRoadType = 0xD00 , OtherRoadType0 = 0xE00 , OtherRoadType1 = 0xE00 | LowerGradeFlag , OtherRoadType2 = 0xE00 | LinkFlag , OtherRoadType3 = 0xE00 | LowerGradeFlag | LinkFlag , OtherRoadType4 = 0xF00 , OtherRoadType5 = 0xF00 | LowerGradeFlag , OtherRoadType6 = 0xF00 | LinkFlag , OtherRoadType7 = 0xF00 | LowerGradeFlag | LinkFlag , TollFlag = 2 , RoundaboutFlag = 4 , RestrictionFlag = 8 , OneWayForwardFlag = 16 , OneWayBackwardFlag = 32 , FirstOverRoadLevel = 0x1000 , FirstUnderRoadLevel = 0xF000 , SecondUnderRoadLevel = 0xE000 , RoadAccessMask = 0xFFFE0000 , BicycleRoadAccessFlag = 0x20000 , MotorCycleRoadAccessFlag = 0x40000 , MotorCarRoadAccessFlag = 0x80000 , HighOccupancyRoadAccessFlag = 0x100000 , GoodsRoadAccessFlag = 0x200000 , HeavyGoodsRoadAccessFlag = 0x400000 , BusRoadAccessFlag = 0x800000 , TaxiRoadAccessFlag = 0x1000000 , PedestrianRoadAccessFlag = 0x2000000 , AgriculturalRoadAccessFlag = 0x4000000 , ForestryRoadAccessFlag = 0x8000000 , EmergencyRoadAccessFlag = 0x10000000 , HazardousRoadAccessFlag = 0x20000000 , WheelChairRoadAccessFlag = 0x40000000 , DisabledRoadAccessFlag = 0x80000000 , MotorVehicleRoadAccessMask = 0xFFFE0000 & ~(PedestrianRoadAccessFlag | BicycleRoadAccessFlag | WheelChairRoadAccessFlag) , PublicServiceVehicleRoadAccessMask = BusRoadAccessFlag | TaxiRoadAccessFlag , Motorway = PrimaryLimitedAccessRoadType , MotorwayLink = PrimaryLimitedAccessRoadType | LinkFlag , TrunkRoad = PrimaryUnlimitedAccessRoadType , TrunkRoadLink = PrimaryUnlimitedAccessRoadType | LinkFlag , PrimaryRoad = PrimaryUnlimitedAccessRoadType | LowerGradeFlag , PrimaryRoadLink = PrimaryUnlimitedAccessRoadType | LowerGradeFlag | LinkFlag , SecondaryRoad = SecondaryRoadType , SecondaryRoadLink = SecondaryRoadType | LinkFlag , TertiaryRoad = SecondaryRoadType | LowerGradeFlag , TertiaryRoadLink = SecondaryRoadType | LowerGradeFlag | LinkFlag , UnclassifiedRoad = MinorRoadType , ResidentialRoad = MinorRoadType | LowerGradeFlag , Track = BywayRoadType , ServiceRoad = ServiceRoadType , PedestrianRoad = PathRoadType , VehicularFerry = VehicularFerryRoadType , PassengerFerry = PassengerFerryRoadType } |
The type of a road belonging to a route segment, etc. More... | |
enum class | AddressPart { Building , Feature , Street , SubLocality , Locality , Island , SubAdminArea , AdminArea , Country , PostCode } |
Address part codes used when searching for address parts separately. | |
enum class | WritableMapType { Memory , SQLite } |
Types of writable maps. More... | |
enum class | FileType { Png , Jpeg , Tiff , Ctm1 , Ctms , Kml , Ctsql , CartoTypeRoute , Gpx } |
File types of interest to CartoType. More... | |
enum class | SideOfRoad { None , Right , Left , Both } |
The side of the road: used in traffic information. | |
enum class | RoadOrientation { None , Forwards , Backwards , Both } |
The orientation of a path along a road: used in traffic information. | |
enum class | LocationRefType { Line , GeoCoordinate , PointAlongLine , PointWithAccessPoint , Circle , Rectangle , Polygon , ClosedLine } |
The type of a location reference used for traffic information. More... | |
enum class | NoticePosition { TopLeft , TopRight , BottomLeft , BottomRight , Top , Right , Left , Bottom , Center } |
Positions for notices like the legend or scale bar. Use functions taking an ExtendedNoticePosition for greater control. More... | |
enum class | RouteAccess { Unknown , Accessible , Isolated , NoRoad } |
The accessibility of a point for routing purposes. The Framework.GetRouteAccess function, if implemented for the current router, returns a value of this type. More... | |
enum class | Align { Center , Standard , Reverse , Left , Right } |
Text alignments. More... | |
enum class | PointType { OnCurve , Quadratic , Cubic } |
Types used by PathPoint. More... | |
enum class | ClipOperation { Intersection , Union , Difference , Xor } |
Types of clipping done by Geometry.Clip. More... | |
enum class | CoordType { Degree , Screen , Map , MapMeter } |
Coordinate types. More... | |
enum class | PathIntersectionType { Unknown , Separate , Intersects , Contains , Contained } |
The ways two paths can intersect. More... | |
enum class | MapTableType { GlobalTable = 0 , LayerTable = 1 , Table2Obsolete = 2 , Table3Obsolete = 3 , ProjectionTable = 4 , StringTable = 5 , LowResolutionLayerTable = 6 , PaletteTable = 7 , TextIndexTable = 8 , Table9Obsolete = 9 , RouteTableAStar = 10 , RouteTableCH = 11 , RouteTableExtra = 12 , RouteTableTurnExpanded = 13 , RouteTableCHStandAlone = 14 , RouteTableTECH = 15 , RouteTableCHTiled = 16 , RouteTableTECHTiled = 17 , RouteTableTurnExpandedCompact = 18 , NoTable = 65535 } |
Identifiers of tables in CTM1 map files. More... | |
enum class | PointFormat { Unknown = 0 , Meter = 2 , ScaledDegree = 7 , Meter32nds = 8 } |
The format used for points in CTM1 data. These numbers must fit into 8 bits for the moment because of the way they are stored in the CTM1 file. The values are discontinuous because several obsolete values have been discarded. More... | |
Functions | |
public delegate void | FindAsyncDelegate (MapObjectList^) |
A delegate type for the asynchronous find function. | |
public delegate void | FindAsyncGroupDelegate (MapObjectGroupList^) |
A delegate type for the asynchronous find function for map object groups. | |
public delegate void | RouterAsyncDelegate (Result, Route^) |
A delegate type for the asynchronous routing functions. | |
The CartoType map rendering library.
|
strong |
Text alignments.
|
strong |
Types of clipping done by Geometry.Clip.
|
strong |
Coordinate types.
|
strong |
File types of interest to CartoType.
Enumerator | |
---|---|
Png | PNG (Portable Network Graphics) image files. |
Jpeg | JPEG (Joint Photographic Expert Group) image files. |
Tiff | TIFF (Tagged Image File Format) image files. |
Ctm1 | CTM1 (CartoType Map Data Type 1) map data files. |
Ctms | CTMS (CartoType Map Data, Serialized) map data files. |
Kml | KML (Keyhole Markup Language) map data files. |
Ctsql | CTSQL (CartoType SQLite format) map data files. |
CartoTypeRoute | CTROUTE (CartoType XML route) files. |
Gpx | GPX (GPS Exchange) files. |
|
strong |
|
strong |
Flags controlling the way the map follows the user location and heading and automatically zooms.
|
strong |
The case of letters and strings in the Latin, Greek, Cyrillic and other alphabetic scripts.
|
strong |
The type of a location reference used for traffic information.
|
strong |
An enumerated type for map objects.
|
strong |
Identifiers of tables in CTM1 map files.
|
strong |
States of the navigation system.
|
strong |
Positions for notices like the legend or scale bar. Use functions taking an ExtendedNoticePosition for greater control.
|
strong |
|
strong |
The format used for points in CTM1 data. These numbers must fit into 8 bits for the moment because of the way they are stored in the CTM1 file. The values are discontinuous because several obsolete values have been discarded.
|
strong |
Types of place to search for in the 'find nearby' parameters.
|
strong |
Types used by PathPoint.
Enumerator | |
---|---|
OnCurve | A point on the curve. |
Quadratic | A control point for a quadratic (conic) Bezier spline curve. |
Cubic | A control point for a cubic Bezier spline curve. |
|
strong |
Result codes returned by CartoType API functions.
Enumerator | |
---|---|
Success | No error; a successful result. |
ErrorNone | No error; a successful result. |
ErrorGeneral | An error has occurred but no other CartoType error is applicable. For example, this error code can be used when FreeType returns an error code for illegal TrueType hinting instructions. |
ErrorNoMemory | ErrorNoMemory is returned when an attempted memory allocation fails. |
ErrorEndOfData | ErrorEndOfData is returned by iterators and streams when no more data is available. It may be treated as an error or not depending on the circumstances. |
ErrorTextUnmodifiable | ErrorTextUnmodifiable is returned when an attempt is made to modify an unmodifiable string represented by a class derived from MString. |
ErrorTextTruncated | ErrorTextTruncated is returned when text inserted into a string derived from MString is too long for a fixed-size buffer. |
ErrorNotFound | ErrorNotFound is returned whenever a resource like a file is not found, or a search fails. It may be treated as an error or not depending on the circumstances. |
ErrorUnimplemented | The code ErrorUnimplemented is used for functions that have not yet been implemented, or for circumstances or options within functions that remain unimplemented because they are deemed to be either rarely or never useful. |
ErrorInvalidOutline | If the graphics system detects an invalid outline, such as one that starts with a cubic control point, it returns ErrorInvalidOutline. |
ErrorIo | The code ErrorIo is used for unexpected read or write errors on files or other data streams. This is for where you attempt to read data that should be there, but the OS says it's unavailable (e.g., someone has taken the CD out of the drive or the network is down). |
ErrorCorrupt | ErrorCorrupt is returned when illegal values are found when reading data from a file or other serialized form. |
ErrorUnknownDataFormat | This error is returned by database accessors, typeface accessors, etc., to indicate that this data format is unknown to a particular accessor. It is not really an error but tells the caller to try the next accessor in the list. |
ErrorNoInverse | This error is returned by transformation inversion if the transformation has no inverse. |
ErrorProjectionOverflow | This error is returned by the projection system if the projection causes overflow. |
ErrorCancel | The code ErrorCancel is returned to cancel an asynchronous operation that uses callbacks. The callback or virtual function returns this code. The caller must terminate further processing on receipt of any error, but this one indicates that there has been no actual error, but the handler has canceled the operation. |
ErrorInvalidArgument | This error is returned when an invalid argument has been given to a function. |
ErrorUnknownVersion | This error is returned by a data reader when it can not deal with the data version. |
ErrorOverflow | This error is returned by the base library when reading data or calculations result in overflow. |
ErrorParallelLines | The error code returned by line intersection algorithms when the lines are parallel. |
ErrorNoPalette | An attempt was made to draw a bitmap needing a color palette but no palette was provided. |
ErrorDuplicate | An attempt was made to insert a duplicate object into a collection class that does not allow duplicates. |
ErrorNoProjection | The projection for converting latitude and longitude to map coordinates is unknown or unavailable. |
ErrorPaletteFull | A palette is full and no new entries can be added. |
ErrorInvalidDashArray | The dash array for drawing strokes is invalid. |
ErrorCentralPath | The central-path system failed to create a usable path. |
ErrorNoRoute | A route was needed by the navigation system but no route was available. |
ErrorZoomLimitReached | There was an attempt to zoom beyond the legal zoom limits for a map. |
ErrorAlreadyProjected | There was an attempt to project a map object that had already been projected. |
ErrorConditionsTooDeeplyNested | Conditions are too deeply nested in the style sheet. |
ErrorNullFont | There was an attempt to use a null font for drawing text. |
ErrorInternetIo | An attempt to read data from the internet failed. |
ErrorDivideByZero | Division by zero in an interpreted expression. |
ErrorTransformFailed | A transform failed because an argument or result was out of range. |
ErrorPngRead | Reading a bitmap from PNG format failed. |
ErrorJpgRead | Reading a bitmap from JPG format failed. |
ErrorNoIntersection | An object did not intersect a specified region. |
ErrorInterrupt | An operation was interrupted, for example by another thread writing to a shared flag. |
ErrorMapDataBaseFormatMismatch | There was an attempt to use map databases of incompatible formats together. |
ErrorEncryptionKeyTooShort | A key supplied for encryption was too short. |
ErrorNoEncryptionKey | No encryption key has been set. |
ErrorEmergencyMessage | A code for standard emergency messages. |
ErrorAlertMessage | A code for standard alert messages. |
ErrorCriticalMessage | A code for standard critical messages. |
ErrorErrorMessage | A code for standard error messages. |
ErrorWarningMessage | A code for standard warning messages. |
ErrorNoticeMessage | A code for standard notice messages. |
ErrorInfoMessage | A code for standard information messages. |
ErrorDebugMessage | A code for standard debug messages. |
ErrorNotNavigating | A function has been called which is available only when navigating. |
ErrorNoFramework | The global framework object does not exist. |
ErrorFrameworkAlreadyExists | The global framework object already exists. |
ErrorUntransliterable | A string was not transliterable. |
ErrorPngWrite | Writing a bitmap to PNG format failed. |
ErrorReadOnlyMapDataBase | There was an attempt to write to a read-only map database. |
ErrorProj4 | There was an error in the PROJ.4 projection library error other than a projection overflow. |
ErrorUnlicensed | A function was called from the unlicensed version of CartoType that is available only in the licensed version. |
ErrorNoRoadsNearStartOfRoute | No route could be created because there were no roads near the start point of a route section. |
ErrorNoRoadsNearEndOfRoute | No route could be created because there were no roads near the end point of a route section. |
ErrorNoRouteConnectivity | No route could be created because the start and end point were not connected. |
ErrorXmlFeatureNotSupported | An unsupported feature was requested from the XML parser. |
ErrorMapNotFound | A map file was not found. |
ErrorFontNotFound | A font file was not found. |
ErrorStyleSheetNotFound | A style sheet was not found. |
StandardErrorCodeCount | The number of standard error codes. |
ErrorXmlRangeStart | The start of the range of errors in XML parsing or in the style sheet format, such as a syntactically incorrect dimension or color. The top byte is 0x10 for style sheet errors, or in the range 0x11 to 0x2A for Expat XML parser error codes. The low three bytes give the error location: one byte for the column number (clamped to 0...255) two bytes for the line number (clamped to 0...65535). |
ErrorXmlRangeEnd | The end of the range of errors in XML parsing or in the style sheet format. |
ErrorSQLite | The base of error codes for returning SQLite errors. The SQLite error code is placed in the lower two bytes. |
|
strong |
The type of a road belonging to a route segment, etc.
Enumerator | |
---|---|
RoutingMask | The toll, roundabout, restriction and direction flags are held in bits 1...5. |
RoadTypeMask | The road type is held in bits 6...11. |
MajorRoadTypeMask | The major road type is held in bits 8...11; bits 7 and 6 are used for finer distinctions. |
RoadLevelMask | The level (0 = surface, positive = above surface, negative = below surface) is held as a signed nybble in bits 12...15. Levels above 0 are not necessarily bridges; they can be embankments or other raised structures, and levels below 0 are not necessarily tunnels. There are separate bits to mark bridges and tunnels: EBridgeRoadTypeFlag and ETunnelRoadTypeFlag. The level mask is also used for levels in the 'Type' attribute of non-road objects. |
TunnelFlag | A bit flag to identify tunnels. |
BridgeFlag | A bit flag to identify bridges. |
RoadLevelShift | The amount by which road levels are shifted. |
RampFlag | A bit flag to allow access ramps to be marked as sub-types of a major road type. |
LinkFlag | A synonym for RampRoadTypeFlag. |
LowerGradeFlag | A bit flag to allow a distinction to be made between grades of road, within the major road type. It allows OSM data to distinguish trunk roads from primary roads in a backward-compatible way. |
UnknownMajorRoadType | Roads of unknown type. |
PrimaryLimitedAccessRoadType | Primary road with limited access (motorway, freeway, etc.). |
PrimaryUnlimitedAccessRoadType | Primary road without limited access: UK 'A' road. |
SecondaryRoadType | Secondary road: UK 'B' road. |
MinorRoadType | Local road or town or city street. |
BywayRoadType | Byway: road or track open to motor vehicles. |
AccessRampRoadType | Access ramp to limited access road. |
ServiceRoadType | Service road or access road. |
VehicularFerryRoadType | Vehicular Ferry route. |
PassengerFerryRoadType | Passenger-only Ferry route. |
PathRoadType | Path or walkway for pedestrians. |
StairwayRoadType | Stairway or escalator for pedestrians. |
CyclePathRoadType | Cycle path. |
FootPathRoadType | Footpath. |
TollFlag | A toll must be paid to use this road. More details may be available in string attributes. |
RoundaboutFlag | A bit flag indicating that the road is part of a roundabout. |
RestrictionFlag | A bit flag indicating that the road has one or more restrictions (e.g., right turn only). The details of the restrictions are stored in string attributes. |
OneWayForwardFlag | A bit flag indicating that the road is one-way in the direction in which it is defined. |
OneWayBackwardFlag | A bit flag indicating that the road is one-way in the reverse direction to that in which it is defined. |
FirstOverRoadLevel | The first raised level: the default level for a bridge or overpass. |
FirstUnderRoadLevel | The first sub-surface level: the default value for an underpass. |
SecondUnderRoadLevel | The second sub-surface level: the default value for a tunnel. |
BicycleRoadAccessFlag | Access is forbidden to bicycles. |
MotorCycleRoadAccessFlag | Access is forbidden to motorcycles. |
MotorCarRoadAccessFlag | Access is forbidden to motor cars. |
HighOccupancyRoadAccessFlag | Access is forbidden to high-occupancy vehicles. |
GoodsRoadAccessFlag | Access is forbidden to light goods vehicles. |
HeavyGoodsRoadAccessFlag | Access is forbidden to heavy goods vehicles. |
BusRoadAccessFlag | Access is forbidden to buses. |
TaxiRoadAccessFlag | Access is forbidden to taxis. |
PedestrianRoadAccessFlag | Access is forbidden to pedestrians. |
AgriculturalRoadAccessFlag | Access is forbidden to agricultural vehicles. |
ForestryRoadAccessFlag | Access is forbidden to forestry vehicles. |
EmergencyRoadAccessFlag | Access is forbidden to emergency vehicles. |
HazardousRoadAccessFlag | Access is forbidden to vehicles carrying hazardous materials. |
WheelChairRoadAccessFlag | Access is forbidden to wheelchairs. |
DisabledRoadAccessFlag | Access is forbidden to vehicles with disabled persons' permits. |
|
strong |
|
strong |
The accessibility of a point for routing purposes. The Framework.GetRouteAccess function, if implemented for the current router, returns a value of this type.
A point is defined as accessible if it is connected to at least 1000 other route segments; thus accessibility is not defined correctly for very small maps.
|
strong |
|
strong |
Types of router; used when selecting a router type.
|
strong |
Flags and constants used when finding text.
|
strong |
Turn types on a route. Turns at junctions are classified by dividing the full circle into 45-degree segments, except for sharp turns left and right, which encompass everything up to an actual U-turn.
The actual turn angle is also given in the Turn class.
|
strong |
Bit flags used in Framework.Navigate to indicate which information is valid.
Enumerator | |
---|---|
Time | A flag used in Framework.Navigate to indicate that the time is valid. |
Position | A flag used in Framework.Navigate to indicate that the position is valid. |
Speed | A flag used in Framework.Navigate to indicate that the speed is valid. |
Course | A flag used in Framework.Navigate to indicate that the course is valid. |
Height | A flag used in Framework.Navigate to indicate that the height is valid. |
|
strong |