Apac.Ecop.AverageQueryController Class Reference

Encapsulates the callout logic needed to plug in a presentation layer to the ECOP query client. Create one of these, providing it the update frequency, the query criteria, and the method handle to update the presentation layer, and the control to be updated. This class will be sure to marshal back to the control thread as necessary because the QueryClient is multi-threaded and the callback will occur on a different thread from that on which the UI control was created. More...

Inheritance diagram for Apac.Ecop.AverageQueryController:

Public Member Functions
	AverageQueryController (int pollFrequency, Apac.Data.MeasurementQueryCriteria criteria, TimeSpan advanceInterval, System.Windows.Forms.Control control)
	AverageQueryController (int pollFrequency, Apac.Data.MeasurementQueryCriteria criteria, TimeSpan advanceInterval, AveragesReadyHandler uiUpdateMethod, System.Windows.Forms.Control control)
void	AveragesReady (IMeasurementAvgPresenter self, Apac.Collections.TimeTrackingList< Apac.Monitoring.WeightedMeasurementAvgs > avgs)
	The callback used to notify the presenter that the averages have been retrieved. More...
Public Member Functions inherited from Apac.Ecop.QueryController< Apac.Data.MeasurementQueryCriteria >
	QueryController (int pollFrequency, T criteria, TimeSpan advanceInterval, System.Windows.Forms.Control control)

Protected Member Functions
override void	OnStatusChanged ()
override void	OnRunStateChanged ()

Properties
AveragesReadyHandler	Update [get, set]
Properties inherited from Apac.Ecop.QueryController< Apac.Data.MeasurementQueryCriteria >
System.Windows.Forms.Control	Control [get]
int	PollFrequencyMS [get, set]
T	QueryCriteria [get]
TimeSpan	AdvanceInterval [get]
	Gets the size of the time interval used to advance the query on each sequential poll. More...
PresenterState	Status [get, set]
bool	Running [get]
Properties inherited from Apac.Ecop.IMeasurementAvgPresenter
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
AvgPresenterRunStateChangedHandler	RunStateChanged
Events inherited from Apac.Ecop.IMeasurementAvgPresenter
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

Encapsulates the callout logic needed to plug in a presentation layer to the ECOP query client. Create one of these, providing it the update frequency, the query criteria, and the method handle to update the presentation layer, and the control to be updated. This class will be sure to marshal back to the control thread as necessary because the QueryClient is multi-threaded and the callback will occur on a different thread from that on which the UI control was created.

Member Function Documentation

AveragesReady()

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

inline

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

Parameters

avgs	The requested averages.

Implements Apac.Ecop.IMeasurementAvgPresenter.

---

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

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