Click or drag to resize

Res1DNetworkHFilter Class

An Res1DNetworkFilter that one reaches only includes H grid points, otherwise it behaves as the Res1DNetworkFilter.
Inheritance Hierarchy
System.Object
  DHI.Mike1D.Generic.NetworkData<Res1DSpatialFilterTypeEnum>
    DHI.Mike1D.ResultDataAccess.Res1DNetworkFilter
      DHI.Mike1D.ResultDataAccess.Res1DNetworkHFilter

Namespace:  DHI.Mike1D.ResultDataAccess
Assembly:  DHI.Mike1D.ResultDataAccess (in DHI.Mike1D.ResultDataAccess.dll) Version: 16.0.0.0 (11.1.1.1111)
Syntax
C#
public class Res1DNetworkHFilter : Res1DNetworkFilter

The Res1DNetworkHFilter type exposes the following members.

Constructors
  NameDescription
Public methodRes1DNetworkHFilter
Initializes a new instance of the Res1DNetworkHFilter class
Top
Properties
  NameDescription
Public propertyCanInterpolate
Flag specifying whether it makes sense to interpolate in values on a reach.
(Inherited from NetworkData<T>.)
Public propertyExtrapolationDistance
Distance from span/gridpoint where extrapolation takes place, i.e., if location chainage is outside the network value chainage span, but less than ExtrapolationDistance from the span, then the nearest value is extrapolated. Set to 0 to disable. Default is zero. Can not be negative.

When CanInterpolate is false, this specifies the distance to a chainage value/span that will return the point/span value, a tolerance value.

(Inherited from NetworkData<T>.)
Public propertyGlobalValue
The global value. Used, if nothing better is found. Setting the global value automatically also sets HasGlobalValue to true.
(Inherited from NetworkData<T>.)
Public propertyHasGlobalValue
Defines whether there is a global value, or strictly speaking, whether to use the global value.
(Inherited from NetworkData<T>.)
Public propertyHasValues
Flag specifying whether this data has values defined at all
(Inherited from NetworkData<T>.)
Public propertyLocalCount
Returns the number of locally defined values
(Inherited from NetworkData<T>.)
Public propertyNodeIdValuePairs
The set of node id's and values defined.
(Inherited from NetworkData<T>.)
Public propertyQuantity
Quantity stored in network data
(Inherited from NetworkData<T>.)
Public propertyReachData
Collection of reach data sets currently active
(Inherited from NetworkData<T>.)
Top
Methods
  NameDescription
Public methodAddGlobalReachValue(String, T)
Add a value defined for an entire reach. This will fail if there is already defined values at locations or in spans of this reach. After successfull addition, values at locations or in spans can not be added.
(Inherited from NetworkData<T>.)
Public methodAddGlobalReachValue(String, Boolean)
Add reach to filter, short of AddGlobalReachValue(String, T) with value All (true) or None (false)
(Inherited from Res1DNetworkFilter.)
Public methodAddValue(String, T)
Add a value for the node identified by nodeId
(Inherited from NetworkData<T>.)
Public methodAddValue(String, Boolean)
Add node to filter
(Inherited from Res1DNetworkFilter.)
Public methodAddValue(ILocation, T)
Add a value on the given location.
(Inherited from NetworkData<T>.)
Public methodAddValue(ILocation, Boolean)
Add location to filter
(Inherited from Res1DNetworkFilter.)
Public methodAddValue(ILocationSpan, T)
Add a value defined within the given span. This corresponds to adding the value at the start and end location of the span.
(Inherited from NetworkData<T>.)
Protected methodCheckGridpointType
Method that may further limit the grid points to accept. To be overridden in
(Overrides Res1DNetworkFilter.CheckGridpointType(IRes1DGridPoint).)
Public methodClear
Delete all localized values
(Inherited from NetworkData<T>.)
Public methodContainsValue
Check if a local value is specified at the location. Returns false if no value is defined for the location.

If more than one value is to be retrieved for the same reach, use the GetReachData(String) first and use that one (for performance).

(Inherited from NetworkData<T>.)
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 methodGetGlobalValue(T)
Get global value. Returns false if no global value is defined.
(Inherited from NetworkData<T>.)
Public methodGetGlobalValue(String, T)
Get value for the specified id. Returns false if no value is defined for the node id.
(Inherited from NetworkData<T>.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetReachData (Inherited from NetworkData<T>.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetValue(String, T)
Get value for the specified node. Returns false if no value is defined for the node id.
(Inherited from NetworkData<T>.)
Public methodGetValue(ILocation, T)
Get value for the specified location. Returns false if no value is defined for the location.

If more than one value is to be retrieved for the same reach, use the GetReachData(String) first and use that one to get the values (for performance).

(Inherited from NetworkData<T>.)
Public methodGetValues
Get value at the given locations. The locations must have same Location.ID and be ordred in the list by increasing chainages.
(Inherited from NetworkData<T>.)
Public methodIsIncluded(IRes1DCatchment)
Returns true if the catchment is included by the filter
(Inherited from Res1DNetworkFilter.)
Public methodIsIncluded(IRes1DNode)
Returns true if the node is included by the filter
(Inherited from Res1DNetworkFilter.)
Public methodIsIncluded(IRes1DReach)
Returns true if the entire reach is included by the filter
(Inherited from Res1DNetworkFilter.)
Public methodIsIncluded(IRes1DReach, IRes1DGridPoint)
Returns true if the gridpoint is included by the filter
(Overrides Res1DNetworkFilter.IsIncluded(IRes1DReach, IRes1DGridPoint).)
Public methodIsIncludedGlobal
Returns true if the global quantity is included by the filter
(Inherited from Res1DNetworkFilter.)
Protected methodIsReachIncluded
Check if reach is included.
(Overrides Res1DNetworkFilter.IsReachIncluded(String).)
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
Fields
Extension Methods
  NameDescription
Public Extension MethodGetValue<Res1DSpatialFilterTypeEnum>(ILocation)Overloaded.
Get a value from the networkData at the given location. If no value is found at location, the global value is used. If no global value is defined, an exception is thrown.
(Defined by GenericExtensions.)
Public Extension MethodGetValue<Res1DSpatialFilterTypeEnum>(ILocation, Res1DSpatialFilterTypeEnum)Overloaded.
Get a value from the networkData at the given location. If no value is found at location, the global value is used. If no global value is defined, the default value is returned.
(Defined by GenericExtensions.)
Public Extension MethodPointValues<Res1DSpatialFilterTypeEnum>
Gives an iterator that iterates over all point values in the network value set.

It will iterate first over all the nodes, and then over all the reaches and its locations.

(Defined by AbstractNetworkDataExtensions.)
Top
See Also