AP&C API Reference
Public Member Functions | Protected Member Functions | Properties | Events | List of all members
Apac.Ecop.MeasurementQueryRequest 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.MeasurementQueryRequest:
Apac.Ecop.QueryController< Apac.Data.MeasurementQueryCriteria > Apac.Ecop.IMeasurementPresenter

Public Member Functions

 MeasurementQueryRequest (int pollFrequency, Apac.Data.MeasurementQueryCriteria criteria, TimeSpan advanceInterval, System.Windows.Forms.Control control)
 
 MeasurementQueryRequest (int pollFrequency, Apac.Data.MeasurementQueryCriteria criteria, TimeSpan advanceInterval, MeasurementsReadyHandler uiUpdateMethod, System.Windows.Forms.Control control)
 
void MeasurementsReady (IMeasurementPresenter self, Apac.Collections.TimeTrackingList< Apac.Monitoring.Measurements > measurements)
 The callback used to notify the presenter that the measurements 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

MeasurementsReadyHandler Update [get, set]
 
- Properties inherited from Apac.Ecop.QueryController< Apac.Data.MeasurementQueryCriteria >
System.Windows.Forms.Control Control [get]
 
int PollFrequencyMS [get, set]
 
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.IMeasurementPresenter
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
 
MeasurementPresenterRunStateChangedHandler RunStateChanged
 
- Events inherited from Apac.Ecop.IMeasurementPresenter
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

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

◆ MeasurementsReady()

void Apac.Ecop.MeasurementQueryRequest.MeasurementsReady ( IMeasurementPresenter  self,
Apac.Collections.TimeTrackingList< Apac.Monitoring.Measurements measurements 
)
inline

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

Parameters
measurementsThe requested measurements.

Implements Apac.Ecop.IMeasurementPresenter.


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