Inheritance diagram for TPG.GeoFramework.RoutePlanningLayer.RoutePlanningLayerViewModel:

Public Member Functions

RoutePlanningLayerViewModel (IRoutePlanningServiceClient serviceClient, IGeoContext geoContext, IGeoNavigator geoNavigator, IGeoLayerViewFactory routePlanningLayerViewFactory)

Properties GetRouteMarkProperties (IRouteInfo route, Point point)

Get route mark properties for route at point.

Parameters

route	Route with marks.
point	Route mark point.

Returns: Route mark properties or null if not found.

void Clear ()

Clear all routes.

bool RemoveRoute (IRouteInfo route)

Remove route.

Parameters

route Route to remove.

Returns: True on success, otherwise false.

void CalculateRoute (RoutingQuery query)

Calculate route.

Parameters

query Parameters in route calculation.

List< RoutingProfiles > GetSupportedProfiles (string routingDatabaseName)

Get a list of routing profiles supported by a routing database.

Returns: List of routing profiles.

List< RoutingDatabaseEntry > GetRoutingDatabaseEntries ()

Get routing databases from service.

Returns: List of routing databases.

ResolveResult ResolveCoordinates (ResolveQuery query)

Resolve coordinates.

Parameters

query Parameters for resolving coordinates.

void CancelRequest (string requestId)

Cancel a running request with specific id.

Parameters

requestId Request id to cancel

override void HandleInputEvent (GeoInputEventArgs inputEventArgs)

Called to forward events to the layer.

override void Update ()

Event called at regular intervals to update contents of the layer.

override void Generate ()

Requests that the layer generates it's view.

void PreExport ()

Called before actual export is performed. The layer must ensure that state that changes the appearance of the layer is not altered.

void Export (Canvas canvas, IGeoContext geoContext, double targetDpi)

The actual export function. Implementing classes should draw their content using the provided canvas and geo context.

Parameters

canvas	The canvas to draw into.
geoContext	The geo context relevant for this export.
targetDpi	The wanted dpi for the export.

void PostExport ()

Called after export is performed. After this no more export functions will be called and the layer should go back to normal operation.

new void Dispose ()

Public Member Functions inherited from TPG.GeoFramework.Core.GeoLayerViewModel

GeoLayerViewModel (IGeoContext geoContext, IGeoNavigator geoNavigator)

abstract void HandleInputEvent (GeoInputEventArgs inputEventArgs)

Called to forward events to the layer.

virtual void Generate ()

Requests that the layer generates it's view.

abstract void Update ()

Event called at regular intervals to update contents of the layer.

virtual void SetDirty (bool isDirty)

Sets a boolean value indicating the need for an update of the contents of a layer.

void SetDirty (object sender)

Sets dirty flag and stores sender, use to avoid cyclic dirtying.

virtual bool IsDirty ()

Public Member Functions inherited from TPG.GeoFramework.Core.ViewModelBase

void Dispose ()

Invoked when this object is being removed from the application and will be subject to garbage collection.

void HandleInputEvent (GeoInputEventArgs inputEventArgs)

Called to forward events to the layer.

void Generate ()

Requests that the layer generates it's view.

void Update ()

Event called at regular intervals to update contents of the layer.

void SetDirty (bool isDirty)

Sets a boolean value indicating the need for an update of the contents of a layer.

void SetDirty (object dirtySource)

Sets dirty flag and stores sender, use to avoid cyclic dirtying.

bool IsDirty ()

void CalculateRoute (RoutingQuery query)

Calculate route.

List< RoutingProfiles > GetSupportedProfiles (string routingDatabaseName)

Get a list of routing profiles supported by a routing database.

List< RoutingDatabaseEntry > GetRoutingDatabaseEntries ()

Get routing databases from service.

ResolveResult ResolveCoordinates (ResolveQuery query)

Resolve coordinates.

void Clear ()

Clear all routes.

bool RemoveRoute (IRouteInfo route)

Remove route.

Properties GetRouteMarkProperties (IRouteInfo route, Point point)

Get route mark properties for route at point.

void CancelRequest (string requestId)

Cancel a running request with specific id.

void PreExport ()

Called before actual export is performed. The layer must ensure that state that changes the appearance of the layer is not altered.

void Export (Canvas canvas, IGeoContext geoContext, double targetDpi)

The actual export function. Implementing classes should draw their content using the provided canvas and geo context.

void PostExport ()

Called after export is performed. After this no more export functions will be called and the layer should go back to normal operation.

Protected Member Functions
override void	SetVisible (bool value)

Protected Member Functions inherited from TPG.GeoFramework.Core.GeoLayerViewModel
virtual void	SetVisible (bool value)

override void	OnDispose (bool disposing)
	Make sure that all layers disconnect their shared GeoContexts.

Protected Member Functions inherited from TPG.GeoFramework.Core.ViewModelBase
virtual void	OnDispose (bool disposing)
	Child classes can override this method to perform clean-up logic, such as removing event handlers.

void	NotifyPropertyChanged< TProperty > (Expression< Func< TProperty > > property, INotifyPropertyChanged sender)

void	NotifyPropertyChanged (string propertyName)

virtual void	OnPropertyChanged ([CallerMemberName] string propertyName=null)

Properties
bool	ShowRouteMarks `[get, set]`
	Show or hide marks for the routes.

IRoutePlanningVisualSettings	VisualSettings `[get]`
	Visual route settings.

IRoutePlanningServiceClient	ServiceClient `[get]`

ObservableCollection< IRouteInfo >	Routes `[get, set]`
	List of routes.

IRouteInfo	SelectedRoute `[get, set]`
	Gets or sets selected route.

ObservableCollection< GeoPos >	PreviewPositions `[get]`
	Show preview position marks before route is calculated.Value will be cleared when RouteCalculationCompleted event is raised.

IGeoLayerView	View `[get, set]`

Properties inherited from TPG.GeoFramework.Core.GeoLayerViewModel
IGeoControlViewModel	GeoControlViewModel `[get, set]`
	Get or set geo control view model.

UIElement	Tooltip `[get, set]`
	Get or set tooltip UI element.

string	Name `[get]`
	A name representing the type of layer.

bool	Visible `[get, set]`
	Gets or sets the visibility of the layer.

IGeoContext	GeoContext `[get, set]`
	Gets or sets the `GeoContext` related to the layer.

IGeoNavigator	GeoNavigator `[get, set]`
	Gets or sets the `GeoNavigator` related to the GeoControl.

IGeoLayerViewFactory	GeoLayerViewFactory `[get, set]`
	Gets a factory responsible for creating a `IGeoLayerViewFactory` view.

IGeoLayerView	GeoLayerView `[get, set]`
	Gets or sets the view associated with this view model.

ClipMargins	ClipMargins `[get, set]`
	Enables or disables clipping of the contents of the view, based on the specifed clip margins.

HashSet< object >	DirtySources `[get]`
	All contributors to current dirty.

Properties inherited from TPG.GeoFramework.Core.ViewModelBase
virtual string	DisplayName `[get, protected set]`
	Returns the user-friendly name of this object. Child classes can set this property to a new value, or override it to determine the value on-demand.

Properties inherited from TPG.GeoFramework.Contracts.Geo.Layer.IViewModelBase
string	DisplayName `[get]`

Properties inherited from TPG.GeoFramework.Contracts.Geo.Layer.IGeoLayerViewModel
string	Name `[get]`
	A name representing the type of layer.

bool	Visible `[get, set]`
	Gets or sets the visibility of the layer.

IGeoContext	GeoContext `[get, set]`
	Gets or sets the `GeoContext` related to the layer.

IGeoLayerViewFactory	GeoLayerViewFactory `[get]`
	Gets a factory responsible for creating a `IGeoLayerViewFactory` view.

IGeoLayerView	GeoLayerView `[get, set]`
	Gets or sets the view associated with this view model.

IGeoNavigator	GeoNavigator `[get, set]`
	Gets or sets the `GeoNavigator` related to the GeoControl.

IGeoControlViewModel	GeoControlViewModel `[get, set]`
	Get or set geo control view model.

ClipMargins	ClipMargins `[get, set]`
	Enables or disables clipping of the contents of the view, based on the specifed clip margins.

HashSet< object >	DirtySources `[get]`
	All contributors to current dirty.

UIElement	Tooltip `[get, set]`
	Get or set tooltip UI element.

Properties inherited from TPG.GeoFramework.RoutePlanningLayer.Contracts.IRoutePlanningLayerViewModel
ObservableCollection< GeoPos >	PreviewPositions `[get]`
	Show preview position marks before route is calculated.

IRoutePlanningVisualSettings	VisualSettings `[get]`
	Visual route settings.

ObservableCollection< IRouteInfo >	Routes `[get]`
	List of routes.

IRouteInfo	SelectedRoute `[get, set]`
	Gets or sets selected route.

bool	ShowRouteMarks `[get, set]`
	Show or hide marks for the routes.

Events
RouteCalculationCancelledHandler	RouteCalculationCancelled

RouteCalculationCompletedHandler	RouteCalculationCompleted = delegate { }

RouteCalculationErrorHandler	RouteCalculationError = delegate { }

Events inherited from TPG.GeoFramework.Core.GeoLayerViewModel
VisibleChangedEventHandler	VisibleChanged = delegate { }

LayerChangedEventHandler	LayerChanged = delegate { }

Events inherited from TPG.GeoFramework.Core.ViewModelBase
PropertyChangedEventHandler	PropertyChanged = delegate { }
	Raised when a property on this object has a new value.

Events inherited from TPG.GeoFramework.Contracts.Geo.Layer.IGeoLayerViewModel
VisibleChangedEventHandler	VisibleChanged
	Visibility changed.

LayerChangedEventHandler	LayerChanged
	Layer changed.

Events inherited from TPG.GeoFramework.RoutePlanningLayer.Contracts.IRoutePlanningLayerViewModel
RouteCalculationCancelledHandler	RouteCalculationCancelled
	Route calculation completed.

RouteCalculationCompletedHandler	RouteCalculationCompleted
	Route calculation completed.

RouteCalculationErrorHandler	RouteCalculationError
	Route calculation error.

Additional Inherited Members
Protected Attributes inherited from TPG.GeoFramework.Core.GeoLayerViewModel
string	_name = null

Member Function Documentation

◆ CalculateRoute()

void TPG.GeoFramework.RoutePlanningLayer.RoutePlanningLayerViewModel.CalculateRoute ( RoutingQuery query )

inline

Calculate route.

Parameters

query Parameters in route calculation.

Implements TPG.GeoFramework.RoutePlanningLayer.Contracts.IRoutePlanningLayerViewModel.

◆ CancelRequest()

void TPG.GeoFramework.RoutePlanningLayer.RoutePlanningLayerViewModel.CancelRequest ( string requestId )

inline

Cancel a running request with specific id.

Parameters

requestId Request id to cancel

Implements TPG.GeoFramework.RoutePlanningLayer.Contracts.IRoutePlanningLayerViewModel.

◆ Clear()

void TPG.GeoFramework.RoutePlanningLayer.RoutePlanningLayerViewModel.Clear ( )

inline

Clear all routes.

Implements TPG.GeoFramework.RoutePlanningLayer.Contracts.IRoutePlanningLayerViewModel.

◆ Export()

void TPG.GeoFramework.RoutePlanningLayer.RoutePlanningLayerViewModel.Export	(	Canvas	canvas,
		IGeoContext	geoContext,
		double	targetDpi
	)

inline

The actual export function. Implementing classes should draw their content using the provided canvas and geo context.

Parameters

canvas	The canvas to draw into.
geoContext	The geo context relevant for this export.
targetDpi	The wanted dpi for the export.

Implements TPG.GeoFramework.Contracts.Geo.Layer.IExportableLayer.

◆ Generate()

override void TPG.GeoFramework.RoutePlanningLayer.RoutePlanningLayerViewModel.Generate ( )

inlinevirtual

Requests that the layer generates it's view.

Reimplemented from TPG.GeoFramework.Core.GeoLayerViewModel.

◆ GetRouteMarkProperties()

Properties TPG.GeoFramework.RoutePlanningLayer.RoutePlanningLayerViewModel.GetRouteMarkProperties	(	IRouteInfo	route,
		Point	point
	)

inline

Get route mark properties for route at point.

Parameters

route	Route with marks.
point	Route mark point.

Returns: Route mark properties or null if not found.

Implements TPG.GeoFramework.RoutePlanningLayer.Contracts.IRoutePlanningLayerViewModel.

◆ GetRoutingDatabaseEntries()

List< RoutingDatabaseEntry > TPG.GeoFramework.RoutePlanningLayer.RoutePlanningLayerViewModel.GetRoutingDatabaseEntries ( )

inline

Get routing databases from service.

Returns: List of routing databases.

Implements TPG.GeoFramework.RoutePlanningLayer.Contracts.IRoutePlanningLayerViewModel.

◆ GetSupportedProfiles()

List< RoutingProfiles > TPG.GeoFramework.RoutePlanningLayer.RoutePlanningLayerViewModel.GetSupportedProfiles ( string routingDatabaseName )

inline

Get a list of routing profiles supported by a routing database.

Returns: List of routing profiles.

Implements TPG.GeoFramework.RoutePlanningLayer.Contracts.IRoutePlanningLayerViewModel.

◆ HandleInputEvent()

override void TPG.GeoFramework.RoutePlanningLayer.RoutePlanningLayerViewModel.HandleInputEvent ( GeoInputEventArgs inputEventArgs )

inlinevirtual

Called to forward events to the layer.

Parameters

inputEventArgs

If the layer handles the event, it must set the Handled property to true.

Implements TPG.GeoFramework.Core.GeoLayerViewModel.

◆ PostExport()

void TPG.GeoFramework.RoutePlanningLayer.RoutePlanningLayerViewModel.PostExport ( )

inline

Called after export is performed. After this no more export functions will be called and the layer should go back to normal operation.

Implements TPG.GeoFramework.Contracts.Geo.Layer.IExportableLayer.

◆ PreExport()

void TPG.GeoFramework.RoutePlanningLayer.RoutePlanningLayerViewModel.PreExport ( )

inline

Called before actual export is performed. The layer must ensure that state that changes the appearance of the layer is not altered.

Implements TPG.GeoFramework.Contracts.Geo.Layer.IExportableLayer.

◆ RemoveRoute()

bool TPG.GeoFramework.RoutePlanningLayer.RoutePlanningLayerViewModel.RemoveRoute ( IRouteInfo route )

inline

Remove route.

Parameters

route Route to remove.

Returns: True on success, otherwise false.

Implements TPG.GeoFramework.RoutePlanningLayer.Contracts.IRoutePlanningLayerViewModel.

◆ ResolveCoordinates()

ResolveResult TPG.GeoFramework.RoutePlanningLayer.RoutePlanningLayerViewModel.ResolveCoordinates ( ResolveQuery query )

inline

Resolve coordinates.

Parameters

query Parameters for resolving coordinates.

Implements TPG.GeoFramework.RoutePlanningLayer.Contracts.IRoutePlanningLayerViewModel.

◆ SetVisible()

override void TPG.GeoFramework.RoutePlanningLayer.RoutePlanningLayerViewModel.SetVisible ( bool value )

inlineprotectedvirtual

Reimplemented from TPG.GeoFramework.Core.GeoLayerViewModel.

◆ Update()

override void TPG.GeoFramework.RoutePlanningLayer.RoutePlanningLayerViewModel.Update ( )

inlinevirtual

Event called at regular intervals to update contents of the layer.

Implements TPG.GeoFramework.Core.GeoLayerViewModel.

Property Documentation

◆ PreviewPositions

ObservableCollection<GeoPos> TPG.GeoFramework.RoutePlanningLayer.RoutePlanningLayerViewModel.PreviewPositions

get

Show preview position marks before route is calculated.Value will be cleared when RouteCalculationCompleted event is raised.

Implements TPG.GeoFramework.RoutePlanningLayer.Contracts.IRoutePlanningLayerViewModel.

◆ Routes

ObservableCollection<IRouteInfo> TPG.GeoFramework.RoutePlanningLayer.RoutePlanningLayerViewModel.Routes

getset

List of routes.

Implements TPG.GeoFramework.RoutePlanningLayer.Contracts.IRoutePlanningLayerViewModel.

◆ SelectedRoute

IRouteInfo TPG.GeoFramework.RoutePlanningLayer.RoutePlanningLayerViewModel.SelectedRoute

getset

Gets or sets selected route.

Implements TPG.GeoFramework.RoutePlanningLayer.Contracts.IRoutePlanningLayerViewModel.

◆ ShowRouteMarks

bool TPG.GeoFramework.RoutePlanningLayer.RoutePlanningLayerViewModel.ShowRouteMarks

getset

Show or hide marks for the routes.

Implements TPG.GeoFramework.RoutePlanningLayer.Contracts.IRoutePlanningLayerViewModel.

◆ VisualSettings

IRoutePlanningVisualSettings TPG.GeoFramework.RoutePlanningLayer.RoutePlanningLayerViewModel.VisualSettings

get

Visual route settings.

Implements TPG.GeoFramework.RoutePlanningLayer.Contracts.IRoutePlanningLayerViewModel.

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

Src/Layers/RoutePlanning/TPG.GeoFramework.RoutePlanningLayer/RoutePlanningLayerViewModel.cs

Public Member Functions

Protected Member Functions

Properties

Events

Additional Inherited Members

Member Function Documentation

◆ CalculateRoute()

◆ CancelRequest()

◆ Clear()

◆ Export()

◆ Generate()

◆ GetRouteMarkProperties()

◆ GetRoutingDatabaseEntries()

◆ GetSupportedProfiles()

◆ HandleInputEvent()

◆ PostExport()

◆ PreExport()

◆ RemoveRoute()

◆ ResolveCoordinates()

◆ SetVisible()

◆ Update()

Property Documentation

◆ PreviewPositions

◆ Routes

◆ SelectedRoute

◆ ShowRouteMarks

◆ VisualSettings