Click or drag to resize

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.
Inheritance Hierarchy
SystemObject
  DHI.Mike1D.BoundaryModule.PeriodicItemOneDayTsProfile

Namespace:  DHI.Mike1D.BoundaryModule.PeriodicItem
Assembly:  DHI.Mike1D.BoundaryModule (in DHI.Mike1D.BoundaryModule.dll) Version: 19.0.0.0 (11.1.1.1111)
Syntax
public class OneDayTsProfile : IOneDayProfile, 
	IExtensibleDataObject

The OneDayTsProfile type exposes the following members.

Properties
  NameDescription
Public propertyExtensionData
Gets or sets the structure that contains extra data.
Public propertyId
ID of Daily Pattern
Public propertyRelative
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.
Public propertyRelativeTimes
Relative times, from 0 to 1, where the value of 1 is one day.
Public propertyValues
Values macthing the RelativeTimes array
Top
Methods
  NameDescription
Public methodStatic memberCreate
Creating a OneDayTsProfile assuming that each value[i] is defined based on the valueType.
Public methodStatic memberCreateMidpointValues
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).
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 methodGetAccumulatedValue
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.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetValue
Get the value of the daily pattern at the given date. Only the time of day part of the date is used.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodPrepare
Prepare item for simulation.
Public methodToString
String describing the object
(Overrides ObjectToString.)
Top
See Also