MapCenter Documentation 4.3.3.0
Application Programming Interface
Copyright (c) 2014 Emapa S.A.
Index
- Modules
- Functions
- Base module
- ActivateMapFile
- AdminDropSession
- AuthCreateGroup
- AuthCreateUser
- AuthDeleteGroup
- AuthDeleteUser
- AuthGetGroup
- AuthGetGroupsList
- AuthGetUserParamEx
- AuthGetUserParams
- AuthGetUsersList
- AuthModifyGroup
- AuthModifyUser
- AuthModifyUserPassword
- AuthSetUserParamEx
- CreateSessionID
- DeactivateMapFile
- DropSession
- GetActiveSessions
- GetAvailableMapFiles
- GetCurrentSessionCount
- GetCurrentViewConfig
- GetLoadedMapsRegion
- GetMapModules
- GetMaxSessionsCount
- GetServerVersion
- GetSessionComment
- GetSessionLanguageContext
- GetSessionLifetimeSeconds
- GetViewConfigList
- KeepSession
- LoadCurrentViewConfig
- ReloadMapFiles
- ServiceConfigGetServiceParams
- ServiceConfigSetServiceParam
- SetCurrentViewConfig
- SetSessionComment
- SetSessionLanguageContext
- Map module
- ConvertMapToScreen
- ConvertScreenToMap
- Degeocode
- DegeocodeAtPoint
- DegeocodeEx
- DegeocodeExWithAttributes
- DegeocodeGetParamValue
- DegeocodeSetParamValue
- ForwardCalc
- GetAvailableIconFormats
- GetAvailableImageFormats
- GetDefaultLayers
- GetDegeocodeLayers
- GetMapPointLength
- GetProjections
- GetScreenPointLength
- GetTiledMapLayers
- InverseCalc
- RenderMapOnHWNDByPoint
- RenderMapOnHWNDByPointWithCopyright
- RenderMapOnHWNDByRect
- RenderMapOnHWNDByRectWithCopyright
- RenderMapOnImageByPoint
- RenderMapOnImageByPointWithCopyright
- RenderMapOnImageByRect
- RenderMapOnImageByRectWithCopyright
- RenderSplitMapOnImageByPoint
- RenderSplitMapOnImageByPointWithCopyright
- RenderSplitMapOnImageByRect
- RenderSplitMapOnImageByRectWithCopyright
- RenderTiledMap
- RenderTiledMapEx
- RenderTiledMapWithCopyright
- Search module
- ClearMapSelection
- Geocode
- GeocodeEx
- MultiGeocodeEx
- SearchAddCityToSelection
- SearchAddObjectToSelection
- SearchAddStreetCrossingToSelection
- SearchAddStreetWithNumToSelection
- SearchGetCityList
- SearchGetCityListEx
- SearchGetCountryList
- SearchGetItemKindList
- SearchGetItemsList
- SearchGetParamValue
- SearchGetParamValues
- SearchGetStreetHandle
- SearchInitialize
- SearchSelectCities
- SearchSelectItems
- SearchSelectItemsEx
- SearchSetItemsFilter
- SearchSetParamValue
- Localize module
- LocalizeAddObjectPositions
- LocalizeGetObjectVisibility
- LocalizeIconAdd
- LocalizeIconClear
- LocalizeIconGet
- LocalizeIconGetCount
- LocalizeIconIDToItemIndex
- LocalizeIconRemove
- LocalizeIconSet
- LocalizeNumFieldsAdd
- LocalizeNumFieldsClear
- LocalizeNumFieldsGet
- LocalizeNumFieldsGetCount
- LocalizeNumFieldsRemove
- LocalizeNumFieldsSet
- LocalizeObjectAdd
- LocalizeObjectAddWithPositions
- LocalizeObjectClear
- LocalizeObjectEntityIDToItemIndex
- LocalizeObjectGet
- LocalizeObjectGetCount
- LocalizeObjectPositionAdd
- LocalizeObjectPositionClear
- LocalizeObjectPositionGet
- LocalizeObjectPositionGetCount
- LocalizeObjectPositionRemove
- LocalizeObjectPositionSet
- LocalizeObjectRemove
- LocalizeObjectSet
- LocalizeSetObjectVisibility
- LocalizeStrFieldsAdd
- LocalizeStrFieldsClear
- LocalizeStrFieldsGet
- LocalizeStrFieldsGetCount
- LocalizeStrFieldsRemove
- LocalizeStrFieldsSet
- Objects module
- AddGroupIcon
- AppendGroup
- AppendObject
- AppendObjectCircle
- AppendObjectEllipse
- AppendObjectPolygon
- AppendObjectPolyline
- AppendObjectRectangle
- AppendObjects
- CancelEditGroup
- CancelEditObject
- CancelEditObjectFields
- CheckUpdate
- ClearSetFilter
- CreateObjectSet
- DeleteGroup
- DeleteGroupIcon
- DeleteObject
- DeleteObjects
- DeleteObjectShape
- EditGroup
- EditObject
- EditObjectFields
- FilterByObjectShape
- FilterByPoint
- FilterByRadius
- FilterByShape
- FilterByText
- GetAggregatedObjects
- GetAggregatedObjectShapes
- GetDatabaseList
- GetDatabaseTableList
- GetGroupBinaryData
- GetGroupIcon
- GetGroupIcons
- GetGroupSettings
- GetGroupShapeSettings
- GetModifiedFields
- GetNextResult_FieldSet
- GetNextResult_IDSet
- GetNextResult_PositionSet
- GetNextResult_RemovedSet
- GetNextResult_Set
- GetNextResult_UpdatedSet
- GetObject
- GetObjectAggregates
- GetObjectBinaryData
- GetObjectCircles
- GetObjectCount
- GetObjectEllipses
- GetObjectFields
- GetObjectPolygons
- GetObjectPolylines
- GetObjectRectangles
- GetRemovedFields
- GetVisibleGroups
- MapBaseConnect
- MapBaseDisconnect
- MapBaseLoadFromBlob
- MapBaseStoreToBlob
- PostGroup
- PostObject
- PostObjects
- SetGroupBinaryData
- SetGroupShapeSettings
- SetObjectBinaryData
- SetObjectFields
- SetObjectIDs
- SetVisibleGroups
- RoutePlanner module
- RoutePlannerCalculatePointDistanceFromRoute
- RoutePlannerCalculatePointWithinRouteBuffer
- RoutePlannerCalculateRoute
- RoutePlannerCalculateRouteDistanceMatrix
- RoutePlannerCalculateRouteFromGPSTrack
- RoutePlannerCalculateRoutesWithMultipleDepots
- RoutePlannerCalculateRoutesWithSingleDepot
- RoutePlannerCalculateRouteWithBinaryResult
- RoutePlannerDriverParamsGet
- RoutePlannerDriverParamsSet
- RoutePlannerEntriesAdd
- RoutePlannerEntriesAddWithDescription
- RoutePlannerEntriesClear
- RoutePlannerEntriesGet
- RoutePlannerEntriesGetCount
- RoutePlannerEntriesGetWithSnapPoints
- RoutePlannerEntriesSet
- RoutePlannerEntriesSetAsDriveThrough
- RoutePlannerEntriesSetWithDescription
- RoutePlannerEntryAdd
- RoutePlannerEntryAddWithDescription
- RoutePlannerEntryComplexMove
- RoutePlannerEntryGet
- RoutePlannerEntryInsert
- RoutePlannerEntryInsertWithDescription
- RoutePlannerEntryMove
- RoutePlannerEntryRemove
- RoutePlannerEntryReverse
- RoutePlannerEntrySet
- RoutePlannerEntrySetWithDescription
- RoutePlannerGetAvailableRoadTypes
- RoutePlannerGetParamValue
- RoutePlannerGetParamValues
- RoutePlannerGetRouteItinerary
- RoutePlannerGetRouteLogisticTOLLSummary
- RoutePlannerGetRouteRepresentation
- RoutePlannerGetRouteRepresentationWithBinaryResult
- RoutePlannerGetRouteSummary
- RoutePlannerGetRouteViaTollSummary
- RoutePlannerRoadParamsGet
- RoutePlannerRoadParamsSet
- RoutePlannerRoadViaTollParamsGet
- RoutePlannerRoadViaTollParamsSet
- RoutePlannerRouteClear
- RoutePlannerRouteLoadFromBlob
- RoutePlannerRouteLoadFromDatabase
- RoutePlannerRouteStoreToBlob
- RoutePlannerRouteStoreToDatabase
- RoutePlannerSetParamValue
- RoutePlannerSimpleCalculateRoute
- RoutePlannerSimpleCalculateRoute2
- RoutePlannerSimpleCalculateRoute2WithBinaryResult
- RoutePlannerSimpleCalculateRoute3
- RoutePlannerSimpleCalculateRoute3WithBinaryResult
- RoutePlannerSimpleCalculateRouteWithBinaryResult
- RoutePlannerVehicleParamExGet
- RoutePlannerVehicleParamExSet
- RoutePlannerVehicleParamsExGet
- RoutePlannerVehicleParamsGet
- RoutePlannerVehicleParamsGet2
- RoutePlannerVehicleParamsSet
- RoutePlannerVehicleParamsSet2
- VehicleRepositoryAddVehicle
- VehicleRepositoryDriverParamsGet
- VehicleRepositoryDriverParamsSet
- VehicleRepositoryRemoveVehicle
- VehicleRepositoryRoadParamsGet
- VehicleRepositoryRoadParamsSet
- VehicleRepositoryVehicleFetch
- VehicleRepositoryVehicleGet
- VehicleRepositoryVehicleReplace
- VehicleRepositoryVehiclesClear
- VehicleRepositoryVehicleSet
- VehicleRepositoryVehiclesGet
- VehicleRepositoryVehiclesSet
- VehicleRepositoryVehicleViaTollGet
- VehicleRepositoryVehicleViaTollSet
- RouteRepository module
- RoutePlannerCalculateAlternativeRoutesAndStore
- RoutePlannerCalculateRoutesWithMultipleDepotsAndStore
- RoutePlannerCalculateRoutesWithSingleDepotAndStore
- RoutePlannerSimpleCalculateAlternativeRoutesAndStore
- RouteRepositoryAddRoute
- RouteRepositoryAddRouteWithIdent
- RouteRepositoryCalculatePointDistanceFromRoute
- RouteRepositoryClear
- RouteRepositoryFetchRoute
- RouteRepositoryFetchRouteWithIdent
- RouteRepositoryGetRouteItinerary
- RouteRepositoryGetRouteItineraryByIdent
- RouteRepositoryGetRouteRepresentation
- RouteRepositoryGetRouteRepresentationByIdent
- RouteRepositoryGetRoutes
- RouteRepositoryGetRoutesCount
- RouteRepositoryGetRouteSummary
- RouteRepositoryGetRouteSummaryByIdent
- RouteRepositoryLoadFromBlob
- RouteRepositoryRemove
- RouteRepositoryRemoveWithIdent
- RouteRepositoryReplaceRoute
- RouteRepositoryReplaceRouteWithIdent
- RouteRepositorySetRouteColor
- RouteRepositorySetRouteColorByIdent
- RouteRepositorySetRouteDescription
- RouteRepositorySetRouteDescriptionByIdent
- RouteRepositorySetRouteVisibility
- RouteRepositorySetRouteVisibilityByIdent
- RouteRepositoryStoreToBlob
- RouteAttributes module
- RouteAttributesAddAlongRouteAttribute
- RouteAttributesAddLineAttribute
- RouteAttributesAddPointAttribute
- RouteAttributesAddPolygonAttribute
- RouteAttributesClearRouteAttribute
- RouteAttributesDeleteRouteAttribute
- RouteAttributesExecuteDataProviderAction
- RouteAttributesGetAttributesProviderList
- RouteAttributesGetDataProviderActions
- RouteAttributesGetDataProviderParams
- RouteAttributesGetPassedAttributesList
- RouteAttributesGetRouteAttribute
- RouteAttributesGetRouteAttributes
- RouteAttributesGetRouteAttributeWithGeometry
- RouteAttributesGetSubscribedProvidersList
- RouteAttributesLoadFromBlob
- RouteAttributesModifyAlongRouteAttribute
- RouteAttributesModifyLineAttribute
- RouteAttributesModifyPointAttribute
- RouteAttributesModifyPolygonAttribute
- RouteAttributesSetDataProviderParam
- RouteAttributesSetRouteAttribute
- RouteAttributesStoreToBlob
- RouteAttributesSubscribeToDataProvider
- RouteAttributesUnsubscribeFromDataProvider
- RouteOptimizer module
- RouteOptimizerAddEntryDeliveryShipment
- RouteOptimizerAddEntryDeliveryShipments
- RouteOptimizerAddEntryPickupShipment
- RouteOptimizerAddEntryPickupShipments
- RouteOptimizerAddEntryTimeWindow
- RouteOptimizerAddEntryTimeWindows
- RouteOptimizerAddShipmentType
- RouteOptimizerClearEntryDeliveryShipments
- RouteOptimizerClearEntryPickupShipments
- RouteOptimizerClearEntryTimeWindows
- RouteOptimizerGetDepotEntry
- RouteOptimizerGetEntryDeliveryShipments
- RouteOptimizerGetEntryPickupShipments
- RouteOptimizerGetEntryShipmentDeliveryPickupTimes
- RouteOptimizerGetEntryTimeWindows
- RouteOptimizerOptimizeRoute
- RouteOptimizerRemoveShipmentType
- RouteOptimizerSetDepotEntry
- RouteOptimizerSetEntryDeliveryShipments
- RouteOptimizerSetEntryPickupShipments
- RouteOptimizerSetEntryShipmentDeliveryPickupTimes
- RouteOptimizerSetEntryTimeWindows
- RouteOptimizerShipmentTypesClear
- RouteOptimizerShipmentTypesGet
- RouteOptimizerShipmentTypesSet
- RouteOptimizerShipmentTypeToShipmentTypeIncompatibilityAdd
- RouteOptimizerShipmentTypeToShipmentTypeIncompatibilityClear
- RouteOptimizerShipmentTypeToShipmentTypeIncompatibilityGet
- RouteOptimizerShipmentTypeToShipmentTypeIncompatibilitySet
- RouteOptimizerSimpleOptimizeRoute
- RouteOptimizerSolveProblem
- RouteOptimizerVehicleCategoryToShipmentTypeIncompatibilityAdd
- RouteOptimizerVehicleCategoryToShipmentTypeIncompatibilityClear
- RouteOptimizerVehicleCategoryToShipmentTypeIncompatibilityGet
- RouteOptimizerVehicleCategoryToShipmentTypeIncompatibilitySet
- Types
- TLongLatPoint
- TLongLatRect
- TFontParameters
- TPoint
- TRect
- TRectsArray
- TLongLatRectArray
- TWideStringArray
- TLongLatPointArray
- TLongLatPoint2DArray
- TPointsArray
- TCaptionPositionArray
- TObjectPosition
- TObjectPositionArray
- TBooleanArray
- TByteArray
- TIconProperties
- TIconPropertiesArray
- TGroupSettings
- TGroupShapeSettings
- TDynamicIntegerArray
- TBlobArray
- TDegeocodeResultEntry
- TDegeocodeResult
- TDegeocodeResultArray
- TDegeocodeCityElementResult
- TDegeocodeCityElementResultArray
- TDegeocodeRoadElementResult
- TDegeocodeRoadElementResultArray
- TDegeocodeExResultEntry
- TDegeocodeExResultEntryArray
- TDegeocodeAtPointResult
- TDegeocodeAtPointResultArray
- TDegeocodeAtPointDatabaseResult
- TDegeocodeAtPointDatabaseResultArray
- TGeocodePointInfo
- TGeocodePointInfoArray
- TGeocodePointInfoEx
- TGeocodePointInfoExArray
- TMultiGeocodePointInfoEx
- TMultiGeocodePointInfoExArray
- TDynamicByteArray
- TTiledMapParams
- TImageRenderParams
- TFloatArray
- TMapFileEntry
- TMapFileEntryArray
- TFloatArrayArray
- TWideStringArrayArray
- TBooleanArrayArray
- TLocalizeObjectPositionData
- TLocalizeObjectPositionDataArray
- TSessionEnumEntry
- TSessionEnumArray
- TViewConfigEntry
- TViewConfigListArray
- TRepositoryRoute
- TRepositoryRouteArray
- TRouteAttributeParams
- TRouteAttributeParamsArray
- TRouteAttributePassedElem
- TRouteAttributePassedArray
- TDriveThrough
- TDriveThroughArray
- TTimeWindow
- TTimeWindowsArray
- TShipment
- TShipmentsArray
- TRouteOptimalizationEntry
- TRouteOptimalizationEntryArray
- TRouteOptimizerResultRoutesEntry
- TRouteOptimizerResultRoutesArray
- TRouteOptimizerEntry2
- TRouteOptimizerEntry2Array
- TRouteOptimizerEntryAction2
- TRouteOptimizerEntryAction2Array
- TRouteOptimizerShipmentMove
- TRouteOptimizerShipmentMovesArray
- TRouteOptimizerEntry
- TRouteOptimizerEntryArray
- TRouteOptimizerShipmentAction
- TRouteOptimizerShipmentActionArray
- TRouteItinerary
- TRouteItineraryArray
- TVehicleParams
- TDriverParams
- TRoadParams
- TRoadParamsArray
- TRoadViaTollParams
- TRoadViaTollParamsArray
- TRoadResults
- TRoadResultsArray
- TViaTollRoadResults
- TViaTollRoadResultsArray
- TLogisticTOLLResults
- TLogisticTOLLResultsArray
- TVehicleEntry
- TVehicleEntryArray
- TVehicleCategoryToShipmentTypeIncompatibility
- TVehicleCategoryToShipmentTypeIncompatibilityArray
- TShipmentTypeToShipmentTypeIncompatibility
- TShipmentTypeToShipmentTypeIncompatibilityArray
- Errors
- OperationSuccessful (1)
- GeneralError (-1)
- FunctionUnimplemented (-2)
- SessionNotFound (-3)
- NonauthorizedAccess (-4)
- NotEnoughPermission (-5)
- SessionLimitExceeded (-10)
- UserSessionLimitExceeded (-11)
- WrongAuthentication (-13)
- ReferentialIntegrityError (-6)
- UniqueIndexViolation (-7)
- DataNotFound (-8)
- UpdateRequired (-9)
- DatabaseBlocked (-12)
- GeneralSearchError (-100)
- InvalidCountryIndex (-101)
- InvalidCityIndex (-102)
- InvalidCityCount (-103)
- InvalidItemKindIndex (-104)
- InvalidItemCount (-105)
- InvalidItemIndex (-106)
- StreetRequired (-107)
- SearchContextNotInitialized (-108)
- InvalidItemHandle (-109)
- NumerationNotFound (-110)
- CrossingNotFound (-111)
- GeneralLocalizeError (-200)
- InvalidLocalizeDataIndex (-201)
- InvalidIcon (-202)
- InvalidLocalizeEntityID (-203)
- InvalidNumericFieldsCount (-204)
- InvalidStringFieldsCount (-205)
- DuplicatedLocalizeEntityID (-206)
- InvalidIconMIMEType (-207)
- InvalidItemsCount (-208)
- InvalidIconData (-209)
- GeneralMapFileError (-300)
- MapFileNotFound (-301)
- MapFileAlreadyOpened (-302)
- MapFileAlreadyClosed (-303)
- WrongFileFormat (-304)
- GeneralRenderingError (-400)
- InvalidHDCHandle (-401)
- InvalidImageSize (-402)
- InvalidImageMIMEType (-403)
- WrongImageSize (-404)
- GeneralAuthorizationError (-500)
- UserAlreadyExists (-501)
- UserDoesNotExist (-502)
- UserGroupAlreadyExists (-503)
- UserGroupDoesNotExist (-504)
- UserGroupReadOnly (-505)
- GeneralRoutePlannerError (-600)
- WrongParamValue (-601)
- WrongParamName (-602)
- InvalidEntryIndex (-603)
- NotEnoughRouteEntries (-604)
- RouteNotFound (-605)
- DuplicatedEntryIndex (-606)
- RouteNotCalculated (-607)
- RouteIdentifierNotFound (-608)
- DuplicatedRoutingDifficultyIdentifier (-630)
- RoutingDifficultyIdentifierNotFound (-631)
- VehicleCategoryAlreadyExists (-660)
- DepotEntryNotSet (-661)
- DuplicatedShipmentIdentifier (-662)
BaseModule
MapCenter is a multiaccessible map server working in client-server architecture in compatibility with WebServices technology. Client applications communicate with the server by way of WebServices application programming interface using SOAP (Simple Object Access Protocol) and HTTP protocols. Specification of MapCenter's interface in WSDL (Web Services Description Language) format is available via [MapCenterURL:Port]/wsdl/IMapCenterService (Port is 6090 by default). For backward compatibility with older versions communication using XML files over HTTP protocol is supported at [MapCenterURL:Port]/xml?version=1.0 or simplier at [MapCenterURL:Port]. Functions supported by WebServices interface are also available in form of XML files at [MapCenterURL:Port]/xml?version=2.0 . All binary parameters (blobs) in functions supported by XML interface should be Base64 encoded and placed in CDATA section. The binary results of them are just like that encoded.
Communication with MapCenter can be optionally authorized (it is not by default and may be enabled using configaration tool). Standard HTTP authorization is used for it. MapCenter has its own user database. Users are grouped into user groups. One user belongs to one or more groups. At the installation MapCenter contains three users: admin (belonging to following groups: admins, dbadmins, dbeditors, mapviewers), user (dbeditors, mapviewers) and viewer (mapviewers). Each of the three default users has a the same password as his name. Lists of available users and groups can be obtained by AuthGetUsersList and AuthGetGroupsList functions. User database can be managed usig following functions: AuthCreateUser, AuthGetUserParams, AuthGetUserParamEx, AuthSetUserParamEx, AuthModifyUser, AuthModifyUserPassword, AuthDeleteUser, AuthCreateGroup, AuthGetGroup, AuthModifyGroup, AuthDeleteGroup. All the functions require MapCenter authorization enabled and can be invoked only by users belonging to admins group.
MapCenter server generates geographic informations based on vector maps in WGS84 coordinates system. Server offers map images and many additional informations concerned with them. MapCenter functionality is divided into modules. A list of modules available in the instance of server used can be obtained by GetMapModules function.
Each client application may set its own map settings and add its own informations onto maps by way of server sessions. At the beginning of communiction with MapCenter, an application should create such session using CreateSessionID function. Each user (if authorization is enabled) can create one or more sessions. Most of server API functions require the session identifier to be given. Sessions are kept alive by server for some time since last request - this time may be obtained using GetSessionLifetimeSeconds function. To lenghten session's live KeepSession function may be helpful. Early created session can be removed immediatelly by DropSession function. Maximum number of concurrently working sessions may be constrained by the MapCenter lincence - function GetMaxSessionsCount returns the limit. Other functions (GetCurrentSessionCount and GetActiveSessions) return data concerning active sessions - user from admins group can view all sessions, but other users see only their sessions. Admins can destroy any session using AdminDropSession function.
Base module of MapCenter server offers also functionality of loading and activating map files delivered (GetAvailableMapFiles, GetLoadedMapsRegion, ReloadMapFiles, ActivateMapFile, DeactivateMapFile). If MapCenter authorization is enabled, only users belonging to admins group can use these functions. Many maps can be processed simultaneously.
MapModule
Map module of MapCenter server offers functions for rendering maps as images (bitmaps or semi-vector files). Supported image formats are returned by GetAvailableImageFormats function, and available geographic projections by GetProjections function.
Single map images are generated by RenderMapOnImageByPoint or RenderMapOnImageByRect function. Map can be split into a matrix of images using RenderSplitMapOnImageByPoint or RenderSplitMapOnImageByRect function. For apllications installed on the same machine as MapCenter server more efficient are functions rendering maps on control canvas (HDC) directly - RenderMapOnHWNDByPoint or RenderMapOnHWNDByRect. RenderTiledMap function is optimized for web applications. It serves normalized maps with fixed zooms allowing efficient caching. All the functions are their twin functions which additionally return copyright clauses of supported map providers. There are functions with ...WithCopyright suffix.
Map module of MapCenter server offers also functionality of converting bitmap to geographic coordinates (ConvertScreenToMap) and vice versa (ConvertMapToScreen), calculating distances between points (GetMapPointLength, GetScreenPointLength, InverseCalc, ForwardCalc) and obtaining geographic informations concerning map points (Degeocode, DegeocodeEx, DegeocodeAtPoint).
SearchModule
Search module of MapCenter server offers functions for searching the maps and address geocoding. Currently searched data is kept into a server session within session search context. The context must be initialized by calling SearchInitialize function.
Map objects beeing searched are grouped into hierarchy - countries contain cities or final map items (roads, airports, rivers, etc.), cities contain final map items. Cities can be found using SearchSelectCities function returning the number of cities found. Required subset of values, stored in the session search context, is accessible by SearchGetCityList or SearchGetCityListEx function. Final map items can be found using SearchSelectItems (searching in cities) or SearchSelectItemsEx (searching in countries) function returning the number of items found. Required subset of values, stored in the session search context, is accessible by SearchGetItemsList function. Each map object may be marked out while map rendering. To add it to the session server context selection one should call one of following functions: SearchAddCityToSelection, SearchAddObjectToSelection, SearchAddStreetWithNumToSelection, SearchAddStreetCrossingToSelection.
Address geocoding is served by Geocode function which returns only one best result for each given address, and GeocodeEx or MultiGeocodeEx functions which return multiple proposals for one given address.
LocalizeModule
Localize module of MapCenter server offers functions for putting application objects equipped with geographic coordinates onto maps. Each localized object can contain many map positions (points) forming a path (track) or a set of single points. Each point (object position) can be marked out on rendered maps with icon or a circle. Currently localized data is kept into a server session.
All global configuration settings of localization are stored in three collections. List of required additional features of localized objects is divided into numeric fields collection and string fields collection; icons are stored in the third collection. The numeric fields collection is maintained with following functions: LocalizeNumFieldsAdd, LocalizeNumFieldsSet, LocalizeNumFieldsGet, LocalizeNumFieldsRemove, LocalizeNumFieldsClear, LocalizeNumFieldsGetCount. The string fields collection is maintained with following functions: LocalizeStrFieldsAdd, LocalizeStrFieldsSet, LocalizeStrFieldsGet, LocalizeStrFieldsRemove, LocalizeStrFieldsClear, LocalizeStrFieldsGetCount. The icons collection is maintained with following functions: LocalizeIconAdd, LocalizeIconSet, LocalizeIconGet, LocalizeIconRemove, LocalizeIconClear, LocalizeIconGetCount.
Collection of localized objects is maintained with functions: LocalizeObjectAdd, LocalizeObjectSet, LocalizeObjectGet, LocalizeObjectRemove, LocalizeObjectClear, LocalizeObjectGetCount. Adding at least one position for an object is necessary for showing the object on maps. Objects positions are maintained with following functions: LocalizeAddObjectPositions, LocalizeObjectPositionAdd, LocalizeObjectPositionSet, LocalizeObjectPositionGet, LocalizeObjectPositionRemove, LocalizeObjectPositionClear, LocalizeObjectPositionGetCount. It is possible to add to the server session an object together with its positions using one function (LocalizeObjectAddWithPositions). Putting a localized object onto maps while map image rendering can be enabled or disabled by LocalizeSetObjectVisibility function. Current visibility settings are accessible by LocalizeGetObjectVisibility function. Objects localized on maps are recognized by DegeocodeAtPoint function and some features of these objects are returned by the function.
ObjectsModule
Objects module of MapCenter server (MapBase) offers functions for connecting to a database and putting icons of records from the database (called objects) equipped with geographic coordinates onto maps, searching them using spatial queries and getting properties of them (object fields). Currently MapCenter suports only databases in its internal format (RSDB) - object sets accessible for MapCenter clients are stored as files in subfolder Rsdb and are of two types: Objects (*.emd files) and Logistics (*.eld files). Working with the functions of the module is possible only by authorized access which should be enabled using the configuration tool (disabled by default). Users from dbadmins group can create, restructure, edit and view databases, dbeditors edit and view data, and mapviewers can only view.
Accessible databases and their tables may be obtained using GetDatabaseList and GetDatabaseTableList functions. Server session can be connected to only one database of each type at the same time. Connection is realized by MapBaseConnect function. For closing the connection MapBaseDisconnect function should be used. Alternativelly there is possibility to load an ad hoc database directly from client application using MapBaseLoadFromBlob function and then to save changes as a file by MapBaseStoreToBlob function. New database can be created on server by CreateObjectSet function.
Record count in the object set is returned by GetObjectCount function. Objects are grouped into object groups, determining visual settings of contained objects. Each object can be placed on maps as a point and additionally can have got one or more spatial shapes assigned to it (polygons, polylines, rectangles, ellipese and circles). Any arbitrary binary data can be also assigned to an object. To obtain object set structure (field list, field feateures, object group list, object group icons) GetObjectFields function should be called. The structure of a database may be changed by function SetObjectFields call. Functions GetGroupSettings, GetGroupShapeSettings, GetGroupIcon and GetGroupIcons offer information on an object group visual settings. The modification of group settings is possible using following functions: EditGroup, PostGroup, AppendGroup, DeleteGroup, CancelEditGroup, AddGroupIcon, DeleteGroupIcon. Directly after object set openinig, all object groups are enabled (their objects are drawn on maps, unless object group settings limit icon visibility to some altitude range). The server session disables (or enables again) some object groups using GetVisibleGroups and SetVisibleGroups functions.
Data of objects can be downloaded from server in form of packages containing required number of objects (records) or in form of single object. The data can be get using following functions: GetNextResult_IDSet, GetNextResult_FieldSet, GetNextResult_PositionSet, GetNextResult_Set, GetObject, GetObjectPolygons, GetObjectPolylines, GetObjectRectangles, GetObjectEllipses, GetObjectCircles, GetObjectBinaryData. The modification of objects is possible using following functions: EditObject, PostObject, PostObjects, AppendObject, AppendObjects, DeleteObject, DeleteObjects, CancelEditObject, AppendObjectPolygon, AppendObjectPolyline, AppendObjectRectangle, AppendObjectEllipse, AppendObjectCircle, DeleteObjectShape, SetObjectBinaryData.
Statistic information about data changed by other parallel users can be received by functions: CheckUpdate, GetModifiedFields, GetRemovedFields, GetNextResult_UpdatedSet, GetNextResult_RemovedSet.
Some numerical and spatial aggregations for objects can be obtained using functions GetObjectAggregates, GetAggregatedObjects, GetAggregatedObjectShapes. Objects may be filtered by following functions: FilterByText, FilterByPoint, FilterByRadius, FilterByObjectShape, FilterByShape, SetObjectIDs. Each filter function works on data currently available in the object set - beeing the result of other previous filters. Filters can be disabled by ClearSetFilter function. Filters of currently opened object set are kept into a server session.
RoutePlannerModule
RoutePlanner module of MapCenter server offers functions for route calculating. Each server session stores a set of parameters taking into account while route calculating: vehicle parameters, driver parameters and road parameters. The parameters can be maintained by following functions: RoutePlannerVehicleParamsGet, RoutePlannerVehicleParamsSet, RoutePlannerVehicleParamsGet2, RoutePlannerVehicleParamsSet2, RoutePlannerDriverParamsGet, RoutePlannerDriverParamsSet, RoutePlannerRoadParamsGet, RoutePlannerRoadParamsSet, RoutePlannerRoadViaTollParamsGet, RoutePlannerRoadViaTollParamsSet. If not explicitly set, the parameters have some default values.
There is also possibility to store in the session more than one vehicle with its own independent parameters. The vehicle repository can be maintained by following functions: VehicleRepositoryAddVehicle, VehicleRepositoryRemoveVehicle, VehicleRepositoryVehicleGet, VehicleRepositoryVehicleSet, VehicleRepositoryVehiclesGet, VehicleRepositoryVehiclesSet, VehicleRepositoryVehiclesClear, VehicleRepositoryRoadParamsGet, VehicleRepositoryRoadParamsSet, VehicleRepositoryVehicleViaTollGet, VehicleRepositoryVehicleViaTollSet. Each vehicle can be fetched from the repository and set as a current session vehicle by VehicleRepositoryVehicleFetch function and replaced using session parameters by VehicleRepositoryVehicleReplace function.
Functions RoutePlannerCalculateRoute or RoutePlannerCalculateRouteWithBinaryResult calculate a route between at least two waypoints (route entries) stored in the sesssion. Calculated route can be removed from the session by RoutePlannerRouteClear function. A list of waypoints is maintained by following functions: RoutePlannerEntriesGet, RoutePlannerEntriesSet, RoutePlannerEntriesSetWithDescription, RoutePlannerEntryAdd, RoutePlannerEntryAddWithDescription, RoutePlannerEntryInsert, RoutePlannerEntryInsertWithDescription, RoutePlannerEntryMove, RoutePlannerEntryComplexMove, RoutePlannerEntryRemove, RoutePlannerEntrySet, RoutePlannerEntrySetWithDescription, RoutePlannerEntriesSetAsDriveThrough, RoutePlannerEntryReverse, RoutePlannerEntriesClear. After calculating the route can be stored in the session. Functions RoutePlannerGetRouteItinerary, RoutePlannerGetRouteRepresentation, RoutePlannerGetRouteRepresentationWithBinaryResult, RoutePlannerGetRouteSummary, RoutePlannerGetRouteViaTollSummary and RoutePlannerGetRouteLogisticTOLLSummary return features of currently stored in the session route.
Function RoutePlannerSimpleCalculateRoute calculates a route using its own parameters and waypoint list which optionally can replace session settings (alternatives are: RoutePlannerSimpleCalculateRouteWithBinaryResult, RoutePlannerSimpleCalculate2, RoutePlannerSimpleCalculateRoute2WithBinaryResult, RoutePlannerSimpleCalculate3, RoutePlannerSimpleCalculateRoute3WithBinaryResult). Function RoutePlannerCalculateRouteDistanceMatrix calculates a set of many routes between many waypoints as start and end points. Function RoutePlannerCalculateRouteFromGPSTrack calculates a route for a given list of waypoints given as a GPS track - it tries to recognize the real route based on the GPS track.
A list of waypoints and a route stored in the session are drawn on maps requested for the session. Visual parameters of routing data and routing options are maintained by functions RoutePlannerGetParamValue, RoutePlannerGetParamValues and RoutePlannerSetParamValue.
Functions RoutePlannerCalculatePointDistanceFromRoute and RoutePlannerCalculatePointWithinRouteBuffer operate on a route calculated and stored in the server session and calculate placement and distances for some given points near by the route.
Functions RoutePlannerCalculateRoutesWithSingleDepot and RoutePlannerCalculateRoutesWithMultipleDepots can calculate many routes at one time. The first function calculates a set of routes beginning with common start point (depot). Each destination point is taken as an end point for subsequent route. The second calculates a set of routes beginning with given start points (depots). Each destination point is taken as an end point for subsequent route beginning with the nearest start point.
RoutePlannerRouteStoreToBlob function generates binary dump of a route (together with route calculating parameters) stored in the server session which can be loaded later by RoutePlannerRouteLoadFromBlob function.
RouteRepositoryModule
RouteRepository module of MapCenter server offers functions for storing and presenting more than one route in the server session. The module augments functionality of RoutePlanner module. After route calculating, using one of RoutePlanner functions, one can add the route to the repository by RouteRepositoryAddRoute or RouteRepositoryAddRouteWithIdent function. Each route stored in the repository has some properties, i.e. identifier, color, visibility. Identifier is optional, color is set to green, and visibility to true, by default. Current paramaters of routes stored in the repository are available by RouteRepositoryGetRoutes function. The repository can be managed using following functions: RouteRepositoryReplaceRoute, RouteRepositoryReplaceRouteWithIdent, RouteRepositoryRemove, RouteRepositoryRemoveWithIdent, RouteRepositorySetRouteColor, RouteRepositorySetRouteColorByIdent, RouteRepositorySetRouteVisibility, RouteRepositorySetRouteVisibilityByIdent, RouteRepositorySetRouteDescription, RouteRepositorySetRouteDescriptionByIdent, RouteRepositoryClear. Each route can be fetched from repository and set as a current session route by RouteRepositoryFetchRoute or RouteRepositoryFetchRouteWithIdent function. Calculated results of each route are obtained by following functions: RouteRepositoryGetRouteItinerary, RouteRepositoryGetRouteItineraryByIdent, RouteRepositoryGetRouteRepresentation, RouteRepositoryGetRouteRepresentationByIdent, RouteRepositoryGetRouteSummary, RouteRepositoryGetRouteSummaryByIdent.
Functions RoutePlannerCalculateRoutesWithSingleDepotAndStore and RoutePlannerCalculateRoutesWithMultipleDepotsAndStore do the same as corresponding RoutePlannerCalculateRoutesWithSingleDepot and RoutePlannerCalculateRoutesWithMultipleDepots functions. In addition they can store calculated routes in the route repository. Function RouteRepositoryCalculatePointDistanceFromRoute calculates distances for some given points from all routes stored in the server session. Functions RoutePlannerSimpleCalculateAlternativeRoutesAndStore and RoutePlannerCalculateAlternativeRoutesAndStore calculate the optimal route and optionally at most two additional alternative routes. They also can store the resultant routes in the route repository.
RouteRepositoryStoreToBlob function generates binary dump of the whole repository which can be loaded later by RouteRepositoryLoadFromBlob function.
RouteAttributesModule
RouteAttributes module of MapCenter server offers functions for managing of routing difficulties in the server session beeing taken into account while route calculating. The module augments functionality of RoutePlanner module. Each routing difficulty has its geographic form dependent on its geometry kind (point, polyline, road-along placed polyline or polygon) and other properties, such as unique identifier (for management purposes) maximum speed, maximum vehicle height, additional passing through cost, etc. Difficulties can be add to the server session by RouteAttributesAddPointAttribute, RouteAttributesAddLineAttribute, RouteAttributesAddPolygonAttribute or RouteAttributesAddAlongRouteAttribute function. Current paramaters of routing difficulties stored in the session are available by RouteAttributesGetRouteAttributes, RouteAttributesGetRouteAttribute or RouteAttributesGetRouteAttributeWithGeometry function. Routing difficulties can be managed using following functions: RouteAttributesModifyPointAttribute, RouteAttributesModifyLineAttribute, RouteAttributesModifyPolygonAttribute, RouteAttributesModifyAlongRouteAttribute, RouteAttributesSetRouteAttribute, RouteAttributesDeleteRouteAttribute, RouteAttributesClearRouteAttribute.
In addition route planner can take into account difficulties received from other external sources (providers). Functions RouteAttributesSubscribeToDataProvider and RouteAttributesUnsubscribeFromDataProvider allow managing of the sources supported (available list can be get using RouteAttributesGetAttributesProviderList function).
RouteAttributesStoreToBlob function generates binary dump of all session routing difficulties which can be loaded later by RouteAttributesLoadFromBlob function.
For analyze purposes RouteAttributesGetPassedAttributesList function may be useful.
RouteOptimizerModule
RouteOptimizer module of MapCenter server offers functions of two kinds - basic and extended. Basic set of functions offers only route waypoint sequence optimization but extended functions are capable of solving optimal shipment delivery plans for a set of defined vehicle kinds. There are two modes of the optimization - the first takes into account only straight distances between waypoints, but the second default method (switching parameter routeoptimizerparams.calcinterpointlengths by use of function RoutePlannerSetParamValue) calculates all distances on roads. The second method is much slower and is performed with a set of parameters taking into account while route calculating: vehicle parameters, driver parameters and road parameters. The parameters can be maintained by following RoutePlanner module functions: RoutePlannerVehicleParamsGet2, RoutePlannerVehicleParamsSet2, RoutePlannerDriverParamsGet, RoutePlannerDriverParamsSet, RoutePlannerRoadParamsGet, RoutePlannerRoadParamsSet. If not explicitly set, the parameters have some default values.
Basic functions are RouteOptimizerOptimizeRoute and RouteOptimizerSimpleOptimizeRoute. Function RouteOptimizerOptimizeRoute works on at least two waypoints (route entries) stored in the sesssion. A list of waypoints is maintained by following functions: RoutePlannerEntriesGet, RoutePlannerEntriesSet, RoutePlannerEntriesSetWithDescription, RoutePlannerEntryAdd, RoutePlannerEntryAddWithDescription, RoutePlannerEntryInsert, RoutePlannerEntryInsertWithDescription, RoutePlannerEntryMove, RoutePlannerEntryComplexMove, RoutePlannerEntryRemove, RoutePlannerEntrySet, RoutePlannerEntrySetWithDescription, RoutePlannerEntryReverse, RoutePlannerEntriesClear. After calculating the route can be stored in the session. Function RouteOptimizerSimpleOptimizeRoute optimizes a route using its own parameters and waypoint list which optionally can replace session settings.
Extended version of the module has one main function RouteOptimizerSolveProblem. It takes into account the list of waypoints stored in the server session as described above, but waypoints can be augmented with additional properties by marking one of them as a depot point (functions RouteOptimizerSetDepotEntry and RouteOptimizerGetDepotEntry) and assigning to them delivery time windows and delivery shipment data and times (functions RouteOptimizerGetEntryTimeWindows, RouteOptimizerClearEntryTimeWindows, RouteOptimizerAddEntryTimeWindow, RouteOptimizerAddEntryTimeWindows, RouteOptimizerSetEntryTimeWindows, RouteOptimizerGetEntryDeliveryShipments, RouteOptimizerAddEntryDeliveryShipment, RouteOptimizerAddEntryDeliveryShipments, RouteOptimizerClearEntryDeliveryShipments, RouteOptimizerSetEntryDeliveryShipments, RouteOptimizerGetEntryShipmentDeliveryPickupTimes, RouteOptimizerSetEntryShipmentDeliveryPickupTimes). The function generates a set of routes dividing optimally the set of waypoints and assigning them to vehicles defined using following functions: VehicleRepositoryAddVehicle, VehicleRepositoryRemoveVehicle, VehicleRepositoryVehicleGet, VehicleRepositoryVehicleSet, VehicleRepositoryVehiclesGet, VehicleRepositoryVehiclesSet, VehicleRepositoryVehiclesClear, VehicleRepositoryRoadParamsGet, VehicleRepositoryRoadParamsSet, VehicleRepositoryDriverParamsGet, VehicleRepositoryDriverParamsSet, VehicleRepositoryVehicleViaTollGet, VehicleRepositoryVehicleViaTollSet. There is also posibility to set some incompatibilities between shipments and vehicles (functions RouteOptimizerVehicleCategoryToShipmentTypeIncompatibilityClear, RouteOptimizerVehicleCategoryToShipmentTypeIncompatibilityAdd, RouteOptimizerVehicleCategoryToShipmentTypeIncompatibilityGet, RouteOptimizerVehicleCategoryToShipmentTypeIncompatibilitySet, RouteOptimizerShipmentTypeToShipmentTypeIncompatibilityClear, RouteOptimizerShipmentTypeToShipmentTypeIncompatibilityAdd, RouteOptimizerShipmentTypeToShipmentTypeIncompatibilityGet, RouteOptimizerShipmentTypeToShipmentTypeIncompatibilitySet).
Enforces keeping the session available.
Removes the session with all its data.
Gets session comment.
Sets session comment.
Gets session language context.
Sets session language context.
Returns a list of delivered server modules.
Returns versions of the server and data components.
Returns the maximum number of simultaneously processed server sessions. Returns 0 if the number is not constrained.
Returns the number of currently processed server sessions.
Returns a time interval (in seconds), which inactive server session is removed after.
Return statistic information of all active server sessions.
Removes given session with all its data. Administrative rights are required.
Returns a list of supported map projections.
Returns a list of image MIME formats used in functions returning maps as image files.
Returns a list of all default map layers.
Returns a list of all currently loaded map files. When starting server loads all map files (files with extension .eff) from subdirectory DATA of server installation directory.
Returns geographic coordinates of rectangle bounding a sum of all active map file regions.
Realoads all map files placed in subdirectory DATA of server installation directory. All loaded map files are activated by default.
Activates map file identified by FileName. The file must be one of loaded map files.
Deactivates map file identified by FileName. The file must be one of loaded map files.
Returns list od current view config files. When starting server loads all map files (files with extension .efc) from subdirectory DATA of server installation directory.
Returns current session view config.
Sets current session view config.
Loads current session view config from blob.
Adds user account.
Returns user's properties.
Returns a value of user's additional parameter.
Sets a value for user's additional parameter. If the parameter does not exist, it will be created.
Modifies user's account.
Modifies user's password.
Removes user's account.
Returns a list of server users.
Adds user group.
Returns user group comment.
Modifies user group properties.
Removes user group.
Returns a list of user groups.
Returns a service config param list. For future use.
Sets a service config param. For future use.
Generates a map as image file with a middle in a given point. Geographic coordinates of all four corner points of the resultant map are returned, too.
Format of returned image. Supported formats can be received using GetAvailableImageFormats function.
Zoom of requested map being an altitude expressed in meters over sea level. It must be positive value.
Name of required map projection. Supported projections can be received using GetProjections function.
List of required map layers. List of all map layers can be received using GetDefaultLayers function.
Geographic coordinates of right-down point of the resultant map.
Generates a map as image file bounded by a given rectangle. Geographic coordinates of the middle point and altitude of the resultant map are returned, too. The proportions of given geographic rectangle and requested image may differ, so in addition the function returns effective corner points of the resultant map.
Format of returned image. Supported formats can be received using GetAvailableImageFormats function.
Geographic coordinates of the bottom-down point of the requested map.
Name of required map projection. Supported projections can be received using GetProjections function.
List of required map layers. List of all map layers can be received using GetDefaultLayers function.
Geographic coordinates of right-down point of the resultant map.
Generates a map with a middle in a given point. The map is split into a list of image files forming a matrix of tiles. Geographic coordinates of all four corner points of the resultant map are returned, too.
Format of returned images. Supported formats can be received using GetAvailableImageFormats function.
Zoom of requested map being an altitude expressed in meters over sea level. It must be positive value.
Name of required map projection. Supported projections can be received using GetProjections function.
Width of single map tile. It must be positive value. If the total width is not divisible by the value, additional space on all tiles in the last column is filled with white.
Height of single map tile. It must be positive value. If the total height is not divisible by the value, additional space on all tiles in the last row is filled with white.
List of required map layers. List of all map layers can be received using GetDefaultLayers function.
Geographic coordinates of right-down point of the resultant map.
Generates a map bounded by a given rectangle. The map is split into a list of image files forming a matrix of tiles. Geographic coordinates of the middle point and altitude of the resultant map are returned, too. The proportions of given geographic rectangle and requested total image may differ, so in addition the function returns effective corner points of the resultant map.
Format of returned images. Supported formats can be received using GetAvailableImageFormats function.
Geographic coordinates of the bottom-down point of the requested map.
Name of required map projection. Supported projections can be received using GetProjections function.
Width of single map tile. It must be positive value. If the total width is not divisible by the value, additional space on all tiles in the last column is filled with white.
Height of single map tile. It must be positive value. If the total height is not divisible by the value, additional space on all tiles in the last row is filled with white.
List of required map layers. List of all map layers can be received using GetDefaultLayers function.
Geographic coordinates of right-down point of the resultant map.
Generates a map with a middle in a given point. The map is rendered on a canvas (HDC) of pointed control (HWND), so the function works only if a client application is run on the same machine as the server. Geographic coordinates of all four corner points of the resultant map are returned, too.
Zoom of requested map being an altitude expressed in meters over sea level. It must be positive value.
Name of required map projection. Supported projections can be received using GetProjections function.
List of required map layers. List of all map layers can be received using GetDefaultLayers function.
Geographic coordinates of right-down point of the resultant map.
Generates a map bounded by a given rectangle. The map is rendered on a canvas (HDC) of pointed control (HWND), so the function works only if a client application is run on the same machine as the server. Geographic coordinates of the middle point and altitude of the resultant map are returned, too. The proportions of given geographic rectangle and the canvas may differ, so in addition the function returns effective corner points of the resultant map.
Geographic coordinates of the bottom-down point of the requested map.
Name of required map projection. Supported projections can be received using GetProjections function.
List of required map layers. List of all map layers can be received using GetDefaultLayers function.
Geographic coordinates of right-down point of the resultant map.
Generates a map as image file with a middle in a given point. Geographic coordinates of all four corner points of the resultant map are returned, too. Additionally returns copyrights of the map providers.
Format of returned image. Supported formats can be received using GetAvailableImageFormats function.
Zoom of requested map being an altitude expressed in meters over sea level. It must be positive value.
Name of required map projection. Supported projections can be received using GetProjections function.
List of required map layers. List of all map layers can be received using GetDefaultLayers function.
Geographic coordinates of right-down point of the resultant map.
Generates a map as image file bounded by a given rectangle. Geographic coordinates of the middle point and altitude of the resultant map are returned, too. The proportions of given geographic rectangle and requested image may differ, so in addition the function returns effective corner points of the resultant map. Additionally returns copyrights of the map providers.
Format of returned image. Supported formats can be received using GetAvailableImageFormats function.
Geographic coordinates of the bottom-down point of the requested map.
Name of required map projection. Supported projections can be received using GetProjections function.
List of required map layers. List of all map layers can be received using GetDefaultLayers function.
Geographic coordinates of right-down point of the resultant map.
Generates a map with a middle in a given point. The map is split into a list of image files forming a matrix of tiles. Geographic coordinates of all four corner points of the resultant map are returned, too. Additionally returns copyrights of the map providers.
Format of returned images. Supported formats can be received using GetAvailableImageFormats function.
Zoom of requested map being an altitude expressed in meters over sea level. It must be positive value.
Name of required map projection. Supported projections can be received using GetProjections function.
Width of single map tile. It must be positive value. If the total width is not divisible by the value, additional space on all tiles in the last column is filled with white.
Height of single map tile. It must be positive value. If the total height is not divisible by the value, additional space on all tiles in the last row is filled with white.
List of required map layers. List of all map layers can be received using GetDefaultLayers function.
Geographic coordinates of right-down point of the resultant map.
Generates a map bounded by a given rectangle. The map is split into a list of image files forming a matrix of tiles. Geographic coordinates of the middle point and altitude of the resultant map are returned, too. The proportions of given geographic rectangle and requested total image may differ, so in addition the function returns effective corner points of the resultant map. Additionally returns copyrights of the map providers.
Format of returned images. Supported formats can be received using GetAvailableImageFormats function.
Geographic coordinates of the bottom-down point of the requested map.
Name of required map projection. Supported projections can be received using GetProjections function.
Width of single map tile. It must be positive value. If the total width is not divisible by the value, additional space on all tiles in the last column is filled with white.
Height of single map tile. It must be positive value. If the total height is not divisible by the value, additional space on all tiles in the last row is filled with white.
List of required map layers. List of all map layers can be received using GetDefaultLayers function.
Geographic coordinates of right-down point of the resultant map.
Generates a map with a middle in a given point. The map is rendered on a canvas (HDC) of pointed control (HWND), so the function works only if a client application is run on the same machine as the server. Geographic coordinates of all four corner points of the resultant map are returned, too. Additionally returns copyrights of the map providers.
Zoom of requested map being an altitude expressed in meters over sea level. It must be positive value.
Name of required map projection. Supported projections can be received using GetProjections function.
List of required map layers. List of all map layers can be received using GetDefaultLayers function.
Geographic coordinates of right-down point of the resultant map.
Generates a map bounded by a given rectangle. The map is rendered on a canvas (HDC) of pointed control (HWND), so the function works only if a client application is run on the same machine as the server. Geographic coordinates of the middle point and altitude of the resultant map are returned, too. The proportions of given geographic rectangle and the canvas may differ, so in addition the function returns effective corner points of the resultant map. Additionally returns copyrights of the map providers.
Geographic coordinates of the bottom-down point of the requested map.
Name of required map projection. Supported projections can be received using GetProjections function.
List of required map layers. List of all map layers can be received using GetDefaultLayers function.
Geographic coordinates of right-down point of the resultant map.
Removes all session selections, i.e. selections of found map elements.
Generates a map split into a list of normalized image files forming a matrix of tiles. Each image has 256x256 pixels. Zoom has discrete values between 0 and 19. Dimentions of the matrix are returned, too. If the given zoom equals 0, total region of loaded maps is normalized to a single tile, so in this case the resultant matrix has size 1x1. If zoom equals 1, the map is zoomed in and the map region is divided by 2 in both dimensions, so the matrix has size 2x2, and so on. The maximum size of resultant matrix is 8x8, and it's possible for zoom with value 3 and higher.
Format of returned images. Supported formats can be received using GetAvailableImageFormats function. Optionally, the image format can be augmented by additional tile parameters using semicolon as a delimiter, e.g. "image/png;DPI=192", "image/png;TileSize=512".
X-position (row number) of the first tile of the resultant matrix in the global matrix available for the given zoom. Its value depends on zoom and must be between 0 and 2^Zoom - 1.
Y-position (column number) of the first tile of the resultant matrix in the global matrix available for the given zoom. Its value depends on zoom and must be between 0 and 2^Zoom - 1.
List of required layers. List of all supported layers can be received using GetTiledMapLayers function.
X-dimension (number of rows) of the resultant tiles matrix - 1 for the zoom 0, 2 for 1, 4 for 2 and 8 for other zoom values.
Generates a map split into a list of normalized image files forming a matrix of tiles. Each image has 256x256 pixels. Zoom has discrete values between 0 and 19. Dimentions of the matrix are returned, too. If the given zoom equals 0, total region of loaded maps is normalized to a single tile, so in this case the resultant matrix has size 1x1. If zoom equals 1, the map is zoomed in and the map region is divided by 2 in both dimensions, so the matrix has size 2x2, and so on. The maximum size of resultant matrix is 8x8, and it's possible for zoom with value 3 and higher. Additionally returns copyrights of the map providers.
Format of returned images. Supported formats can be received using GetAvailableImageFormats function. Optionally, the image format can be augmented by additional tile parameters using semicolon as a delimiter, e.g. "image/png;DPI=192", "image/png;TileSize=512".
X-position (row number) of the first tile of the resultant matrix in the global matrix available for the given zoom. Its value depends on zoom and must be between 0 and 2^Zoom - 1.
Y-position (column number) of the first tile of the resultant matrix in the global matrix available for the given zoom. Its value depends on zoom and must be between 0 and 2^Zoom - 1.
List of required layers. List of all supported layers can be received using GetTiledMapLayers function.
X-dimension (number of rows) of the resultant tiles matrix - 1 for the zoom 0, 2 for 1, 4 for 2 and 8 for other zoom values.
Generates a map split into a list of normalized image files forming a matrix of tiles. Each image has 256x256 pixels. Zoom has discrete values between 0 and 19. Dimentions of the matrix are returned, too. If the given zoom equals 0, total region of loaded maps is normalized to a single tile, so in this case the resultant matrix has size 1x1. If zoom equals 1, the map is zoomed in and the map region is divided by 2 in both dimensions, so the matrix has size 2x2, and so on. The maximum size of resultant matrix is 8x8, and it's possible for zoom with value 3 and higher.
Format of returned images. Supported formats can be received using GetAvailableImageFormats function. Optionally, the image format can be augmented by additional tile parameters using semicolon as a delimiter, e.g. "image/png;DPI=192", "image/png;TileSize=512".
X-position (row number) of the first tile of the resultant matrix in the global matrix available for the given zoom. Its value depends on zoom and must be between 0 and 2^Zoom - 1.
Y-position (column number) of the first tile of the resultant matrix in the global matrix available for the given zoom. Its value depends on zoom and must be between 0 and 2^Zoom - 1.
List of required layers. List of all supported layers can be received using GetTiledMapLayers function.
List of required map layers. List of all map layers can be received using GetDefaultLayers function.
X-dimension (number of rows) of the resultant tiles matrix - 1 for the zoom 0, 2 for 1, 4 for 2 and 8 for other zoom values.
Returns a list of all layers supported by RenderTiledMap function.
Converts geographic coordinates to screen coordinates (image pixels).
Zoom of the map being an altitude expressed in meters over sea level. It must be positive value.
Name of required map projection. Supported projections can be received using GetProjections function.
The resultant list of screen points. Their coordinates may be negative or higher than given image sizes.
Converts screen coordinates (image pixels) to geographic ones.
Zoom of the map being an altitude expressed in meters over sea level. It must be positive value.
Name of required map projection. Supported projections can be received using GetProjections function.
A list of screen points to be converted. Their coordinates may be negative or higher than given image sizes.
Calculates total length in meters of a path composed of given list of geographic points.
Calculates total length in meters of a path composed of given list of screen points.
Zoom of the map being an altitude expressed in meters over sea level. It must be positive value.
Name of required map projection. Supported projections can be received using GetProjections function.
A list of screen points to be converted. Their coordinates may be negative or higher than given image sizes.
Calculates a length in meters and azimuths between two geographic poins.
Resultant azimuth from the start to the stop point. It is an angle in degrees between 0 and 360 counterclockwise.
Returns a destination point with given distance from the start point according to the given azimuth.
Returns a list of all map layers taking into account by degecode functions.
Returns a value for given parameter of degeocoding stored in
the session. Parameter value meanings:
* degeocodeparams.degeocodetime -
time of degeocoding within a day, when value 1/24 means 01:00 a.m, 2/24 means
02:00 a.m. and so on (by default it is 09:00 a.m.)
*
degeocodeparams.vehicletype - vehicle type for degeocoding purposes as defined
in the TVehicleEntry
(default value is 0)
Sets a value for given parameter of degeocoding stored in the session.
Returns (degeocodes) geographic information for a list of given geographic points. An administrative and only the closest urbanistic and topographic information concerning each point is generated.
Zoom of a map being an altitude expressed in meters over sea level. It must be positive value.
Name of required map projection. Supported projections can be received using GetProjections function.
List of required degeocode layers. List of the layers can be received using GetDegeocodeLayers function.
If this option is on, the function ommits unnamed map elements, i.e. roads, forests without names. Otherwise all elements are taking into account.
If this option is on, the function ommits those map elements, which are not displayed in the given zoom. Otherwise all elements are taking into account.
Returns (degeocodes) geographic information for a list of given geographic points. Only the closest information concerning each point is generated (for all given layers).
Zoom of a map being an altitude expressed in meters over sea level. It must be positive value.
Name of required map projection. Supported projections can be received using GetProjections function.
List of required degeocode layers. List of the layers can be received using GetDegeocodeLayers function.
If this option is on, the function ommits unnamed map elements, i.e. roads, forests without names. Otherwise all elements are taking into account.
If this option is on, the function ommits those map elements, which are not displayed in the given zoom. Otherwise all elements are taking into account.
Returns (degeocodes) geographic information for a list of given geographic points. Only the closest information concerning each point is generated (for all given layers). For future use.
Zoom of a map being an altitude expressed in meters over sea level. It must be positive value.
Name of required map projection. Supported projections can be received using GetProjections function.
List of required degeocode layers. List of the layers can be received using GetDegeocodeLayers function.
If this option is on, the function ommits unnamed map elements, i.e. roads, forests without names. Otherwise all elements are taking into account.
If this option is on, the function ommits those map elements, which are not displayed in the given zoom. Otherwise all elements are taking into account.
Returns (degeocodes) geographic information for the given geographic point. An information for all given layers maching the given search radius is generated.
Zoom of a map being an altitude expressed in meters over sea level. It must be positive value.
Name of required map projection. Supported projections can be received using GetProjections function.
Maximum number of required resultant elements. It must be nonnegative value, 0 means no limits. Elements of each resultant category are counted independently.
List of required degeocode layers. List of the layers can be received using GetDegeocodeLayers function.
If this option is on, the function ommits unnamed map elements, i.e. roads, forests without names. Otherwise all elements are taking into account.
If this option is on, the function ommits those map elements, which are not displayed in the given zoom. Otherwise all elements are taking into account.
The list of external objects found (saved in the session and placed on a map).
Connects given server session to a database described with connection string and opens a object set containing records from the database. Any previous connection of the same database type should be closed by the session before - only one database of each type can be opened.
Connection parameters transferred as a semicolon separated string in form "Parameter1=Value1;Parameter2=Value2;...". Available parameters are: DBName (it should be one of available database names returned by GetDatabaseList function), UserName, UserPassword. Parameters may be placed in any order.
Disconnects given server session from a database. Some connection of given database type should be active before.
Loads a database file (*.emd for objects or *.eld for logistics) and opens the database for current session only with administrative privileges. Function has same effect as if a database would be opened using MapBaseConnect function, so the connection should be finalized by a call of MapBaseDisconnect function.
Returns current content of a database loaded previously using MapBaseLoadFromBlob function (for saving of any database changes to a file).
Returns a list of available databases of given type configured on the server.
Returns a list of tables (object sets) available for given database type.
Returns a count of objects in a object set.
Returns a structure of object set currently opened.
Types of corresponding object fields. Following values are
supported:
- Character or string field = 0x01
- 16-bit integer field =
0x02
- 32-bit integer field = 0x03
- 16-bit unsigned integer field =
0x04
- Boolean field = 0x05
- Floating-point numeric field = 0x06
-
Date field = 0x09
- Time field = 0x0A
- Date and time field =
0x0B
Sizes of corresponding object fields. Size is the maximum number of characters in the string field. For all other field types, size value is always 0.
Precision of corresponding object fields. It is used in formatting the value in a floating-point fields only and is the number of digits beyond the decimal point. For all other field types, precision value is always 0.
Parameters of corresponding object fields. It is a bit
vector for each field - each bit deals with one parameter:
- key field =
0x01
- link field (hyperlink values) = 0x02
- hidden field = 0x04
-
indexed field = 0x08
- not null field (value required) =
0x10
Specific features of corresponding object fields. Following
values are supported:
- name (object name being drawn on maps) = 0x01
-
city (for geocoding purposes) = 0x02
- street (for geocoding purposes) =
0x03
- number (for geocoding purposes) = 0x04
- postal code (for
geocoding purposes) = 0x05
- break time (for routing purposes) = 0x0A
-
country (for geocoding purposes) = 0x0F
Sets a new structure of an object set currently opened (requires administrative privileges). Any subset of data fileds can be changed. EditObjectFields should be invoked before.
New types of corresponding object fields. Following values
are supported:
- Character or string field = 0x01
- 16-bit integer field
= 0x02
- 32-bit integer field = 0x03
- 16-bit unsigned integer field =
0x04
- Boolean field = 0x05
- Floating-point numeric field = 0x06
-
Date field = 0x09
- Time field = 0x0A
- Date and time field =
0x0B
New sizes of corresponding object fields. Size is the maximum number of characters in the string field. For all other field types, size value is always 0.
New precision of corresponding object fields. It is used in formatting the value in a floating-point fields only and is the number of digits beyond the decimal point. For all other field types, precision value is always 0.
New parameters of corresponding object fields. It is a bit
vector for each field - each bit deals with one parameter:
- key field =
0x01
- link field (hyperlink values) = 0x02
- hidden field = 0x04
-
indexed field = 0x08
- not null field (value required) =
0x10
Specific features of corresponding object fields. Following
values are supported:
- name (object name being drawn on maps) = 0x01
-
city (for geocoding purposes) = 0x02
- street (for geocoding purposes) =
0x03
- number (for geocoding purposes) = 0x04
- postal code (for
geocoding purposes) = 0x05
- break time (for routing purposes) = 0x0A
-
country (for geocoding purposes) = 0x0F
Creates a new object set (requires administrative privileges).
Object set parameters transferred as a semicolon separated string in form "Parameter1=Value1;Parameter2=Value2;...". Available parameters are: DBName, UserName, UserPassword. Parameters may be placed in any order.
New types of corresponding object fields. Following values
are supported:
- Character or string field = 0x01
- 16-bit integer field
= 0x02
- 32-bit integer field = 0x03
- 16-bit unsigned integer field =
0x04
- Boolean field = 0x05
- Floating-point numeric field = 0x06
-
Date field = 0x09
- Time field = 0x0A
- Date and time field =
0x0B
Sizes of corresponding object fields. Size is the maximum number of characters in the string field. For all other field types, size value is always 0.
Precision of corresponding object fields. It is used in formatting the value in a floating-point fields only and is the number of digits beyond the decimal point. For all other field types, precision value is always 0.
Parameters of corresponding object fields. It is a bit
vector for each field - each bit deals with one parameter:
- key field =
0x01
- link field (hyperlink values) = 0x02
- hidden field = 0x04
-
indexed field = 0x08
- not null field (value required) =
0x10
Specific features of corresponding object fields. Following
values are supported:
- name (object name being drawn on maps) = 0x01
-
city (for geocoding purposes) = 0x02
- street (for geocoding purposes) =
0x03
- number (for geocoding purposes) = 0x04
- postal code (for
geocoding purposes) = 0x05
- country (for geocoding purposes) =
0x0F
Option of saving new object set to the disk. If false, object set will be volatile - only for current session.
Returns all properties of an object identified by given ID.
Names of object fields to be returned. The list of all fields in the object set may be obtained using GetObjectFields function.
Locks object identified by given ID for changing.
Posts new data for object identified by given ID. The object should be locked by EditObject before. After success object will be unlocked.
Names of object fields to be changed. The list of all fields in the object set may be obtained using GetObjectFields function.
Position of object name being drawn on maps nearby its icon.
It is the alignment of object name with reference to its icon. Supported values
are:
- bottom-right = 0x00
- bottom = 0x01
- bottom-left = 0x02
- left = 0x03
- top-left = 0x04
- top = 0x05
- top-right = 0x06
- right = 0x07
Posts new data for a set of objects identified by given IDs.
Names of object fields to be changed. The list of all fields in the object set may be obtained using GetObjectFields function.
A list of positions of object name being drawn on maps
nearby its icon. It is the alignment of object name with reference to its icon.
Supported values are:
- bottom-right = 0x00
- bottom = 0x01
-
bottom-left = 0x02
- left = 0x03
- top-left = 0x04
- top = 0x05
- top-right = 0x06
- right = 0x07
Inserts new object to the object set.
Names of object fields to be set. The list of all fields in the object set may be obtained using GetObjectFields function.
Position of object name being drawn on maps nearby its icon.
It is the alignment of object name with reference to its icon. Supported values
are:
- bottom-right = 0x00
- bottom = 0x01
- bottom-left = 0x02
- left = 0x03
- top-left = 0x04
- top = 0x05
- top-right = 0x06
- right = 0x07
Inserts a set of new objects to the object set.
Names of object fields to be set. The list of all fields in the object set may be obtained using GetObjectFields function.
A list of positions of object name being drawn on maps
nearby its icon. It is the alignment of object name with reference to its icon.
Supported values are:
- bottom-right = 0x00
- bottom = 0x01
-
bottom-left = 0x02
- left = 0x03
- top-left = 0x04
- top = 0x05
- top-right = 0x06
- right = 0x07
Removes object identified by given ID.
Rmoves objects identified by given IDs.
A list of not deleted objects (locked by other users or not existing).
Unlocks object identified by given ID.
Inserts new or overwrites existing polygon within a shape list tied with object identified by given ID. The object will be locked after the call.
Shape identifier. Value -1 is required in case of new shape insertion. New sequence identifier will be generated automatically.
Returns coordinates of polygon(s) tied with object identified by given ID.
Inserts new or overwrites existing polyline within a shape list tied with object identified by given ID. The object will be locked after the call.
Shape identifier. Value -1 is required in case of new shape insertion. New sequence identifier will be generated automatically.
Returns coordinates of polyline(s) tied with object identified by given ID.
Inserts new or overwrites existing ellipse within a shape list tied with object identified by given ID. The object will be locked after the call.
Shape identifier. Value -1 is required in case of new shape insertion. New sequence identifier will be generated automatically.
Returns coordinates of ellipse(s) tied with object identified by given ID.
Inserts new or overwrites existing rectangle within a shape list tied with object identified by given ID. The object will be locked after the call.
Shape identifier. Value -1 is required in case of new shape insertion. New sequence identifier will be generated automatically.
Returns coordinates of rectangle(s) tied with object identified by given ID.
Inserts new or overwrites existing circle within a shape list tied with object identified by given ID. The object will be locked after the call.
Shape identifier. Value -1 is required in case of new shape insertion. New sequence identifier will be generated automatically.
Returns coordinates of circle(s) tied with object identified by given ID.
Removes a shape from the shape list tied with object identified by given ID.
Returns a binary data tied with object identified by given ID.
Sets an arbitrary binary data for object identified by given ID.
Returns a binary data tied with object group identified by given ID.
Sets an arbitrary binary data for object group identified by given ID.
Returns settings of an object group.
Names of fields essential for an object group - other fields in object set are not important for the object group.
Returns settings of an object group concerning shape visualization.
Sets settings of an object group concerning shape visualization.
Sets the visibility on maps for object groups.
A list of object group identifiers to be shown on maps. Other object groups in the object set will be hidden. The list of identifiers for all object groups in the object set may be obtained using GetObjectFields function.
Returns object group visibility.
Locks an object group for changing.
Posts new data for object group identified by given ID. The group should be locked by EditGroup before. After success object group will be unlocked.
Names of fields essential for the object group - other fields in object set are not important for the object group.
Inserts new object group to the object set.
Names of fields essential for the object group - other fields in object set are not important for the object group.
Removes object group identified by given ID.
Unlocks object group identified by given ID.
Returns a bitmap being an icon assigned to the object group.
Adds new icon to the object set.
Removes an icon from the object set.
Returns a list of all icons stored in a database.
Returns a statistic information about data changed by other users since last call of that function.
Number of objects changed. A list of them may be obtained using GetNextResult_UpdatedSet function.
Number of objects removed. A list of them may be obtained using GetNextResult_RemovedSet function.
Returns a list of database fields modified since last call of that function.
Returns a list of database fields removed since last call of that function.
Filters currently opened object set using text or numeric search. Takes into account objects being results of previous filter performed by the server session on the object set. Function returns only number of objects matching given conditions. Object data may be obtained using GetNextResult_Set function.
Names of condition fields. The list of all fields in the object set may be obtained using GetObjectFields function.
Search conditions for corresponding fields. Currently containment condition for text fields and equivalent condition for other fields are supported. In both cases string "=" should be given.
Filters currently opened object set. Function finds objects that are nearest to the given point. Takes into account objects being results of previous filter performed by the server session on the object set. Function returns only number of objects found. Object data may be obtained using GetNextResult_Set function.
Filters currently opened object set. Function finds objects placed in geographic circle with given middle point and radius. Takes into account objects being results of previous filter performed by the server session on the object set. Function returns only number of objects found. Object data may be obtained using GetNextResult_Set function.
Filters currently opened object set. Function finds objects placed in or intersected with given object shape stored in the database. Takes into account objects being results of previous filter performed by the server session on the object set. Function returns only number of objects found. Object data may be obtained using GetNextResult_Set function.
Filters currently opened object set. Function finds objects placed in or intersected with given object shape. Takes into account objects being results of previous filter performed by the server session on the object set. Function returns only number of objects found. Object data may be obtained using GetNextResult_Set function.
Returns values for given object field, for given part of the object set.
Name of requested field. The list of all fields in the object set may be obtained using GetObjectFields function.
Returns object identifiers and identifiers of their groups for the next part of the object set.
Returns geographic information for given part of the object set.
Positions of object names being drawn on maps nearby its
icons. The position is the alignment of object name with reference to its icon.
Supported values are:
- bottom-right = 0x00
- bottom = 0x01
-
bottom-left = 0x02
- left = 0x03
- top-left = 0x04
- top = 0x05
- top-right = 0x06
- right = 0x07
Returns the next part of the object set. Values for given object fields, object identifiers and identifiers of their groups and geographic information are returned.
Names of requested fields. The list of all fields in the object set may be obtained using GetObjectFields function.
Positions of object names being drawn on maps nearby its
icons. The position is the alignment of object name with reference to its icon.
Supported values are:
- bottom-right = 0x00
- bottom = 0x01
-
bottom-left = 0x02
- left = 0x03
- top-left = 0x04
- top = 0x05
- top-right = 0x06
- right = 0x07
Returns the next part of the objects updated by other users. Values for given object fields, object identifiers and identifiers of their groups and geographic information are returned.
Names of requested fields. The list of all fields in the object set may be obtained using GetObjectFields function.
Positions of object names being drawn on maps nearby its
icons. The position is the alignment of object name with reference to its icon.
Supported values are:
- bottom-right = 0x00
- bottom = 0x01
-
bottom-left = 0x02
- left = 0x03
- top-left = 0x04
- top = 0x05
- top-right = 0x06
- right = 0x07
Returns the next part of the object identifiers removed by other users.
Filters currently opened object set. Takes into account objects being results of previous filter performed by the server session on the object set. Function finds objects with given identifiers or objects, which haven't got given identifiers. The behaviour depends on value of AllowSelected parameter.
Returns aggregate values for object fields.
Names of requested fields. The list of all fields in the object set may be obtained using GetObjectFields function.
A list of sum values for requested fields. Empty strings are returned for non-numeric fields.
A list of average values for requested fields. Empty strings are returned for non-numeric fields.
Disables all filters performed on the object set by the server session. All objects are available from now.
Locks the currently opened object set for restructuring (requires administrative privileges).
Unlocks the currently opened object set locked by EditObjectFields function (requires administrative privileges).
Returns identifiers of objects with shapes containing given objects.
Returns identifiers of objects contained in shapes of given objects.
A list of informations of object aggregation possibility - whether given objects have got any shapes tied with them (in case of an empty list of identifiers returned for some object, to distinguish between objects without shapes and objects with shapes but without objects contained).
Clears a search context in the given server session and initializes required search mode of the searching.
This option enables searching without national (diacritic) characters (instead of them equivalent ASCII characters may be used).
Returns a list of available countries. The first item of the list is empty - it is "any country" entry.
Searches for cities with names cantaining given prefix at the beginning of any word. Cities are searched in the given country. Postal code and administrative regions help in avoiding of ambiguity. The function returns only length of the resultant list. Found cities are kept in the session search context. Search process is case-insensitive.
The number of country being an index in the list returned by SearchGetCountryList function. Value 0 (the first index) corresponds to "any country".
A phrase being searched at the beginning of city names. The phrase may be empty to obtain all cities.
Returns a part of list of cities found by SearchSelectCities function. In addition names and abbreviations of administrative regions are returned for each city.
A start index of requested part of the city list found and kept in the session search context. Value 0 is the first index.
Count of requested cities. Function returns at most 100 cities, so if the value is greater, length of resultant lists should be checked.
The list of abbreviations for administrative regions containing found cities. Country and lower level area abreviations are returned for each city as a list of strings.
The list of administrative regions containing found cities. Country and lower level area names are returned for each city as a list of strings.
Returns a part of list of cities found by SearchSelectCities function. In addition names and abbreviations of administrative regions are returned for each city.
A start index of requested part of the city list found and kept in the session search context. Value 0 is the first index.
Count of requested cities. Function returns at most 100 cities, so if the value is greater, length of resultant lists should be checked.
The list of abbreviations for administrative regions containing found cities. Country and lower level area abreviations are returned for each city in form of one string containing the abbreviations separated with character '|'.
The list of administrative regions containing found cities. Country and lower level area names are returned for each city in form of one string containing the names separated with character '|'.
Returns a list of available kinds of searched map elements. The first item of the list is empty - it is "any element kind" entry.
The list of element kinds. Currenty the list contains: squares, estates, quarters, highway exits, airports, roads, rivers, lakes, cemeteries, parks.
Set the list of map element kinds which are used requesting the SearchSelectItems or SearchSelectItemsEx functions with the ItemKindIndex parameter set to 0. By default all element kinds are used.
The list of element kind indices (only indices returned by SearchGetItemKindList function are permitted).
Searches for map elements of certain kind with names cantaining given prefix at the beginning of any word. Elements are searched in the given city. The function returns only length of the resultant list. Found elements are kept in the session search context. Search process is case-insensitive.
The number of city being an index in the list created in the session context by SearchSelectCities function. Value 0 is the first index.
The number of element kind being an index in the list returned by SearchGetItemKindList function. Value 0 (the first index) corresponds to "any element kind".
A phrase being searched at the beginning of any word of map element names. For elements of some kinds (rivers, lakes, cemeteries, parks) only begginings of whole names are matched. The phrase may be empty to obtain all elements.
Searches for map elements of certain kind with names cantaining given prefix at the beginning of any word. Elements are searched in the given country. The function returns only length of the resultant list. Found elements are kept in the session search context. Search process is case-insensitive.
The number of country being an index in the list returned by SearchGetCountryList function. Value 0 (the first index) corresponds to "any country".
The number of element kind being an index in the list returned by SearchGetItemKindList function. Value 0 (the first index) corresponds to "any element kind".
A phrase being searched at the beginning of any word of map element names. For elements of some kinds (rivers, lakes, cemeteries, parks) only begginings of whole names are matched. The phrase may be empty to obtain all elements.
Returns a part of list of map elements found by SearchSelectItems or SearchSelectItemsEx function. In addition indices of corresponding element kinds are returned for each element.
A start index of requested part of the element list found and kept in the session search context. Value 0 is the first index.
Count of requested elements. Function returns at most 100 elements, so if the value is greater, length of resultant lists should be checked.
The list of corresponding element kinds being indices in the list returned by SearchGetItemKindList function.
Adds found city to session selection. Name of the city will be marked out on all maps generated for the session. All selections are removed by ClearMapSelection function. Function returns geographic information about boundaries and middle point of the city.
The number of city being an index in the list created in the session context by SearchSelectCities function. Value 0 is the first index.
Adds found map element to session selection. Name and area of the element will be marked out on all maps generated for the session. All selections are removed by ClearMapSelection function. Function returns geographic information about boundaries and middle point of the element.
The number of element being an index in the list created in the session context by SearchSelectItems or SearchSelectItemsEx function. Value 0 is the first index.
Geographic coordinates of the rectangle bounding the area of the map element.
Searches for the given building number on a street and adds it to session selection. Found position will be marked out on all maps generated for the session. All selections are removed by ClearMapSelection function. Function returns geographic coordinates of found point.
The number of element being an index in the list created in the session context by SearchSelectItems or SearchSelectItemsEx function. Value 0 is the first index. The element must be of kind "roads".
Returns a global identifier (a handle) of a map element being of kind "roads". The handle is fixed for the server session, not only for session search context.
The number of element being an index in the list created in the session context by SearchSelectItems or SearchSelectItemsEx function. Value 0 is the first index. The element must be of kind "roads".
Searches for a crossing for two streets and adds it to session selection. Found crossing will be marked out on all maps generated for the session. All selections are removed by ClearMapSelection function. Function returns geographic coordinates of the crossing point.
A handle to the first street. The handle to a street found by SearchSelectItems or SearchSelectItemsEx function should be get using SearchGetStreetHandle function.
A handle to the second street. The handle to a street found by SearchSelectItems or SearchSelectItemsEx function should be get using SearchGetStreetHandle function.
Translates addresses to their geographic coordinates. For each address the function returns the geocode level, too.
This option enables searching without national (diacritic) characters (instead of them equivalent ASCII characters may be given).
A list of resultant geocode levels. The geocode level is a
bit vector - each bit deals with one address item:
- country = 0x01
-
2nd level administrative area (county) = 0x02
- 3rd level administrative
area (district) = 0x04
- city = 0x08
- postal code = 0x10
- street =
0x20
- building numeration = 0x40
If an address item was taken into
account while geocoding process, its bit is set to 1. If an address was not
geocoded, the geocode level for it has value 0 (all bits set to
0).
Translates an address to its geographic coordinates. More than one result can be proposed. The function returns the address found and its geocode level for each proposal.
This option enables searching without national (diacritic) characters (instead of them equivalent ASCII characters may be given).
Maximal result count. Function returns at most 100 results, so if the value is greater, length of resultant lists should be checked.
A list of resultant geocode levels for proposals found. The
geocode level is a bit vector - each bit deals with one address item:
-
country = 0x01
- 2nd level administrative area (county) = 0x02
- 3rd
level administrative area (district) = 0x04
- city = 0x08
- postal code
= 0x10
- street = 0x20
- building numeration = 0x40
- 4rd level
administrative area (commune) = 0x80
If an address item was taken into
account while geocoding process, its bit is set to 1. If an address was not
geocoded, the geocode level for it has value 0 (all bits set to
0).
Translates addresses to their geographic coordinates. More than one result for each address can be proposed. The function returns addresses found and the geocode levels for each proposal.
This option enables searching without national (diacritic) characters (instead of them equivalent ASCII characters may be given).
Maximal result count. Function returns at most 100 results, so if the value is greater, length of resultant lists should be checked.
Returns properties of a field contained in the numeric fields collection saved in the server session.
Index of a field in the collection. It must be a value between 0 and count-1, when count may be obtained using LocalizeNumFieldsGetCount function.
Information on whether the field values are returned by DegeocodeAtPoint function as a part of localized object description.
Changes properties of a field contained in the numeric fields collection saved in the server session.
Index of a field in the collection. It must be a value between 0 and count-1, when count may be obtained using LocalizeNumFieldsGetCount function.
Information on whether the field values are returned by DegeocodeAtPoint function as a part of localized object description.
Adds a new field to the numeric fields collection saved in the server session. The field is appended at the end of the collection.
Information on whether the field values are returned by DegeocodeAtPoint function as a part of localized object description.
Removes a field from the numeric fields collection saved in the server session.
Index of a field in the collection. It must be a value between 0 and count-1, when count may be obtained using LocalizeNumFieldsGetCount function.
Removes all fields from the numeric fields collection saved in the server session.
Returns the number of fields in the numeric fields collection saved in the server session.
Returns properties of a field contained in the string fields collection saved in the server session.
Index of a field in the collection. It must be a value between 0 and count-1, when count may be obtained using LocalizeStrFieldsGetCount function.
Information on whether the field values are returned by DegeocodeAtPoint function as a part of localized object description.
Changes properties of a field contained in the string fields collection saved in the server session.
Index of a field in the collection. It must be a value between 0 and count-1, when count may be obtained using LocalizeStrFieldsGetCount function.
Information on whether the field values are returned by DegeocodeAtPoint function as a part of localized object description.
Adds a new field to the string fields collection saved in the server session. The field is appended at the end of the collection.
Information on whether the field values are returned by DegeocodeAtPoint function as a part of localized object description.
Removes a field from the string fields collection saved in the server session.
Index of a field in the collection. It must be a value between 0 and count-1, when count may be obtained using LocalizeStrFieldsGetCount function.
Removes all fields from the string fields collection saved in the server session.
Returns the number of fields in the string fields collection saved in the server session.
Adds a new icon to the icons collection saved in the server session. The icon is appended at the end of the collection.
Returns properties of an icon contained in the icons collection saved in the server session.
Index of an icon in the collection. It must be a value between 0 and count-1, when count may be obtained using LocalizeIconGetCount function.
Changes properties of an icon contained in the icons collection saved in the server session.
Index of an icon in the collection. It must be a value between 0 and count-1, when count may be obtained using LocalizeIconGetCount function.
Returns the number of icons in the icons collection saved in the server session.
Removes an icon from the icons collection saved in the server session.
Index of an icon in the collection. It must be a value between 0 and count-1, when count may be obtained using LocalizeIconGetCount function.
Removes all icons from the icons collection saved in the server session.
Returns an index of an icon in the icons collection saved in the server session - the icon with the given identifier .
Index of an icon in the collection. It is a value between 0 and count-1, when count may be obtained using LocalizeIconGetCount function.
Adds a new object position to the positions collection of the given localized object saved in the server session. The position is appended at the end of the collection. If the RemovePreviousPositions option is active for the localized object, earlier added positions are removed. The new position is from now displayed on maps rendered for the session.
Values for all numeric fields contained in the collection saved in the server session.
Values for all string fields contained in the collection saved in the server session.
The position description, displayed next to the position of an object on the map when the ShowDescription option is active. If the ShowIcon option is active, the description is displayed under the icon.
Information on whether to display the description of the position of the object on the map.
Information on whether to display the name of the object next to the position of the object on the map, unless the ShowName option is deactivated directly for the localized object (concerns only the last object position).
Information on whether to display the icon in the given position of the object on the map, unless the ShowIcon option is deactivated directly for the localized object (concerns only the last object position).
The color of the icon, which replaces in it the so-called modifiable color, set permanently at the value 0x00FF00FF. It must be a value in 0x00BBGGRR format (BB=blue, GG=green, RR=red).
Returns properties of an object position contained in the positions collection of the given localized object saved in the server session.
Index of an object position in the collection. It must be a value between 0 and count-1, when count may be obtained using LocalizeObjectPositionGetCount function.
Values of all numeric fields contained in the collection saved in the server session.
Values of all string fields contained in the collection saved in the server session.
The position description, displayed next to the position of an object on the map when the ShowDescription option is active. If the ShowIcon option is active, the description is displayed under the icon.
Information on whether to display the description of the position of the object on the map.
Information on whether to display the name of the object next to the position of the object on the map, unless the ShowName option is deactivated directly for the localized object (concerns only the last object position).
Information on whether to display the icon in the given position of the object on the map, unless the ShowIcon option is deactivated directly for the localized object (concerns only the last object position).
Changes properties of an object position contained in the positions collection of the given localized object saved in the server session.
Index of an object position in the collection. It must be a value between 0 and count-1, when count may be obtained using LocalizeObjectPositionGetCount function.
Values for all numeric fields contained in the collection saved in the server session.
Values for all string fields contained in the collection saved in the server session.
The position description, displayed next to the position of an object on the map when the ShowDescription option is active. If the ShowIcon option is active, the description is displayed under the icon.
Information on whether to display the description of the position of the object on the map.
Information on whether to display the name of the object next to the position of the object on the map, unless the ShowName option is deactivated directly for the localized object (concerns only the last object position).
Information on whether to display the icon in the given position of the object on the map, unless the ShowIcon option is deactivated directly for the localized object (concerns only the last object position).
The color of the icon, which replaces in it the so-called modifiable color, set permanently at the value 0x00FF00FF. It must be a value in 0x00BBGGRR format (BB=blue, GG=green, RR=red).
Removes an object position from the positions collection of the given localized object saved in the server session.
Index of an object position in the collection. It must be a value between 0 and count-1, when count may be obtained using LocalizeObjectPositionGetCount function.
Removes all object positions from the positions collection of the given localized object saved in the server session.
Returns the number of object positions in the positions collection of the given localized object saved in the server session.
Adds a new object to the localized objects collection saved in the server session. The object is appended at the end of the collection.
Object name displayed by the last position of an object on the map, providing the ShowName option is active.
The color of the icon, which replaces in it the so-called modifiable color, set permanently at the value 0x00FF00FF. It must be a value in 0x00BBGGRR format (BB=blue, GG=green, RR=red).
The color of the track created by the object positions. It must be a value in 0x00BBGGRR format (BB=blue, GG=green, RR=red).
Information on whether to delete the previous object positions while localizing new positions of the object.
Returns properties of an object contained in the localized objects collection saved in the server session.
Index of an object in the collection. It must be a value between 0 and count-1, when count may be obtained using LocalizeObjectGetCount function.
Object name displayed by the last position of an object on the map, providing the ShowName option is active.
The color of the icon, which replaces in it the so-called modifiable color, set permanently at the value 0x00FF00FF. It is a value in 0x00BBGGRR format (BB=blue, GG=green, RR=red).
The color of the track created by the object positions. It is a value in 0x00BBGGRR format (BB=blue, GG=green, RR=red).
Changes properties of an object contained in the localized objects collection saved in the server session.
Index of an object in the collection. It must be a value between 0 and count-1, when count may be obtained using LocalizeObjectGetCount function.
Object name displayed by the last position of an object on the map, providing the ShowName option is active.
The color of the icon, which replaces in it the so-called modifiable color, set permanently at the value 0x00FF00FF. It must be a value in 0x00BBGGRR format (BB=blue, GG=green, RR=red).
The color of the track created by the object positions. It must be a value in 0x00BBGGRR format (BB=blue, GG=green, RR=red).
Information on whether to delete the previous object positions while localizing new positions of the object.
Removes an object from the localized objects collection saved in the server session.
Index of an object in the collection. It must be a value between 0 and count-1, when count may be obtained using LocalizeObjectGetCount function.
Removes all objects from the localized objects collection saved in the server session.
Returns the number of objects in the localized objects collection saved in the server session.
Returns an index of an object in the localized objects collection saved in the server session - the object with the given identifier .
Index of an object in the collection. It is a value between 0 and count-1, when count may be obtained using LocalizeObjectGetCount function.
Adds a new object to the localized objects collection saved in the server session. The object is appended at the end of the collection. The object is added together with a list of positions.
Object name displayed by the last position of an object on the map, providing the ShowName option is active.
The color of the icon, which replaces in it the so-called modifiable color, set permanently at the value 0x00FF00FF. It must be a value in 0x00BBGGRR format (BB=blue, GG=green, RR=red).
The color of the track created by the object positions. It must be a value in 0x00BBGGRR format (BB=blue, GG=green, RR=red).
Information on whether to delete the previous object positions while localizing new positions of the object.
Values for all string fields contained in the collection saved in the server session (for all positions given in ObjectPositions parameter).
Values for all numeric fields contained in the collection saved in the server session (for all positions given in ObjectPositions parameter).
Adds new positions to the positions collection of the given localized object saved in the server session. The positions are appended at the end of the collection. If the RemovePreviousPositions option is active for the localized object, earlier added positions are removed. New positions are from now displayed on maps rendered for the session.
Values for all string fields contained in the collection saved in the server session (for all positions given in ObjectPositions parameter).
Values for all numeric fields contained in the collection saved in the server session (for all positions given in ObjectPositions parameter).
Changes the visibility of all localized object in collection saved in the server session.
A list of localized objects visibility informations. Length of the list must equal the number of objects in the localized objects collection.
Returns information about visibility of all localized object in collection saved in the server session.
A list of localized objects visibility informations. Length of the list equals the number of objects in the localized objects collection.
Returns a list of icon MIME formats used in localization functions.
Returns a list of road types.
Calculates a route for a given list of waypoints using given vehicle, driver and road parameters. Calculated route, waypoints and the calculate parameters can be opionally stored in the server session for further processing. Function returns resultant route features.
Indicates whether to really calculate a route or not. If the option is set to False, the function can only store waypoints and other parameters in the session.
Option of returning automatic generated geographical waypoint descriptons.
Option of returning geographic route representation - a list of all points forming a route.
Indicates whether to store given driver parameters in the session replacing present parameters.
Indicates whether to store given vehicle parameters in the session replacing present parameters.
Indicates whether to store given road parameters in the session replacing present parameters.
Indicates whether to store given waypoints in the session replacing present list of waypoints.
Indicates whether to store resultant route in the session for futher processing, i.e. for map presentation or getting route itinerary.
Total duration time of toll route sectors, when value 1 means 1 day, 0.5 means 12 hours and so on.
Geographic route representation - a list of all points forming a route. Returned if option ReturnRouteRepresentation is set to True.
Resultant route itinerary - a list of all route events. Returned if option ReturnRouteItinerary is set to True.
A list of automatic generated geographical waypoint descriptons - information on waypoint nearest city, street or road. Returned if option ReturnRoutePlanEntriesDescription is set to True.
Calculates a route for a given list of waypoints using given vehicle, driver, road and viaTOLL parameters. Calculated route, waypoints and the calculate parameters can be opionally stored in the server session for further processing. Function returns resultant route features.
Indicates whether to really calculate a route or not. If the option is set to False, the function can only store waypoints and other parameters in the session.
Option of returning automatic generated geographical waypoint descriptons.
Option of returning geographic route representation - a list of all points forming a route.
Option of returning resultant viaTOLL results divided into separated road types.
Indicates whether to store given driver parameters in the session replacing present parameters.
Indicates whether to store given vehicle parameters in the session replacing present parameters.
Indicates whether to store given road parameters in the session replacing present parameters.
Indicates whether to store given waypoints in the session replacing present list of waypoints.
Indicates whether to store resultant route in the session for futher processing, i.e. for map presentation or getting route itinerary.
Total duration time of toll route sectors, when value 1 means 1 day, 0.5 means 12 hours and so on.
Geographic route representation - a list of all points forming a route. Returned if option ReturnRouteRepresentation is set to True.
Resultant route itinerary - a list of all route events. Returned if option ReturnRouteItinerary is set to True.
A list of automatic generated geographical waypoint descriptons - information on waypoint nearest city, street or road. Returned if option ReturnRoutePlanEntriesDescription is set to True.
Calculates a route for a given list of waypoints using given vehicle, driver, road, viaTOLL and additional routing parameters. Calculated route, waypoints and the calculate parameters can be opionally stored in the server session for further processing. Function returns resultant route features.
A list of additional routing parameter values. Each parameter may be passed as a pair "ParamName=ParamValue". List of all supported parameters may be obtained by RoutePlannerGetParamValues function.
A list of difficulty providers to be used. The list of supported providers can be get using RouteAttributesGetAttributesProviderList function.
Indicates whether to really calculate a route or not. If the option is set to False, the function can only store waypoints and other parameters in the session.
Option of returning automatic generated geographical waypoint descriptons.
Option of returning geographic route representation - a list of all points forming a route.
Option of returning resultant viaTOLL results divided into separated road types.
Indicates whether to store given driver parameters in the session replacing present parameters.
Indicates whether to store given vehicle parameters in the session replacing present parameters.
Indicates whether to store given road parameters in the session replacing present parameters.
Indicates whether to store given waypoints in the session replacing present list of waypoints.
Indicates whether to store given routing parameters in the session replacing present parameters.
Indicates whether to set given routing difficulty provider list in the session replacing present list.
Indicates whether to store given waypoint properties in the session replacing present properties.
Indicates whether to store resultant route in the session for futher processing, i.e. for map presentation or getting route itinerary.
Total duration time of toll route sectors, when value 1 means 1 day, 0.5 means 12 hours and so on.
Geographic route representation - a list of all points forming a route. Returned if option ReturnRouteRepresentation is set to True.
Resultant route itinerary - a list of all route events. Returned if option ReturnRouteItinerary is set to True.
A list of automatic generated geographical waypoint descriptons - information on waypoint nearest city, street or road. Returned if option ReturnRoutePlanEntriesDescription is set to True.
Calculates an optimal and at most two alternative routes for a given list of waypoints using given vehicle, driver, road, viaTOLL and additional routing parameters, and optionally stores them in route repository. The optimal route, waypoints and the calculate parameters can be opionally stored in the server session for further processing. Function returns resultant route features.
A list of additional routing parameter values. Each parameter may be passed as a pair "ParamName=ParamValue". List of all supported parameters may be obtained by RoutePlannerGetParamValues function.
A list of difficulty providers to be used. The list of supported providers can be get using RouteAttributesGetAttributesProviderList function.
Indicates whether to store first resultant route in the session for futher processing, i.e. for map presentation or getting route itinerary.
Indicates whether to store given driver parameters in the session replacing present parameters.
Indicates whether to store given vehicle parameters in the session replacing present parameters.
Indicates whether to store given road parameters in the session replacing present parameters.
Indicates whether to store given waypoints in the session replacing present list of waypoints.
Indicates whether to store given routing parameters in the session replacing present parameters.
Indicates whether to set given routing difficulty provider list in the session replacing present list.
Indicates whether to store given waypoint properties in the session replacing present properties.
Total duration time for each calculated route, when value 1 means 1 day, 0.5 means 12 hours and so on.
Calculates an optimal and at most two alternative routes for a list of waypoints stored in the server session using vehicle, driver and road parameters stored in the session. If the parameters were not previously saved in the session, then default parameters are used. The function optionally stores calculated routes in route repository. The optimal route, waypoints and the calculate parameters can be opionally stored in the server session for further processing. Function returns resultant route features.
Indicates whether to store first resultant route in the session for futher processing, i.e. for map presentation or getting route itinerary.
Total duration time for each calculated route, when value 1 means 1 day, 0.5 means 12 hours and so on.
Calculates a route for a given list of waypoints using given vehicle, driver and road parameters. Calculated route, waypoints and the calculate parameters can be opionally stored in the server session for further processing. Function returns resultant route features (route representation in binary format).
Indicates whether to really calculate a route or not. If the option is set to False, the function can only store waypoints and other parameters in the session.
Option of returning automatic generated geographical waypoint descriptons.
Option of returning geographic route representation - a list of all points forming a route.
Indicates whether to store given driver parameters in the session replacing present parameters.
Indicates whether to store given vehicle parameters in the session replacing present parameters.
Indicates whether to store given road parameters in the session replacing present parameters.
Indicates whether to store given waypoints in the session replacing present list of waypoints.
Indicates whether to store resultant route in the session for futher processing, i.e. for map presentation or getting route itinerary.
Total duration time of toll route sectors, when value 1 means 1 day, 0.5 means 12 hours and so on.
Geographic route representation - a list of all points forming a route returned in binary format (each point is encoded in 16 bytes, 8 bytes for latitude and 8 bytes for longitude as Intel compatible double real numbers). Returned if option ReturnRouteRepresentation is set to True.
Resultant route itinerary - a list of all route events. Returned if option ReturnRouteItinerary is set to True.
A list of automatic generated geographical waypoint descriptons - information on waypoint nearest city, street or road. Returned if option ReturnRoutePlanEntriesDescription is set to True.
Calculates a route for a given list of waypoints using given vehicle, driver, road and viaTOLL parameters. Calculated route, waypoints and the calculate parameters can be opionally stored in the server session for further processing. Function returns resultant route features (route representation in binary format).
Indicates whether to really calculate a route or not. If the option is set to False, the function can only store waypoints and other parameters in the session.
Option of returning automatic generated geographical waypoint descriptons.
Option of returning geographic route representation - a list of all points forming a route.
Option of returning resultant viaTOLL results divided into separated road types.
Indicates whether to store given driver parameters in the session replacing present parameters.
Indicates whether to store given vehicle parameters in the session replacing present parameters.
Indicates whether to store given road parameters in the session replacing present parameters.
Indicates whether to store given waypoints in the session replacing present list of waypoints.
Indicates whether to store resultant route in the session for futher processing, i.e. for map presentation or getting route itinerary.
Total duration time of toll route sectors, when value 1 means 1 day, 0.5 means 12 hours and so on.
Geographic route representation - a list of all points forming a route returned in binary format (each point is encoded in 16 bytes, 8 bytes for latitude and 8 bytes for longitude as Intel compatible double real numbers). Returned if option ReturnRouteRepresentation is set to True.
Resultant route itinerary - a list of all route events. Returned if option ReturnRouteItinerary is set to True.
A list of automatic generated geographical waypoint descriptons - information on waypoint nearest city, street or road. Returned if option ReturnRoutePlanEntriesDescription is set to True.
Calculates a route for a given list of waypoints using given vehicle, driver, road, viaTOLL and additional routing parameters. Calculated route, waypoints and the calculate parameters can be opionally stored in the server session for further processing. Function returns resultant route features (route representation in binary format).
A list of additional routing parameter values. Each parameter may be passed as a pair "ParamName=ParamValue". List of all supported parameters may be obtained by RoutePlannerGetParamValues function.
A list of difficulty providers to be used. The list of supported providers can be get using RouteAttributesGetAttributesProviderList function.
Indicates whether to really calculate a route or not. If the option is set to False, the function can only store waypoints and other parameters in the session.
Option of returning automatic generated geographical waypoint descriptons.
Option of returning geographic route representation - a list of all points forming a route.
Option of returning resultant viaTOLL results divided into separated road types.
Indicates whether to store given driver parameters in the session replacing present parameters.
Indicates whether to store given vehicle parameters in the session replacing present parameters.
Indicates whether to store given road parameters in the session replacing present parameters.
Indicates whether to store given waypoints in the session replacing present list of waypoints.
Indicates whether to store given routing parameters in the session replacing present parameters.
Indicates whether to set given routing difficulty provider list in the session replacing present list.
Indicates whether to store given waypoint properties in the session replacing present properties.
Indicates whether to store resultant route in the session for futher processing, i.e. for map presentation or getting route itinerary.
Total duration time of toll route sectors, when value 1 means 1 day, 0.5 means 12 hours and so on.
Geographic route representation - a list of all points forming a route returned in binary format (each point is encoded in 16 bytes, 8 bytes for latitude and 8 bytes for longitude as Intel compatible double real numbers). Returned if option ReturnRouteRepresentation is set to True.
Resultant route itinerary - a list of all route events. Returned if option ReturnRouteItinerary is set to True.
A list of automatic generated geographical waypoint descriptons - information on waypoint nearest city, street or road. Returned if option ReturnRoutePlanEntriesDescription is set to True.
Calculates a route for a list of waypoints stored in the server session using vehicle, driver and road parameters stored in the session. If the parameters were not previously saved in the session, then default parameters are used. Calculated route can be opionally stored in the server session for further processing. Function returns resultant route features.
Option of returning user or automatic generated geographical waypoint descriptons.
Option of returning geographic route representation - a list of all points forming a route.
Indicates whether to store resultant route in the session for futher processing, i.e. for map presentation or getting route itinerary.
Total duration time of toll route sectors, when value 1 means 1 day, 0.5 means 12 hours and so on.
Geographic route representation - a list of all points forming a route. Returned if option ReturnRouteRepresentation is set to True.
Resultant route itinerary - a list of all route events. Returned if option ReturnRouteItinerary is set to True.
A list of user or automatic generated geographical waypoint descriptons - information on waypoint nearest city, street or road. Returned if option ReturnRoutePlanEntriesDescription is set to True.
Calculates a route for a list of waypoints stored in the server session using vehicle, driver and road parameters stored in the session. If the parameters were not previously saved in the session, then default parameters are used. Calculated route can be opionally stored in the server session for further processing. Function returns resultant route features (route representation in binary format).
Option of returning user or automatic generated geographical waypoint descriptons.
Option of returning geographic route representation - a list of all points forming a route.
Indicates whether to store resultant route in the session for futher processing, i.e. for map presentation or getting route itinerary.
Total duration time of toll route sectors, when value 1 means 1 day, 0.5 means 12 hours and so on.
Geographic route representation - a list of all points forming a route returned in binary format (each point is encoded in 16 bytes, 8 bytes for latitude and 8 bytes for longitude as Intel compatible double real numbers). Returned if option ReturnRouteRepresentation is set to True.
Resultant route itinerary - a list of all route events. Returned if option ReturnRouteItinerary is set to True.
A list of user or automatic generated geographical waypoint descriptons - information on waypoint nearest city, street or road. Returned if option ReturnRoutePlanEntriesDescription is set to True.
Returns an itinerary for a claculated route stored in the server session.
Returns geographic route representation for a claculated route stored in the server session.
Geographic route representation - a list of all points forming a route.
Returns geographic route representation in binary format for a claculated route stored in the server session.
Returns summary for a claculated route stored in the server session.
Returns viaTOLL summary for a calaculated route stored in the server session.
Returns toll costs for a calaculated route stored in the server session.
Sets waypoint list in the session replacing present list.
A list of visit times for corresponding waypoints. Value 1 means 1 day, 0.5 means 12 hours and so on.
Automatic generated geographical waypoint descriptons - information on waypoint nearest city, street or road.
Sets waypoint list in the session replacing present list. User description for each waypoint can be set.
A list of visit times for corresponding waypoints. Value 1 means 1 day, 0.5 means 12 hours and so on.
Returns waypoint list stored in the session.
A list of visit times for corresponding waypoints. Value 1 means 1 day, 0.5 means 12 hours and so on.
Returns waypoint list stored in the session. Additionally waypoint snap points are returned.
A list of geographic coordinates of waypoint's snap points.
A list of visit times for corresponding waypoints. Value 1 means 1 day, 0.5 means 12 hours and so on.
Appends a new waypoint to a waypoint list stored in the session.
Appends a new waypoint with user description to a waypoint list stored in the session.
Adds new waypoints to waypoint list in the session.
A list of visit times for corresponding waypoints. Value 1 means 1 day, 0.5 means 12 hours and so on.
Automatic generated geographical waypoint descriptons - information on waypoint nearest city, street or road.
Adds new waypoints to waypoint list in the session. User description for each waypoint can be set.
A list of visit times for corresponding waypoints. Value 1 means 1 day, 0.5 means 12 hours and so on.
Inserts a new waypoint at a given position of waypoint list stored in the session.
Index of a target position in the waypoint list. It must be a value between 0 and count, when count may be obtained using RoutePlannerEntriesGetCount function.
Inserts a new waypoint with user description at a given position of waypoint list stored in the session.
Index of a target position in the waypoint list. It must be a value between 0 and count, when count may be obtained using RoutePlannerEntriesGetCount function.
Gets parameters for a given waypoint from waypoint lists stored in the session.
Index of a position in the waypoint list. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.
Sets parameters for a given waypoint from waypoint lists stored in the session.
Index of a position in the waypoint list. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.
Sets parameters and user description for a given waypoint from waypoint lists stored in the session.
Index of a position in the waypoint list. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.
Moves a waypoint from one position in waypoint list stored in the session to another.
Index of current waypoint position in the waypoint list. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.
Index of a target position in the waypoint list. It must be a value between 0 and count, when count-1 may be obtained using RoutePlannerEntriesGetCount function.
Moves many waypoints at given positions in waypoint list stored in the session to another positons beginning with one specified position.
Indices of current waypoint positions in the waypoint list. Each must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.
Index of a target position in the waypoint list for the first of all waypoints to be moved. It must be a value between 0 and count, when count-1 may be obtained using RoutePlannerEntriesGetCount function.
Reverses waypoint list.
Removes waypoint at given position in waypoint list stored in the session.
Index of a position in the waypoint list. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.
Clears a waypoint list stored in the session.
Returns a count of waypoints stored in the session.
Sets waypoints in the session as precise points or with tollerance.
Removes a route last calculated and stored in the session.
Calculates a set of routes beginning with common start point (depot). Each destination point is taken as an end point for subsequent route.
Total duration time for each calculated route, when value 1 means 1 day, 0.5 means 12 hours and so on.
Calculates a set of routes beginning with common start point (depot) and optionally stores them in route repository. Each destination point is taken as an end point for subsequent route.
Total duration time for each calculated route, when value 1 means 1 day, 0.5 means 12 hours and so on.
Calculates a set of routes beginning with given start points (depots). Each destination point is taken as an end point for subsequent route beginning with the nearest start point.
A list of start point numbers choosen for calculated routes (beginning with 0).
Total duration time for each calculated route, when value 1 means 1 day, 0.5 means 12 hours and so on.
Calculates a set of routes beginning with given start points (depots) and optionally stores them in route repository. Each destination point is taken as an end point for subsequent route beginning with the nearest start point.
A list of start point numbers choosen for calculated routes (beginning with 0).
Total duration time for each calculated route, when value 1 means 1 day, 0.5 means 12 hours and so on.
Calculates a set of routes for each given waypoints (from each point as a start point to all others as end points independently)
Total duration time for each calculated route, when value 1 means 1 day, 0.5 means 12 hours and so on.
Calculates distances from a route stored in the server session.
Resultant list of calculated distances (in meters). If calculated distance is greater then MaxLength, it will equal 0.
Recognizes whether given points belong to a buffer formed by a route stored in the server session.
Calculates a route for a given list of waypoints given as a GPS track file using vehicle, driver and road parameters stored in the session. If the parameters were not previously saved in the session, then default parameters are used. Calculated route can be opionally stored in the server session for further processing. Function returns resultant route features.
Option of returning geographic route representation - a list of all points forming a route.
Indicates whether to store resultant route in the session for futher processing, i.e. for map presentation or getting route itinerary.
Geographic route representation - a list of all points forming a route. Returned if option ReturnRouteRepresentation is set to True.
Returns current vehicle parameters stored in the session.
Sets new vehicle parameters in the session replacing present parameters.
Returns current extended vehicle parameters stored in the session.
Sets new extended vehicle parameters in the session replacing present parameters.
Returns current value for additional vehicle parameter stored in the session.
Returns current values for all additional vehicle parameters stored in the session.
Sets a new value for additional vehicle parameter in the session.
Returns current driver parameters stored in the session.
Sets new driver parameters in the session replacing present parameters.
Returns current road parameters stored in the session.
Sets new road parameters in the session replacing present parameters.
Returns current viaTOLL parameters stored in the session.
Sets new viaTOLL parameters in the session replacing present parameters.
Returns a value for given parameter of routing stored in the session. List of all supported parameters may be obtained by RoutePlannerGetParamValues function.
Returns values for all parameters of routing stored in the
session. For color parameters value must be decimal number corresponding to
hexadecimal number 0x00BBGGRR (BB=blue, GG=green, RR=red). Parameter value
meanings:
* routeplanentries.flagstyle - style of waypoint indicators:
-
0 = rectangle without description
- 1 = rectangle with waypoint sequential
number beginning from number 1 for the first waypoint (default)
- 2 =
rectangle with description
- 3 = rectangle with description and waypoint
sequential number beginning from number 1 for the first waypoint
- 4 =
rectangle with "Start", "Via", "Stop" labels
- 5 = rectangle with multiline
description
- 6 = rectangle with multiline description and waypoint
sequential number beginning from number 1 for the first waypoint
- 7 = no
indicators
- 8 = circle
- 9 = circle with waypoint sequential number
beginning from number 1 for the first waypoint
*
routeplanentries.startflagcolor - color of the first waypoint indicator (default
value is green)
* routeplanentries.viaflagcolor - color of via waypoint
indicators (default value is purple)
* routeplanentries.finishflagcolor -
color of the last waypoint indicator (default value is green)
*
routeplanrepresentation.visible - option of route visibility:
- 0 =
disabled
- 1 = enabled (default)
* routeplanrepresentation.color - color
of the route (default value is green)
* routeplanrepresentation.width -
route width in pixels, only for value 1 for routeplanrepresentation.position
parameter (default value is 3)
* routeplanrepresentation.payroadvisible -
option of payed route segments visibility:
- 0 = disabled (default)
- 1
= enabled
* routeplanrepresentation.payroadcolor - color of payed route
segments (default value is red)
* routeplanrepresentation.payroadwidth -
payed route width in pixels, only for value 1 for
routeplanrepresentation.position parameter (default value is 3)
*
routeplanrepresentation.chargeroadvisible - option of charged route segments
visibility:
- 0 = disabled (default)
- 1 = enabled
*
routeplanrepresentation.chargeroadcolor - color of charged route segments
(default value is red)
* routeplanrepresentation.chargeroadwidth - charged
route width in pixels, only for value 1 for routeplanrepresentation.position
parameter (default value is 3)
* routeplanrepresentation.viatollroadvisible
- option of viaTOLL route segments visibility:
- 0 = disabled (default)
- 1 = enabled
* routeplanrepresentation.viatollroadcolor - color of viaTOLL
route segments (default value is red)
*
routeplanrepresentation.viatollroadwidth - viaTOLL route width in pixels, only
for value 1 for routeplanrepresentation.position parameter (default value is
3)
* routeplanrepresentation.position - route placement:
- 0 = under
roads (default)
- 1 = above roads
*
routeplanerparams.addpointtosnaplinetocalculation - distance between waypoint
and nearest road affects route length:
- 0 = disabled (default)
- 1 =
enabled
* routeplanerparams.attachtoroadfromdescription - waypoints are
placed on the named road given in function
RoutePlannerEntryAddWithDescription:
- 0 = disabled (default)
- 1 =
enabled
* routeplanerparams.cleancalculatedrouteondriverparamsmodification -
previously calculated route is removed from session after driver parameter
modification:
- 0 = disabled
- 1 = enabled (default)
*
routeplanerparams.cleancalculatedrouteonentriesmodification - previously
calculated route is removed from session after waypoint list modification:
-
0 = disabled
- 1 = enabled (default)
*
routeplanerparams.cleancalculatedrouteonrouteplanparamsmodification - previously
calculated route is removed from session after route planner parameter
modification:
- 0 = disabled
- 1 = enabled (default)
*
routeplanerparams.cleancalculatedrouteonvehicleparamsentriesmodification -
previously calculated route is removed from session after vehicle parameter
modification:
- 0 = disabled
- 1 = enabled (default)
*
routeplanerparams.hardroadrestrictions - impassable roads are always omitted
(even if target waypoint is set on that road):
- 0 = disabled (default)
- 1 = enabled
* routeplanerparams.snaptoblockedlinks - waypoint snap points
are placed on impassable roads too:
- 0 = disabled
- 1 = enabled
(default)
* routeplanerparams.snaptoferries - waypoints are placed on ferry
lines too:
- 0 = disabled
- 1 = enabled (default)
*
routeplanerparams.softferriesrestrictions - ferry lines are used when is no
other way, even if they are forbidden:
- 0 = disabled
- 1 = enabled
(default)
* routeplanerparams.useonewayrestritions - one-way restrictions
are on:
- 0 = disabled
- 1 = enabled (default)
*
routeplanerparams.useturnrestrictions - turn restrictions are on:
- 0 =
disabled
- 1 = enabled (default)
*
routeplanerparams.usesegmentrestrictions - for future use:
- 0 =
disabled
- 1 = enabled (default)
*
routeplanerparams.usestoredtimewindows - for future use:
- 0 =
disabled(default)
- 1 = enabled
* routeplanerparams.usepayroads -
toll-roads are accepted while routing:
- 0 = enabled (default)
- 1 =
softly disabled - enabled only when there is no other route to the target
waypoint
- 2 = hardly disabled - all payed roads are absolutelly
forbidden
- 3 = setting dervied from
routeattributes.hardblockedroadattributesrestrictions parameter
*
routeplanerparams.useviatollroads - viaTOLL roads are accepted while
routing:
- 0 = enabled (default)
- 1 = softly disabled - enabled only
when there is no other route to the target waypoint
- 2 = hardly disabled -
all viaTOLL roads are absolutelly forbidden
- 3 = setting dervied from
routeattributes.hardblockedroadattributesrestrictions parameter
*
routeplanerparams.usechargeroads - charged roads are accepted while routing:
- 0 = enabled (default)
- 1 = softly disabled - enabled only when there is
no other route to the target waypoint
- 2 = hardly disabled - all charged
roads are absolutelly forbidden
- 3 = setting dervied from
routeattributes.hardblockedroadattributesrestrictions parameter
*
routeplanerparams.useunpavedroads - unpaved roads are accepted while
routing:
- 0 = enabled (default)
- 1 = softly disabled - enabled only
when there is no other route to the target waypoint
- 2 = hardly disabled -
all unpaved roads are absolutelly forbidden
- 3 = setting dervied from
routeattributes.hardblockedroadattributesrestrictions parameter
*
routeplanerparams.usemaxvehicleweight - weight restrictions are on (parameter
takes effect when LogisticsAttributes provider is subscribed):
- 0 =
disabled - all weight restrictions are ignored
- 1 = softly enabled - weight
restrictions are ignored only when there is no other route to the target
waypoint
- 2 = hardly enabled - all weight restrictions are taken
absolutelly into consideration (default)
- 3 = setting dervied from
routeattributes.hardblockedroadattributesrestrictions parameter
*
routeplanerparams.usemaxvehicleweightperaxle - weight per axle restrictions are
on (parameter takes effect when LogisticsAttributes provider is subscribed):
- 0 = disabled - all weight per axle restrictions are ignored
- 1 = softly
enabled - weight per axle restrictions are ignored only when there is no other
route to the target waypoint
- 2 = hardly enabled - all weight per axle
restrictions are taken absolutelly into consideration (default)
- 3 =
setting dervied from routeattributes.hardblockedroadattributesrestrictions
parameter
* routeplanerparams.usemaxvehiclelength - length restrictions are
on (parameter takes effect when LogisticsAttributes provider is subscribed):
- 0 = disabled - all length restrictions are ignored
- 1 = softly enabled -
length restrictions are ignored only when there is no other route to the target
waypoint
- 2 = hardly enabled - all length restrictions are taken
absolutelly into consideration (default)
- 3 = setting dervied from
routeattributes.hardblockedroadattributesrestrictions parameter
*
routeplanerparams.usemaxvehiclewidth - width restrictions are on (parameter
takes effect when LogisticsAttributes provider is subscribed):
- 0 =
disabled - all width restrictions are ignored
- 1 = softly enabled - width
restrictions are ignored only when there is no other route to the target
waypoint
- 2 = hardly enabled - all width restrictions are taken absolutelly
into consideration (default)
- 3 = setting dervied from
routeattributes.hardblockedroadattributesrestrictions parameter
*
routeplanerparams.usemaxvehicleheight - height restrictions are on (parameter
takes effect when LogisticsAttributes provider is subscribed):
- 0 =
disabled - all height restrictions are ignored
- 1 = softly enabled - height
restrictions are ignored only when there is no other route to the target
waypoint
- 2 = hardly enabled - all height restrictions are taken
absolutelly into consideration (default)
- 3 = setting dervied from
routeattributes.hardblockedroadattributesrestrictions parameter
*
routeplanerparams.hazmatgeneralhazardousmaterials - hazardous material
restrictions are on (parameter takes effect when LogisticsAttributes provider is
subscribed):
- 0 = disabled - the restrictions are ignored
- 1 = softly
enabled - the restrictions are ignored only when there is no other route to the
target waypoint
- 2 = hardly enabled - the restrictions are taken
absolutelly into consideration (default)
- 3 = setting dervied from
routeattributes.hardblockedroadattributesrestrictions parameter
*
routeplanerparams.hazmatexplosivematerials - explosive material restrictions are
on (parameter takes effect when LogisticsAttributes provider is subscribed):
- 0 = disabled - the restrictions are ignored
- 1 = softly enabled - the
restrictions are ignored only when there is no other route to the target
waypoint
- 2 = hardly enabled - the restrictions are taken absolutelly into
consideration (default)
- 3 = setting dervied from
routeattributes.hardblockedroadattributesrestrictions parameter
*
routeplanerparams.hazmatgoodsharmfultowater - water harmful material
restrictions are on (parameter takes effect when LogisticsAttributes provider is
subscribed):
- 0 = disabled - the restrictions are ignored
- 1 = softly
enabled - the restrictions are ignored only when there is no other route to the
target waypoint
- 2 = hardly enabled - the restrictions are taken
absolutelly into consideration (default)
- 3 = setting dervied from
routeattributes.hardblockedroadattributesrestrictions parameter
*
routeplanerparams.recalculaterouteonturnrestrictionfail - a route is
recalculated when there is no way to route without turning off restrictions:
- 0 = disabled
- 1 = enabled (default)
*
routeplanerparams.breakmatrixcalculationonfail - route matrix is broken at first
calculation failure:
- 0 = disabled (default)
- 1 = enabled
*
routeplanerparams.raportcrossroads - route itinerary contains crossroads:
-
0 = disabled (default)
- 1 = only crossroad for named streets
- 2 = all
crossroads enabled
* routeplanerparams.defaultdrivethroughviapoints - all
waypoints (except of the first and the last) are used as drive through waypoints
with tollerance:
- 0 = disabled (default)
- 1 = enabled
*
routeplanerparams.defaultdrivethroughradius - drive through waypoint radius
(drive tollerance in meters):
- 0 = precise waypoints
- any positive
value = waypoints with tollerance (default value is 10000 = 10km)
*
routeplanerparams.enableregionalroadsfortracks - all regional roads are allowed
for trucks:
- 0 = disabled (default)
- 1 = enabled
*
routeplanerparams.routereportformat - for future use
*
routeoptimizerparams.calcinterpointlengths - route optimizer calculates full
routes between waypoints:
- 0 = disabled (default)
- 1 = enabled
*
routeoptimizerparams.routeoptimizecalculatetype - type of route calculating
while optimization (parameter takes effect when option
routeoptimizerparams.calcinterpointlengths is enabled):
- 0 = shortest
route
- 1 = quickest route (default)
- 2 = cheapest route
*
routeoptimizerparams.planninghorizon - maximal duration of a route planning (in
days, default value is 10)
* routeoptimizerparams.maxrouteduration - maximal
duration of a single route (in minutes, default value is 540 = 9 hours)
*
routeoptimizerparams.maxwaitingtime - maximal time of waiting at a single route
point (in minutes, default value is 120 = 2 hours)
*
routeoptimizerparams.maxcumuldrivingbeforeshortbreak - maximal duration of a
contigous driving without a break (in minutes, default value is 270 = 4.5
hours)
* routeoptimizerparams.drivetimemargin - maximal tollerance time at a
single route point (in minutes, default value is 2)
*
routeoptimizerparams.drivetimemarginpercent - maximal tollerance at a single
route point (in percents, default value is 5)
*
routeoptimizerparams.loadingtimemargin - maximal tollerance for shipment loading
time at a single route point (in minutes, default value is 2)
*
routeoptimizerparams.loadingtimemarginpercent - maximal tollerance for shipment
loading at a single route point (in percents, default value is 5)
*
routeoptimizerparams.unloadingtimemargin - maximal tollerance for shipment
unloading time at a single route point (in minutes, default value is 2)
*
routeoptimizerparams.unloadingtimemarginpercent - maximal tollerance for
shipment unloading at a single route point (in percents, default value is 5)
* routeoptimizerparams.separatediffrentpoints - assumption of non-zero distance
between two equivalent route points:
- 0 = disabled
- 1 = enabled
(default)
* routeattributes.hardblockedroadattributesrestrictions -
impassable traffic difficulties are always omitted (even if the target waypoint
is set within the difficulty):
- 0 = disabled (default) - all difficulty
parameters are ignored when routing to the target waypoint
- 1 = enabled -
all difficulty parameters are taken absolutelly into consideration
- 2 =
enabled - all difficulty parameters except of Closed parameter are taken
absolutelly into consideration, but Closed is ignored when routing to the target
waypoint
* routeattributes.allowentertoblockedzone - impassable difficulties
being zones blocked for routing are ignored when the target waypoint is set in
such zone:
- 0 = disabled (default)
- 1 = enabled
*
routeattributes.collectrouteattributes - routing difficulties are collected for
analyze purposes:
- 0 = disabled (default)
- 1 = enabled
*
routeattributes.showblockedattributes - routing difficulties which have
influenced on the last calculated route are drawn on maps as red bubbles:
-
0 = disabled (default)
- 1 = enabled
*
routeattributes.showvisitedattributes - routing difficulties which were taken
into account but haven't influenced on the last calculated route are drawn on
maps as green bubbles:
- 0 = disabled (default)
- 1 = enabled
*
routeattributes.maxaltitudeforattributes - maximal altitude for bubbles drawn
after setting up routeattributes.showblockedattributes or
routeattributes.showvisitedattributes (default value 0 means no limit)
*
routeattributes.speedprofilestype - for future use
*
logistictollattributes.currentcurrency - current currency 3-letter international
abbreviation (default value is PLN)
*
logistictollattributes.preferedvinettespandays - vinette time perdiod for
vinette road (in days, default value is 7-14)
*
logistictollattributes.defaultaxles - default number of axles for vehicles
(default value is 2)
* logistictollattributes.defaultemission - default
emission standard for vehicles (default value is 5)
*
logistictollattributes.defaulthasdpf - vehicles are supported with the DPF
filter:
- 0 = disabled
- 1 = enabled (default)
*
logistictollattributes.notaxcosts - costs are returned without the tax:
- 0
= disabled (default)
- 1 = enabled
Sets a value for given parameter of routing stored in the session. List of all supported parameters may be obtained by RoutePlannerGetParamValues function.
Loads current route from binary representation.
Stores current route to binary representation.
Loads current route from database.
Stores current route to database.
Clears the route repository.
Returns the count of routes stored int the repository.
Returns all routes stored in the repository.
Adds a new (last calculated) route to the repository.
Adds a new (last calculated) identified route to the repository.
Raplaces existing route in the route repository with the last calculated.
Index of a route. It must be a value between 0 and count-1, when count may be obtained using RouteRepositoryGetRoutesCount function.
Raplaces existing route in the route repository with the last calculated.
Fetches existing route from the repository. It becomes current session route.
Index of a route. It must be a value between 0 and count-1, when count may be obtained using RouteRepositoryGetRoutesCount function.
Fetches existing route from the repository. It becomes current session route.
Removes existing route from the repository.
Index of a route. It must be a value between 0 and count-1, when count may be obtained using RouteRepositoryGetRoutesCount function.
Removes existing route from the repository.
Sets color for route existing in the repository.
Index of a route. It must be a value between 0 and count-1, when count may be obtained using RouteRepositoryGetRoutesCount function.
Sets color for route existing in the repository.
Enables/disables visibility on maps of route existing in the respository.
Index of a route. It must be a value between 0 and count-1, when count may be obtained using RouteRepositoryGetRoutesCount function.
Enables/disables visibility on maps of route existing in the respository.
Sets description for route existing in the repository.
Index of a route. It must be a value between 0 and count-1, when count may be obtained using RouteRepositoryGetRoutesCount function.
Sets description for route existing in the repository.
Returns itinerary for route existing in the repository.
Index of a route. It must be a value between 0 and count-1, when count may be obtained using RouteRepositoryGetRoutesCount function.
Returns itinerary for route existing in the repository.
Returns geographic route representation for route existing in the repository.
Index of a route. It must be a value between 0 and count-1, when count may be obtained using RouteRepositoryGetRoutesCount function.
Geographic route representation - a list of all points forming a route.
Returns geographic route representation for route existing in the repository.
Geographic route representation - a list of all points forming a route.
Returns summary for route existing in the repository.
Index of a route. It must be a value between 0 and count-1, when count may be obtained using RouteRepositoryGetRoutesCount function.
Returns summary for route existing in the repository.
Loads route repository from binary representation.
Stores route repository to binary representation.
Calculates distances from a routes stored in the server session's repository.
Resultant matrix of calculated distances (in meters) - for each route and for each point. If calculated distance is greater then MaxLength, it will equal 0.
Removes all routing difficulties stored in the session.
Adds new point routing difficulty to the session.
Option of auto-generating difficulty unique identifier. If set to true, identifier given in difficulty properties will be ignored.
Adds new polyline routing difficulty to the session.
Option of auto-generating difficulty unique identifier. If set to true, identifier given in difficulty properties will be ignored.
Adds new polygonal routing difficulty to the session.
Option of auto-generating difficulty unique identifier. If set to true, identifier given in difficulty properties will be ignored.
Adds new polyline road-along placed routing difficulty to the session. Polyline coordinates will be generated automatically between given start and finish points.
Option of auto-generating difficulty unique identifier. If set to true, identifier given in difficulty properties will be ignored.
All points of generated polyline (if ReturnRepresentation option was set to true).
Modifies geographic properties of point routing difficulty identified by given identifier.
Modifies geographic properties of polyline routing difficulty identified by given identifier.
Modifies geographic properties of polygonal routing difficulty identified by given identifier.
Modifies geographic properties of polyline road-along placed routing difficulty identified by given identifier.
All points of generated polyline (if ReturnRepresentation option was set to true).
Modifies properties of routing difficulty identified by given identifier.
Removes routing difficulty identified by given identifier.
Returns properties of routing difficulty identified by given identifier.
Returns properties of routing difficulty identified by given identifier together with its gegraphic coordinates.
Difficulty geometry kind:
- point = 0x00
-
road-along placed polyline = 0x01
- polyline = 0x02
- polygon = 0x03
- none = 0x04
A list of all difficulty points (number of point is dependent on difficulty geometry kind).
Returns all routing difficulties stored in the session.
Loads routing difficulties from binary representation.
Stores all routing difficulties to binary representation.
Returns a list of supported routing difficulty providers.
Returns a list of currently subscribed routing difficulty providers.
Subcribes to one of supported routing difficulty providers.
Provider name. The list of supported providers can be get using RouteAttributesGetAttributesProviderList function.
Unsubcribes from one of subscribed routing difficulty providers.
Provider name. The list of currently subscribed providers can be get using RouteAttributesGetSubscribedProvidersList function.
Returns all parameter names and values for given routing difficulty provider.
Provider name. The list of supported providers can be get using RouteAttributesGetAttributesProviderList function.
Sets a value for given parameter of routing difficulty provider.
Provider name. The list of supported providers can be get using RouteAttributesGetAttributesProviderList function.
Parameter name. The list of supported parameters can be get using RouteAttributesGetDataProviderParams function.
Returns all actions supported for given routing difficulty provider.
Provider name. The list of currently subscribed providers can be get using RouteAttributesGetSubscribedProvidersList function.
Executes one of the action supported for given routing difficulty provider.
Provider name. The list of currently subscribed providers can be get using RouteAttributesGetSubscribedProvidersList function.
Action name. The list of currently supported actions can be get using RouteAttributesGetDataProviderActions function.
Retrieves a list of routing difficulties used while the last route calculation (if routeattributes.collectrouteattributes option is on).
List of the difficulties which were taken into account but haven't influenced on the last calculated route.
List of the difficulties which have influenced on the last calculated route.
Optimizes a route in way of reordering a sequence of waypoints using given vehicle, driver and road parameters. Calculated route (if it really was calculated), waypoints and the calculate parameters can be opionally stored in the server session for further processing. Function returns new waypoint order and resultant route features.
Route optimization type:
- from start to end = 0x00
- from start to best end = 0x01
- from best start to end = 0x02
- from
best start to best end = 0x03
- cycle on all points =
0x04
Indicates whether to really calculate a route or not. If the option is set to False, the function can only store waypoints and other parameters in the session.
Option of returning automatic generated geographical waypoint descriptons.
Option of returning geographic route representation - a list of all points forming a route.
Indicates whether to store given driver parameters in the session replacing present parameters.
Indicates whether to store given vehicle parameters in the session replacing present parameters.
Indicates whether to store given road parameters in the session replacing present parameters.
Indicates whether to store given waypoints in the session replacing present list of waypoints.
Indicates whether to store resultant route in the session for futher processing, i.e. for map presentation or getting route itinerary.
Properties of the waypoint entries after optimization process.
Total duration time of toll route sectors, when value 1 means 1 day, 0.5 means 12 hours and so on.
Geographic route representation - a list of all points forming a route. Returned if option ReturnRouteRepresentation is set to True.
Resultant route itinerary - a list of all route events. Returned if option ReturnRouteItinerary is set to True.
A list of automatic generated geographical waypoint descriptons - information on waypoint nearest city, street or road. Returned if option ReturnRoutePlanEntriesDescription is set to True.
Optimizes a route in way of reordering a sequence of waypoints using vehicle, driver and road parameters stored in the session. If the parameters were not previously saved in the session, then default parameters are used. Calculated route (if it really was calculated) can be opionally stored in the server session for further processing. Function returns new waypoint order and resultant route features.
Route optimization type:
- from start to end = 0x00
- from start to best end = 0x01
- from best start to end = 0x02
- from
best start to best end = 0x03
- cycle on all points =
0x04
Indicates whether to really calculate a route or not. If the option is set to False, the function can only store waypoints and other parameters in the session.
Indicates whether to store new waypoint order in the session replacing present list of waypoints.
Option of returning user or automatic generated geographical waypoint descriptons.
Option of returning geographic route representation - a list of all points forming a route.
Indicates whether to store resultant route in the session for futher processing, i.e. for map presentation or getting route itinerary.
Properties of the waypoint entries after optimization process.
Total duration time of toll route sectors, when value 1 means 1 day, 0.5 means 12 hours and so on.
Geographic route representation - a list of all points forming a route. Returned if option ReturnRouteRepresentation is set to True.
Resultant route itinerary - a list of all route events. Returned if option ReturnRouteItinerary is set to True.
A list of user or automatic generated geographical waypoint descriptons - information on waypoint nearest city, street or road. Returned if option ReturnRoutePlanEntriesDescription is set to True.
Defines within the server session a new shipment type which is identified by an arbitrary name.
Deletes one of defined shipment types.
Returns a list of currently defined shipment types.
Sets for the server session a new set of shipment types replacing existing one, if present.
Removes all shipment types defined in the server session.
Marks one of the waypoints defined in the server session as a depot.
Index of the waypoint . It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.
Gets the index of currently set depot waypoint.
Index of the depot waypoint. It is a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.
Returns a list of all time windows defined for a waypoint.
Index of the waypoint. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.
Deletes all time windows defined for a waypoint.
Index of the waypoint. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.
Adds a new time window for a waypoint.
Index of the waypoint. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.
Adds a list of time windows for a waypoint.
Index of the waypoint. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.
Sets a new set of time windows for a waypoint.
Index of the waypoint. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.
Returns a list of all delivery shipments defined for a waypoint.
Index of the waypoint. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.
Adds a new delivery shipment for a waypoint.
Index of the waypoint. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.
Adds a list of delivery shipments for a waypoint.
Index of the waypoint. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.
Deletes all delivery shipments defined for a waypoint.
Index of the waypoint. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.
Sets a new set of delivery shipments for a waypoint.
Index of the waypoint. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.
Returns a list of all pickup shipments defined for a waypoint. For future use.
Index of the waypoint. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.
Adds a new pickup shipment for a waypoint. For future use.
Index of the waypoint. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.
Adds a list of pickup shipments for a waypoint. For future use.
Index of the waypoint. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.
Deletes all pickup shipments defined for a waypoint. For future use.
Index of the waypoint. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.
Sets a new set of pickup shipments for a waypoint. For future use.
Index of the waypoint. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.
Returns delivery and pickup times defined for a waypoint.
Index of the waypoint. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.
Sets new delivery and pickup times for a waypoint.
Index of the waypoint. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.
Deletes entire list of incompatibilities between vehicle categories and shipment types.
Adds a new entry to the list of incompatibilities between vehicle categories and shipment types defined in the server session.
Vehicle category. The list of currently defined categories may be obtained using VehicleRepositoryVehiclesGet function.
Shipment type. The list of currently defined shipment types may be obtained using RouteOptimizerShipmentTypesGet function.
Returns a list of all incompatibilities between vehicle categories and shipment types defined in the server session.
Resultant list of incompatibility pairs.
Sets a new set of incompatibilities between vehicle categories and shipment types.
A list of incompatibility pairs.
Deletes entire list of incompatibilities between some two shipment types.
Adds a new entry to the list of incompatibilities between some two shipment types defined in the server session.
First shipment type. The list of currently defined shipment types may be obtained using RouteOptimizerShipmentTypesGet function.
Second shipment type. The list of currently defined shipment types may be obtained using RouteOptimizerShipmentTypesGet function.
Returns a list of all incompatibilities between some shipment types defined in the server session.
Resultant list of incompatibility pairs.
Sets a new set of incompatibilities between shipment types.
A list of incompatibility pairs.
Optimizes a shipment task for shipments defined for route waypoints returning a set of routes for vehicle categories stored in the server session.
A list of all resultant delivery shipment actions.
Defines a new vehicle within the server session's vehicle repository.
Deletes one of the vehicles stored in the session's vehicle repository.
Index of vehicle in the repository. It must be a value between 0 and count-1, when count is the number of vehicles.
Returns parameters of one of the vehicles stored in the session's vehicle repository.
Index of vehicle in the repository. It must be a value between 0 and count-1, when count is the number of vehicles.
Sets new vehicle parameters in the session's vehicle repository replacing present parameters.
Index of vehicle in the repository. It must be a value between 0 and count-1, when count is the number of vehicles.
Returns current road parameters of one of the vehicles stored in the session's vehicle repository.
Index of vehicle in the repository. It must be a value between 0 and count-1, when count is the number of vehicles.
Sets new road parameters for given vehicle stored in the repository replacing present parameters.
Index of vehicle in the repository. It must be a value between 0 and count-1, when count is the number of vehicles.
Returns current viaTOLL parameters of one of the vehicles stored in the session's vehicle repository.
Index of vehicle in the repository. It must be a value between 0 and count-1, when count is the number of vehicles.
Sets new viaTOLL parameters for given vehicle stored in the repository replacing present parameters.
Index of vehicle in the repository. It must be a value between 0 and count-1, when count is the number of vehicles.
Returns current driver parameters of one of the vehicles stored in the session's vehicle repository.
Index of vehicle in the repository. It must be a value between 0 and count-1, when count is the number of vehicles.
Sets new driver parameters for given vehicle stored in the repository replacing present parameters.
Index of vehicle in the repository. It must be a value between 0 and count-1, when count is the number of vehicles.
Fetches existing vehicle with all its parameters from the repository. The vehicle and its road parameters become current session parameters for routing.
Index of vehicle in the repository. It must be a value between 0 and count-1, when count is the number of vehicles.
Raplaces all parameters of one of the vehicle in the repository with current vehicle and road parameters stored in the session.
Index of vehicle in the repository. It must be a value between 0 and count-1, when count is the number of vehicles.
Returns a list of all vehicles stored in the session's vehicle repository.
Sets a new set of vehicles in the vehicle repository.
Deletes all vehicles stored in the session's vehicle repository.
Returns a value for given parameter of searching stored in the session. List of all supported parameters may be obtained by SearchGetParamValues function.
Returns values for all parameters of searching stored in the
session. Parameter value meanings:
* geocodeparams.firststreetwordpriority -
street word priority:
- 0 = last word priority (default)
- 1 = first
word priority
* geocodeparams.filteroutelems - a list of element kinds to be
filtered out while geocoding (by default the list is empty). The list of
available kinds can be obtained by SearchGetItemKindList
function.
* geocodeparams.attachnumerationtostreet - the coordinates of
numeration points are attached to streets:
- 0 = disabled (default)
- 1
= enabled
Sets a value for given parameter of searching stored in the session. List of all supported parameters may be obtained by SearchGetParamValues function.
A geographic point based on the WGS84 coordinate system (datum).
A geographic rectangle described with two geographic points.
A font parameters.
Array of TRect items.
Array of TLongLatRect items.
Array of WideString items.
Array of TLongLatPoint items.
Array of TLongLatPointArray items.
Array of TPoint items.
Array of TCaptionPosition items.
Geographic data of an object.
Status of object geographic position obtained while
geocoding process (geocode level). The geocode level is a bit vector - each bit
deals with one address item:
- country = 0x01
- 2nd level administrative
area (county) = 0x02
- 3rd level administrative area (district) = 0x04
-
city = 0x08
- postal code = 0x10
- street = 0x20
- building
numeration = 0x40
- manually geocoded = 0x80
If an address item was
taken into account while geocoding process, its bit is set to 1. If an address
was not geocoded, the geocode level for it has value 0 (all bits set to
0).
Array of TObjectPosition items.
Array of Boolean items.
Array of Byte items.
Icon properties.
Format of the icon. Supported formats can be received using GetAvailableIconFormats function.
Array of TIconProperties items.
Visual settings of an object group.
Index of icon assigned to the object group. Value 0 means the group has no icon assigned - its icon is dynamically drawn. Otherwise, the index must be one of icon indices returned by GetGroupIcons function.
Radius (in pixels) of dynamically drawn object icon. It must be a positive value. The value is essential only when IconIndex equals 0.
If this option is set to False , dynamically drawn object icon is transparent, otherwise no. The value is essential only when IconIndex equals 0.
The color of the icon. It must be a value in 0x00BBGGRR format (BB=blue, GG=green, RR=red). The value is essential only when IconIndex equals 0.
Width (in pixels) of the icon border. It must be a nonnegative value. The value is essential only when IconIndex equals 0.
The color of the icon border. It must be a value in 0x00BBGGRR format (BB=blue, GG=green, RR=red). The value is essential only when IconIndex equals 0.
Minimum zoom of object icon visibility being an altitude expressed in meters over sea level. It must be positive value.
Maximum zoom of object icon visibility being an altitude expressed in meters over sea level. It must be positive value.
Visual shape settings of an object group.
The color of shape interiors. It must be a value in 0x00BBGGRR format (BB=blue, GG=green, RR=red).
The color of shape borders. It must be a value in 0x00BBGGRR format (BB=blue, GG=green, RR=red).
Array of Integer items.
Array of BLOB items.
An information concerning a map element being a result of degeocoding.
Geographic information concerning a point on map.
Array of TDegeocodeResult items.
An information concerning a city being a result of degeocoding.
Array of TDegeocodeCityElementResult items.
An information concerning a road being a result of degeocoding.
This value is set to true if the road is one-direction road. Otherwise it is set to false.
Array of TDegeocodeRoadElementResult items.
An information concerning an element being a result of extended degeocoding.
Array of TDegeocodeExResultEntry items.
An information concerning a map element being a result of degeocoding.
Array of TDegeocodeAtPointResult items.
An information concerning a non map object being a result of degeocoding.
The category of the object found:
- Objects - MapBase
objects
- Logistics - logistic objects from MapBase, i.e. traffic
difficulties
- Localize - licalization objects
- CalculatedRoute -
points of route representation
- RoutePlannerEntries - route waypoints
-
TrafficInformation - traffic difficulties stored in the session or subscribed
from difficulty providers
Array of TDegeocodeAtPointDatabaseResult items.
Address information.
Array of TGeocodePointInfo items.
Extended address information. City, street and administrative abbreviations (terminated with dot) are permitted.
Array of TGeocodePointInfoEx items.
Extended address information. City, street and administrative abbreviations (terminated with dot) are permitted.
An index within the array of geocoded addresses which the entry is for, beginning with 0 for the first address.
A list of resultant geocode levels for proposals found. The
geocode level is a bit vector - each bit deals with one address item:
-
country = 0x01
- 2nd level administrative area (county) = 0x02
- 3rd
level administrative area (district) = 0x04
- city = 0x08
- postal code
= 0x10
- street = 0x20
- building numeration = 0x40
- 4rd level
administrative area (commune) = 0x80
If an address item was taken into
account while geocoding process, its bit is set to 1. If an address was not
geocoded, the geocode level for it has value 0 (all bits set to
0).
Array of TMultiGeocodePointInfoEx items.
Array of Byte items.
Parameters used while tiled map image creation.
Parameters used while map image creation.
Array of Double items.
Properties of map file loaded by server.
Array of TMapFileEntry items.
Array of TFloatArray items.
Array of TWideStringArray items.
Array of TBooleanArray items.
Properties of a localized object position.
The position description, displayed next to the position of an object on the map when the ShowDescription option is active. If the ShowIcon option is active, the description is displayed under the icon.
Information on whether to display the description of the position of the object on the map.
Information on whether to display the name of the object next to the position of the object on the map, unless the ShowName option is deactivated directly for the localized object (concerns only the last object position).
Information on whether to display the icon in the given position of the object on the map, unless the ShowIcon option is deactivated directly for the localized object (concerns only the last object position).
Array of TLocalizeObjectPositionData items.
Properties of a server session.
Time of session creation. Time (in the GMT time zone) is number of days since 30-12-1899 12:00 AM.
Array of TSessionEnumEntry items.
Properties of view config file loaded by server.
Array of TViewConfigEntry items.
Properties of route stored in the route repository.
Array of TRepositoryRoute items.
Properties of routing difficulty.
A list of vehicle types the difficulty concerns. The vehicle
filter is a bit vector - each bit deals with one vehicle type:
- Passenger
car = 0x01
- Transport truck = 0x02
- Motorcycle = 0x04
- Pedestrian
= 0x08
- Bicycle = 0x10
- Delivery truck = 0x20
- Residental vehicle
= 0x40
- Taxi = 0x80
- Public bus = 0x100
- Straight truck =
0x200
- Non-standard vehicle = 0x400
Time of passing through the difficulty, when value 1 means 1 day, 0.5 means 12 hours and so on.
Time (in the GMT time zone) of the difficulty binding start (number of days since 30-12-1899 12:00 AM).
Time (in the GMT time zone) of the difficulty binding stop (number of days since 30-12-1899 12:00 AM).
Array of TRouteAttributeParams items.
Properties of the routing difficulty collected while route calculation analyzing.
Array of TRouteAttributePassedElem items.
Waypoint properties.
Index of a position in the waypoint list. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.
Array of TDriveThrough items.
Properties of the time window definiton.
Array of TTimeWindow items.
Properties of the shipment definition.
Shipment type. The list of currently defined shipment types may be obtained using RouteOptimizerShipmentTypesGet function.
Array of TShipment items.
Properties of the waypoint entry for route optimization purposes.
Original waypoint index before optimization process. The first waypoint has index 0, second has index 1 and so on.
Array of TRouteOptimalizationEntry items.
Properties of the optimized route.
Array of TRouteOptimizerResultRoutesEntry items.
Properties of the optimized route segment.
Array of TRouteOptimizerEntry2 items.
Properties of a single shipment action.
Array of TRouteOptimizerEntryAction2 items.
Properties of the optimizer shipment event.
Index of the route within the list of optimized routes, beginning with 0 for the first route.
Array of TRouteOptimizerShipmentMove items.
Properties of the optimized route segment.
Array of TRouteOptimizerEntry items.
Properties of a single shipment action.
Index of the optimizer entry (route segment) to perform the action, being an index of one of the item in resultant array of type TRouteOptimizerEntryArray, beginning with 0 for the first entry.
Array of TRouteOptimizerShipmentAction items.
Route itinerary entry parameters.
Event type:
- Other action = 0x00
- Depart from a
waypoint = 0x1
- Arrive at a waypoint = 0x02
- Turn left = 0x03
-
Turn right = 0x04
- Bear left = 0x05
- Bear right = 0x6
- Merge onto
a highway or motorway, or limited-access road = 0x07
- Continue traveling in
the same direction as in the previous instruction = 0x08
- Turn back to
travel in the opposite direction as the previous direction = 0x09
- Take a
roundabout = 0x0A
- A warning indicating that delays can be expected because
of construction = 0x0B
- A warning indicating that stops or road closures
can be expected because of road construction = 0x0C
- A warning indicating
that the name of the road changes = 0x0D
- Turn or bear left, and then
immediately turn or bear left = 0x0E
- Turn or bear left, and then
immediately turn or bear right = 0x0F
- Turn or bear right, and then
immediately turn or bear left = 0x10
- Turn or bear right, and then
immediately turn or bear right = 0x11
- Take a ramp = 0x12
- Take a ramp
to the left = 0x13
- Take a ramp to the right = 0x14
- Continue straight
when faced with multiple options = 0x15
- Stay to the left when faced with
multiple options = 0x16
- Stay to the right when faced with multiple options
= 0x17
- Border crossing = 0x18
- Beginning of journey day = 0x19
-
End of journey day = 0x1A
- Toll-road gate = 0x1B
- Beginning of
toll-road = 0x1C
- End of toll-road = 0x1D
- Beginning of driver rest
time = 0x1E
- End of driver rest time = 0x1F
- Beginning of ferry travel
= 0x20
- End of ferry travel = 0x21
- Refuel needed = 0x22
-
Beginning of charged road = 0x23
- End of charged road = 0x24
-
Beginning of viaTOLL road = 0x25
- End of viaTOLL road =
0x26
Main description of event. In case of events concerning road name changes (0x03, 0x04, 0x05, 0x06, 0x07, 0x0A, 0x0D, 0x0E, 0x0F, 0x10, 0x11) it contains current road name. For waypoint events (0x01, 0x02) it is waypoint number (the first waypoint has number 1, second has number 2 and so on) and for day change events (0x19, 0x1A) - number of journey day.
Array of TRouteItinerary items.
Vehicle parameters.
Vehicle type:
- Passenger car = 0x00
- Transport
truck = 0x01
- Motorcycle = 0x02
- Pedestrian = 0x03
- Bicycle =
0x04
- Delivery truck = 0x05
- Residental vehicle = 0x06
- Taxi =
0x07
- Public bus = 0x08
- Straight truck = 0x09
- Non-standard
vehicle = 0x0A
Cost of 1 kilometer long route sector passed by the vehicle. It must be nonnegative float value.
Driver parameters.
Road parameters.
Array of TRoadParams items.
viaTOLL parameters.
Array of TRoadViaTollParams items.
Summaric route results taking into account roads of one given type.
Array of TRoadResults items.
Summaric viaTOLL results taking into account roads of one given type.
Array of TViaTollRoadResults items.
Summaric cost results of toll roads for the given country.
Array of TLogisticTOLLResults items.
Vehicle parameters - TVehicleParams extended with name, external type, count of vehicles and weight per axle.
Vehicle type:
- Passenger car = 0x00
- Transport
truck = 0x01
- Motorcycle = 0x02
- Pedestrian = 0x03
- Bicycle =
0x04
- Delivery truck = 0x05
- Residental vehicle = 0x06
- Taxi =
0x07
- Public bus = 0x08
- Straight truck = 0x09
- Non-standard
vehicle = 0x0A
Cost of 1 kilometer long route sector passed by the vehicle. It must be nonnegative float value.
Cost of 1 hour route duration passed by the vehicle. It must be nonnegative float value.
Vehicle load type. It is a bit vector - each bit deals with
one type:
- General hazardous materials = 0x01
- Explosive materials =
0x02
- Goods harmful to water = 0x04
Beginning time of the vehicle availability, when value 1/24 means 01:00 a.m, 2/24 means 02:00 a.m. and so on.
Ending time of the vehicle availability, when value 1/24 means 01:00 a.m, 2/24 means 02:00 a.m. and so on.
Maximal duration of a contigous driving without a break (in minutes).
Index of the starting waypoint for the vehicle. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function. For future use.
Index of the finishing waypoint for the vehicle. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function. For future use.
Array of TVehicleEntry items.
A pair of vehilce category and shipment type.
Array of TVehicleCategoryToShipmentTypeIncompatibility items.
A pair of shipment types.
Array of TShipmentTypeToShipmentTypeIncompatibility items.
FunctionUnimplemented
Category: Standard errors
Code: -2
SessionNotFound
Category: Standard errors
Code: -3
NonauthorizedAccess
Category: Standard errors
Code: -4
NotEnoughPermission
Category: Standard errors
Code: -5
SessionLimitExceeded
Category: Standard errors
Code: -10
UserSessionLimitExceeded
Category: Standard errors
Code: -11
ReferentialIntegrityError
Category: Data errors
Code: -6
UpdateRequired
Category: Data errors
Code: -9
DatabaseBlocked
Category: Data errors
Code: -12
GeneralSearchError
Category: Search errors
Code: -100
InvalidCountryIndex
Category: Search errors
Code: -101
InvalidCityIndex
Category: Search errors
Code: -102
InvalidCityCount
Category: Search errors
Code: -103
InvalidItemKindIndex
Category: Search errors
Code: -104
InvalidItemCount
Category: Search errors
Code: -105
InvalidItemIndex
Category: Search errors
Code: -106
StreetRequired
Category: Search errors
Code: -107
SearchContextNotInitialized
Category: Search errors
Code: -108
InvalidItemHandle
Category: Search errors
Code: -109
NumerationNotFound
Category: Search errors
Code: -110
GeneralLocalizeError
Category: Localize errors
Code: -200
InvalidLocalizeDataIndex
Category: Localize errors
Code: -201
InvalidLocalizeEntityID
Category: Localize errors
Code: -203
InvalidNumericFieldsCount
Category: Localize errors
Code: -204
InvalidStringFieldsCount
Category: Localize errors
Code: -205
DuplicatedLocalizeEntityID
Category: Localize errors
Code: -206
InvalidIconMIMEType
Category: Localize errors
Code: -207
InvalidItemsCount
Category: Localize errors
Code: -208
InvalidIconData
Category: Localize errors
Code: -209
GeneralMapFileError
Category: Map file errors
Code: -300
MapFileAlreadyOpened
Category: Map file errors
Code: -302
MapFileAlreadyClosed
Category: Map file errors
Code: -303
GeneralRenderingError
Category: Rendering errors
Code: -400
InvalidImageMIMEType
Category: Rendering errors
Code: -403
GeneralAuthorizationError
Category: Authorization errors
Code: -500
UserGroupAlreadyExists
Category: Authorization errors
Code: -503
UserGroupReadOnly
Category: Authorization errors
Code: -505
GeneralRoutePlannerError
Category: RoutePlanner errors
Code: -600
InvalidEntryIndex
Category: RoutePlanner errors
Code: -603
RouteNotFound
Category: RoutePlanner errors
Code: -605
DuplicatedEntryIndex
Category: RoutePlanner errors
Code: -606
RouteNotCalculated
Category: RoutePlanner errors
Code: -607
RouteIdentifierNotFound
Category: RoutePlanner errors
Code: -608
DuplicatedRoutingDifficultyIdentifier
Category: RoutePlanner errors
Code: -630
RoutingDifficultyIdentifierNotFound
Category: RoutePlanner errors
Code: -631
VehicleCategoryAlreadyExists
Category: RouteOptimizer errors
Code: -660
DepotEntryNotSet
Category: RouteOptimizer errors
Code: -661
DuplicatedShipmentIdentifier
Category: RouteOptimizer errors
Code: -662
Creates a new server session.