CartoType .NET API 8.0.2, 2022-07-04
for development in C#, Visual Basic and other .NET languages
Classes | Enumerations | Functions
CartoType Namespace Reference

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  FeatureInfo
 Feature information for a map object, represented internally as a 32-bit value. 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  MapObjectMatch
 Information returned by MapObject.Match. 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  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  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 , Ski
}
 Constants used to select frequently-used profiles. 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...
 
enum class  FeatureType {
  Motorway = 0 , MotorwayLink = 1 , TrunkRoad = 2 , TrunkLink = 3 ,
  PrimaryRoad = 4 , PrimaryLink = 5 , SecondaryRoad = 6 , SecondaryLink = 7 ,
  TertiaryRoad = 8 , UnclassifiedRoad = 9 , ResidentialRoad = 10 , Track = 11 ,
  ServiceRoad = 12 , PedestrianRoad = 13 , VehicularFerry = 14 , PassengerFerry = 15 ,
  LivingStreet = 16 , Cycleway = 17 , Path = 18 , Footway = 19 ,
  Bridleway = 20 , Steps = 21 , OtherRoad = 22 , UnpavedRoad = 23 ,
  Railway = 24 , LightRail = 25 , Subway = 26 , AerialWay = 27 ,
  SkiDownhill = 28 , SkiNordic = 29 , Waterway = 30 , UnknownRoute = 31 ,
  UnknownNonRoute = 32 , Aerodrome = FeatureTypeCode('a','e','r') , Airport = FeatureTypeCode('a','i','r') , AirportGate = FeatureTypeCode('a','g','t') ,
  AirportHoldingPosition = FeatureTypeCode('a','h','p') , Allotments = FeatureTypeCode('a','l','l') , AlpineHut = FeatureTypeCode('a','l','p') , AmbulanceStation = FeatureTypeCode('a','m','b') ,
  Apron = FeatureTypeCode('a','p','r') , AerialWayPylon = FeatureTypeCode('a','p','y') , Artwork = FeatureTypeCode('a','r','t') , AerialWayStation = FeatureTypeCode('a','s','t') ,
  AirTerminal = FeatureTypeCode('a','t','e') , Atm = FeatureTypeCode('a','t','m') , Attraction = FeatureTypeCode('a','t','t') , Bar = FeatureTypeCode('b','a','r') ,
  Basin = FeatureTypeCode('b','a','s') , Bay = FeatureTypeCode('b','a','y') , Beach = FeatureTypeCode('b','e','a') , Beacon = FeatureTypeCode('b','e','c') ,
  BedAndBreakfast = FeatureTypeCode('b','e','d') , Bench = FeatureTypeCode('b','e','n') , Bank = FeatureTypeCode('b','n','k') , Boatyard = FeatureTypeCode('b','o','a') ,
  Borough = FeatureTypeCode('b','o','r') , Boundary = FeatureTypeCode('b','o','u') , BicycleParking = FeatureTypeCode('b','p','k') , BicycleRental = FeatureTypeCode('b','r','e') ,
  BareRock = FeatureTypeCode('b','r','c') , Barracks = FeatureTypeCode('b','r','k') , BrownField = FeatureTypeCode('b','r','o') , BusStop = FeatureTypeCode('b','s','p') ,
  BusStation = FeatureTypeCode('b','s','t') , BufferStop = FeatureTypeCode('b','u','f') , Building = FeatureTypeCode('b','u','i') , Bunker = FeatureTypeCode('b','u','n') ,
  Cabin = FeatureTypeCode('c','a','b') , Cafe = FeatureTypeCode('c','a','f') , CampSite = FeatureTypeCode('c','a','m') , Canal = FeatureTypeCode('c','a','n') ,
  CaveEntrance = FeatureTypeCode('c','a','v') , CableCar = FeatureTypeCode('c','c','r') , CableDistributionCabinet = FeatureTypeCode('c','d','c') , Cemetery = FeatureTypeCode('c','e','m') ,
  ChairLift = FeatureTypeCode('c','h','a') , CheckPoint = FeatureTypeCode('c','h','e') , Chalet = FeatureTypeCode('c','h','l') , CivilBoundary = FeatureTypeCode('c','i','b') ,
  Cinema = FeatureTypeCode('c','i','n') , City = FeatureTypeCode('c','i','t') , Cliff = FeatureTypeCode('c','l','f') , Clinic = FeatureTypeCode('c','l','i') ,
  Commercial = FeatureTypeCode('c','m','r') , Coastline = FeatureTypeCode('c','o','a') , College = FeatureTypeCode('c','o','l') , Common = FeatureTypeCode('c','o','m') ,
  Construction = FeatureTypeCode('c','n','s') , Conservation = FeatureTypeCode('c','n','v') , Continent = FeatureTypeCode('c','o','n') , County = FeatureTypeCode('c','o','u') ,
  CarPark = FeatureTypeCode('c','p','k') , CarRental = FeatureTypeCode('c','r','e') , Crossing = FeatureTypeCode('c','r','o') , Country = FeatureTypeCode('c','r','y') ,
  CarSharing = FeatureTypeCode('c','s','h') , CutLine = FeatureTypeCode('c','u','t') , CarWash = FeatureTypeCode('c','w','a') , CaravanSite = FeatureTypeCode('c','v','n') ,
  CyclingRoute = FeatureTypeCode('c','y','r') , Dam = FeatureTypeCode('d','a','m') , DangerArea = FeatureTypeCode('d','a','n') , Dentist = FeatureTypeCode('d','e','n') ,
  Disused = FeatureTypeCode('d','i','s') , Ditch = FeatureTypeCode('d','i','t') , Dock = FeatureTypeCode('d','o','c') , DogPark = FeatureTypeCode('d','o','g') ,
  Drain = FeatureTypeCode('d','r','a') , DragLift = FeatureTypeCode('d','r','g') , Doctors = FeatureTypeCode('d','r','s') , District = FeatureTypeCode('d','s','t') ,
  ElectricVehicleCharging = FeatureTypeCode('e','v','c') , Farm = FeatureTypeCode('f','a','r') , FarmYard = FeatureTypeCode('f','a','y') , Fell = FeatureTypeCode('f','e','l') ,
  FerryTerminal = FeatureTypeCode('f','e','t') , FastFood = FeatureTypeCode('f','f','d') , FireExtinguisher = FeatureTypeCode('f','i','e') , FireFlapper = FeatureTypeCode('f','i','f') ,
  FireHose = FeatureTypeCode('f','i','h') , FireStation = FeatureTypeCode('f','i','s') , FitnessStation = FeatureTypeCode('f','i','t') , FireHydrant = FeatureTypeCode('f','i','y') ,
  Forestry = FeatureTypeCode('f','o','r') , Fishing = FeatureTypeCode('f','s','h') , Fuel = FeatureTypeCode('f','u','e') , Funicular = FeatureTypeCode('f','u','n') ,
  Garages = FeatureTypeCode('g','a','r') , Gate = FeatureTypeCode('g','a','t') , Garden = FeatureTypeCode('g','d','n') , Generator = FeatureTypeCode('g','e','n') ,
  GreenHouse = FeatureTypeCode('g','h','o') , Glacier = FeatureTypeCode('g','l','a') , GolfCourse = FeatureTypeCode('g','o','l') , Gondola = FeatureTypeCode('g','o','n') ,
  GoodsAerialWay = FeatureTypeCode('g','o','o') , Grass = FeatureTypeCode('g','r','a') , GreenField = FeatureTypeCode('g','r','e') , GritBin = FeatureTypeCode('g','r','b') ,
  GraveYard = FeatureTypeCode('g','r','y') , GuestHouse = FeatureTypeCode('g','u','e') , Halt = FeatureTypeCode('h','a','l') , Hamlet = FeatureTypeCode('h','a','m') ,
  Hangar = FeatureTypeCode('h','a','n') , Heath = FeatureTypeCode('h','e','a') , Helipad = FeatureTypeCode('h','e','l') , RailwayHalt = FeatureTypeCode('h','l','t') ,
  HikingRoute = FeatureTypeCode('h','i','k') , HorseRiding = FeatureTypeCode('h','o','r') , Hospital = FeatureTypeCode('h','o','s') , Hotel = FeatureTypeCode('h','o','t') ,
  HorseRidingRoute = FeatureTypeCode('h','r','r') , Hostel = FeatureTypeCode('h','s','t') , IceRink = FeatureTypeCode('i','c','e') , Industrial = FeatureTypeCode('i','n','d') ,
  Information = FeatureTypeCode('i','n','f') , Island = FeatureTypeCode('i','s','l') , IsolatedDwelling = FeatureTypeCode('i','s','o') , Junction = FeatureTypeCode('j','c','t') ,
  Kindergarten = FeatureTypeCode('k','i','n') , LandFill = FeatureTypeCode('l','a','n') , Land = FeatureTypeCode('l','n','d') , LevelCrossing = FeatureTypeCode('l','e','v') ,
  Library = FeatureTypeCode('l','i','b') , Locality = FeatureTypeCode('l','o','c') , LockGate = FeatureTypeCode('l','o','k') , MaritimeBoundary = FeatureTypeCode('m','a','b') ,
  Mall = FeatureTypeCode('m','a','l') , Marsh = FeatureTypeCode('m','a','r') , Meadow = FeatureTypeCode('m','e','a') , Military = FeatureTypeCode('m','i','l') ,
  Marina = FeatureTypeCode('m','n','a') , Motel = FeatureTypeCode('m','o','t') , MinorPowerLine = FeatureTypeCode('m','p','l') , MiniatureGolf = FeatureTypeCode('m','r','g') ,
  MiniatureRailway = FeatureTypeCode('m','r','y') , Mud = FeatureTypeCode('m','u','d') , Municipality = FeatureTypeCode('m','u','n') , Museum = FeatureTypeCode('m','u','s') ,
  NatureReserve = FeatureTypeCode('n','a','t') , NationalPark = FeatureTypeCode('n','a','p') , NavalBase = FeatureTypeCode('n','a','v') , Neighborhood = FeatureTypeCode('n','e','i') ,
  NursingHome = FeatureTypeCode('n','u','r') , Orchard = FeatureTypeCode('o','r','c') , PrecisionApproachPathIndicator = FeatureTypeCode('p','a','p') , Park = FeatureTypeCode('p','a','r') ,
  PublicBuilding = FeatureTypeCode('p','b','u') , PostBox = FeatureTypeCode('p','b','x') , PicnicTable = FeatureTypeCode('p','c','t') , Peak = FeatureTypeCode('p','e','a') ,
  Pharmacy = FeatureTypeCode('p','h','a') , Phone = FeatureTypeCode('p','h','o') , PicnicSite = FeatureTypeCode('p','i','c') , Pier = FeatureTypeCode('p','i','e') ,
  Pipeline = FeatureTypeCode('p','i','p') , ParkingEntrance = FeatureTypeCode('p','k','e') , Parking = FeatureTypeCode('p','k','g') , ParkingSpace = FeatureTypeCode('p','k','s') ,
  PlantNursery = FeatureTypeCode('p','l','a') , Platform = FeatureTypeCode('p','l','f') , PlaceOfWorship = FeatureTypeCode('p','l','w') , Playground = FeatureTypeCode('p','l','y') ,
  PostOffice = FeatureTypeCode('p','o','f') , Police = FeatureTypeCode('p','o','l') , ProtectedArea = FeatureTypeCode('p','r','a') , PowerSubStation = FeatureTypeCode('p','s','s') ,
  Pub = FeatureTypeCode('p','u','b') , PowerLine = FeatureTypeCode('p','w','l') , PowerStation = FeatureTypeCode('p','w','s') , Quarry = FeatureTypeCode('q','a','r') ,
  Range = FeatureTypeCode('r','a','n') , Rapids = FeatureTypeCode('r','a','p') , Recycling = FeatureTypeCode('r','c','y') , RecreationGround = FeatureTypeCode('r','e','c') ,
  Reef = FeatureTypeCode('r','e','e') , Region = FeatureTypeCode('r','e','g') , Retail = FeatureTypeCode('r','e','t') , Ridge = FeatureTypeCode('r','i','j') ,
  River = FeatureTypeCode('r','i','v') , Rock = FeatureTypeCode('r','o','c') , RoundHouse = FeatureTypeCode('r','o','u') , ResidentialArea = FeatureTypeCode('r','s','d') ,
  Restaurant = FeatureTypeCode('r','s','t') , Reservoir = FeatureTypeCode('r','s','v') , Runway = FeatureTypeCode('r','u','n') , Route = FeatureTypeCode('r','u','t') ,
  RiverBank = FeatureTypeCode('r','v','b') , SaltPond = FeatureTypeCode('s','a','l') , Sand = FeatureTypeCode('s','a','n') , Sauna = FeatureTypeCode('s','a','u') ,
  School = FeatureTypeCode('s','c','h') , Scree = FeatureTypeCode('s','c','r') , Scrub = FeatureTypeCode('s','c','b') , Sea = FeatureTypeCode('s','e','a') ,
  StateEmergencyServiceStation = FeatureTypeCode('s','e','s') , Shop = FeatureTypeCode('s','h','o') , SkiRoute = FeatureTypeCode('s','k','r') , Slipway = FeatureTypeCode('s','l','i') ,
  SportsCenter = FeatureTypeCode('s','p','o') , SportsPitch = FeatureTypeCode('s','p','p') , Spring = FeatureTypeCode('s','p','r') , SportsTrack = FeatureTypeCode('s','p','t') ,
  State = FeatureTypeCode('s','t','a') , Stadium = FeatureTypeCode('s','t','m') , RailwayStation = FeatureTypeCode('s','t','n') , Station = FeatureTypeCode('s','t','n') ,
  Stone = FeatureTypeCode('s','t','o') , StopPosition = FeatureTypeCode('s','t','p') , Stream = FeatureTypeCode('s','t','r') , Strait = FeatureTypeCode('s','t','t') ,
  Suburb = FeatureTypeCode('s','u','b') , Supermarket = FeatureTypeCode('s','u','p') , SurveyPoint = FeatureTypeCode('s','u','r') , SubwayEntrance = FeatureTypeCode('s','w','e') ,
  SwimmingPool = FeatureTypeCode('s','w','i') , Tank = FeatureTypeCode('t','a','n') , Taxi = FeatureTypeCode('t','a','x') , Theatre = FeatureTypeCode('t','h','e') ,
  ThemePark = FeatureTypeCode('t','h','p') , Toilet = FeatureTypeCode('t','o','i') , Town = FeatureTypeCode('t','o','w') , TurningCircle = FeatureTypeCode('t','c','i') ,
  TurningPoint = FeatureTypeCode('t','p','t') , Tram = FeatureTypeCode('t','r','a') , Tree = FeatureTypeCode('t','r','e') , TrafficSignals = FeatureTypeCode('t','r','f') ,
  TrackPoint = FeatureTypeCode('t','r','p') , TreeRow = FeatureTypeCode('t','r','r') , TramStop = FeatureTypeCode('t','r','s') , TurnTable = FeatureTypeCode('t','u','r') ,
  Tower = FeatureTypeCode('t','w','r') , Taxiway = FeatureTypeCode('t','w','y') , University = FeatureTypeCode('u','n','i') , VisualApproachSlopeIndicator = FeatureTypeCode('v','a','s') ,
  VillageGreen = FeatureTypeCode('v','i','g') , Village = FeatureTypeCode('v','i','l') , Vineyard = FeatureTypeCode('v','i','n') , ViewPoint = FeatureTypeCode('v','i','w') ,
  Volcano = FeatureTypeCode('v','o','l') , Waterfall = FeatureTypeCode('w','a','f') , WaterPark = FeatureTypeCode('w','a','p') , Water = FeatureTypeCode('w','a','t') ,
  Weir = FeatureTypeCode('w','e','r') , Wetland = FeatureTypeCode('w','e','t') , Windsock = FeatureTypeCode('w','i','s') , WalkingRoute = FeatureTypeCode('w','l','k') ,
  Wood = FeatureTypeCode('w','o','o') , Works = FeatureTypeCode('w','o','r') , Waypoint = FeatureTypeCode('w','p','t') , WaterTower = FeatureTypeCode('w','t','t') ,
  WaterWell = FeatureTypeCode('w','t','w') , Zoo = FeatureTypeCode('z','o','o') , LegacyFootpath = FeatureTypeCode('f','o','o') , LegacyBridleway = FeatureTypeCode('b','r','i') ,
  LegacyCycleway = FeatureTypeCode('c','y','c') , LegacySteps = FeatureTypeCode('s','t','e') , Invalid = 32767
}
 Every map object has a feature type. More...
 
enum class  FeatureDiscriminator { NonRoute = 0 , BridgeRoute = 1 , TunnelRoute = 2 , Route = 3 }
 The feature discriminator stored in a FeatureInfo object. More...
 
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 ,
  ErrorFeatureInfoIsNotRoute = 66 , ErrorFeatureInfoIsRoute = 67 , StandardErrorCodeCount = 68 , ErrorXmlRangeStart = 0x10000000 ,
  ErrorXmlRangeEnd = 0x2AFFFFFF , ErrorSQLite = 0x30000000
}
 Result codes returned by CartoType API functions. 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.
 
uint32_t constexpr FeatureTypeCode (int A, int B, int C)
 
void ThrowError (unsigned int aError)
 

Detailed Description

The CartoType map rendering library.

Enumeration Type Documentation

◆ Align

enum class CartoType::Align
strong

Text alignments.

Enumerator
Center 

Center the text.

Standard 

Align to the left for left-to-right text, to the right for right-to-left text.

Reverse 

Align to the right for left-to-right text, to the left for right-to-left text.

Left 

Align to the left and leave space on the right.

Right 

Align to the right and leave space on the left.

◆ ClipOperation

enum class CartoType::ClipOperation
strong

Types of clipping done by Geometry.Clip.

Enumerator
Intersection 

Returns the intersection of two paths; commutative.

Union 

Returns the union of two paths; commutative.

Difference 

Returns the difference of two paths; non-commutative.

Xor 

Returns the exclusive-or of the two paths; that is, any regions which are in neither path; commutative.

◆ CoordType

enum class CartoType::CoordType
strong

Coordinate types.

Enumerator
Degree 

Longitude (x) and latitude (y) in degrees.

Screen 

Pixels on the display: x increases to the right and y increases downwards.

Map 

Map coordinates: projected meters, 32nds of meters or 64ths of meters, depending on the map.

MapMeter 

Map meters: projected meters, not correcting for distortion introduced by the projection.

◆ FeatureDiscriminator

The feature discriminator stored in a FeatureInfo object.

Enumerator
NonRoute 

Not a route.

BridgeRoute 

A route that is a bridge.

TunnelRoute 

A route that is a tunnel.

Route 

A route that is neither a tunnel nor a bridge.

◆ FeatureType

enum class CartoType::FeatureType
strong

Every map object has a feature type.

The first 32 feature types are used for routable objects and their values are indexes into tables of speeds and weights in route profiles. Other feature types are constructed from three-letter codes.

All feature type values must fit into 15 bits, and therefore must be in the range 0...32767.

◆ FileType

enum class CartoType::FileType
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.

◆ FollowFlag

enum class CartoType::FollowFlag
strong

Bit flags used by the FollowMode constants.

Enumerator
Location 

A flag to make the center of the map follow the user's location.

Heading 

A flag to rotate the map to the user's heading.

Zoom 

A flag to set the map to a suitable zoom level for the user's speed.

◆ FollowMode

enum class CartoType::FollowMode
strong

Flags controlling the way the map follows the user location and heading and automatically zooms.

Enumerator
None 

The map does not follow the user's location or heading.

Location 

The map is centred on the user's location.

LocationHeading 

The map is centred on the user's location and rotated to the user's heading.

LocationZoom 

The map is centred on the user's location and zoomed to a suitable level for the user's speed.

LocationHeadingZoom 

The map is centred on the user's location, rotated to the user's heading, and zoomed to a suitable level for the user's speed.

◆ LetterCase

enum class CartoType::LetterCase
strong

The case of letters and strings in the Latin, Greek, Cyrillic and other alphabetic scripts.

Enumerator
None 

A code used when the letter case is to be left as it is, or is irrelevant.

Lower 

The case of the letters 'a', 'b', c', etc.

Upper 

The case of the letters 'A', 'B', 'C, etc.

Title 

The case of letters like U+01C8 'Lj' and a few others; also indicates that the first letter of each word should be changed to titlecase.

◆ LocationRefType

enum class CartoType::LocationRefType
strong

The type of a location reference used for traffic information.

Enumerator
Line 

A line in the route network.

GeoCoordinate 

A point on the earth's surface.

PointAlongLine 

A point on a line in the route network.

PointWithAccessPoint 

A point on the route network providing access to a nearby POI: the first point is the point on the line, the second is the POI.

Circle 

A circle defined as a point and a radius.

Rectangle 

A rectangle aligned to the grid of latitude and longitude: it is defined using two points at opposite corners.

Polygon 

A polygon defined using a set of points.

ClosedLine 

A closed line in the route network.

◆ MapObjectType

enum class CartoType::MapObjectType
strong

An enumerated type for map objects.

Enumerator
Point 

A point in two-dimensional space.

Line 

A line in two-dimensional space, consisting of one or more open contours.

Polygon 

A polygon in two-dimensional space, consisting of one or more closed contours.

Array 

Information arranged as an array of values, such as an image or height data. Essentially a texture in graphics terms.

TypeCount 

The total number of map object types. This is not an actual type.

◆ MapTableType

enum class CartoType::MapTableType
strong

Identifiers of tables in CTM1 map files.

Enumerator
GlobalTable 

The ID of the global information table.

LayerTable 

The ID of the table containing the layers containing the map objects; see also KLowResolutionLayerTable.

Table2Obsolete 

The ID of the obsolete text index table.

Table3Obsolete 

The ID of the obsolete projection table used up to CTM1 version 3.0.

ProjectionTable 

The ID of the the table containing the map projection.

StringTable 

The ID of the table of compressed strings referenced by the map objects.

LowResolutionLayerTable 

The ID of the table containing layer data containing map objects at lower resolutions, simplified for display at smaller scales; see also KLayerTable.

PaletteTable 

The ID of the table containing color palettes for raster image objects.

TextIndexTable 

The ID of the table containing the text index used when searching for string attributes.

Table9Obsolete 

The ID of the table containing the obsolete serialised A-star routing network used up to format version 4.1.

RouteTableAStar 

The ID of the A-star routing data table.

RouteTableCH 

The ID of the contraction hierarchy routing data table.

RouteTableExtra 

The ID of the table containing extra information used for A-star routing.

RouteTableTurnExpanded 

The ID of the turn-expanded routing data table.

RouteTableCHStandAlone 

The ID of the table containing contraction hierarchy routing data that can optionally be used stand-alone, in combination with other map files.

RouteTableTECH 

The ID of the turn-expanded contraction hierarchy routing data table.

RouteTableCHTiled 

The ID of the table containing contraction hierarchy routing data that is a tile that can be used with other tiles from the same data set.

RouteTableTECHTiled 

The ID of the table containing turn-expanded contraction hierarchy routing data that is a tile that can be used with other tiles from the same data set.

RouteTableTurnExpandedCompact 

The ID of the table containing compact turn-expanded routing data, which uses less run-time RAM.

NoTable 

An ID used when no table exists or the table type is unknown.

◆ NavigationState

enum class CartoType::NavigationState
strong

States of the navigation system.

Enumerator
None 

No route has been created, or navigation is disabled.

NoPosition 

There is a route but no position has been supplied.

Turn 

The current position is on the route and turn information is available.

OffRoute 

The current position is off the route.

ReRouteNeeded 

Re-routing is needed. This state is used only when automatic re-routing is turned off, for instance when using a slower routing algorithm.

ReRouteDone 

A new route has been calculated after a period off route.

TurnRound 

The latest position is on the route but a U-turn is needed.

Arrival 

The latest position is on the route and very close to the destination.

◆ NoticePosition

enum class CartoType::NoticePosition
strong

Positions for notices like the legend or scale bar. Use functions taking an ExtendedNoticePosition for greater control.

Enumerator
TopLeft 

The top left corner of the display.

TopRight 

The top right corner of the display.

BottomLeft 

The bottom left corner of the display.

BottomRight 

The bottom right corner of the display.

Top 

The center of the top edge of the display.

Right 

The center of the right side of the display.

Left 

The center of the left side of the display.

Bottom 

The center of the bottom edge of the display.

Center 

The center of the display.

◆ PathIntersectionType

The ways two paths can intersect.

Enumerator
Unknown 

The intersection type is unknown.

Separate 

The paths do not intersect.

Intersects 

The paths intersect or are identical.

Contains 

The first path contains the second.

Contained 

The second path contains the first.

◆ PointFormat

enum class CartoType::PointFormat
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.

Enumerator
Unknown 

An arbitrary or unknown point format.

Meter 

Units are projected map meters.

ScaledDegree 

Units are degrees as 11.21 fixed-point numbers. That is, there are 2^21 (2097152) units to a degree. This format is used only by the makemap tool, for representing unprojected map data.

Meter32nds 

Units are 32nds of projected map meters. This is the default format for CTM1 data.

◆ PointType

enum class CartoType::PointType
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.

◆ Result

enum class CartoType::Result
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.

ErrorFeatureInfoIsNotRoute 

An attempt was made to set a route attribute on a feature info that is not a route.

ErrorFeatureInfoIsRoute 

An attempt was made to set a non-route attribute on a feature info that is a route.

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.

◆ RoundaboutState

enum class CartoType::RoundaboutState
strong

Turns involving roundabouts are marked as such so that exit numbers can be counted

Enumerator
None 

This junction does not involve a roundabout.

Enter 

This junction enters a roundabout.

Continue 

This junction continues around a roundabout.

Exit 

This junction exits a roundabout.

◆ RouteAccess

enum class CartoType::RouteAccess
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.

Enumerator
Unknown 

The accessibility of the point is unknown.

Accessible 

The point is accessible for outward routing.

Isolated 

Routes cannot leave the point. The usual cause is an error in the map data like a one-way road that is a dead end.

NoRoad 

There are no routable roads or tracks near the point.

◆ RouteProfileType

enum class CartoType::RouteProfileType
strong

Constants used to select frequently-used profiles.

Enumerator
Car 

A profile type for private car navigation.

Walk 

A profile type for walking.

Cycle 

A profile type for cycling.

Hike 

A profile type for walking, preferring off-road paths.

Ski 

A profile type for downhill skiing.

◆ RouterType

enum class CartoType::RouterType
strong

Types of router; used when selecting a router type.

Enumerator
Default 

This router type causes the default router to be selected: the one for which serialized data is available in the map file, or, failing that, StandardAStar.

StandardAStar 

The A* router, which gives fast performance but takes a lot of memory and cannot create a route going twice through the same junction.

TurnExpandedAStar 

A version of the A* router with road nodes and turn arcs; slower than StandardAStar, and uses more memory, but can generate routes going twice through the same junction, for more flexible routing.

StandardContractionHierarchy 

The contraction hierarchy router is intended where less RAM is available: for example with large maps on mobile devices. It gives the same routes as StandardAStar, but is a little slower and does not support custom route profiles; the route profile is decided at the time of creating the CTM1 file.

TECH 

Turn-expanded contraction hierarchy.

◆ StringMatchMethod

enum class CartoType::StringMatchMethod
strong

Flags and constants used when finding text.

Enumerator
PrefixFlag 

A flag to match all strings for which the search term is a perfect match or a prefix.

IgnoreSymbolsFlag 

A flag to ignore all characters that are not letters, digits or whitespace when matching.

FoldAccentsFlag 

A flag to match accented and unaccented letters.

FuzzyFlag 

A flag to allow imperfect matches with a small number of omitted, incorrect or extra characters.

FoldCaseFlag 

A flag to fold letter case.

IgnoreWhitespaceFlag 

A flag to ignore whitespace when matching.

Exact 

Strings must match exactly.

FoldCase 

Fold case when matching strings.

Prefix 

The search term must be an exact match or a prefix of the found string.

IgnoreNonAlphanumerics 

Ignore all characters that are not letters or digits.

Loose 

Loose matching: ignore non-alphanumerics and fold accents and case.

Fuzzy 

Allow fuzzy matches: ignore non-alphanumerics, fold accents and allow imperfect matches.

◆ TurnType

enum class CartoType::TurnType
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.

Enumerator
None 

No turn exists or is needed. This turn type is used at the start of a route.

Ahead 

A turn of less than 22.5 degrees left or right, unless this is a fork with two choices, in which case the turn will be bear right or bear left.

BearRight 

A turn between 22.5 degrees and 67.5 degrees right or a turn through a smaller angle which is the rightmost of a fork with two choices.

Right 

A turn between 67.5 degrees and 112.5 degrees right.

SharpRight 

A turn between 112.5 degrees and 180 degrees right.

Around 

This turn type is use for U-turns: turns back along the same road.

SharpLeft 

A turn between 112.5 degrees and 180 degrees left.

Left 

A turn between 67.5 degrees and 112.5 degrees left.

BearLeft 

A turn between 22.5 degrees and 67.5 degrees left. or a turn through a smaller angle which is the leftmost of a fork with two choices.

◆ ValidityFlag

enum class CartoType::ValidityFlag
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.

◆ WritableMapType

enum class CartoType::WritableMapType
strong

Types of writable maps.

Enumerator
Memory 

A writable map stored in memory.

SQLite 

A writable map stored in an SQLite database.

Function Documentation

◆ FeatureTypeCode()

uint32_t constexpr CartoType::FeatureTypeCode ( int  A,
int  B,
int  C 
)
inlineconstexpr

Constructs a 15-bit feature type code from 3 lower-case letters.

◆ ThrowError()

void CartoType::ThrowError ( unsigned int  aError)

Throws an exception for the CartoType error code aError. For internal use.