StandardCrossSectionFilter Class |
basic filter for cross sections, e.g., for partial loading or display.
allows filtering by branch name(s), TopoId(s), and area.
TODO: If use, reimplement using dictionary instead of arrays, for performance.
Inheritance HierarchyNamespace: DHI.Mike1D.CrossSectionModule
Assembly: DHI.Mike1D.CrossSectionModule (in DHI.Mike1D.CrossSectionModule.dll) Version: 16.0.0.0 (11.1.1.1111)
SyntaxC#
public class StandardCrossSectionFilter : ICrossSectionFilter, IExtensibleDataObject
The StandardCrossSectionFilter type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | StandardCrossSectionFilter |
constructor
|
Properties| Name | Description | |
|---|---|---|
 | Branches |
the branches to filter, case insensitive. Returns empty array if none.
Set to empty array or to null to deactivate.
|
| ExtensionData |
Holds data from an extended DataContract
|
| TopoIDs |
the TopoIDs to filter, case insensitive. Returns empty array if none.
Set to empty array or to null to deactivate.
|
Methods| Name | Description | |
|---|---|---|
| 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.) |
| GetArea |
the geographic area to filter. Requires that a cross section has end point
coordinates defined, otherwise it won't pass. Not active if all coordinates
are COMMath.DOUBLE_NaN.
|
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Passes |
returns true if the argument passes the filter
|
| SetArea |
the geographic area to filter. Requires that a cross section has end point
coordinates defined, otherwise it won't pass. Set all coordinates to
COMMath.DOUBLE_NaN to deactivate.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See Also