AP&C API Reference
Public Member Functions | Protected Member Functions | Properties | List of all members
Apac.Monitoring.WeightedMeasurementAvgs Class Reference

This is a list of lists containing WeightedMeasurementAvg instances and (optionally) keyed by element ID. More...

Inheritance diagram for Apac.Monitoring.WeightedMeasurementAvgs:
Apac.Collections.TimestampedList< WeightedMeasurementAvg >

Public Member Functions

 WeightedMeasurementAvgs ()
 Initializes a new instance of the WeightedMeasurementAvgs class. More...
 
 WeightedMeasurementAvgs (DateTime stamp)
 Initializes a new instance of the WeightedMeasurementAvgs class. More...
 
 WeightedMeasurementAvgs (Monitoring.ManagedElement element)
 Initializes a new instance of the WeightedMeasurementAvgs class. More...
 
 WeightedMeasurementAvgs (DateTime stamp, Monitoring.ManagedElement element)
 Initializes a new instance of the WeightedMeasurementAvgs class. More...
 
bool Contains (uint elementid)
 Determines whether this collection contains an element with the specified elementid . More...
 
- Public Member Functions inherited from Apac.Collections.TimestampedList< WeightedMeasurementAvg >
 TimestampedList ()
 Initializes a new instance of the TimestampedList<T> class. More...
 
 TimestampedList (DateTime stamp)
 Initializes a new instance of the TimestampedList<T> class. More...
 
 TimestampedList (DateTime stamp, Monitoring.ManagedElement element)
 Initializes a new instance of the TimestampedList<T> class. More...
 
 TimestampedList (DateTime stamp, IList< T > list)
 Initializes a new instance of the TimestampedList<T> class. More...
 
override void GetObjectData (SerializationInfo info, StreamingContext context)
 Gets the object data. More...
 
int CompareTo (object obj)
 Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. More...
 

Protected Member Functions

 WeightedMeasurementAvgs (SerializationInfo info, StreamingContext context)
 Initializes a new instance of the WeightedMeasurementAvgs class. More...
 
override void OnProcessedIn (WeightedMeasurementAvg item)
 
override void OnProcessedOut (WeightedMeasurementAvg item)
 
- Protected Member Functions inherited from Apac.Collections.TimestampedList< WeightedMeasurementAvg >
 TimestampedList (SerializationInfo info, StreamingContext context)
 Initializes a new instance of the TimestampedList<T> class. More...
 

Properties

WeightedMeasurementAvg this[uint elementid] [get]
 Gets the WeightedMeasurementAvg with the specified elementid. More...
 
decimal Mean [get]
 Gets the mean (average) value in the collection. Bear in mind this is the average value of a set of averages, not an aggregated average of all values used to make all averages in the collection. More...
 
- Properties inherited from Apac.Collections.TimestampedList< WeightedMeasurementAvg >
DateTime Timestamp [get]
 Gets the timestamp. More...
 
int Bucket [get]
 Gets the bucket, which is a five minute period. There are 12 buckets in an hour and 288 buckets in a day. More...
 
int Offset [get]
 Gets the offset into the bucket in seconds. More...
 
Monitoring.ManagedElement Element [get]
 The mapping containing the identifier and other information about the element to which this list applies. An element ID of zero (0) means either a mixed list or no association to an element is established. More...
 

Detailed Description

This is a list of lists containing WeightedMeasurementAvg instances and (optionally) keyed by element ID.

Constructor & Destructor Documentation

◆ WeightedMeasurementAvgs() [1/5]

Apac.Monitoring.WeightedMeasurementAvgs.WeightedMeasurementAvgs ( )
inline

Initializes a new instance of the WeightedMeasurementAvgs class.

◆ WeightedMeasurementAvgs() [2/5]

Apac.Monitoring.WeightedMeasurementAvgs.WeightedMeasurementAvgs ( DateTime  stamp)
inline

Initializes a new instance of the WeightedMeasurementAvgs class.

Parameters
stampThe stamp.

◆ WeightedMeasurementAvgs() [3/5]

Apac.Monitoring.WeightedMeasurementAvgs.WeightedMeasurementAvgs ( Monitoring.ManagedElement  element)
inline

Initializes a new instance of the WeightedMeasurementAvgs class.

Parameters
elementThe element.

◆ WeightedMeasurementAvgs() [4/5]

Apac.Monitoring.WeightedMeasurementAvgs.WeightedMeasurementAvgs ( DateTime  stamp,
Monitoring.ManagedElement  element 
)
inline

Initializes a new instance of the WeightedMeasurementAvgs class.

Parameters
stampThe stamp.
elementThe element.

◆ WeightedMeasurementAvgs() [5/5]

Apac.Monitoring.WeightedMeasurementAvgs.WeightedMeasurementAvgs ( SerializationInfo  info,
StreamingContext  context 
)
inlineprotected

Initializes a new instance of the WeightedMeasurementAvgs class.

Parameters
infoThe info.
contextThe context.

Member Function Documentation

◆ Contains()

bool Apac.Monitoring.WeightedMeasurementAvgs.Contains ( uint  elementid)
inline

Determines whether this collection contains an element with the specified elementid .

Parameters
elementidThe elementid.
Returns
true if [contains] [the specified elementid]; otherwise, false.

Property Documentation

◆ Mean

decimal Apac.Monitoring.WeightedMeasurementAvgs.Mean
get

Gets the mean (average) value in the collection. Bear in mind this is the average value of a set of averages, not an aggregated average of all values used to make all averages in the collection.

◆ this[uint elementid]

WeightedMeasurementAvg Apac.Monitoring.WeightedMeasurementAvgs.this[uint elementid]
get

Gets the WeightedMeasurementAvg with the specified elementid.

The WeightedMeasurementAvg.

Parameters
elementidThe elementid.
Returns

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