Class OppositeSet<TParent, TCollected>

Namespace

NMF.Collections.ObjectModel

Assembly

NMF.Collections.dll

Denotes an abstract base class for a set with opposites

public abstract class OppositeSet<TParent, TCollected> : DecoratedSet<TCollected>, ISet<TCollected>, ICollection<TCollected>, IEnumerable<TCollected>, IList, ICollection, IEnumerable

Type Parameters

TParent

the type of the parent

TCollected

the type of the collection items

Inheritance

object

DecoratedSet<TCollected>

OppositeSet<TParent, TCollected>

Implements

ISet<TCollected>

ICollection<TCollected>

IEnumerable<TCollected>

IList

ICollection

IEnumerable

Inherited Members

DecoratedSet<TCollected>.Items

DecoratedSet<TCollected>.ExceptWith(IEnumerable<TCollected>)

DecoratedSet<TCollected>.IntersectWith(IEnumerable<TCollected>)

DecoratedSet<TCollected>.IsProperSubsetOf(IEnumerable<TCollected>)

DecoratedSet<TCollected>.IsProperSupersetOf(IEnumerable<TCollected>)

DecoratedSet<TCollected>.IsSubsetOf(IEnumerable<TCollected>)

DecoratedSet<TCollected>.IsSupersetOf(IEnumerable<TCollected>)

DecoratedSet<TCollected>.Overlaps(IEnumerable<TCollected>)

DecoratedSet<TCollected>.SetEquals(IEnumerable<TCollected>)

DecoratedSet<TCollected>.SymmetricExceptWith(IEnumerable<TCollected>)

DecoratedSet<TCollected>.UnionWith(IEnumerable<TCollected>)

DecoratedSet<TCollected>.Contains(TCollected)

DecoratedSet<TCollected>.CopyTo(TCollected[], int)

DecoratedSet<TCollected>.Count

DecoratedSet<TCollected>.GetEnumerator()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

OppositeSet(TParent)

Creates a new instance

protected OppositeSet(TParent parent)

Parameters

parent TParent

the parent model element

Exceptions

ArgumentNullException

thrown if parent is null

Properties

Parent

Gets the parent element

public TParent Parent { get; }

Property Value

TParent

Methods

Add(TCollected)

Adds an element to the current set and returns a value to indicate if the element was successfully added.

public override bool Add(TCollected item)

Parameters

item TCollected

The element to add to the set.

Returns

bool

true if the element is added to the set; false if the element is already in the set.

Clear()

Removes all items from the ICollection<T>.

public override void Clear()

Exceptions

NotSupportedException

The ICollection<T> is read-only.

Remove(TCollected)

Removes the first occurrence of a specific object from the ICollection<T>.

public override bool Remove(TCollected item)

Parameters

item TCollected

The object to remove from the ICollection<T>.

Returns

bool

true if item was successfully removed from the ICollection<T>; otherwise, false. This method also returns false if item is not found in the original ICollection<T>.

Exceptions

NotSupportedException

The ICollection<T> is read-only.

SetOpposite(TCollected, TParent)

Sets the opposite of the given item

protected abstract void SetOpposite(TCollected item, TParent newParent)

Parameters

item TCollected

the item

newParent TParent

the new parent or null, if the item is removed from the collection