Route Planning

Route planning library. More...

Modules
	Route Planning
	Route planning components.
	Route Monitoring
	Route monitoring components.

Data Structures
class	IRouteExtensionProperties
	Extension properties interface. It can be implemented by Route, RouteLeg, Waypoint and EvenMark. More...
class	IRouteLeg
	Route leg interface. More...
class	IRouteLegEdit
	Route leg edit interface. More...
class	IWaypoint
	Route way point interface. More...
class	IFoundElementInfo
	Route found element info interface. More...
class	IFoundElementInfoEnum
	Route found elements enumeration interface. More...
class	IRoute
	Route interface. More...
class	IRoutePortrayalProperty
	Route portrayal property interface. More...
class	IRouteEditorStateStack
	Route editor state stack interface. More...
class	IRouteEditor
	Route editor interface. More...
class	IRouteStorage
	Route storage interface. More...
class	IRouteUtil
	Route utility interface. More...
class	IRouteEditorInternal
	Intended for the fast loading to the route editor. More...

Enumerations
enum	RouteCalculatorParametersEnum
	Route calculator parameters.
enum	RouteElementType {   kRouteElementType_None = 0x0, kRouteElementType_Waypoint = 0x1, kRouteElementType_Leg = 0x2, kRouteElementType_EventMark = 0x4,   kRouteElementType_ParallelIndexLine = 0x8, kRouteElementType_PositionReference = 0x10 , kRouteElementType_LegWithCurve = kRouteElementType_Leg | kRouteElementType_LegCurve, kRouteElementType_All = 0xF }
	Route element type mask. More...
enum	RoutePropertiesEnum { ,   kRouteProperty_Comment = kRouteProperty_First, kRouteProperty_DeparturePort, kRouteProperty_ArrivalPort, kRouteProperty_IsVisible,   kRouteProperty_IsActive , kRouteProperty_UpdateVersion, kRouteProperty_IsTemporary, kRouteProperty_IsCaution,   kRouteProperty_Distance, kRouteProperty_FileContent, kRouteProperty_RouteAuthor, kRouteProperty_RouteStatus,   kRouteProperty_VesselName, kRouteProperty_VesselMMSI, kRouteProperty_VesselIMO, kRouteProperty_WODistance,   kRouteProperty_IsReference }
	Route properties (extension of dataset properties). More...
enum	RouteLegPropertiesEnum {   kRouteLegProperty_IsRhumbline = kRAC_LEG_TYPE, kRouteLegProperty_DeviationStarboard = kRAC_DEV_STARBORD, kRouteLegProperty_DeviationPort = kRAC_DEV_PORT, kRouteLegProperty_PlannedSpeed = kRAC_PLANNED_SPEED,   kRouteLegProperty_Highlight = kRAC_HLTTYPE, kRouteLegProperty_Index = kRAC_OBJIDX, kRouteLegProperty_PassageType = kRAC_PASSAGE_TYPE, kRouteLegProperty_SpeedMin = kRAC_SPEED_MIN,   kRouteLegProperty_SpeedMax = kRAC_SPEED_MAX, kRouteLegProperty_SafetyContour = kRAC_SAFETY_CONTOUR, kRouteLegProperty_SafetyDepth = kRAC_SAFETY_DEPTH, kRouteLegProperty_DraughtForward = kRAC_DRAUGHT_FORWARD,   kRouteLegProperty_DraughtAft = kRAC_DRAUGHT_AFT, kRouteLegProperty_StaticUKC = kRAC_STATIC_UKC, kRouteLegProperty_DynamicUKC = kRAC_DYNAMIC_UKC, kRouteLegProperty_Masthead = kRAC_MASTHEAD,   kRouteLegProperty_LegReport = kRAC_LEG_REPORT, kRouteLegProperty_LegInfo = kRAC_LEG_INFO, kRouteLegProperty_LegNote1 = kRAC_LEG_NOTE1, kRouteLegProperty_LegNote2 = kRAC_LEG_NOTE2,   kRouteLegProperty_DeepContour = kRAC_DEEP_CONTOUR }
	Route leg properties. More...
enum	WaypointPropertiesEnum {   kWaypointProperty_Name = senc::s101::kFAC_OBJNAM, kWaypointProperty_Index = kRAC_OBJIDX, kWaypointProperty_TurningRadius = kRAC_ANGLE, kWaypointProperty_Selected = kRAC_SELWPT,   kWaypointProperty_ID = kRAC_WAYPNT_ID, kWaypointProperty_Revision = kRAC_WAYPNT_REV, kWaypointProperty_IsWrongGeometry = kRAC_SELTYPE , kWaypointProperty_PilotBoarding = kRAC_PILOT_BOARDING,   kWaypointProperty_WODistance = kRAC_WO_DISTANCE, kWaypointProperty_BeamLineLength = kRAC_BEAM_LINE_LENGTH, kWaypointProperty_ScheduledETD = kRAC_ETD, kWaypointProperty_ScheduledETA = kRAC_ETA,   kWaypointProperty_WODistanceSet = kRAC_WO_DISTANCE_SET, kWaypointProperty_Leg_PassageType = kRAC_PASSAGE_TYPE, kWaypointProperty_Leg_GeometryType = kRouteLegProperty_IsRhumbline, kWaypointProperty_Leg_DeviationStarboard = kRouteLegProperty_DeviationStarboard,   kWaypointProperty_Leg_DeviationPort = kRouteLegProperty_DeviationPort, kWaypointProperty_Leg_PlannedSpeed = kRouteLegProperty_PlannedSpeed, kWaypointProperty_Leg_Highlight = kRouteLegProperty_Highlight, kWaypointProperty_Leg_SpeedMax = kRouteLegProperty_SpeedMax,   kWaypointProperty_Leg_SpeedMin = kRouteLegProperty_SpeedMin, kWaypointProperty_Leg_SafetyContour = kRouteLegProperty_SafetyContour, kWaypointProperty_Leg_SafetyDepth = kRouteLegProperty_SafetyDepth, kWaypointProperty_Leg_DraughtForward = kRouteLegProperty_DraughtForward,   kWaypointProperty_Leg_DraughtAft = kRouteLegProperty_DraughtAft, kWaypointProperty_Leg_StaticUKC = kRouteLegProperty_StaticUKC, kWaypointProperty_Leg_DynamicUKC = kRouteLegProperty_DynamicUKC, kWaypointProperty_Leg_Masthead = kRouteLegProperty_Masthead,   kWaypointProperty_Leg_LegReport = kRouteLegProperty_LegReport, kWaypointProperty_Leg_LegInfo = kRouteLegProperty_LegInfo, kWaypointProperty_Leg_LegNote1 = kRouteLegProperty_LegNote1, kWaypointProperty_Leg_LegNote2 = kRouteLegProperty_LegNote2,   kWaypointProperty_Leg_DeepContour = kRouteLegProperty_DeepContour }
	Route way point properties. More...
enum	RouteStorageTypes { kRouteStorageType_FilesVersion1 = 0 }
	Route storage types. More...
enum	RouteStorageParameters {   kRouteStorageParameter_FolderPath = 0, kRouteStorageParameter_ResourceLockComponent = 1, kRouteStorageParameter_NavBoxClient = 2, kRouteStorageParameter_BinPath = 3,   kRouteStorageParameter_RestorePath = 4 }
	Route storage parameters. More...
enum	RouteStatuses { kRouteStatus_Invisible = 0, kRouteStatus_Visible }
	Route statuses. More...
enum	RouteFormat
	Route formats.
enum	RouteFormatParameters
	Route formats parameters.
enum	RouteImportParameters { kRouteImportParameters_OutputRouteFilename = 0, kRouteImportParameters_RouteNameToImport = 1, kRouteImportParameters_RouteNameToSet = 2, kRouteImportParameters_StrictMode = 3 }
	Route import parameters. More...
enum	RouteExportParameters { kRouteExportParameters_OutputRouteFilename = 0, kRouteExportParameters_ExportEventMarks = 1 }
	Route export parameters. More...
enum	RouteFormatProperties
	Route format properties.

Variables
static const char	kRouteFormatKey_Navtor [] = "Navtor"
	Route formats import/export.
static const char	kRouteFormatDescr_Navtor [] = "Navtor"
	Route formats import/export.
static const wchar_t	kNavBox_RouteStorageBinPath [] = L"RoutesBin"
	Routes bin path in NavBox.

Detailed Description

Route planning library.

Enumeration Type Documentation

RouteElementType

enum RouteElementType

Route element type mask.

Enumerator
kRouteElementType_None	Empty mask.
kRouteElementType_Waypoint	Way point.
kRouteElementType_Leg	Leg.
kRouteElementType_EventMark	Event mark.
kRouteElementType_ParallelIndexLine	PI.
kRouteElementType_PositionReference	Position reference.
kRouteElementType_LegWithCurve	< Curve part of the leg
kRouteElementType_All	All parts.

RoutePropertiesEnum

enum RoutePropertiesEnum

Route properties (extension of dataset properties).

Enumerator
kRouteProperty_Comment	Comment.
kRouteProperty_DeparturePort	Reference to the port of departure.
kRouteProperty_ArrivalPort	Reference to the port of arrival.
kRouteProperty_IsVisible	Marks route as visible.
kRouteProperty_IsActive	Marks route as active (specific visual representation, e.g. for monitoring)
kRouteProperty_UpdateVersion	Route version in current session.
kRouteProperty_IsTemporary	Marks route as temporary (specific visual representation)
kRouteProperty_IsCaution	Marks route as caution.
kRouteProperty_Distance	Route distance.
kRouteProperty_FileContent	Route file content.
kRouteProperty_RouteAuthor	Route author.
kRouteProperty_RouteStatus	Route status.
kRouteProperty_VesselName	Vessel name.
kRouteProperty_VesselMMSI	Vessel MMSI.
kRouteProperty_VesselIMO	Vessel IMO.
kRouteProperty_WODistance	WO distance.
kRouteProperty_IsReference	Marks route as referenced (specific visual representation, CHGRF color for route)

RouteLegPropertiesEnum

enum RouteLegPropertiesEnum

Route leg properties.

Enumerator
kRouteLegProperty_IsRhumbline	Marks leg as rhumb line (LegtypeAttributesEnum)
kRouteLegProperty_DeviationStarboard	Starboard XTE.
kRouteLegProperty_DeviationPort	Portside XTE.
kRouteLegProperty_PlannedSpeed	Planned speed on the leg.
kRouteLegProperty_Highlight	Leg highlight type (RouteHighlightAttributeEnum)
kRouteLegProperty_Index	Leg Index.
kRouteLegProperty_PassageType	Leg passage type.
kRouteLegProperty_SpeedMin	Lowest cruising speed in knots on the leg.
kRouteLegProperty_SpeedMax	Highest cruising speed in knots on the leg.
kRouteLegProperty_SafetyContour	Safety contour in meters.
kRouteLegProperty_SafetyDepth	Safety depth in meters.
kRouteLegProperty_DraughtForward	Static draught forward in meters.
kRouteLegProperty_DraughtAft	Static draught aft in meters.
kRouteLegProperty_StaticUKC	Minimum UKC on the leg.
kRouteLegProperty_DynamicUKC	Minimum dynamic UKC on the leg.
kRouteLegProperty_Masthead	Height of masthead.
kRouteLegProperty_LegReport	Reporting information.
kRouteLegProperty_LegInfo	Nice to know.
kRouteLegProperty_LegNote1	Notes regarding the ETD/ETA.
kRouteLegProperty_LegNote2	Local remarks.
kRouteLegProperty_DeepContour	Deep contour in meters.

WaypointPropertiesEnum

enum WaypointPropertiesEnum

Route way point properties.

Enumerator
kWaypointProperty_Name	Name.
kWaypointProperty_Index	Index.
kWaypointProperty_TurningRadius	Turning radius.
kWaypointProperty_Selected	Tells if way point is selected.
kWaypointProperty_ID	ID.
kWaypointProperty_Revision	Revision.
kWaypointProperty_IsWrongGeometry	Marks way point as being a part of wrong route segment.
kWaypointProperty_PilotBoarding	Pilot boarding Undefined/Embarkment/Disembarkment.
kWaypointProperty_WODistance	Distance from WO line to WO point.
kWaypointProperty_BeamLineLength	Beam lines length in NM.
kWaypointProperty_ScheduledETD	Scheduled ETD.
kWaypointProperty_ScheduledETA	Scheduled ETA.
kWaypointProperty_WODistanceSet	Distance from WO line to WO point that set after calculation.
kWaypointProperty_Leg_PassageType	Passage type.
kWaypointProperty_Leg_GeometryType	Outgoing leg geometry type (is rhumb line)
kWaypointProperty_Leg_DeviationStarboard	Outgoing leg starboard deviation.
kWaypointProperty_Leg_DeviationPort	Outgoing leg port deviation.
kWaypointProperty_Leg_PlannedSpeed	Outgoing leg planned speed.
kWaypointProperty_Leg_Highlight	Outgoing leg highlight type (RouteHighlightAttributeEnum)
kWaypointProperty_Leg_SpeedMax	Highest cruising speed in knots on the leg.
kWaypointProperty_Leg_SpeedMin	Lowest cruising speed in knots on the leg.
kWaypointProperty_Leg_SafetyContour	Safety contour in meters.
kWaypointProperty_Leg_SafetyDepth	Safety depth in meters.
kWaypointProperty_Leg_DraughtForward	Static draught forward in meters.
kWaypointProperty_Leg_DraughtAft	Static draught aft in meters.
kWaypointProperty_Leg_StaticUKC	Minimum UKC on the leg.
kWaypointProperty_Leg_DynamicUKC	Minimum dynamic UKC on the leg.
kWaypointProperty_Leg_Masthead	Height of masthead.
kWaypointProperty_Leg_LegReport	Reporting information.
kWaypointProperty_Leg_LegInfo	Nice to know.
kWaypointProperty_Leg_LegNote1	Notes regarding the ETD/ETA.
kWaypointProperty_Leg_LegNote2	Local remarks.
kWaypointProperty_Leg_DeepContour	Deep contour in meters.

RouteStorageTypes

enum RouteStorageTypes

Route storage types.

Enumerator
kRouteStorageType_FilesVersion1	Set of files.

RouteStorageParameters

enum RouteStorageParameters

Route storage parameters.

Enumerator
kRouteStorageParameter_FolderPath	Path to the storage location.
kRouteStorageParameter_ResourceLockComponent	Lock reference.
kRouteStorageParameter_NavBoxClient	Pointer to the NavBox client.
kRouteStorageParameter_BinPath	Bin path.
kRouteStorageParameter_RestorePath	Restore path.

RouteStatuses

enum RouteStatuses

Route statuses.

Enumerator
kRouteStatus_Invisible	Route is invisible.
kRouteStatus_Visible	Route is visible.

RouteImportParameters

enum RouteImportParameters

Route import parameters.

Enumerator
kRouteImportParameters_OutputRouteFilename	Output file name, string.
kRouteImportParameters_RouteNameToImport	The route name to import (first route is imported if omitted), string.
kRouteImportParameters_RouteNameToSet	The route name of imported route (original route name is used if omitted), string.
kRouteImportParameters_StrictMode	Use strict import mode (break on missed mandatory fields), bool.

RouteExportParameters

enum RouteExportParameters

Route export parameters.

Enumerator
kRouteExportParameters_OutputRouteFilename	The filename of the exported route, string.
kRouteExportParameters_ExportEventMarks	Export event marks (only for RTZ format), bool.