Apac.Ecop.IMeasurementPresenter 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 measurements are available. More...

Inheritance diagram for Apac.Ecop.IMeasurementPresenter:

Public Member Functions
void	MeasurementsReady (IMeasurementPresenter self, Apac.Collections.TimeTrackingList< Measurements > measurements)
	The callback used to notify the presenter that the measurements have been retrieved. More...

Properties
int	PollFrequencyMS [get, set]
	Gets or sets frequency at which the measurements are to be polled. Allowing a set here allows for different scenarios in startup polling and long-term polling to be accomplished with the same presenter instance. 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 measurements. More...
MeasurementsReadyHandler	Update [get, set]
	Delegate property used to set the callout routine that gets invoked when measurements have been fetched from the server. 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
MeasurementPresenterStateChangedHandler	StatusChanged
	Notification that the status of the presenter has changed. More...
MeasurementPresenterRunStateChangedHandler	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 measurements are available.

Template Parameters

T	The measurement type to be served - should correspond with the type of data being tracked in the measurements.

Member Function Documentation

MeasurementsReady()

void Apac.Ecop.IMeasurementPresenter.MeasurementsReady	(	IMeasurementPresenter	self,
		Apac.Collections.TimeTrackingList< Measurements >	measurements
	)

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

Parameters

measurements

The requested measurements.

Implemented in Apac.Ecop.MeasurementQueryRequest.

Property Documentation

AdvanceInterval

TimeSpan Apac.Ecop.IMeasurementPresenter.AdvanceInterval

get

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

PollFrequencyMS

int Apac.Ecop.IMeasurementPresenter.PollFrequencyMS

getset

Gets or sets frequency at which the measurements are to be polled. Allowing a set here allows for different scenarios in startup polling and long-term polling to be accomplished with the same presenter instance.

QueryCriteria

MeasurementQueryCriteria Apac.Ecop.IMeasurementPresenter.QueryCriteria

get

The criteria to be used when polling for measurements.

Running

bool Apac.Ecop.IMeasurementPresenter.Running

get

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

Status

PresenterState Apac.Ecop.IMeasurementPresenter.Status

getset

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

Update

MeasurementsReadyHandler Apac.Ecop.IMeasurementPresenter.Update

getset

Delegate property used to set the callout routine that gets invoked when measurements have been fetched from the server.

Event Documentation

RunStateChanged

MeasurementPresenterRunStateChangedHandler Apac.Ecop.IMeasurementPresenter.RunStateChanged

Notification that the running state of the presenter has changed.

StatusChanged

MeasurementPresenterStateChangedHandler Apac.Ecop.IMeasurementPresenter.StatusChanged

Notification that the status of the presenter has changed.

---

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

• /var/lib/jenkins/workspace/apac/APAC/Ecop/IMeasurementPresenter.cs