AP&C API Reference
Public Member Functions | Properties | List of all members
Apac.Data.IMeasurementStore Interface Reference

The contract to be implemented by entities providing access to the store of measurements maintained by the system. More...

Inheritance diagram for Apac.Data.IMeasurementStore:
Apac.Data.IMeasurementQuery Apac.Data.IDataStore Apac.Data.ThreadedMeasurementStore Apac.Data.DatabaseStore Apac.Data.XmlFileStore Apac.Data.FirebirdStore

Public Member Functions

void RecordAlerts (Monitoring.Alerts alerts)
 Should records the alerts. More...
 
void RecordAlerts (Monitoring.Alerts alerts, StoreAccessCompleteHandler callout)
 Should records the alerts, will call back on callout . More...
 
void RetrieveAlerts (bool activeOnly, StoreAccessCompleteHandler callout)
 Should retrieve the alerts. More...
 
void RecordMeasurements (Monitoring.Measurements measurements)
 Should record raw measurements in the given bucket. More...
 
void RecordFiveMinAverages (Monitoring.WeightedMeasurementAvgs averages)
 Should record the given averages to the given 5-minute store. More...
 
void RecordHourlyAverages (Monitoring.WeightedMeasurementAvgs averages)
 Should record the given averages to the given 5-minute store. More...
 
void RecordDailyAverages (Monitoring.WeightedMeasurementAvgs averages)
 Should record the given averages to the given daily store. More...
 
void RecordMonthlyAverages (Monitoring.WeightedMeasurementAvgs averages)
 Should record the given averages to the given monthy store. More...
 
void RecordMeasurements (Monitoring.Measurements measurements, StoreAccessCompleteHandler callout)
 Should record raw measurements in the given bucket and call out to the delegate when complete. More...
 
void RecordFiveMinAverages (Monitoring.WeightedMeasurementAvgs averages, StoreAccessCompleteHandler callout)
 Should record the given averages to the given 5-minute store and call out to the delegate when complete. More...
 
void RecordHourlyAverages (Monitoring.WeightedMeasurementAvgs averages, StoreAccessCompleteHandler callout)
 Should record the given averages to the given 5-minute store and call out to the delegate when complete. More...
 
void RecordDailyAverages (Monitoring.WeightedMeasurementAvgs averages, StoreAccessCompleteHandler callout)
 Should record the given averages to the given daily store and call out to the delegate when complete. More...
 
void RecordMonthlyAverages (Monitoring.WeightedMeasurementAvgs averages, StoreAccessCompleteHandler callout)
 Should record the given averages to the given monthy store and call out to the delegate when complete. More...
 
- Public Member Functions inherited from Apac.Data.IMeasurementQuery
TimeTrackingList< Monitoring.MeasurementsFetchMeasurements (MeasurementQueryCriteria criteria)
 
TimeTrackingList< Monitoring.WeightedMeasurementAvgsFetchFiveMinuteAverages (MeasurementQueryCriteria criteria)
 
TimeTrackingList< Monitoring.WeightedMeasurementAvgsFetchHourlyAverages (MeasurementQueryCriteria criteria)
 
TimeTrackingList< Monitoring.WeightedMeasurementAvgsFetchDailyAverages (MeasurementQueryCriteria criteria)
 
TimeTrackingList< Monitoring.WeightedMeasurementAvgsFetchMonthlyAverages (MeasurementQueryCriteria criteria)
 
- Public Member Functions inherited from Apac.Data.IDataStore
void Initialize (Configuration.DataStoreConfig config)
 
void Open ()
 
void Close ()
 

Properties

Monitoring.AlertCache AlertCache [get]
 Gets the alert cache. More...
 
- Properties inherited from Apac.Data.IDataStore
string Location [get]
 

Detailed Description

The contract to be implemented by entities providing access to the store of measurements maintained by the system.

Template Parameters
T

Member Function Documentation

◆ RecordAlerts() [1/2]

void Apac.Data.IMeasurementStore.RecordAlerts ( Monitoring.Alerts  alerts)

Should records the alerts.

Parameters
alertsThe alerts.

◆ RecordAlerts() [2/2]

void Apac.Data.IMeasurementStore.RecordAlerts ( Monitoring.Alerts  alerts,
StoreAccessCompleteHandler  callout 
)

Should records the alerts, will call back on callout .

Parameters
alertsThe alerts.
calloutThe method that will be called whent the store access has completed.

◆ RecordDailyAverages() [1/2]

void Apac.Data.IMeasurementStore.RecordDailyAverages ( Monitoring.WeightedMeasurementAvgs  averages)

Should record the given averages to the given daily store.

Parameters
averagesThe averages to be recorded, which also indicate the time components of the recording.

◆ RecordDailyAverages() [2/2]

void Apac.Data.IMeasurementStore.RecordDailyAverages ( Monitoring.WeightedMeasurementAvgs  averages,
StoreAccessCompleteHandler  callout 
)

Should record the given averages to the given daily store and call out to the delegate when complete.

Parameters
averagesThe averages to be recorded, which also indicate the time components of the recording.
calloutThe delegate that gets called after the measurements are recorded. Individual implementations may choose to call this delegate asynchronously.

◆ RecordFiveMinAverages() [1/2]

void Apac.Data.IMeasurementStore.RecordFiveMinAverages ( Monitoring.WeightedMeasurementAvgs  averages)

Should record the given averages to the given 5-minute store.

Parameters
averagesThe averages to be recorded, which also indicate the time components of the recording.

◆ RecordFiveMinAverages() [2/2]

void Apac.Data.IMeasurementStore.RecordFiveMinAverages ( Monitoring.WeightedMeasurementAvgs  averages,
StoreAccessCompleteHandler  callout 
)

Should record the given averages to the given 5-minute store and call out to the delegate when complete.

Parameters
averagesThe averages to be recorded, which also indicate the time components of the recording.
calloutThe delegate that gets called after the measurements are recorded. Individual implementations may choose to call this delegate asynchronously.

◆ RecordHourlyAverages() [1/2]

void Apac.Data.IMeasurementStore.RecordHourlyAverages ( Monitoring.WeightedMeasurementAvgs  averages)

Should record the given averages to the given 5-minute store.

Parameters
averagesThe averages to be recorded, which also indicate the time components of the recording.

◆ RecordHourlyAverages() [2/2]

void Apac.Data.IMeasurementStore.RecordHourlyAverages ( Monitoring.WeightedMeasurementAvgs  averages,
StoreAccessCompleteHandler  callout 
)

Should record the given averages to the given 5-minute store and call out to the delegate when complete.

Parameters
averagesThe averages to be recorded, which also indicate the time components of the recording.
calloutThe delegate that gets called after the measurements are recorded. Individual implementations may choose to call this delegate asynchronously.

◆ RecordMeasurements() [1/2]

void Apac.Data.IMeasurementStore.RecordMeasurements ( Monitoring.Measurements  measurements)

Should record raw measurements in the given bucket.

Parameters
measurementsThe measurements to be recorded, which also indicate the time components of the recording.

◆ RecordMeasurements() [2/2]

void Apac.Data.IMeasurementStore.RecordMeasurements ( Monitoring.Measurements  measurements,
StoreAccessCompleteHandler  callout 
)

Should record raw measurements in the given bucket and call out to the delegate when complete.

Parameters
measurementsThe measurements to be recorded, which also indicate the time components of the recording.
calloutThe delegate that gets called after the measurements are recorded. Individual implementations may choose to call this delegate asynchronously.

◆ RecordMonthlyAverages() [1/2]

void Apac.Data.IMeasurementStore.RecordMonthlyAverages ( Monitoring.WeightedMeasurementAvgs  averages)

Should record the given averages to the given monthy store.

Parameters
averagesThe averages to be recorded, which also indicate the time components of the recording.

◆ RecordMonthlyAverages() [2/2]

void Apac.Data.IMeasurementStore.RecordMonthlyAverages ( Monitoring.WeightedMeasurementAvgs  averages,
StoreAccessCompleteHandler  callout 
)

Should record the given averages to the given monthy store and call out to the delegate when complete.

Parameters
averagesThe averages to be recorded, which also indicate the time components of the recording.
calloutThe delegate that gets called after the measurements are recorded. Individual implementations may choose to call this delegate asynchronously.

◆ RetrieveAlerts()

void Apac.Data.IMeasurementStore.RetrieveAlerts ( bool  activeOnly,
StoreAccessCompleteHandler  callout 
)

Should retrieve the alerts.

Parameters
activeOnlyIndicates if only active alerts should be retrieved.
calloutThe method that will be called whent the store access has completed.
Returns
Returns a List{Monitoring.Alert} containing any uncleared alerts.

Implemented in Apac.Data.ThreadedMeasurementStore.

Property Documentation

◆ AlertCache

Monitoring.AlertCache Apac.Data.IMeasurementStore.AlertCache
get

Gets the alert cache.

The alert cache.


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