Click or drag to resize

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 Hierarchy
SystemObject
  DHI.Mike1D.ResultDataAccessFilter

Namespace:  DHI.Mike1D.ResultDataAccess
Assembly:  DHI.Mike1D.ResultDataAccess (in DHI.Mike1D.ResultDataAccess.dll) Version: 19.0.0.0 (11.1.1.1111)
Syntax
public class Filter : IFilter, IExtensibleDataObject

The Filter type exposes the following members.

Constructors
  NameDescription
Public methodFilter
Initializes a new instance of the Filter class
Top
Properties
  NameDescription
Public propertyDataItemFilters
List of data item filters
Public propertyExtensionData
Holds data from an extended DataContract
Public propertyLoadStep
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,...

Public propertyPeriods
List of time periods in selection
Public propertyTimeFilter
Bool indicating if this filter will filter in time
Top
Methods
  NameDescription
Public methodAddDataItemFilter
Method for explicitly adding a filter

Provides COM interop support for adding filters to list.

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 methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInclude(IDataItem)
Returns true if the provided data item is to be included by the filter.
Public methodInclude(DateTime, Int32)
Returns true if the timestep matching provided dateTime and timestepIndex is to be included by the filter.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also