Apac.Data.MeasurementQueryCriteria Class Reference

Inheritance diagram for Apac.Data.MeasurementQueryCriteria:

Public Member Functions
	MeasurementQueryCriteria (IList< uint > elementIds, string measurementType, int startingBucket, int startingOffset, uint numSamples, uint subintervalModulus)
	Builds a query criteria object that lets the data store perform a store-specific query to the data set. This form of the object allows querying by bucket and (optionally) offset. More...
	MeasurementQueryCriteria (IList< uint > elementIds, string measurementType, string markType, uint numSamples, uint subintervalModulus)
	Builds a list of More...
	MeasurementQueryCriteria (string elementCategory, string measurementType, string markType, uint numSamples, uint subintervalModulus)
	MeasurementQueryCriteria (IList< uint > elementIds, DateRange window, string measurementType, uint subintervalModulus)
	MeasurementQueryCriteria (decimal requestedValue, DateRange window)
	MeasurementQueryCriteria (string elementCategory, string measurementType, DateRange window, uint subintervalModulus)
void	BumpOffset (int bumpSize)
void	BumpWindow (TimeSpan advanceInterval)
void	AdjustToEndOfWindow (uint numSamples)
override string	ToString ()
void	GetObjectData (SerializationInfo info, StreamingContext context)

Protected Member Functions
	MeasurementQueryCriteria (SerializationInfo info, StreamingContext context)

Properties
IList< uint >	ElementIds [get, set]
decimal	Value [get, set]
DateRange	Window [get, set]
ValueRange	Range [get, set]
uint	SubintervalModulus [get, set]
	Sets the modulus used to filter the results on an interval. Note that zero (0) is not a valid value and will be converted to one (1). More...
string	MeasurementType [get, set]
string	MarkType [get, set]
int	StartingBucket [get, set]
int	StartingOffset [get, set]
uint	NumberOfSamples [get, set]
string	ElementCategory [get, set]

Constructor & Destructor Documentation

MeasurementQueryCriteria() [1/2]

Apac.Data.MeasurementQueryCriteria.MeasurementQueryCriteria ( IList< uint >  elementIds, string  measurementType, int  startingBucket, int  startingOffset, uint  numSamples, uint  subintervalModulus  )

inline

Builds a query criteria object that lets the data store perform a store-specific query to the data set. This form of the object allows querying by bucket and (optionally) offset.

Parameters

elementIds	The list of elements to which the query applies.
measurementType	The type of measurements to query. See Measurement<ushort>.MeasurementType.
startingBucket	The bucket used to start the query.
startingOffset	The offset used to start the query. If offset (seconds) isn't applicable to the query, then use -1.
numSamples	The number of samples to return.
subintervalModulus	A modulus used to filter out measurements by period. For example, sending a subintervalModulus of 5 on a query with a measurementType of 'Measurement' will result in every fifth measurement coming back that meets the other criteria.

MeasurementQueryCriteria() [2/2]

Apac.Data.MeasurementQueryCriteria.MeasurementQueryCriteria ( IList< uint >  elementIds, string  measurementType, string  markType, uint  numSamples, uint  subintervalModulus  )

inline

Builds a list of

Parameters

elementIds	The list of elements to which the query applies.
markType	The type of algorithm used to establish the mark time for the query. The mark time sets the beginning range of the query by date.
measurementType	The type of measurements to query. See Measurement<ushort>.MeasurementType.
numSamples	The number of measurements to retrieve. This is used with measurementType to determine the size of the date range to query.
subintervalModulus	A modulus used to filter out measurements by period. For example, sending a subintervalModulus of 5 on a query with a measurementType of 'Measurement' will result in every fifth measurement coming back that meets the other criteria.

Property Documentation

SubintervalModulus

uint Apac.Data.MeasurementQueryCriteria.SubintervalModulus

getset

Sets the modulus used to filter the results on an interval. Note that zero (0) is not a valid value and will be converted to one (1).

---

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

• /var/lib/jenkins/workspace/apac/APAC/APACCore/Data/MeasurementQueryCriteria.cs