Res1DNetworkFilter Class |
Namespace: DHI.Mike1D.ResultDataAccess
The Res1DNetworkFilter type exposes the following members.
Name | Description | |
---|---|---|
![]() | Res1DNetworkFilter |
Constructor
|
Name | Description | |
---|---|---|
![]() | CanInterpolate |
Flag specifying whether it makes sense to interpolate
in values on a reach.
(Inherited from NetworkDataT.) |
![]() | ExtrapolationDistance |
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.
(Inherited from NetworkDataT.)When CanInterpolate is false, this specifies the distance to a chainage value/span that will return the point/span value, a tolerance value. |
![]() | GlobalValue |
The global value. Used, if nothing better is found.
Setting the global value automatically also sets
HasGlobalValue to true.
(Inherited from NetworkDataT.) |
![]() | HasGlobalValue |
Defines whether there is a global value, or strictly
speaking, whether to use the global value.
(Inherited from NetworkDataT.) |
![]() | HasValues |
Flag specifying whether this data has values defined at all
(Inherited from NetworkDataT.) |
![]() | LocalCount |
Returns the number of locally defined values
(Inherited from NetworkDataT.) |
![]() | NodeIdValuePairs |
The set of node id's and values defined.
(Inherited from NetworkDataT.) |
![]() | Quantity |
Quantity stored in network data
(Inherited from NetworkDataT.) |
![]() | ReachData |
Collection of reach data sets currently active
(Inherited from NetworkDataT.) |
Name | Description | |
---|---|---|
![]() | AddGlobalReachValue(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 NetworkDataT.) |
![]() | AddGlobalReachValue(String, Boolean) |
Add reach to filter, short of
AddGlobalReachValue(String, T)
with value All (true) or None (false)
|
![]() | AddValue(String, T) |
Add a value for the node identified by nodeId (Inherited from NetworkDataT.) |
![]() | AddValue(String, Boolean) |
Add node to filter
|
![]() | AddValue(ILocation, T) |
Add a value on the given location.
(Inherited from NetworkDataT.) |
![]() | AddValue(ILocation, Boolean) |
Add location to filter
|
![]() | AddValue(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 NetworkDataT.) |
![]() | AddValue(ILocation, T, Boolean) |
Add a value on the given location.
(Inherited from NetworkDataT.) |
![]() | CheckGridpointType |
Method that may further limit the grid points to accept.
To be overridden in
|
![]() | Clear |
Delete all localized values. The global value is not deleted.
(Inherited from NetworkDataT.) |
![]() | ContainsValue(ILocation) |
Check if a local value is specified at the location. Returns false if no value is
defined for the location.
(Inherited from NetworkDataT.)If more than one value is to be retrieved for the same reach, use the GetReachData(String) first and use that one (for performance). |
![]() | ContainsValue(ILocation, Direction) |
Check if a local value is specified at the location. Returns false if no value is
defined for the location.
(Inherited from NetworkDataT.)If more than one value is to be retrieved for the same reach, use the GetReachData(String) first and use that one (for performance). |
![]() | 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.) |
![]() | GetGlobalValue(T) |
Get global value. Returns false if no global value is defined.
(Inherited from NetworkDataT.) |
![]() | GetGlobalValue(String, T) |
Get value for the specified id. Returns false if no value is
defined for the node id.
(Inherited from NetworkDataT.) |
![]() | GetHashCode | Serves as the default hash function. (Inherited from Object.) |
![]() | GetReachData |
Get a NetworkReachDataSetT for the reach with the given ID
(Inherited from NetworkDataT.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | GetValue(String, T) |
Get value for the specified node. Returns false if no value is
defined for the node id.
(Inherited from NetworkDataT.) |
![]() | GetValue(ILocation, T) |
Get value for the specified location. Returns false if no value is
defined for the location.
(Inherited from NetworkDataT.)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). |
![]() | GetValue(ILocation, T, Boolean) |
Get value for the specified location. Returns false if no value is
defined for the location.
(Inherited from NetworkDataT.)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). |
![]() | GetValues |
Get value at the given locations. The locations must have same Location.ID and
be ordred in the list by increasing chainages.
(Inherited from NetworkDataT.) |
![]() | HasNodeLocalValue |
Returns true if the node has local value defined.
(Inherited from NetworkDataT.) |
![]() | HasReachLocalValues |
Returns true if the reach has local values defined.
(Inherited from NetworkDataT.) |
![]() | IsIncluded(INetworkCatchment) |
Returns true if the catchment is included by the filter
|
![]() | IsIncluded(INetworkNode) |
Returns true if the node is included by the filter
|
![]() | IsIncluded(INetworkReach) |
Returns true if the entire reach is included by the filter
|
![]() | IsIncluded(INetworkReach, INetworkGridPoint) |
Returns true if the gridpoint is included by the filter
|
![]() | IsIncludedGlobal |
Returns true if the global quantity is included by the filter
|
![]() | IsReachIncluded |
Check if reach is included.
|
![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
Name | Description | |
---|---|---|
![]() | _interpolator |
Interpolator used when CanInterpolate is set
(Inherited from NetworkDataT.) |
![]() | _nodeValueMap |
Mapping node names to node values
(Inherited from NetworkDataT.) |
![]() | _reachValueMap |
Mapping reach names to reach data set
(Inherited from NetworkDataT.) |
Name | Description | |
---|---|---|
![]() | GetValueRes1DSpatialFilterTypeEnum(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.) |
![]() | GetValueRes1DSpatialFilterTypeEnum(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.) |
![]() | NetworkValuesRes1DSpatialFilterTypeEnum |
Gives an enumerable that iterates over all point values in the network value set.
(Defined by AbstractNetworkDataExtensions.)It will iterate first over all the nodes, and then over all the reaches and its locations. |
![]() | PointValuesRes1DSpatialFilterTypeEnum |
Gives an iterator that iterates over all point values in the network value set.
(Defined by AbstractNetworkDataExtensions.)It will iterate first over all the nodes, and then over all the reaches and its locations. |