Route Monitoring

Route monitoring components. More...

Data Structures
class	IRouteCalculator
	Route calculator interface. More...
class	IRouteMonitor
	Route monitoring manager interface. More...

Enumerations
enum	RouteMonitorParameters { kRouteMonitorParameter_OfCourseThreshold = 0 }
	Route monitoring parameters. More...
enum	VoyageProperties {   kVoyageProperty_WPIndex = 0, kVoyageProperty_CTS, kVoyageProperty_XTD, kVoyageProperty_DTA,   kVoyageProperty_TTG, kVoyageProperty_TTA, kVoyageProperty_ETA, kVoyageProperty_DWOL,   kVoyageProperty_Dist, kVoyageProperty_PlannedSpeed, kVoyageProperty_CurrentSpeed, kVoyageProperty_BWW,   kVoyageProperty_DepartureTime, kVoyageProperty_TWOL, kVoyageProperty_ActiveEventMarks, kVoyageProperty_OutOfCourse,   kVoyageProperty_DeviationError, kVoyageProperty_IsTurning, kVoyageProperty_EndOfRoute, kVoyageProperty_WPUnreachable,   kVoyageProperty_StartWPIndex, kVoyageProperty_EndWPIndex, kVoyageProperty_TTA_Collection, kVoyageProperty_WPName,   kVoyageProperty_TTA_Collection_CurrentSpeed, kVoyageProperty_TTA_CurrentSpeed, kVoyageProperty_ETA_CurrentSpeed, kVoyageProperty_ParallelIndexLineAlerts,   kVoyageProperty_RouteName, kVoyageProperty_Next_Leg_BWW, kVoyageProperty_Next_Leg_Distance, kVoyageProperty_WPLat,   kVoyageProperty_WPLon, kVoyageProperty_ForceGoToStartWP, kVoyageProperty_OwnShipOnRoute_Lat, kVoyageProperty_OwnShipOnRoute_Lon,   kVoyageProperty_LastValue }
	Voyage properties. More...

Variables
static const sdk::ComponentId	kRouteMonitorCID = "RouteMonitorCID"
	Route monitoring manager.
static const sdk::ComponentId	kRouteCalculatorCID = "RouteCalculatorCID"
	Route monitoring calculator.

Detailed Description

Route monitoring components.

Enumeration Type Documentation

RouteMonitorParameters

enum RouteMonitorParameters

Route monitoring parameters.

Enumerator
kRouteMonitorParameter_OfCourseThreshold	Maximal allowed course deviation in degrees.

VoyageProperties

enum VoyageProperties

Voyage properties.

Enumerator
kVoyageProperty_WPIndex	Destination way point index.
kVoyageProperty_CTS	Course to steer.
kVoyageProperty_XTD	Cross track distance.
kVoyageProperty_DTA	Distance to arrival.
kVoyageProperty_TTG	Time to go.
kVoyageProperty_TTA	Time to arrival at the planned speed.
kVoyageProperty_ETA	Estimated time of arrival at the planned speed.
kVoyageProperty_DWOL	Distance to wheel over line.
kVoyageProperty_Dist	Distance to the way point.
kVoyageProperty_PlannedSpeed	Planned speed.
kVoyageProperty_CurrentSpeed	Current speed.
kVoyageProperty_BWW	Bearing from previous way point to the current one.
kVoyageProperty_DepartureTime	Time of the departure.
kVoyageProperty_TWOL	Time to wheel over line.
kVoyageProperty_ActiveEventMarks	Active event marks.
kVoyageProperty_OutOfCourse	Tells if vessel is out of course.
kVoyageProperty_DeviationError	Positive value tells that distance outside of the corridor.
kVoyageProperty_IsTurning	Tells if vessel is turning (to the next way point)
kVoyageProperty_EndOfRoute	Tells that vessel has reached end of the route.
kVoyageProperty_WPUnreachable	Tells that way point is unreachable.
kVoyageProperty_StartWPIndex	Voyage start way point index.
kVoyageProperty_EndWPIndex	Voyage end way point index.
kVoyageProperty_TTA_Collection	Time to arrival for all voyage legs.
kVoyageProperty_WPName	Name of the current way point.
kVoyageProperty_TTA_Collection_CurrentSpeed	Time to arrival for all voyage legs at the current speed.
kVoyageProperty_TTA_CurrentSpeed	Time to arrival at the current speed.
kVoyageProperty_ETA_CurrentSpeed	Estimated time of arrival at the current speed.
kVoyageProperty_ParallelIndexLineAlerts	Parallel index line alerts, see IParallelIndexLineAlerts interface.
kVoyageProperty_RouteName	Active route name
kVoyageProperty_Next_Leg_BWW	Next leg BWW
kVoyageProperty_Next_Leg_Distance	Next leg length.
kVoyageProperty_WPLat	Destination waypoint latitude.
kVoyageProperty_WPLon	Destination waypoint longitude.
kVoyageProperty_ForceGoToStartWP	Force to go to starting waypoint.
kVoyageProperty_OwnShipOnRoute_Lat	Ownship point projected to the route geometry latitude.
kVoyageProperty_OwnShipOnRoute_Lon	Ownship point projected to the route geometry longitude.
kVoyageProperty_LastValue	Last enum value.