Route storage and route. More...

#include <base/inc/sdk_results.h>
#include <base/inc/forward_declarations.h>
#include <base/inc/interfaces/parameters/parameters_interface.h>
#include <base/inc/interfaces/enum/enum_interface.h>
#include <base/inc/interfaces/collection/collection_interface.h>
#include <base/inc/interfaces/stream/stream_interface.h>
#include <base/inc/sdk_any_handler.h>
#include <datalayer/inc/geodatabase/gdb_workspace.h>
#include <datalayer/inc/senc/senc_feature_catalog_s101.h>
#include <ecdislayer/inc/route_planning/route_const.h>
#include <ecdislayer/inc/route_planning/voyage_properties.h>

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	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 wchar_t	kNavtorRouteFileNameExtension [] = L"route"
	Route file name extensions. More...

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 storage and route.

Author: The NAVTOR SDK authors.

Date: 12/2012

Maintenance:: The NAVTOR SDK authors.

Variable Documentation

◆ kNavtorRouteFileNameExtension

const wchar_t kNavtorRouteFileNameExtension[] = L"route"

static

Route file name extensions.

Parameters

[in]	[optional]	output_route_filename Output file name.
[in]	route_name_to_import	The route name to import. Empty string is accepted, first route is imported in this case.
[in]	[optional]	route_name_to_set The route name of imported route. Empty string is accepted, original route name is used.

Data Structures

Enumerations

Variables

Detailed Description

Variable Documentation

◆ kNavtorRouteFileNameExtension