Click or drag to resize

EntityFilterChain<TEntity> Class

Groups entities into EntitySets with a series of filters.
Inheritance Hierarchy
System.Object
  AGI.Foundation.Infrastructure.DefinitionalObject
    AGI.Foundation.Tracking.EntityFilterChain<TEntity>

Namespace:  AGI.Foundation.Tracking
Assembly:  AGI.Foundation.Tracking (in AGI.Foundation.Tracking.dll) Version: 25.1.421.0 (25.1.421.0)
Syntax
public class EntityFilterChain<TEntity> : DefinitionalObject
where TEntity : class, IEntityIdentifier

Type Parameters

TEntity
The type of entity.

The EntityFilterChain<TEntity> type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyFilters
Gets the list of filters being managed by this chain. After changing this collection, you must call ApplyChanges() in order for the changes to take effect.
Public propertyHomelessEntities
Gets the set of entities that do not match any of the filters in the chain.
Public propertyInputEntities
Gets or sets the input entity set being filtered. After setting this property, you must call ApplyChanges() in order for the change to take effect.
Public propertyIsFrozen
Gets a value indicating whether this object is frozen. A frozen object cannot be modified and an ObjectFrozenException will be thrown if an attempt is made to do so.
(Inherited from DefinitionalObject.)
Public propertyMatchingStrategy
Gets or sets the MatchingStrategy used to place entities into the Filters collection. You must call ApplyChanges() in order for the change to take effect.
Top
Methods
  NameDescription
Public methodApplyChanges
Applies any changes so that they take effect the next time RedistributeEntities() is invoked. It is necessary to call this method after setting the InputEntities and MatchingStrategy properties and after modifying the Filters collection.
Protected methodCheckForSameDefinition(DefinitionalObject)
Checks to determine if another instance has the same definition as this instance and returns true if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return false for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
(Overrides DefinitionalObject.CheckForSameDefinition(DefinitionalObject).)
Protected methodCheckForSameDefinition(EntityFilterChain<TEntity>)
Checks to determine if another instance has the same definition as this instance and returns true if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return false for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
Public methodClone
Clones this object using the specified context.
(Overrides DefinitionalObject.Clone(CopyContext).)
Protected methodComputeCurrentDefinitionHashCode
Computes a hash code based on the current properties of this object. Derived classes MUST override this method and compute a hash code that combines: a unique hash code seed, the base implementation result, and the hash codes of all new fields introduced by the derived class which are used in the CheckForSameDefinition(DefinitionalObject) method.
(Overrides DefinitionalObject.ComputeCurrentDefinitionHashCode().)
Public methodEnumerateDependencies
Enumerates the dependencies of this object by calling Enumerate<T> (T) for each object that this object directly depends upon. Derived classes which contain additional dependencies MUST override this method, call the base implementation, and enumerate dependencies introduced by the derived class.
(Inherited from DefinitionalObject.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFreeze
Freezes this object. Further attempts to modify it will result in an ObjectFrozenException.
(Inherited from DefinitionalObject.)
Protected methodFreezeAggregatedObjects
Called by Freeze() to also freeze any objects that are considered to be a part of this object. Derived classes which contain additional aggregated objects MUST override this method, call the base implementation, and freeze aggregated objects introduced by the derived class. The objects that need to be frozen in this method are frequently created in this object's constructor and are not settable via properties.
(Inherited from DefinitionalObject.)
Public methodGetDefinitionHashCode()
Gets a hash code representing the definition of this object.
(Inherited from DefinitionalObject.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsSameDefinition
Determines if this object has the same definition as another object.
(Inherited from DefinitionalObject.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodRedistributeEntities()
Redistributes all entities in InputEntities among the specified Filters using a new Transaction.
Public methodRedistributeEntities(Transaction)
Redistributes all entities in InputEntities among the specified Filters using the provided Transaction.
Protected methodThrowIfFrozen
Throws ObjectFrozenException if this object IsFrozen. This method should be called from any method or property that modifies this object.
(Inherited from DefinitionalObject.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also