NAVTOR SDK  v.3.0
Software Development Kit for fast and efficient development of ECDIS, ECS and generic marine applications
IRoute Class Referenceabstract

Route interface. More...

#include <route_storage_interfaces.h>

Inheritance diagram for IRoute:
ISDKComponent

Public Member Functions

virtual SDKResult SDK_CALLTYPE GetName (SDKString &name) const =0 throw ()
 Returns route name.
 
virtual SDKResult SDK_CALLTYPE GetProperty (RoutePropertiesEnum id, SDKAny &value) const =0 throw ()
 Returns route property.
 
virtual SDKResult SDK_CALLTYPE GetWaypointsCount (SDKUInt32 &count) const =0 throw ()
 Returns number of route way points.
 
virtual SDKResult SDK_CALLTYPE GetWaypoint (SDKUInt32 index, IWaypointSP &waypoint) const =0 throw ()
 Returns route way point.
 
virtual SDKResult SDK_CALLTYPE Find (RouteElementType type, const SDKGeoPointRect &geo_rect, IFoundElementInfoEnum **out_value) const =0 throw ()
 Finds the route object under specified geographic rectangle.
 
virtual SDKResult SDK_CALLTYPE GetCorridorGeometryAsSurface (SDKUInt32 leg_index, double split_distance, SDK_GEOMETRY_NAMESPACE::IGeometrySP &geometry) const =0 throw ()
 Returns specified leg corridor.
 
virtual SDKResult SDK_CALLTYPE GetLegTrackGeometryAsSurface (SDKUInt32 leg_index, double split_distance, double corridor_width, SDK_GEOMETRY_NAMESPACE::IGeometrySP &geometry) const =0 throw ()
 Returns the leg track geometry as a corridor with the specified width.
 
virtual SDKResult SDK_CALLTYPE GetLegTrackGeometry (SDKUInt32 leg_index, double split_distance, SDK_GEOMETRY_NAMESPACE::IGeometrySP &geometry) const =0 throw ()
 Returns the leg track geometry.
 
virtual SDKResult SDK_CALLTYPE GetWOP (SDKUInt32 leg_index, SDKGeoPoint &position) const =0 throw ()
 Returns wheel-over point position.
 
template<typename T >
SDKResult GetPropertyT (RoutePropertiesEnum id, T &out) const throw ()
 Returns route properties.
 
- Public Member Functions inherited from ISDKComponent
virtual SDKAtomicRefCount SDK_CALLTYPE AddRef () const =0 throw ()
 Increments the reference count for an interface on a component.

 
virtual SDKAtomicRefCount SDK_CALLTYPE Release () const =0 throw ()
 Decrements the reference count for an interface on a component.
 
virtual SDKResult SDK_CALLTYPE GetInterface (const InterfaceId &id, void **obj_ptr)=0 throw ()
 Returns pointers to the supported interfaces on a component.
 
template<typename _Itf >
SDKResult GetInterface (_Itf **obj_ptr) throw ()
 Returns pointers to the supported interfaces on a component.
 

Detailed Description

Route interface.


The documentation for this class was generated from the following file: