Res1DNetworkQFilter Methods |
The Res1DNetworkQFilter type exposes the following members.
Methods| 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)
(Inherited from Res1DNetworkFilter.) |
| AddValue(String, T) |
Add a value for the node identified by nodeId (Inherited from NetworkDataT.) |
| AddValue(String, Boolean) |
Add node to filter
(Inherited from Res1DNetworkFilter.) |
| AddValue(ILocation, T) |
Add a value on the given location.
(Inherited from NetworkDataT.) |
| AddValue(ILocation, Boolean) |
Add location to filter
(Inherited from Res1DNetworkFilter.) |
| 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.) |
 | CheckGridpointType |
Method that may further limit the grid points to accept.
To be overridden in
(Overrides Res1DNetworkFilterCheckGridpointType(IRes1DGridPoint).) |
| Clear |
Delete all localized values
(Inherited from NetworkDataT.) |
| ContainsValue |
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 a hash function for a particular type. (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). |
| 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.) |
| IsIncluded(IRes1DCatchment) |
Returns true if the catchment is included by the filter
(Inherited from Res1DNetworkFilter.) |
| IsIncluded(IRes1DNode) |
Returns true if the node is included by the filter
(Inherited from Res1DNetworkFilter.) |
| IsIncluded(IRes1DReach) |
Returns true if the entire reach is included by the filter
(Inherited from Res1DNetworkFilter.) |
| IsIncluded(IRes1DReach, IRes1DGridPoint) |
Returns true if the gridpoint is included by the filter
(Overrides Res1DNetworkFilterIsIncluded(IRes1DReach, IRes1DGridPoint).) |
| IsIncludedGlobal |
Returns true if the global quantity is included by the filter
(Inherited from Res1DNetworkFilter.) |
| IsReachIncluded |
Check if reach is included.
(Overrides Res1DNetworkFilterIsReachIncluded(String).) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Extension Methods| 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.) |
| 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. |
See Also