Click or drag to resize

WaveApproximation Class

Wave approximation network values.
Inheritance Hierarchy
SystemObject
  DHI.Mike1D.GenericNetworkDataWaveApproximationType
    DHI.Mike1D.HDParameterDataAccessWaveApproximation

Namespace:  DHI.Mike1D.HDParameterDataAccess
Assembly:  DHI.Mike1D.HDParameterDataAccess (in DHI.Mike1D.HDParameterDataAccess.dll) Version: 19.0.0.0 (11.1.1.1111)
Syntax
public class WaveApproximation : NetworkData<WaveApproximationType>

The WaveApproximation type exposes the following members.

Constructors
  NameDescription
Public methodWaveApproximation
Constructor
Top
Properties
  NameDescription
Public propertyCanInterpolate
Flag specifying whether it makes sense to interpolate in values on a reach.
(Inherited from NetworkDataT.)
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 NetworkDataT.)
Public propertyGlobalValue
The global value. Used, if nothing better is found. Setting the global value automatically also sets HasGlobalValue to true.
(Inherited from NetworkDataT.)
Public propertyHasGlobalValue
Defines whether there is a global value, or strictly speaking, whether to use the global value.
(Inherited from NetworkDataT.)
Public propertyHasValues
Flag specifying whether this data has values defined at all
(Inherited from NetworkDataT.)
Public propertyLocalCount
Returns the number of locally defined values
(Inherited from NetworkDataT.)
Public propertyNodeIdValuePairs
The set of node id's and values defined.
(Inherited from NetworkDataT.)
Public propertyQuantity
Quantity stored in network data
(Inherited from NetworkDataT.)
Public propertyReachData
Collection of reach data sets currently active
(Inherited from NetworkDataT.)
Top
Methods
  NameDescription
Public methodAddGlobalReachValue
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.)
Public methodAddValue(String, T)
Add a value for the node identified by nodeId
(Inherited from NetworkDataT.)
Public methodAddValue(ILocation, T)
Add a value on the given location.
(Inherited from NetworkDataT.)
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 NetworkDataT.)
Public methodAddValue(ILocation, T, Boolean)
Add a value on the given location.
(Inherited from NetworkDataT.)
Public methodClear
Delete all localized values. The global value is not deleted.
(Inherited from NetworkDataT.)
Public methodContainsValue(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.)
Public methodContainsValue(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.)
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 NetworkDataT.)
Public methodGetGlobalValue(String, T)
Get value for the specified id. Returns false if no value is defined for the node id.
(Inherited from NetworkDataT.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetReachData (Inherited from NetworkDataT.)
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 NetworkDataT.)
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 NetworkDataT.)
Public methodGetValue(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.)
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 NetworkDataT.)
Public methodHasNodeLocalValue
Returns true if the node has local value defined.
(Inherited from NetworkDataT.)
Public methodHasReachLocalValues
Returns true if the reach has local values defined.
(Inherited from NetworkDataT.)
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 MethodGetValueWaveApproximationType(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 MethodGetValueWaveApproximationType(ILocation, WaveApproximationType)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 MethodNetworkValuesWaveApproximationType
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.)
Public Extension MethodPointValuesWaveApproximationType
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