AP&C API Reference
Public Member Functions | Protected Member Functions | Properties | Events | List of all members
Apac.Collections.TimeTrackingList< T > Class Template Reference

A collection that tracks the upper and lower time stamps of Apac.Monitoring.ITimeStamped items added to it and also the minimum and maximum values of items added to it. More...

Inheritance diagram for Apac.Collections.TimeTrackingList< T >:
Apac.Monitoring.ITimeTracking Apac.Collections.TimestampedList< T >

Public Member Functions

 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...
 
virtual void GetObjectData (SerializationInfo info, StreamingContext context)
 

Protected Member Functions

 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

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]
 

Events

Apac.Monitoring.ListChangedHandler ListChanged
 Occurs when the contents of the list has changed. More...
 
- Events inherited from Apac.Monitoring.ITimeTracking
ListChangedHandler ListChanged
 

Detailed Description

A collection that tracks the upper and lower time stamps of Apac.Monitoring.ITimeStamped items added to it and also the minimum and maximum values of items added to it.

Template Parameters
TThe type of items contained in the list.
Type Constraints
T :Apac.Monitoring.ITimeStamped 

Constructor & Destructor Documentation

◆ TimeTrackingList() [1/3]

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

◆ TimeTrackingList() [2/3]

Apac.Collections.TimeTrackingList< T >.TimeTrackingList ( System.Collections.Generic.IList< T >  list)
inline

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

Parameters
listThe list.

◆ TimeTrackingList() [3/3]

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

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

Parameters
infoThe info.
contextThe context.

Member Function Documentation

◆ AddRange()

void Apac.Collections.TimeTrackingList< T >.AddRange ( System.Collections.Generic.IEnumerable< T >  list)
inline

Adds a set of items to the collection.

Parameters
listThe list.

◆ ClearItems()

override void Apac.Collections.TimeTrackingList< T >.ClearItems ( )
inlineprotected

Removes all elements from the T:System.Collections.ObjectModel.Collection`1.

◆ Find()

T Apac.Collections.TimeTrackingList< T >.Find ( Predicate< T >  match)
inline

Finds the specified T by using match , which is defined by the caller.

Parameters
matchThe match.
Returns
Returns the required T or null.

◆ GetSorted()

T [] Apac.Collections.TimeTrackingList< T >.GetSorted ( System.Collections.Generic.IComparer< T >  comparer)
inline

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.

Returns
Returns T:T[] with the sorted list.

◆ InsertItem()

override void Apac.Collections.TimeTrackingList< T >.InsertItem ( int  index,
item 
)
inlineprotected

Inserts an element into the T:System.Collections.ObjectModel.Collection`1 at the specified index.

Parameters
indexThe zero-based index at which item should be inserted.
itemThe object to insert. The value can be null for reference types.
Exceptions
T:System.ArgumentOutOfRangeExceptionindex is less than zero.-or-index is greater than P:System.Collections.ObjectModel.Collection`1.Count.

◆ OnListChanged()

virtual void Apac.Collections.TimeTrackingList< T >.OnListChanged ( System.ComponentModel.ListChangedEventArgs  args)
inlineprotectedvirtual

Raises the E:ListChanged event.

Parameters
argsThe System.ComponentModel.ListChangedEventArgs instance containing the event data.

◆ OnProcessedIn()

virtual void Apac.Collections.TimeTrackingList< T >.OnProcessedIn ( item)
inlineprotectedvirtual

Allows subclasses to act when an item is processed into the collection.

Parameters
item

◆ OnProcessedOut()

virtual void Apac.Collections.TimeTrackingList< T >.OnProcessedOut ( item)
inlineprotectedvirtual

Allows subclasses to act when an item is processed out of the collection.

Parameters
item

◆ RemoveItem()

override void Apac.Collections.TimeTrackingList< T >.RemoveItem ( int  index)
inlineprotected

Removes the element at the specified index of the T:System.Collections.ObjectModel.Collection`1.

Parameters
indexThe zero-based index of the element to remove.
Exceptions
T:System.ArgumentOutOfRangeExceptionindex is less than zero.-or-index is equal to or greater than P:System.Collections.ObjectModel.Collection`1.Count.

◆ SetItem()

override void Apac.Collections.TimeTrackingList< T >.SetItem ( int  index,
item 
)
inlineprotected

Replaces the element at the specified index.

Parameters
indexThe zero-based index of the element to replace.
itemThe new value for the element at the specified index. The value can be null for reference types.
Exceptions
T:System.ArgumentOutOfRangeExceptionindex is less than zero.-or-index is greater than P:System.Collections.ObjectModel.Collection`1.Count.

Property Documentation

◆ LowerBoundStamp

DateTime Apac.Collections.TimeTrackingList< T >.LowerBoundStamp
get

Gets the lower bound stamp.

◆ Maximum

Gets the maximum value in the collection.

◆ Minimum

Gets the minimum value in the collection.

◆ UpperBoundStamp

DateTime Apac.Collections.TimeTrackingList< T >.UpperBoundStamp
get

Gets the upper bound stamp.

Event Documentation

◆ ListChanged

Apac.Monitoring.ListChangedHandler Apac.Collections.TimeTrackingList< T >.ListChanged

Occurs when the contents of the list has changed.


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