Class DisplayPluginViewModel

Base class for the main display view model. Allows display interact with the rest of application.

Inheritance
System.Object
DisposableBase
DisposableBindableBase
DisplayPluginViewModel
Implements
System.IDisposable
System.ComponentModel.INotifyPropertyChanged
Inherited Members
Namespace: MAT.Atlas.Client.Presentation.Displays
Assembly: MAT.Atlas.Client.Presentation.dll
Syntax
public abstract class DisplayPluginViewModel : DisposableBindableBase, INotifyOfDisposal, IDisposable, INotifyPropertyChanged, IDisplayLetterViewModel

Constructors

DisplayPluginViewModel()

Declaration
protected DisplayPluginViewModel()

Properties

ActiveCompositeSessionContainer

Active composite session container ICompositeSessionContainer.

Declaration
protected ICompositeSessionContainer ActiveCompositeSessionContainer { get; }
Property Value
Type Description
ICompositeSessionContainer

CanRetrieveData

Gets whether a display can receive data by having a valid session assigned to it.

Declaration
protected bool CanRetrieveData { get; }
Property Value
Type Description
System.Boolean

true if this instance is active; otherwise, false.

IsSelected

Gets a value indicating whether this instance is active.

Declaration
protected bool IsSelected { get; }
Property Value
Type Description
System.Boolean

true if this instance is active; otherwise, false.

ScopeIdentity

Gets the scope identity.

Declaration
protected IScopeIdentity ScopeIdentity { get; }
Property Value
Type Description
IScopeIdentity

The scope identity IScopeIdentity.

ServiceContext

Gets the service context of the display.

Declaration
protected IDisplayPluginServiceContext ServiceContext { get; }
Property Value
Type Description
IDisplayPluginServiceContext

The display plugin service context IDisplayPluginServiceContext.

Methods

OnActiveDisplayPageChanged(Boolean)

Occurs when display's page active state changed.

Declaration
public virtual void OnActiveDisplayPageChanged(bool isActive)
Parameters
Type Name Description
System.Boolean isActive

true means the display can resume running; otherwise false.

OnCanRenderDisplayChanged(Boolean)

Occurs when underlying display selection changes.

Declaration
public virtual void OnCanRenderDisplayChanged(bool canRender)
Parameters
Type Name Description
System.Boolean canRender

true can render i.e. visible; otherwise false.

OnCompositeSessionContainerChanged()

Occurs when active composite session container changed.

Declaration
public virtual void OnCompositeSessionContainerChanged()

OnCompositeSessionLoaded(CompositeSessionEventArgs)

Occurs when a composite session is loaded.

Declaration
public virtual void OnCompositeSessionLoaded(CompositeSessionEventArgs args)
Parameters
Type Name Description
CompositeSessionEventArgs args

Loaded composite session CompositeSessionEventArgs.

OnCompositeSessionUnLoaded(CompositeSessionUnloadedEventArgs)

Occurs when a composite session is unloaded.

Declaration
public virtual void OnCompositeSessionUnLoaded(CompositeSessionUnloadedEventArgs args)
Parameters
Type Name Description
CompositeSessionUnloadedEventArgs args

Unloaded composite session CompositeSessionUnloadedEventArgs.

OnCursorDataPointChanged(ICompositeSession)

Occurs when the cursor data point changed.

Declaration
public virtual void OnCursorDataPointChanged(ICompositeSession compositeSession)
Parameters
Type Name Description
ICompositeSession compositeSession ICompositeSession

OnDisposeManagedResources()

Called to free managed resources.

Declaration
protected override void OnDisposeManagedResources()
Overrides

OnInitialised()

Occurs when display view model completed initialisation.

Declaration
protected virtual void OnInitialised()

OnParameterAdded(ParameterEventArgs)

Occurs when a parameter is added.

Declaration
public virtual void OnParameterAdded(ParameterEventArgs args)
Parameters
Type Name Description
ParameterEventArgs args

Added parameter ParameterEventArgs

OnParameterContainerAdded(IDisplayParameterContainer)

Occurs when the parameter container is added.

Declaration
public virtual void OnParameterContainerAdded(IDisplayParameterContainer parameterContainer)
Parameters
Type Name Description
IDisplayParameterContainer parameterContainer IDisplayParameterContainer

OnParameterContainerRemoved(Guid)

Occurs when the parameter container is removed.

Declaration
public virtual void OnParameterContainerRemoved(Guid instanceIdentifier)
Parameters
Type Name Description
System.Guid instanceIdentifier

Parameter instance identifier InstanceIdentifier.

OnParameterRemoved(ParameterEventArgs)

Occurs when a parameter is removed.

Declaration
public virtual void OnParameterRemoved(ParameterEventArgs args)
Parameters
Type Name Description
ParameterEventArgs args

Removed parameter ParameterEventArgs

OnSessionTimeRangeChanged(ICompositeSession)

Occurs when the data time range changed.

Declaration
public virtual void OnSessionTimeRangeChanged(ICompositeSession compositeSession)
Parameters
Type Name Description
ICompositeSession compositeSession ICompositeSession

ReadProperty<T>(T, String)

Reads the property value.

Declaration
public T ReadProperty<T>(T defaultValue, string propertyName = "")
Parameters
Type Name Description
T defaultValue

The default value.
System.String propertyName

The key.
Returns
Type Description
T

The property value.
Type Parameters
Name Description
T

The type of the property.

SaveProperty<T>(T, String)

Saves the display property value value.

Declaration
public void SaveProperty<T>(T item, string propertyName = "")
Parameters
Type Name Description
T item

The item value.
System.String propertyName

The property name.
Type Parameters
Name Description
T

The Property type

Implements

System.IDisposable
System.ComponentModel.INotifyPropertyChanged