Filter Class |
Filter allowing user to specify a subset of the data set.
It contains a list of IDataItemFilter
that must all accept a dataitem before it is accepted
by this filter.
Inheritance HierarchyNamespace: DHI.Mike1D.ResultDataAccess
Assembly: DHI.Mike1D.ResultDataAccess (in DHI.Mike1D.ResultDataAccess.dll) Version: 16.0.0.0 (11.1.1.1111)
SyntaxC#
public class Filter : IFilter, IExtensibleDataObject
The Filter type exposes the following members.
ConstructorsProperties| Name | Description | |
|---|---|---|
 | DataItemFilters |
List of data item filters
|
| ExtensionData |
Holds data from an extended DataContract
|
| LoadStep |
Indicate the step value for time steps when loading data from filein the file for loading time steps.
A value of 10 means that only time step with indices that divide with 10 are loaded, i.e. 0, 10, 20,... |
| Periods |
List of time periods in selection
|
| TimeFilter |
Bool indicating if this filter will filter in time
|
Methods| Name | Description | |
|---|---|---|
 | AddDataItemFilter |
Method for explicitly adding a filter
Provides COM interop support for adding filters to list. |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| Include(IDataItem) |
Returns true if the provided data item is to be included
by the filter.
|
| Include(DateTime, Int32) |
Returns true if the timestep matching provided dateTime
and timestepIndex is to be included by the filter.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See Also