Class ObservableEnumerable<T>
Denotes an abstract base class for collection-valued DDG nodes
Inherited Members
Namespace: NMF.Expressions.Linq
Assembly: NMF.Expressions.Linq.dll
Syntax
public abstract class ObservableEnumerable<T> : INotifyEnumerable<T>, INotifyEnumerable, INotifiable, ICollection<T>, IEnumerable<T>, IEnumerable, INotifyCollectionChanged, IDisposable, ISuccessorListType Parameters
| Name | Description |
|---|---|
| T | The type of elements |
Properties
| Edit this page View SourceAllSuccessors
Declaration
public IEnumerable<INotifiable> AllSuccessors { get; }Property Value
| Type | Description |
|---|---|
| IEnumerable<INotifiable> |
Count
Declaration
public virtual int Count { get; }Property Value
| Type | Description |
|---|---|
| int |
Dependencies
Nodes that notify this node.
Declaration
public abstract IEnumerable<INotifiable> Dependencies { get; }Property Value
| Type | Description |
|---|---|
| IEnumerable<INotifiable> |
ExecutionMetaData
Used by the execution engine during incremental execution.
Declaration
public ExecutionMetaData ExecutionMetaData { get; }Property Value
| Type | Description |
|---|---|
| ExecutionMetaData |
HasEventSubscriber
Indicates whether the collection has event subscribers attached
Declaration
protected bool HasEventSubscriber { get; }Property Value
| Type | Description |
|---|---|
| bool |
HasSuccessors
True, if there is any successor, otherwise False
Declaration
public bool HasSuccessors { get; }Property Value
| Type | Description |
|---|---|
| bool |
IsAttached
True, if successors are attached, otherwise False
Declaration
public bool IsAttached { get; }Property Value
| Type | Description |
|---|---|
| bool |
IsReadOnly
Declaration
public virtual bool IsReadOnly { get; }Property Value
| Type | Description |
|---|---|
| bool |
Successors
The nodes that will get notified by this node.
Declaration
public ISuccessorList Successors { get; }Property Value
| Type | Description |
|---|---|
| ISuccessorList |
Methods
| Edit this page View SourceAdd(T)
Declaration
public virtual void Add(T item)Parameters
| Type | Name | Description |
|---|---|---|
| T | item |
Clear()
Declaration
public virtual void Clear()Contains(T)
Declaration
public virtual bool Contains(T item)Parameters
| Type | Name | Description |
|---|---|---|
| T | item |
Returns
| Type | Description |
|---|---|
| bool |
CopyTo(T[], int)
Declaration
public void CopyTo(T[] array, int arrayIndex)Parameters
| Type | Name | Description |
|---|---|---|
| T[] | array | |
| int | arrayIndex |
Dispose()
Declaration
public void Dispose()GetEnumerator()
Declaration
public abstract IEnumerator<T> GetEnumerator()Returns
| Type | Description |
|---|---|
| IEnumerator<T> |
GetSuccessor(int)
Gets the successor at the given index
Declaration
public INotifiable GetSuccessor(int index)Parameters
| Type | Name | Description |
|---|---|---|
| int | index | The index |
Returns
| Type | Description |
|---|---|
| INotifiable | The DDG node with the given index |
Notify(IList<INotificationResult>)
Gets called when one of the dependencies signals a notification.
Declaration
public abstract INotificationResult Notify(IList<INotificationResult> sources)Parameters
| Type | Name | Description |
|---|---|---|
| IList<INotificationResult> | sources | Contains information about what triggered this notification. |
Returns
| Type | Description |
|---|---|
| INotificationResult | An object describing the changes that happened in this notification. |
OnAddItem(T, int)
Raises the collection changed event for an added item
Declaration
protected void OnAddItem(T item, int index = -1)Parameters
| Type | Name | Description |
|---|---|---|
| T | item | The item that is added |
| int | index | The index at which the item is added or -1 |
OnAddItems(IEnumerable<T>, int)
Raises the collection changed event for added items
Declaration
protected void OnAddItems(IEnumerable<T> items, int index = -1)Parameters
| Type | Name | Description |
|---|---|---|
| IEnumerable<T> | items | The items that are added |
| int | index | The start index at which items are added |
OnAttach()
Gets called when a successor attaches and there was no successor before
Declaration
protected virtual void OnAttach()OnCleared()
Raises the event that the collection was cleared
Declaration
protected void OnCleared()OnCollectionChanged(NotifyCollectionChangedEventArgs)
Raises a collection changed event
Declaration
protected void OnCollectionChanged(NotifyCollectionChangedEventArgs e)Parameters
| Type | Name | Description |
|---|---|---|
| NotifyCollectionChangedEventArgs | e | the event data |
OnDetach()
Gets called when the last successor detaches
Declaration
protected virtual void OnDetach()OnMoveItem(T, int, int)
Raises the event that the item was moved
Declaration
protected void OnMoveItem(T item, int oldIndex = 0, int newIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| T | item | the moved item |
| int | oldIndex | the old index |
| int | newIndex | the new index |
OnMoveItems(IEnumerable<T>, int, int)
Raises the event that the items were moved
Declaration
protected void OnMoveItems(IEnumerable<T> items, int oldIndex = 0, int newIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| IEnumerable<T> | items | the moved items |
| int | oldIndex | the old index |
| int | newIndex | the new index |
OnRemoveItem(T, int)
Raises the event that an item was removed
Declaration
protected void OnRemoveItem(T item, int index = -1)Parameters
| Type | Name | Description |
|---|---|---|
| T | item | The item that was removed |
| int | index | The index at which the item was removed or -1 |
OnRemoveItems(IEnumerable<T>, int)
Raises the event that items were removed
Declaration
protected void OnRemoveItems(IEnumerable<T> items, int index = -1)Parameters
| Type | Name | Description |
|---|---|---|
| IEnumerable<T> | items | The items that have been removed |
| int | index | The index at which items have been removed |
OnReplaceItem(T, T, int)
Raises the event that the item was replaced
Declaration
protected void OnReplaceItem(T old, T item, int index = -1)Parameters
| Type | Name | Description |
|---|---|---|
| T | old | the old item |
| T | item | the new item |
| int | index | the index of the elemnt or -1 |
OnReplaceItems(IEnumerable<T>, IEnumerable<T>, int)
Raises the event that items were replaced
Declaration
protected void OnReplaceItems(IEnumerable<T> oldItems, IEnumerable<T> newItems, int index = -1)Parameters
| Type | Name | Description |
|---|---|---|
| IEnumerable<T> | oldItems | the old items |
| IEnumerable<T> | newItems | the new items |
| int | index | the index at which the items have been replaced |
RaiseEvents(IList<T>, IList<T>, IList<T>, int, int)
Raises the events for the collections of changes
Declaration
protected void RaiseEvents(IList<T> added, IList<T> removed, IList<T> moved, int oldItemsStartIndex = -1, int newItemsStartIndex = -1)Parameters
| Type | Name | Description |
|---|---|---|
| IList<T> | added | A list of the added items |
| IList<T> | removed | A list of the removed items |
| IList<T> | moved | A list of the moved items |
| int | oldItemsStartIndex | the start index of old items or -1 |
| int | newItemsStartIndex | the start index of new items or -1 |
Remove(T)
Declaration
public virtual bool Remove(T item)Parameters
| Type | Name | Description |
|---|---|---|
| T | item |
Returns
| Type | Description |
|---|---|
| bool |
Set(INotifiable)
Add the given DDG node to the list
Declaration
public void Set(INotifiable node)Parameters
| Type | Name | Description |
|---|---|---|
| INotifiable | node | The DDG node to add |
SetDummy()
Sets a dummy
Declaration
public void SetDummy()ToString()
Declaration
public override string ToString()Returns
| Type | Description |
|---|---|
| string |
Overrides
| Edit this page View SourceUnset(INotifiable, bool)
Unset the given DDG node as successor
Declaration
public void Unset(INotifiable node, bool leaveDummy = false)Parameters
| Type | Name | Description |
|---|---|---|
| INotifiable | node | the DDG node |
| bool | leaveDummy | True, to leave the dummy in operation, otherwise False |
UnsetAll()
Clear the list
Declaration
public void UnsetAll()Events
| Edit this page View SourceCollectionChanged
Declaration
public event NotifyCollectionChangedEventHandler CollectionChangedEvent Type
| Type | Description |
|---|---|
| NotifyCollectionChangedEventHandler |