Terminator view model. More...

Inheritance diagram for TPG.GeoFramework.Terminator.TerminatorViewModel:

Public Member Functions

TerminatorViewModel (IGeoContext geoContext, ITerminatorViewFactory viewFactory)

Constructor.

override void HandleInputEvent (GeoInputEventArgs inputEventArgs)

Called to forward events to the layer.

Parameters

inputEventArgs

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

override void Update ()

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

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 ()

Properties
TimeSpan	UpdateInterval `[get, set]`
	Get or set update interval (default = 10 min)

bool	AutoUpdate `[get, set]`
	Get or set auto update (default = true)

DateTime	UtcTime `[get, set]`
	Get or set time explicitly - if other than current.

DashStyle	LineStyle `[get, set]`
	Get or set line style.

int	LineThickness `[get, set]`
	Get or set line thickness.

Color	LineColor `[get, set]`
	Get or set line colour.

bool	NightShading `[get, set]`
	Enable/disable night shading.

bool	Contour `[get, set]`
	Enable/disable terminator contour.

Color	NightShadingColor `[get, set]`
	Get or set night shading color.

new string	DisplayName `[get]`

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.Terminator.ITerminatorViewModel
TimeSpan	UpdateInterval `[get, set]`
	Get or set update interval (default = 10 min)

bool	AutoUpdate `[get, set]`
	Get or set auto update (default = true)

DateTime	UtcTime `[get, set]`
	Get or set time explicitly - if other than current.

DashStyle	LineStyle `[get, set]`
	Get or set line style.

int	LineThickness `[get, set]`
	Get or set line thickness.

Color	LineColor `[get, set]`
	Get or set line colour.

bool	Contour `[get, set]`
	Enable/disable terminator contour.

bool	NightShading `[get, set]`
	Enable/disable night shading.

Color	NightShadingColor `[get, set]`
	Get or set night shading color.

Additional Inherited Members
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)

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

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.

Detailed Description

Terminator view model.

Constructor & Destructor Documentation

◆ TerminatorViewModel()

TPG.GeoFramework.Terminator.TerminatorViewModel.TerminatorViewModel	(	IGeoContext	geoContext,
		ITerminatorViewFactory	viewFactory
	)

inline

Constructor.

Parameters

geoContext	Geo context.
viewFactory	Factory for associated view.

Member Function Documentation

◆ HandleInputEvent()

override void TPG.GeoFramework.Terminator.TerminatorViewModel.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.

◆ Update()

override void TPG.GeoFramework.Terminator.TerminatorViewModel.Update ( )

inlinevirtual

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

Implements TPG.GeoFramework.Core.GeoLayerViewModel.

Property Documentation

◆ AutoUpdate

bool TPG.GeoFramework.Terminator.TerminatorViewModel.AutoUpdate

getset

Get or set auto update (default = true)

Implements TPG.GeoFramework.Terminator.ITerminatorViewModel.

◆ Contour

bool TPG.GeoFramework.Terminator.TerminatorViewModel.Contour

getset

Enable/disable terminator contour.

Implements TPG.GeoFramework.Terminator.ITerminatorViewModel.

◆ DisplayName

new string TPG.GeoFramework.Terminator.TerminatorViewModel.DisplayName

get

Implements TPG.GeoFramework.Contracts.Geo.Layer.IViewModelBase.

◆ LineColor

Color TPG.GeoFramework.Terminator.TerminatorViewModel.LineColor

getset

Get or set line colour.

Implements TPG.GeoFramework.Terminator.ITerminatorViewModel.

◆ LineStyle

DashStyle TPG.GeoFramework.Terminator.TerminatorViewModel.LineStyle

getset

Get or set line style.

Implements TPG.GeoFramework.Terminator.ITerminatorViewModel.

◆ LineThickness

int TPG.GeoFramework.Terminator.TerminatorViewModel.LineThickness

getset

Get or set line thickness.

Implements TPG.GeoFramework.Terminator.ITerminatorViewModel.

◆ NightShading

bool TPG.GeoFramework.Terminator.TerminatorViewModel.NightShading

getset

Enable/disable night shading.

Implements TPG.GeoFramework.Terminator.ITerminatorViewModel.

◆ NightShadingColor

Color TPG.GeoFramework.Terminator.TerminatorViewModel.NightShadingColor

getset

Get or set night shading color.

Implements TPG.GeoFramework.Terminator.ITerminatorViewModel.

◆ UpdateInterval

TimeSpan TPG.GeoFramework.Terminator.TerminatorViewModel.UpdateInterval

getset

Get or set update interval (default = 10 min)

Implements TPG.GeoFramework.Terminator.ITerminatorViewModel.

◆ UtcTime

DateTime TPG.GeoFramework.Terminator.TerminatorViewModel.UtcTime

getset

Get or set time explicitly - if other than current.

Implements TPG.GeoFramework.Terminator.ITerminatorViewModel.

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

Src/Layers/Terminator/TPG.GeoFramework.Terminator/TerminatorViewModel.cs

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TerminatorViewModel()

Member Function Documentation

◆ HandleInputEvent()

◆ Update()

Property Documentation

◆ AutoUpdate

◆ Contour

◆ DisplayName

◆ LineColor

◆ LineStyle

◆ LineThickness

◆ NightShading

◆ NightShadingColor

◆ UpdateInterval

◆ UtcTime