OneDayTsProfile Class

Implementation of IOneDayProfile A IOneDayProfile is a list of pairs of TimeOfDay times and values that repeat every day. A IOneDayProfile is a set of pairs of times and values. Times are the TimeOfDay part of a date, the first one must have zero TimeOfDay part (beginning of day), all elements must have increasing TimeOfDay parts. Data is stored in an time series item (because it has all the interpolation routines), and the type of values (instantaneous, forward step etc. must be proveded at creation. A special version exists where the values are defined to be instantaneous in the middle between two times, see CreateMidpointValues(IListDouble, IListDouble, String, IDiagnostics) Values can be absolute or relative. When relative, GetValue will in general not return the values that was given as input. The values are scaled such that if integrating GetValue(t) over a day, the result is one.

Definition

Namespace: DHI.Mike1D.BoundaryModule.PeriodicItem
Assembly: DHI.Mike1D.BoundaryModule (in DHI.Mike1D.BoundaryModule.dll) Version: 24.0.0.0 (11.1.1.1111)
C#
public class OneDayTsProfile : IOneDayProfile, 
	IExtensibleDataObject
Inheritance
Object    OneDayTsProfile
Implements
IOneDayProfile, IExtensibleDataObject

Properties

ExtensionData 
Id ID of Daily Pattern
Relative Specifies whether the DailyPattern is relative or absolute. If relative, the DailyPattern is scaled such that its values integrates to 1 over one day. Default is true.
RelativeTimes Relative times, from 0 to 1, where the value of 1 is one day.
Values Values macthing the RelativeTimes array

Methods

Create Creating a OneDayTsProfile assuming that each value[i] is defined based on the valueType.
CreateMidpointValues Creating a OneDayTsProfile assuming that each value[i] is defined in the middle of the interval times[i] to times[i+1], assuming that the value is valid until time 60*60*24 (secondsInOneDay).
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)
GetAccumulatedValue Get the accumulated value of the one-day-profile in the given interval. Only the time of day part of the date is used. If start is exactly on midnight, is it assumed to be 0 hours. If end is exactly on midnigt is is assumed to be 24 hours.
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
GetValue Get the value of the daily pattern at the given date. Only the time of day part of the date is used.
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Prepare Prepare item for simulation.
ToString String describing the object
(Overrides ObjectToString)

See Also