Skip to content

Working with Sessions#

A Session is a collection of data samples obtained from a data source.

Multiple Sessions may be loaded at one time and grouped into Sets.

Custom displays should respond appropriately when Sessions are loaded/unloaded.

Sessions Object Model#

Each Set is represented by a composite session container

Set

A Set is associated with a display

Associated Set

A composite session container contains zero or more composite sessions.

When there is more than one composite session that constitutes a compare set (overlay)

Overlay Set

A composite session contains one or more sessions.

When there is more than one session they can either be appended or overlaid

Append Set

Note

Associate sessions are not part of the this model.

Session properties, notification overrides and services#

  • DisplayPluginViewModel properties
    • ActiveCompositeSessionContainer property
      • Access to the Set associated with a display (can be null if no association)
  • DisplayPluginViewModel notifications
    • The following overrides are called for sessions
      • OnCompositeSessionLoaded()
        • Called when a composite session is loaded
      • OnCompositeSessionUnLoaded()
        • Called when a composite session is unloaded
      • OnCompositeSessionContainerChanged()
        • Called when a Set associated with a display is changed (i.e. ActiveCompositeSessionContainer property has changed)
  • Session Services
    • ISessionService
      • GetParameter()
        • Get details about a specific parameter
      • GetParametersCount()
        • Get the count of all parameters within a composite session
      • GetParameters()
        • Get details of all parameters within a composite session
    • ISessionSummaryService
      • GetSessionSummary()
        • Get session summary for session