Click or drag to resize

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

Namespace:  DHI.Mike1D.CrossSectionModule
Assembly:  DHI.Mike1D.CrossSectionModule (in DHI.Mike1D.CrossSectionModule.dll) Version: 19.0.0.0 (11.1.1.1111)
Syntax
Copy
public class StandardCrossSectionFilter : ICrossSectionFilter, 
	IExtensibleDataObject

The StandardCrossSectionFilter type exposes the following members.

Constructors
  NameDescription
Public methodStandardCrossSectionFilter
constructor
Top
Properties
  NameDescription
Public propertyBranches
the branches to filter, case insensitive. Returns empty array if none. Set to empty array or to null to deactivate.
Public propertyExtensionData
Holds data from an extended DataContract
Public propertyTopoIDs
the TopoIDs to filter, case insensitive. Returns empty array if none. Set to empty array or to null to deactivate.
Top
Methods
  NameDescription
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 methodGetArea
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 Generic.Util.UndefinedDouble.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodPasses
returns true if the argument passes the filter
Public methodSetArea
the geographic area to filter. Requires that a cross section has end point coordinates defined, otherwise it won't pass. Set all coordinates to Generic.Util.UndefinedDouble to deactivate.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also