WaveApproximation Class

Wave approximation network values.

Definition

Namespace: DHI.Mike1D.HDParameterDataAccess
Assembly: DHI.Mike1D.HDParameterDataAccess (in DHI.Mike1D.HDParameterDataAccess.dll) Version: 24.0.0.0 (11.1.1.1111)
C#
public class WaveApproximation : NetworkData<WaveApproximationType>
Inheritance
Object    NetworkDataWaveApproximationType    WaveApproximation

Constructors

WaveApproximation Constructor

Properties

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.

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)
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)

Methods

AddGlobalReachValue 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)
AddValue(ILocation, T) Add a value on the given location.
(Inherited from NetworkDataT)
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(ILocation, T, Boolean) Add a value on the given location.
(Inherited from NetworkDataT)
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)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
ToStringReturns a string that represents the current object.
(Inherited from Object)

Fields

_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)

Extension Methods

GetValueWaveApproximationType 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)
GetValueWaveApproximationType 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)
GetValueWaveApproximationType 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)
GetValueWaveApproximationType 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)
NetworkValuesWaveApproximationType 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)
PointValuesWaveApproximationType 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