Skip to content

Latest commit

 

History

History
21 lines (16 loc) · 2.23 KB

ScheduleFixedInterval.md

File metadata and controls

21 lines (16 loc) · 2.23 KB

HoneybeeSchema.Model.ScheduleFixedInterval

Properties

Name Type Description Notes
Identifier string Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).
DisplayName string Display name of the object with no character restrictions. [optional]
Values List<double> A list of timeseries values occuring at each timestep over the course of the simulation.
Type string [optional] [readonly] [default to "ScheduleFixedInterval"]
ScheduleTypeLimit ScheduleTypeLimit ScheduleTypeLimit object that will be used to validate schedule values against upper/lower limits and assign units to the schedule values. If None, no validation will occur. [optional]
Timestep int An integer for the number of steps per hour that the input values correspond to. For example, if each value represents 30 minutes, the timestep is 2. For 15 minutes, it is 4. [optional] [default to 1]
StartDate List<int> A list of two integers for [month, day], representing the start date when the schedule values begin to take effect.A third integer may be added to denote whether the date should be re-serialized for a leap year (it should be a 1 in this case). [optional]
PlaceholderValue double A value that will be used for all times not covered by the input values. Typically, your simulation should not need to use this value if the input values completely cover the simulation period. [optional] [default to 0D]
Interpolate bool Boolean to note whether values in between intervals should be linearly interpolated or whether successive values should take effect immediately upon the beginning time corresponding to them. [optional] [default to false]

[Back to Model list] [Back to API list] [Back to README]