Res1DNetworkHFilter Methods

Methods

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 successful 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(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)
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, 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
(Overrides Res1DNetworkFilterCheckGridpointType(INetworkGridPoint))
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.

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 NetworkDataT)
ContainsValue(ILocation, Direction) 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 NetworkDataT)
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows 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)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetReachData Get a NetworkReachDataSetT for the reach with the given ID
(Inherited from NetworkDataT)
GetTypeGets the Type of the current instance.
(Inherited from Object)
GetValue(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 NetworkDataT)
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, Boolean) 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 NetworkDataT)
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
(Inherited from Res1DNetworkFilter)
IsIncluded(INetworkNode) Returns true if the node is included by the filter
(Inherited from Res1DNetworkFilter)
IsIncluded(INetworkReach) Returns true if the entire reach is included by the filter
(Inherited from Res1DNetworkFilter)
IsIncluded(INetworkReach, INetworkGridPoint) Returns true if the gridpoint is included by the filter
(Overrides Res1DNetworkFilterIsIncluded(INetworkReach, INetworkGridPoint))
IsIncluded(INetworkReach, INetworkGridPoint, Boolean) Returns true if the gridpoint is included by the filter
(Inherited from Res1DNetworkFilter)
IsIncludedGlobal Returns true if the global quantity is included by the filter
(Inherited from Res1DNetworkFilter)
IsReachIncluded Check if reach is included.
(Overrides Res1DNetworkFilterIsReachIncluded(String))
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
ReachGlobalFilterType
(Inherited from Res1DNetworkFilter)
ToStringReturns a string that represents the current object.
(Inherited from Object)

Extension Methods

GetValueRes1DSpatialFilterTypeEnum 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 Get a value from the networkData at the given nodeId. 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 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)
GetValueRes1DSpatialFilterTypeEnum Get a value from the networkData at the given nodeId. 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.

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


(Defined by AbstractNetworkDataExtensions)
PointValuesRes1DSpatialFilterTypeEnum 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)

See Also