AP&C API Reference
Public Member Functions | Protected Member Functions | Properties | List of all members
Apac.Collections.TimestampedList< T > Class Template Reference
Inheritance diagram for Apac.Collections.TimestampedList< T >:
Apac.Collections.TimeTrackingList< T > Apac.Monitoring.ITimeStamped Apac.Monitoring.ITimeTracking

Public Member Functions

 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...
 
- Public Member Functions inherited from Apac.Collections.TimeTrackingList< T >
 TimeTrackingList ()
 Initializes a new instance of the TimeTrackingList<T> class. More...
 
 TimeTrackingList (System.Collections.Generic.IList< T > list)
 Initializes a new instance of the TimeTrackingList<T> class. More...
 
void AddRange (System.Collections.Generic.IEnumerable< T > list)
 Adds a set of items to the collection. More...
 
Find (Predicate< T > match)
 Finds the specified T by using match , which is defined by the caller. More...
 
T[] GetSorted (System.Collections.Generic.IComparer< T > comparer)
 Gets a sorted version of the collection. The references provided in the System.Collections.Generic.IEnumerable<T> are 'live' in the collection. Updates to those objects will change the objects in the collection. More...
 

Protected Member Functions

 TimestampedList (SerializationInfo info, StreamingContext context)
 Initializes a new instance of the TimestampedList<T> class. More...
 
- Protected Member Functions inherited from Apac.Collections.TimeTrackingList< T >
 TimeTrackingList (SerializationInfo info, StreamingContext context)
 Initializes a new instance of the TimeTrackingList<T> class. More...
 
override void InsertItem (int index, T item)
 Inserts an element into the T:System.Collections.ObjectModel.Collection`1 at the specified index. More...
 
override void SetItem (int index, T item)
 Replaces the element at the specified index. More...
 
override void RemoveItem (int index)
 Removes the element at the specified index of the T:System.Collections.ObjectModel.Collection`1. More...
 
override void ClearItems ()
 Removes all elements from the T:System.Collections.ObjectModel.Collection`1. More...
 
virtual void OnListChanged (System.ComponentModel.ListChangedEventArgs args)
 Raises the E:ListChanged event. More...
 
virtual void OnProcessedIn (T item)
 Allows subclasses to act when an item is processed into the collection. More...
 
virtual void OnProcessedOut (T item)
 Allows subclasses to act when an item is processed out of the collection. More...
 

Properties

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...
 
- Properties inherited from Apac.Collections.TimeTrackingList< T >
Minimum [get]
 Gets the minimum value in the collection. More...
 
Maximum [get]
 Gets the maximum value in the collection. More...
 
DateTime LowerBoundStamp [get]
 Gets the lower bound stamp. More...
 
DateTime UpperBoundStamp [get]
 Gets the upper bound stamp. More...
 
- Properties inherited from Apac.Monitoring.ITimeTracking
DateTime LowerBoundStamp [get]
 
DateTime UpperBoundStamp [get]
 
- Properties inherited from Apac.Monitoring.ITimeStamped
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...
 

Additional Inherited Members

- Events inherited from Apac.Collections.TimeTrackingList< T >
Apac.Monitoring.ListChangedHandler ListChanged
 Occurs when the contents of the list has changed. More...
 
- Events inherited from Apac.Monitoring.ITimeTracking
ListChangedHandler ListChanged
 

Constructor & Destructor Documentation

◆ TimestampedList() [1/5]

Initializes a new instance of the TimestampedList<T> class.

◆ TimestampedList() [2/5]

Apac.Collections.TimestampedList< T >.TimestampedList ( DateTime  stamp)
inline

Initializes a new instance of the TimestampedList<T> class.

Parameters
stampThe stamp.

◆ TimestampedList() [3/5]

Apac.Collections.TimestampedList< T >.TimestampedList ( DateTime  stamp,
Monitoring.ManagedElement  element 
)
inline

Initializes a new instance of the TimestampedList<T> class.

Parameters
stampThe stamp.
elementThe element.

◆ TimestampedList() [4/5]

Apac.Collections.TimestampedList< T >.TimestampedList ( DateTime  stamp,
IList< T >  list 
)
inline

Initializes a new instance of the TimestampedList<T> class.

Parameters
stampThe stamp.
listThe list.

◆ TimestampedList() [5/5]

Apac.Collections.TimestampedList< T >.TimestampedList ( SerializationInfo  info,
StreamingContext  context 
)
inlineprotected

Initializes a new instance of the TimestampedList<T> class.

Parameters
infoThe info.
contextThe context.

Member Function Documentation

◆ CompareTo()

int Apac.Collections.TimestampedList< T >.CompareTo ( object  obj)
inline

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.

Parameters
objAn object to compare with this instance.
Returns
A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has these meanings: Value Meaning Less than zero This instance precedes obj in the sort order. Zero This instance occurs in the same position in the sort order as obj . Greater than zero This instance follows obj in the sort order.

◆ GetObjectData()

override void Apac.Collections.TimestampedList< T >.GetObjectData ( SerializationInfo  info,
StreamingContext  context 
)
inlinevirtual

Gets the object data.

Parameters
infoThe info.
contextThe context.

Reimplemented from Apac.Collections.TimeTrackingList< T >.

Property Documentation

◆ Bucket

int Apac.Collections.TimestampedList< T >.Bucket
get

Gets the bucket, which is a five minute period. There are 12 buckets in an hour and 288 buckets in a day.

◆ Element

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.

◆ Offset

int Apac.Collections.TimestampedList< T >.Offset
get

Gets the offset into the bucket in seconds.

◆ Timestamp

DateTime Apac.Collections.TimestampedList< T >.Timestamp
get

Gets the timestamp.


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