AP&C API Reference
Public Member Functions | Properties | Events | List of all members
Apac.Ecop.IMeasurementAvgPresenter Interface Reference

The interface used by the ECOP core component to interact with the presentation layer, specifically for that layer to specify polling and querying criteria and to provide a callback address for when measurement averages are available. More...

Inheritance diagram for Apac.Ecop.IMeasurementAvgPresenter:
Apac.Ecop.AverageQueryController

Public Member Functions

void AveragesReady (IMeasurementAvgPresenter self, Apac.Collections.TimeTrackingList< WeightedMeasurementAvgs > avgs)
 The callback used to notify the presenter that the averages have been retrieved. More...
 

Properties

int PollFrequencyMS [get]
 The frequency at which the averages are to be polled. More...
 
TimeSpan AdvanceInterval [get]
 Gets the size of the time interval used to advance the query on each sequential poll. More...
 
MeasurementQueryCriteria QueryCriteria [get]
 The criteria to be used when polling for averages. More...
 
AveragesReadyHandler Update [get, set]
 The callback used to notify the presenter that the averages have been retrieved. More...
 
PresenterState Status [get, set]
 The current status of the polling thread for the presenter. See PresenterState. More...
 
bool Running [get]
 Indicates if the polling thread for the presenter is in the running mode or not. More...
 

Events

AvgPresenterStateChangedHandler StatusChanged
 Notification that the status of the presenter has changed. More...
 
AvgPresenterRunStateChangedHandler RunStateChanged
 Notification that the running state of the presenter has changed. More...
 

Detailed Description

The interface used by the ECOP core component to interact with the presentation layer, specifically for that layer to specify polling and querying criteria and to provide a callback address for when measurement averages are available.

Member Function Documentation

◆ AveragesReady()

void Apac.Ecop.IMeasurementAvgPresenter.AveragesReady ( IMeasurementAvgPresenter  self,
Apac.Collections.TimeTrackingList< WeightedMeasurementAvgs avgs 
)

The callback used to notify the presenter that the averages have been retrieved.

Parameters
avgsThe requested averages.

Implemented in Apac.Ecop.AverageQueryController.

Property Documentation

◆ AdvanceInterval

TimeSpan Apac.Ecop.IMeasurementAvgPresenter.AdvanceInterval
get

Gets the size of the time interval used to advance the query on each sequential poll.

◆ PollFrequencyMS

int Apac.Ecop.IMeasurementAvgPresenter.PollFrequencyMS
get

The frequency at which the averages are to be polled.

◆ QueryCriteria

MeasurementQueryCriteria Apac.Ecop.IMeasurementAvgPresenter.QueryCriteria
get

The criteria to be used when polling for averages.

◆ Running

bool Apac.Ecop.IMeasurementAvgPresenter.Running
get

Indicates if the polling thread for the presenter is in the running mode or not.

◆ Status

PresenterState Apac.Ecop.IMeasurementAvgPresenter.Status
getset

The current status of the polling thread for the presenter. See PresenterState.

◆ Update

AveragesReadyHandler Apac.Ecop.IMeasurementAvgPresenter.Update
getset

The callback used to notify the presenter that the averages have been retrieved.

Parameters
averagesThe requested averages.

Event Documentation

◆ RunStateChanged

AvgPresenterRunStateChangedHandler Apac.Ecop.IMeasurementAvgPresenter.RunStateChanged

Notification that the running state of the presenter has changed.

◆ StatusChanged

AvgPresenterStateChangedHandler Apac.Ecop.IMeasurementAvgPresenter.StatusChanged

Notification that the status of the presenter has changed.


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