IRouteEditor Class Reference

Route editor interface. More...

#include <route_storage_interfaces.h>

Inheritance diagram for IRouteEditor:

Public Member Functions
virtual SDKResult SDK_CALLTYPE	GetWorkspace (IWorkspace **workspace)=0 throw ()
	Returns route editor workspace.
virtual SDKResult SDK_CALLTYPE	SetName (const SDKString &name)=0 throw ()
	Sets route name.
virtual SDKResult SDK_CALLTYPE	SetRouteProperty (RoutePropertiesEnum property_id, const SDKAny &property_value)=0 throw ()
	Sets route properties.
virtual SDKResult SDK_CALLTYPE	InsertWaypoint (SDKUInt32 before_index, const SDKGeoPoint &position)=0 throw ()
	Insert new way point.
virtual SDKResult SDK_CALLTYPE	RemoveWaypoint (SDKUInt32 waypoint_index)=0 throw ()
	Removes specified way point.
virtual SDKResult SDK_CALLTYPE	SetWaypointPosition (SDKUInt32 waypoint_index, const SDKGeoPoint &position)=0 throw ()
	Changes way point position.
virtual SDKResult SDK_CALLTYPE	SetWaypointProperty (SDKUInt32 waypoint_index, WaypointPropertiesEnum property_id, const SDKAny &value)=0 throw ()
	Sets way point property.
virtual SDKResult SDK_CALLTYPE	GetWaypointProperty (SDKUInt32 waypoint_index, WaypointPropertiesEnum property_id, SDKAny &value) const =0 throw ()
	Returns way point property.
virtual SDKResult SDK_CALLTYPE	SetLegProperty (SDKUInt32 leg_index, RouteLegPropertiesEnum property_id, const SDKAny &value)=0 throw ()
	Sets route leg property.
virtual SDKResult SDK_CALLTYPE	SetSelectorPosition (SDKUInt32 selector_idx, const SDKAny &selector_type, const SDKGeoPoint &position)=0 throw ()
	Sets selector position.
virtual SDKResult SDK_CALLTYPE	RemoveSelector (SDKInt32 selector_idx)=0 throw ()
	Removes selector.
virtual SDKResult SDK_CALLTYPE	ReverseRoute ()=0 throw ()
	Reverses route.
virtual SDKResult SDK_CALLTYPE	GetRoute (IRouteSP &route)=0 throw ()
	Returns route interface.
virtual SDKResult SDK_CALLTYPE	UpdateChanges ()=0 throw ()
	Synchronizes route editor content with the route storage.
virtual SDKResult SDK_CALLTYPE	UpdateChangesAsNew ()=0 throw ()
	Creates new route & synchronizes route editor content with the route storage.
virtual SDKResult SDK_CALLTYPE	CommitChanges ()=0 throw ()
	Synchronizes route editor content with the route storage and commits the route storage.
virtual SDKResult SDK_CALLTYPE	CommitChangesAsNew ()=0 throw ()
	Creates new route, synchronizes route editor content with the route storage and commits the route storage.
virtual SDKResult SDK_CALLTYPE	SetBearingLines (SDKUInt32 waypoint_index)=0 throw ()
	Sets bearing lines.
virtual SDKResult SDK_CALLTYPE	RemoveBearingLines ()=0 throw ()
	Removes bearing lines.
virtual SDKResult SDK_CALLTYPE	SetBeamLines (SDKUInt32 wp_index, double beam_line_length)=0 throw ()
	Sets the beam lines.
virtual SDKResult SDK_CALLTYPE	RemoveBeamLines ()=0 throw ()
	Removes the beam lines.
virtual SDKResult SDK_CALLTYPE	IsModified () const =0 throw ()
	Returns Err_True if the route was modified, returns Err_False otherwise.
virtual SDKResult SDK_CALLTYPE	AppendRoute (const IRouteSP &route)=0 throw ()
	Append the route. More...
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 editor interface.

Member Function Documentation

AppendRoute()

virtual SDKResult SDK_CALLTYPE AppendRoute ( const IRouteSP &  route ) throw ( )

pure virtual

Append the route.

Parameters

route

[in] Route to append.

---

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

• route_storage_interfaces.h