public class BoundaryItemConstant : AbstractBoundaryItem,
IBoundaryItemConstant, IAdvancedBoundaryItem, IBoundaryItem, IBoundaryAdaptive, IExtensibleDataObject| BoundaryItemConstant | Initializes a new instance of the BoundaryItemConstant class |
| ApplicationBegin |
Start datetime of the application of the item.
If user specified values are set, remember also to set the UseApplicationInterval Remarks
If UseApplicationInterval is false, this is set automatically during prepare phase to either
(Inherited from AbstractBoundaryItem) |
| ApplicationEnd |
End datetime of the application of the item
If user specified values are set, remember also to set the UseApplicationInterval (Inherited from AbstractBoundaryItem) |
| ConstValue | Setter access for the constant value. Use GetValue to retrieve it. |
| EumQuantity |
EUM quantity of boundary item.
Used for validation and in AD also for unit conversion. (Overrides AbstractBoundaryItemEumQuantity) |
| ExtensionData | Data from an extended DataContract not recognized here |
| IsDryWeatherFlow |
Boundary items can be marked as "dry weather flow" (used in MIKE URBAN). This is used in
Long Term Simulation to exclude dry weather flow from the total inflow when evaluating
how to start a new LTS job (if selecting a new hot start file)
This flag has no effect on the simulation, only on LTS job evaluations. (Inherited from AbstractBoundaryItem) |
| ScaleFactor |
A factor by which values are scaled. Default 1.0.
Only valid for certain item types, e.g., load/inflow types, not for types like waterlevel. (Inherited from AbstractBoundaryItem) |
| SoftstartDuration |
Duration of softstart period. Default 0
(Inherited from AbstractBoundaryItem) |
| SoftstartType |
Type of softstart. Default none
Softstart does not make sense for all boundary types, typically only for those that otherwise can be disabled/left out of the simulation. Softstart starttime is ApplicationBegin which if not set explicitly is either
(Inherited from AbstractBoundaryItem) |
| SoftstartValue |
Softstart initial value. Default 0.0
(Inherited from AbstractBoundaryItem) |
| UseApplicationInterval |
Boolean specifying whether the application of the item is limited in time
Set this flag if user specified values of ApplicationBegin and ApplicationEnd is to be used. If this flag is not set the application begin and end time will be overwritten/controlled by the Boundary Data, set in Prepare(DateTime, DateTime, IDiagnostics) or by the individual boundary item. (Inherited from AbstractBoundaryItem) |
| create | BoundaryItemConstant factory, creates and returns a new object. |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| GetAccumulatedValue | Get boundary value accumulated over the specified period. It is the callers responsibility to check if the item is applicable at the given datetime before calling GetAccumulatedValue. If the item is only applicable over a part of the interval, it must return the accumulated value for that part of the interval. (Overrides AbstractBoundaryItemGetAccumulatedValue(DateTime, DateTime)) |
| GetDeleteValue |
returns the delete value to this boundary
(Inherited from AbstractBoundaryItem) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetNextTransitionTime |
Default implementation of GetNextTransitionTime(DateTime)
returning the incoming datetime as the next transition time
(Overrides AbstractBoundaryItemGetNextTransitionTime(DateTime)) |
| GetPreferredTimeStep | Get preferred time step, which should not vary more than maxRelChange within the given time step. |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| GetValue |
Get value for this source
(Overrides AbstractBoundaryItemGetValue(DateTime)) |
| IsApplicable(DateTime) |
Checks whether the item is applicable at the given datetime.
(Inherited from AbstractBoundaryItem) |
| IsApplicable(DateTime, DateTime) |
Checks whether the item is applicable at the given time interval.
It returns true also if the item covers only a part of the
start-end interval
(Inherited from AbstractBoundaryItem) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| Prepare |
Prepare item for simulation.
(Inherited from AbstractBoundaryItem) |
| SoftstartAccumulatedWeighting |
Weights the accumulatedValue with the hot-start value.
(Inherited from AbstractBoundaryItem) |
| SoftstartFactor |
Calculate the strength factor of the softstart.
Uses _applicationBegin as the startup
Usage:
a = SoftStartFactor(t);
Value = (1-a)*_softstartValue + (a)*Value;
(Inherited from AbstractBoundaryItem) |
| ToString |
Custom textual representation
(Overrides ObjectToString) |
| Validate |
Validate this
(Overrides AbstractBoundaryItemValidate) |
| _applicationBegin | See ApplicationBegin (Inherited from AbstractBoundaryItem) |
| _applicationEnd | See ApplicationEnd (Inherited from AbstractBoundaryItem) |
| _scaleFactor | See ScaleFactor (Inherited from AbstractBoundaryItem) |
| _softstartDuration | See SoftstartDuration (Inherited from AbstractBoundaryItem) |
| _softstartType | See SoftstartType (Inherited from AbstractBoundaryItem) |
| _softstartValue | See SoftstartValue (Inherited from AbstractBoundaryItem) |
| _useApplicationInterval | See UseApplicationInterval (Inherited from AbstractBoundaryItem) |
| GetAccumulatedValue |
Method for IBoundaryItem implementing GetAccumulatedValue(DateTime, DateTime, TimeSpan) (Defined by BoundaryExtensions) |