dragonfly-schema 1.1504.0 → 2.100.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { Face3D, Mesh3D, Autocalculate, VentilationControlAbridged, VentilationOpening, ProcessAbridged, IDdBaseModel, Ground, Outdoors, Surface, Adiabatic, OtherSideTemperature, Room, GlobalConstructionSet, ConstructionSetAbridged, ConstructionSet, OpaqueConstructionAbridged, WindowConstructionAbridged, ShadeConstruction, AirBoundaryConstructionAbridged, OpaqueConstruction, WindowConstruction, AirBoundaryConstruction, EnergyMaterial, EnergyMaterialNoMass, EnergyMaterialVegetation, EnergyWindowMaterialGlazing, EnergyWindowMaterialSimpleGlazSys, EnergyWindowMaterialGas, EnergyWindowMaterialGasMixture, EnergyWindowMaterialGasCustom, EnergyWindowFrame, EnergyWindowMaterialBlind, EnergyWindowMaterialShade, IdealAirSystemAbridged, VAV, PVAV, PSZ, PTAC, ForcedAirFurnace, FCUwithDOASAbridged, WSHPwithDOASAbridged, VRFwithDOASAbridged, RadiantwithDOASAbridged, FCU, WSHP, VRF, Baseboard, EvaporativeCooler, Residential, WindowAC, GasUnitHeater, Radiant, DetailedHVAC, SHWSystem, ProgramTypeAbridged, ProgramType, ScheduleRulesetAbridged, ScheduleFixedIntervalAbridged, ScheduleRuleset, ScheduleFixedInterval, ScheduleTypeLimit, GlobalModifierSet, ModifierSet, ModifierSetAbridged, Plastic, Glass, BSDF, Glow, Light, Trans, Metal, Void, Mirror, Units } from 'honeybee-schema';
1
+ import { Face3D, Mesh3D, Autocalculate, ProcessAbridged, DaylightingControl, VentilationControlAbridged, VentilationOpening, VentilationFan, IDdBaseModel, Ground, Outdoors, Surface, Adiabatic, OtherSideTemperature, Room, GlobalConstructionSet, ConstructionSetAbridged, ConstructionSet, OpaqueConstructionAbridged, WindowConstructionAbridged, ShadeConstruction, AirBoundaryConstructionAbridged, OpaqueConstruction, WindowConstruction, AirBoundaryConstruction, EnergyMaterial, EnergyMaterialNoMass, EnergyMaterialVegetation, EnergyWindowMaterialGas, EnergyWindowMaterialGasCustom, EnergyWindowMaterialGasMixture, EnergyWindowFrame, EnergyWindowMaterialSimpleGlazSys, EnergyWindowMaterialGlazing, EnergyWindowMaterialBlind, EnergyWindowMaterialShade, IdealAirSystemAbridged, VAV, PVAV, PSZ, PTAC, ForcedAirFurnace, FCUwithDOASAbridged, WSHPwithDOASAbridged, VRFwithDOASAbridged, RadiantwithDOASAbridged, FCU, WSHP, VRF, Baseboard, EvaporativeCooler, Residential, WindowAC, GasUnitHeater, Radiant, DetailedHVAC, SHWSystem, ProgramTypeAbridged, ProgramType, ScheduleRulesetAbridged, ScheduleFixedIntervalAbridged, ScheduleRuleset, ScheduleFixedInterval, ScheduleTypeLimit, GlobalModifierSet, ModifierSet, ModifierSetAbridged, Plastic, Glass, BSDF, Glow, Light, Trans, Metal, Void, Mirror } from 'honeybee-schema';
2
2
  import { ValidationOptions } from 'class-validator';
3
3
 
4
4
  declare abstract class _OpenAPIGenBaseModel {
@@ -60,7 +60,25 @@ declare class _WindowParameterBase extends _OpenAPIGenBaseModel {
60
60
  validate(): Promise<boolean>;
61
61
  }
62
62
 
63
- /** Base class for all objects that are not extensible with additional keys.\n\nThis effectively includes all objects except for the Properties classes\nthat are assigned to geometry objects. */
63
+ /** An enumeration. */
64
+ declare enum AllAirEconomizerType {
65
+ NoEconomizer = "NoEconomizer",
66
+ DifferentialDryBulb = "DifferentialDryBulb",
67
+ DifferentialEnthalpy = "DifferentialEnthalpy",
68
+ DifferentialDryBulbAndEnthalpy = "DifferentialDryBulbAndEnthalpy",
69
+ FixedDryBulb = "FixedDryBulb",
70
+ FixedEnthalpy = "FixedEnthalpy",
71
+ ElectronicEnthalpy = "ElectronicEnthalpy"
72
+ }
73
+
74
+ /** An enumeration. */
75
+ declare enum BaseboardEquipmentType {
76
+ ElectricBaseboard = "ElectricBaseboard",
77
+ BoilerBaseboard = "BoilerBaseboard",
78
+ ASHPBaseboard = "ASHPBaseboard",
79
+ DHWBaseboard = "DHWBaseboard"
80
+ }
81
+
64
82
  declare class BuildingEnergyPropertiesAbridged extends _OpenAPIGenBaseModel {
65
83
  /** type */
66
84
  type: string;
@@ -77,7 +95,6 @@ declare class BuildingEnergyPropertiesAbridged extends _OpenAPIGenBaseModel {
77
95
  validate(): Promise<boolean>;
78
96
  }
79
97
 
80
- /** Base class for all objects that are not extensible with additional keys.\n\nThis effectively includes all objects except for the Properties classes\nthat are assigned to geometry objects. */
81
98
  declare class BuildingRadiancePropertiesAbridged extends _OpenAPIGenBaseModel {
82
99
  /** type */
83
100
  type: string;
@@ -104,12 +121,33 @@ declare class BuildingPropertiesAbridged extends _OpenAPIGenBaseModel {
104
121
  validate(): Promise<boolean>;
105
122
  }
106
123
 
124
+ /** Instructions for detailed clearstory windows, defined by 2D Polygons. */
125
+ declare class DetailedClearstory extends _OpenAPIGenBaseModel {
126
+ /** An array of two sub-arrays with each sub-array representing the start and end point of a 2D line segment in the world XY system. This establishes the plane and domain in which the clearstory geometries exist. */
127
+ baseLine: number[][];
128
+ /** A number for the Z-coordinate that places the base_line and the corresponding clearstory window polygons in 3D space. This elevation value should be below all of the 3D clearstory window geometries and helps set the origin of the plane in which the clearstory geometry exists. */
129
+ elevation: number;
130
+ /** An array of arrays with each sub-array representing a polygonal boundary of a clearstory window or door. Each sub-array should consist of arrays representing points, which contain 2 values for 2D coordinates in the plane defined by the base_line. The base_line plane is assumed to have an origin at the end point of the line segment (the second point) and an X-axis extending along the length of the segment. The Y-axis of the plane always points upwards. Therefore, both X and Y coordinates of the points in each polygon should be positive. */
131
+ polygons: number[][][];
132
+ /** type */
133
+ type: string;
134
+ /** An array of booleans that align with the polygons and note whether each of the polygons represents a door out onto a roof or balcony (True) or a clearstory window (False). If None, it will be assumed that all polygons represent windows and they will be translated to Apertures in any resulting Honeybee model */
135
+ areDoors?: boolean[];
136
+ constructor();
137
+ init(_data?: any): void;
138
+ static fromJS(data: any): DetailedClearstory;
139
+ toJSON(data?: any): Record<string, any>;
140
+ validate(): Promise<boolean>;
141
+ }
142
+
107
143
  /** Geometry for specifying sloped roofs over a Story. */
108
144
  declare class RoofSpecification extends _OpenAPIGenBaseModel {
109
145
  /** An array of Face3D (or Mesh3D) objects representing the geometry of the Roof. Cases where Room2Ds are only partially covered by these roof geometries will result in those portions of the Room2Ds being extruded to their floor_to_ceiling_height. */
110
146
  geometry: (Face3D | Mesh3D)[];
111
147
  /** type */
112
148
  type: string;
149
+ /** A list of ClearstoryParameter objects that dictate how to generate window geometries for any vertical walls that result from the translation of roof geometry. If None, no clearstory windows will exist over the roof. */
150
+ clearstoryParameters?: DetailedClearstory[];
113
151
  constructor();
114
152
  init(_data?: any): void;
115
153
  static fromJS(data: any): RoofSpecification;
@@ -258,7 +296,7 @@ declare class RepeatingWindowRatio extends _WindowParameterBase {
258
296
  windowHeight: number;
259
297
  /** A number for the target height above the bottom edge of the wall to start the windows. Note that, if the ratio is too large for the height, the ratio will take precedence and the sill_height will be smaller than this value. */
260
298
  sillHeight: number;
261
- /** A number for the target separation between individual window centerlines. If this number is larger than the parent rectangle base, only one window will be produced. */
299
+ /** A number for the target separation between individual window center lines. If this number is larger than the parent rectangle base, only one window will be produced. */
262
300
  horizontalSeparation: number;
263
301
  /** type */
264
302
  type: string;
@@ -318,7 +356,6 @@ declare class SingleWindow extends _WindowParameterBase {
318
356
  validate(): Promise<boolean>;
319
357
  }
320
358
 
321
- /** Base class for all objects that are not extensible with additional keys.\n\nThis effectively includes all objects except for the Properties classes\nthat are assigned to geometry objects. */
322
359
  declare class Room2DComparisonProperties extends _OpenAPIGenBaseModel {
323
360
  /** type */
324
361
  type: string;
@@ -337,7 +374,6 @@ declare class Room2DComparisonProperties extends _OpenAPIGenBaseModel {
337
374
  validate(): Promise<boolean>;
338
375
  }
339
376
 
340
- /** Base class for all objects that are not extensible with additional keys.\n\nThis effectively includes all objects except for the Properties classes\nthat are assigned to geometry objects. */
341
377
  declare class Room2DDoe2Properties extends _OpenAPIGenBaseModel {
342
378
  /** type */
343
379
  type: string;
@@ -358,7 +394,6 @@ declare class Room2DDoe2Properties extends _OpenAPIGenBaseModel {
358
394
  validate(): Promise<boolean>;
359
395
  }
360
396
 
361
- /** Base class for all objects that are not extensible with additional keys.\n\nThis effectively includes all objects except for the Properties classes\nthat are assigned to geometry objects. */
362
397
  declare class Room2DEnergyPropertiesAbridged extends _OpenAPIGenBaseModel {
363
398
  /** type */
364
399
  type: string;
@@ -370,12 +405,16 @@ declare class Room2DEnergyPropertiesAbridged extends _OpenAPIGenBaseModel {
370
405
  hvac?: string;
371
406
  /** An optional identifier of a Service Hot Water (SHW) system that specifies how the hot water load of the Room is met. If None, the hot water load will be met with a generic system that only measures thermal loadand does not account for system efficiencies. */
372
407
  shw?: string;
408
+ /** An optional list of Process objects for process loads within the room. These can represent wood burning fireplaces, kilns, manufacturing equipment, and various industrial processes. They can also be used to represent certain pieces of equipment to be separated from the other end uses, such as MRI machines, theatrical lighting, and elevators. */
409
+ processLoads?: ProcessAbridged[];
410
+ /** An optional DaylightingControl object to dictate the dimming of lights. If None, the lighting will respond only to the schedule and not the daylight conditions within the room. */
411
+ daylightingControl?: DaylightingControl;
373
412
  /** An optional VentilationControl object to dictate the opening of windows. If None, the windows will never open. */
374
413
  windowVentControl?: VentilationControlAbridged;
375
414
  /** An optional VentilationOpening to specify the operable portion of all windows of the Room2D. If None, the windows will never open. */
376
415
  windowVentOpening?: VentilationOpening;
377
- /** An optional list of Process objects for process loads within the room. These can represent wood burning fireplaces, kilns, manufacturing equipment, and various industrial processes. They can also be used to represent certain pieces of equipment to be separated from the other end uses, such as MRI machines, theatrical lighting, and elevators. */
378
- processLoads?: ProcessAbridged[];
416
+ /** An optional list of VentilationFan objects for fans within the room. Note that these fans are not connected to the heating or cooling system and are meant to represent the intentional circulation of unconditioned outdoor air for the purposes of keeping a space cooler, drier or free of indoor pollutants (as in the case of kitchen or bathroom exhaust fans). For the specification of mechanical ventilation of conditioned outdoor air, the Room.ventilation property should be used and the Room should be given a HVAC that can meet this specification. */
417
+ fans?: VentilationFan[];
379
418
  constructor();
380
419
  init(_data?: any): void;
381
420
  static fromJS(data: any): Room2DEnergyPropertiesAbridged;
@@ -446,7 +485,7 @@ declare class RoomGridParameter extends _GridParameterBase {
446
485
  }
447
486
 
448
487
  /** Instructions for a SensorGrid of radial directions around positions from floors.\n\nThis type of sensor grid is particularly helpful for studies of multiple\nview directions, such as imageless glare studies. */
449
- declare class RoomRadialGridParameter extends RoomGridParameter {
488
+ declare class RoomRadialGridParameter {
450
489
  /** A positive integer for the number of radial directions to be generated around each position. */
451
490
  dirCount: number;
452
491
  /** A vector as 3 (x, y, z) values to set the start direction of the generated directions. This can be used to orient the resulting sensors to specific parts of the scene. It can also change the elevation of the resulting directions since this start vector will always be rotated in the XY plane to generate the resulting directions. */
@@ -455,6 +494,14 @@ declare class RoomRadialGridParameter extends RoomGridParameter {
455
494
  meshRadius: (Autocalculate | number);
456
495
  /** type */
457
496
  type: string;
497
+ /** A number for how far to offset the grid from the Room2D floors. (Default: 1.0, suitable for Models in Meters). */
498
+ offset: number;
499
+ /** A number for the distance at which sensors close to walls should be removed. Note that this option has no effect unless the value is more than half of the dimension. */
500
+ wallOffset: number;
501
+ /** The dimension of the grid cells as a number. */
502
+ dimension: number;
503
+ /** A boolean to note whether the resulting SensorGrid should include the mesh. */
504
+ includeMesh: boolean;
458
505
  constructor();
459
506
  init(_data?: any): void;
460
507
  static fromJS(data: any): RoomRadialGridParameter;
@@ -462,7 +509,6 @@ declare class RoomRadialGridParameter extends RoomGridParameter {
462
509
  validate(): Promise<boolean>;
463
510
  }
464
511
 
465
- /** Base class for all objects that are not extensible with additional keys.\n\nThis effectively includes all objects except for the Properties classes\nthat are assigned to geometry objects. */
466
512
  declare class Room2DRadiancePropertiesAbridged extends _OpenAPIGenBaseModel {
467
513
  /** type */
468
514
  type: string;
@@ -495,11 +541,10 @@ declare class Room2DPropertiesAbridged extends _OpenAPIGenBaseModel {
495
541
  validate(): Promise<boolean>;
496
542
  }
497
543
 
498
- /** Base class for all objects requiring a identifiers acceptable for all engines. */
499
544
  declare class Room2D extends IDdBaseModel {
500
545
  /** A list of 2D points representing the outer boundary vertices of the Room2D. The list should include at least 3 points and each point should be a list of 2 (x, y) values. */
501
546
  floorBoundary: number[][];
502
- /** A number to indicate the height of the floor plane in the Z axis. */
547
+ /** A number to indicate the Z-coordinate (or elevation) of the room floor plane. */
503
548
  floorHeight: number;
504
549
  /** A number for the distance between the floor and the ceiling. */
505
550
  floorToCeilingHeight: number;
@@ -540,7 +585,6 @@ declare class Room2D extends IDdBaseModel {
540
585
  validate(): Promise<boolean>;
541
586
  }
542
587
 
543
- /** Base class for all objects that are not extensible with additional keys.\n\nThis effectively includes all objects except for the Properties classes\nthat are assigned to geometry objects. */
544
588
  declare class StoryEnergyPropertiesAbridged extends _OpenAPIGenBaseModel {
545
589
  /** type */
546
590
  type: string;
@@ -553,7 +597,6 @@ declare class StoryEnergyPropertiesAbridged extends _OpenAPIGenBaseModel {
553
597
  validate(): Promise<boolean>;
554
598
  }
555
599
 
556
- /** Base class for all objects that are not extensible with additional keys.\n\nThis effectively includes all objects except for the Properties classes\nthat are assigned to geometry objects. */
557
600
  declare class StoryRadiancePropertiesAbridged extends _OpenAPIGenBaseModel {
558
601
  /** type */
559
602
  type: string;
@@ -587,7 +630,6 @@ declare enum StoryType {
587
630
  FloorPlenum = "FloorPlenum"
588
631
  }
589
632
 
590
- /** Base class for all objects requiring a identifiers acceptable for all engines. */
591
633
  declare class Story extends IDdBaseModel {
592
634
  /** An array of dragonfly Room2D objects that together form an entire story of a building. */
593
635
  room2ds: Room2D[];
@@ -612,7 +654,6 @@ declare class Story extends IDdBaseModel {
612
654
  validate(): Promise<boolean>;
613
655
  }
614
656
 
615
- /** Base class for all objects requiring a identifiers acceptable for all engines. */
616
657
  declare class Building extends IDdBaseModel {
617
658
  /** Extension properties for particular simulation engines (Radiance, EnergyPlus). */
618
659
  properties: BuildingPropertiesAbridged;
@@ -631,7 +672,6 @@ declare class Building extends IDdBaseModel {
631
672
  validate(): Promise<boolean>;
632
673
  }
633
674
 
634
- /** Base class for all objects that are not extensible with additional keys.\n\nThis effectively includes all objects except for the Properties classes\nthat are assigned to geometry objects. */
635
675
  declare class ContextShadeEnergyPropertiesAbridged extends _OpenAPIGenBaseModel {
636
676
  /** type */
637
677
  type: string;
@@ -646,7 +686,6 @@ declare class ContextShadeEnergyPropertiesAbridged extends _OpenAPIGenBaseModel
646
686
  validate(): Promise<boolean>;
647
687
  }
648
688
 
649
- /** Base class for all objects that are not extensible with additional keys.\n\nThis effectively includes all objects except for the Properties classes\nthat are assigned to geometry objects. */
650
689
  declare class ContextShadeRadiancePropertiesAbridged extends _OpenAPIGenBaseModel {
651
690
  /** type */
652
691
  type: string;
@@ -673,7 +712,6 @@ declare class ContextShadePropertiesAbridged extends _OpenAPIGenBaseModel {
673
712
  validate(): Promise<boolean>;
674
713
  }
675
714
 
676
- /** Base class for all objects requiring a identifiers acceptable for all engines. */
677
715
  declare class ContextShade extends IDdBaseModel {
678
716
  /** An array of planar Face3Ds and or Mesh3Ds that together represent the context shade. */
679
717
  geometry: (Face3D | Mesh3D)[];
@@ -690,7 +728,126 @@ declare class ContextShade extends IDdBaseModel {
690
728
  validate(): Promise<boolean>;
691
729
  }
692
730
 
693
- /** Base class for all objects that are not extensible with additional keys.\n\nThis effectively includes all objects except for the Properties classes\nthat are assigned to geometry objects. */
731
+ /** Choices for how the shading device is controlled. */
732
+ declare enum ControlType {
733
+ AlwaysOn = "AlwaysOn",
734
+ OnIfHighSolarOnWindow = "OnIfHighSolarOnWindow",
735
+ OnIfHighHorizontalSolar = "OnIfHighHorizontalSolar",
736
+ OnIfHighOutdoorAirTemperature = "OnIfHighOutdoorAirTemperature",
737
+ OnIfHighZoneAirTemperature = "OnIfHighZoneAirTemperature",
738
+ OnIfHighZoneCooling = "OnIfHighZoneCooling",
739
+ OnNightIfLowOutdoorTempAndOffDay = "OnNightIfLowOutdoorTempAndOffDay",
740
+ OnNightIfLowInsideTempAndOffDay = "OnNightIfLowInsideTempAndOffDay",
741
+ OnNightIfHeatingAndOffDay = "OnNightIfHeatingAndOffDay"
742
+ }
743
+
744
+ /** An enumeration. */
745
+ declare enum EconomizerType {
746
+ NoEconomizer = "NoEconomizer",
747
+ DifferentialDryBulb = "DifferentialDryBulb",
748
+ DifferentialEnthalpy = "DifferentialEnthalpy"
749
+ }
750
+
751
+ /** An enumeration. */
752
+ declare enum EvaporativeCoolerEquipmentType {
753
+ EvapCoolers_ElectricBaseboard = "EvapCoolers_ElectricBaseboard",
754
+ EvapCoolers_BoilerBaseboard = "EvapCoolers_BoilerBaseboard",
755
+ EvapCoolers_ASHPBaseboard = "EvapCoolers_ASHPBaseboard",
756
+ EvapCoolers_DHWBaseboard = "EvapCoolers_DHWBaseboard",
757
+ EvapCoolers_Furnace = "EvapCoolers_Furnace",
758
+ EvapCoolers_UnitHeaters = "EvapCoolers_UnitHeaters",
759
+ EvapCoolers = "EvapCoolers"
760
+ }
761
+
762
+ /** An enumeration. */
763
+ declare enum FaceType {
764
+ Wall = "Wall",
765
+ Floor = "Floor",
766
+ RoofCeiling = "RoofCeiling",
767
+ AirBoundary = "AirBoundary"
768
+ }
769
+
770
+ /** An enumeration. */
771
+ declare enum FCUEquipmentType {
772
+ FCU_Chiller_Boiler = "FCU_Chiller_Boiler",
773
+ FCU_Chiller_ASHP = "FCU_Chiller_ASHP",
774
+ FCU_Chiller_DHW = "FCU_Chiller_DHW",
775
+ FCU_Chiller_ElectricBaseboard = "FCU_Chiller_ElectricBaseboard",
776
+ FCU_Chiller_GasHeaters = "FCU_Chiller_GasHeaters",
777
+ FCU_Chiller = "FCU_Chiller",
778
+ FCU_ACChiller_Boiler = "FCU_ACChiller_Boiler",
779
+ FCU_ACChiller_ASHP = "FCU_ACChiller_ASHP",
780
+ FCU_ACChiller_DHW = "FCU_ACChiller_DHW",
781
+ FCU_ACChiller_ElectricBaseboard = "FCU_ACChiller_ElectricBaseboard",
782
+ FCU_ACChiller_GasHeaters = "FCU_ACChiller_GasHeaters",
783
+ FCU_ACChiller = "FCU_ACChiller",
784
+ FCU_DCW_Boiler = "FCU_DCW_Boiler",
785
+ FCU_DCW_ASHP = "FCU_DCW_ASHP",
786
+ FCU_DCW_DHW = "FCU_DCW_DHW",
787
+ FCU_DCW_ElectricBaseboard = "FCU_DCW_ElectricBaseboard",
788
+ FCU_DCW_GasHeaters = "FCU_DCW_GasHeaters",
789
+ FCU_DCW = "FCU_DCW"
790
+ }
791
+
792
+ /** An enumeration. */
793
+ declare enum FCUwithDOASEquipmentType {
794
+ DOAS_FCU_Chiller_Boiler = "DOAS_FCU_Chiller_Boiler",
795
+ DOAS_FCU_Chiller_ASHP = "DOAS_FCU_Chiller_ASHP",
796
+ DOAS_FCU_Chiller_DHW = "DOAS_FCU_Chiller_DHW",
797
+ DOAS_FCU_Chiller_ElectricBaseboard = "DOAS_FCU_Chiller_ElectricBaseboard",
798
+ DOAS_FCU_Chiller_GasHeaters = "DOAS_FCU_Chiller_GasHeaters",
799
+ DOAS_FCU_Chiller = "DOAS_FCU_Chiller",
800
+ DOAS_FCU_ACChiller_Boiler = "DOAS_FCU_ACChiller_Boiler",
801
+ DOAS_FCU_ACChiller_ASHP = "DOAS_FCU_ACChiller_ASHP",
802
+ DOAS_FCU_ACChiller_DHW = "DOAS_FCU_ACChiller_DHW",
803
+ DOAS_FCU_ACChiller_ElectricBaseboard = "DOAS_FCU_ACChiller_ElectricBaseboard",
804
+ DOAS_FCU_ACChiller_GasHeaters = "DOAS_FCU_ACChiller_GasHeaters",
805
+ DOAS_FCU_ACChiller = "DOAS_FCU_ACChiller",
806
+ DOAS_FCU_DCW_Boiler = "DOAS_FCU_DCW_Boiler",
807
+ DOAS_FCU_DCW_ASHP = "DOAS_FCU_DCW_ASHP",
808
+ DOAS_FCU_DCW_DHW = "DOAS_FCU_DCW_DHW",
809
+ DOAS_FCU_DCW_ElectricBaseboard = "DOAS_FCU_DCW_ElectricBaseboard",
810
+ DOAS_FCU_DCW_GasHeaters = "DOAS_FCU_DCW_GasHeaters",
811
+ DOAS_FCU_DCW = "DOAS_FCU_DCW"
812
+ }
813
+
814
+ /** Designates the acceptable fuel types for process loads. */
815
+ declare enum FuelTypes {
816
+ Electricity = "Electricity",
817
+ NaturalGas = "NaturalGas",
818
+ Propane = "Propane",
819
+ FuelOilNo1 = "FuelOilNo1",
820
+ FuelOilNo2 = "FuelOilNo2",
821
+ Diesel = "Diesel",
822
+ Gasoline = "Gasoline",
823
+ Coal = "Coal",
824
+ Steam = "Steam",
825
+ DistrictHeating = "DistrictHeating",
826
+ DistrictCooling = "DistrictCooling",
827
+ OtherFuel1 = "OtherFuel1",
828
+ OtherFuel2 = "OtherFuel2",
829
+ None = "None"
830
+ }
831
+
832
+ /** An enumeration. */
833
+ declare enum FurnaceEquipmentType {
834
+ Furnace = "Furnace",
835
+ Furnace_Electric = "Furnace_Electric"
836
+ }
837
+
838
+ /** An enumeration. */
839
+ declare enum GasType {
840
+ Air = "Air",
841
+ Argon = "Argon",
842
+ Krypton = "Krypton",
843
+ Xenon = "Xenon"
844
+ }
845
+
846
+ /** An enumeration. */
847
+ declare enum GasUnitHeaterEquipmentType {
848
+ GasHeaters = "GasHeaters"
849
+ }
850
+
694
851
  declare class ModelComparisonProperties extends _OpenAPIGenBaseModel {
695
852
  /** type */
696
853
  type: string;
@@ -701,7 +858,6 @@ declare class ModelComparisonProperties extends _OpenAPIGenBaseModel {
701
858
  validate(): Promise<boolean>;
702
859
  }
703
860
 
704
- /** Base class for all objects that are not extensible with additional keys.\n\nThis effectively includes all objects except for the Properties classes\nthat are assigned to geometry objects. */
705
861
  declare class ModelDoe2Properties extends _OpenAPIGenBaseModel {
706
862
  /** type */
707
863
  type: string;
@@ -712,7 +868,6 @@ declare class ModelDoe2Properties extends _OpenAPIGenBaseModel {
712
868
  validate(): Promise<boolean>;
713
869
  }
714
870
 
715
- /** Base class for all objects that are not extensible with additional keys.\n\nThis effectively includes all objects except for the Properties classes\nthat are assigned to geometry objects. */
716
871
  declare class ModelEnergyProperties extends _OpenAPIGenBaseModel {
717
872
  /** type */
718
873
  type: string;
@@ -723,7 +878,7 @@ declare class ModelEnergyProperties extends _OpenAPIGenBaseModel {
723
878
  /** A list of all unique constructions in the model. This includes constructions across all the Model construction_sets. */
724
879
  constructions?: (OpaqueConstructionAbridged | WindowConstructionAbridged | ShadeConstruction | AirBoundaryConstructionAbridged | OpaqueConstruction | WindowConstruction | AirBoundaryConstruction)[];
725
880
  /** A list of all unique materials in the model. This includes materials needed to make the Model constructions. */
726
- materials?: (EnergyMaterial | EnergyMaterialNoMass | EnergyMaterialVegetation | EnergyWindowMaterialGlazing | EnergyWindowMaterialSimpleGlazSys | EnergyWindowMaterialGas | EnergyWindowMaterialGasMixture | EnergyWindowMaterialGasCustom | EnergyWindowFrame | EnergyWindowMaterialBlind | EnergyWindowMaterialShade)[];
881
+ materials?: (EnergyMaterial | EnergyMaterialNoMass | EnergyMaterialVegetation | EnergyWindowMaterialGas | EnergyWindowMaterialGasCustom | EnergyWindowMaterialGasMixture | EnergyWindowFrame | EnergyWindowMaterialSimpleGlazSys | EnergyWindowMaterialGlazing | EnergyWindowMaterialBlind | EnergyWindowMaterialShade)[];
727
882
  /** List of all HVAC systems in the Model. */
728
883
  hvacs?: (IdealAirSystemAbridged | VAV | PVAV | PSZ | PTAC | ForcedAirFurnace | FCUwithDOASAbridged | WSHPwithDOASAbridged | VRFwithDOASAbridged | RadiantwithDOASAbridged | FCU | WSHP | VRF | Baseboard | EvaporativeCooler | Residential | WindowAC | GasUnitHeater | Radiant | DetailedHVAC)[];
729
884
  /** List of all Service Hot Water (SHW) systems in the Model. */
@@ -741,7 +896,6 @@ declare class ModelEnergyProperties extends _OpenAPIGenBaseModel {
741
896
  validate(): Promise<boolean>;
742
897
  }
743
898
 
744
- /** Base class for all objects that are not extensible with additional keys.\n\nThis effectively includes all objects except for the Properties classes\nthat are assigned to geometry objects. */
745
899
  declare class ModelRadianceProperties extends _OpenAPIGenBaseModel {
746
900
  /** type */
747
901
  type: string;
@@ -776,7 +930,15 @@ declare class ModelProperties extends _OpenAPIGenBaseModel {
776
930
  validate(): Promise<boolean>;
777
931
  }
778
932
 
779
- /** Base class for all objects requiring a identifiers acceptable for all engines. */
933
+ /** An enumeration. */
934
+ declare enum Units {
935
+ Meters = "Meters",
936
+ Millimeters = "Millimeters",
937
+ Feet = "Feet",
938
+ Inches = "Inches",
939
+ Centimeters = "Centimeters"
940
+ }
941
+
780
942
  declare class Model extends IDdBaseModel {
781
943
  /** Extension properties for particular simulation engines (Radiance, EnergyPlus). */
782
944
  properties: ModelProperties;
@@ -803,8 +965,265 @@ declare class Model extends IDdBaseModel {
803
965
  validate(): Promise<boolean>;
804
966
  }
805
967
 
968
+ /** An enumeration. */
969
+ declare enum ModuleType {
970
+ Standard = "Standard",
971
+ Premium = "Premium",
972
+ ThinFilm = "ThinFilm"
973
+ }
974
+
975
+ /** Acceptable values for the moisture diffusion model for vegetation. */
976
+ declare enum MoistureDiffusionModel {
977
+ Simple = "Simple",
978
+ Advanced = "Advanced"
979
+ }
980
+
981
+ /** An enumeration. */
982
+ declare enum MountingType {
983
+ FixedOpenRack = "FixedOpenRack",
984
+ FixedRoofMounted = "FixedRoofMounted",
985
+ OneAxis = "OneAxis",
986
+ OneAxisBacktracking = "OneAxisBacktracking",
987
+ TwoAxis = "TwoAxis"
988
+ }
989
+
990
+ /** An enumeration. */
991
+ declare enum PSZEquipmentType {
992
+ PSZAC_ElectricBaseboard = "PSZAC_ElectricBaseboard",
993
+ PSZAC_BoilerBaseboard = "PSZAC_BoilerBaseboard",
994
+ PSZAC_DHWBaseboard = "PSZAC_DHWBaseboard",
995
+ PSZAC_GasHeaters = "PSZAC_GasHeaters",
996
+ PSZAC_ElectricCoil = "PSZAC_ElectricCoil",
997
+ PSZAC_GasCoil = "PSZAC_GasCoil",
998
+ PSZAC_Boiler = "PSZAC_Boiler",
999
+ PSZAC_ASHP = "PSZAC_ASHP",
1000
+ PSZAC_DHW = "PSZAC_DHW",
1001
+ PSZAC = "PSZAC",
1002
+ PSZAC_DCW_ElectricBaseboard = "PSZAC_DCW_ElectricBaseboard",
1003
+ PSZAC_DCW_BoilerBaseboard = "PSZAC_DCW_BoilerBaseboard",
1004
+ PSZAC_DCW_GasHeaters = "PSZAC_DCW_GasHeaters",
1005
+ PSZAC_DCW_ElectricCoil = "PSZAC_DCW_ElectricCoil",
1006
+ PSZAC_DCW_GasCoil = "PSZAC_DCW_GasCoil",
1007
+ PSZAC_DCW_Boiler = "PSZAC_DCW_Boiler",
1008
+ PSZAC_DCW_ASHP = "PSZAC_DCW_ASHP",
1009
+ PSZAC_DCW_DHW = "PSZAC_DCW_DHW",
1010
+ PSZAC_DCW = "PSZAC_DCW",
1011
+ PSZHP = "PSZHP"
1012
+ }
1013
+
1014
+ /** An enumeration. */
1015
+ declare enum PTACEquipmentType {
1016
+ PTAC_ElectricBaseboard = "PTAC_ElectricBaseboard",
1017
+ PTAC_BoilerBaseboard = "PTAC_BoilerBaseboard",
1018
+ PTAC_DHWBaseboard = "PTAC_DHWBaseboard",
1019
+ PTAC_GasHeaters = "PTAC_GasHeaters",
1020
+ PTAC_ElectricCoil = "PTAC_ElectricCoil",
1021
+ PTAC_GasCoil = "PTAC_GasCoil",
1022
+ PTAC_Boiler = "PTAC_Boiler",
1023
+ PTAC_ASHP = "PTAC_ASHP",
1024
+ PTAC_DHW = "PTAC_DHW",
1025
+ PTAC = "PTAC",
1026
+ PTHP = "PTHP"
1027
+ }
1028
+
1029
+ /** An enumeration. */
1030
+ declare enum PVAVEquipmentType {
1031
+ PVAV_Boiler = "PVAV_Boiler",
1032
+ PVAV_ASHP = "PVAV_ASHP",
1033
+ PVAV_DHW = "PVAV_DHW",
1034
+ PVAV_PFP = "PVAV_PFP",
1035
+ PVAV_BoilerElectricReheat = "PVAV_BoilerElectricReheat"
1036
+ }
1037
+
1038
+ /** An enumeration. */
1039
+ declare enum RadiantEquipmentType {
1040
+ Radiant_Chiller_Boiler = "Radiant_Chiller_Boiler",
1041
+ Radiant_Chiller_ASHP = "Radiant_Chiller_ASHP",
1042
+ Radiant_Chiller_DHW = "Radiant_Chiller_DHW",
1043
+ Radiant_ACChiller_Boiler = "Radiant_ACChiller_Boiler",
1044
+ Radiant_ACChiller_ASHP = "Radiant_ACChiller_ASHP",
1045
+ Radiant_ACChiller_DHW = "Radiant_ACChiller_DHW",
1046
+ Radiant_DCW_Boiler = "Radiant_DCW_Boiler",
1047
+ Radiant_DCW_ASHP = "Radiant_DCW_ASHP",
1048
+ Radiant_DCW_DHW = "Radiant_DCW_DHW"
1049
+ }
1050
+
1051
+ /** An enumeration. */
1052
+ declare enum RadiantFaceTypes {
1053
+ Floor = "Floor",
1054
+ Ceiling = "Ceiling",
1055
+ FloorWithCarpet = "FloorWithCarpet",
1056
+ CeilingMetalPanel = "CeilingMetalPanel",
1057
+ FloorWithHardwood = "FloorWithHardwood"
1058
+ }
1059
+
1060
+ /** An enumeration. */
1061
+ declare enum RadiantwithDOASEquipmentType {
1062
+ DOAS_Radiant_Chiller_Boiler = "DOAS_Radiant_Chiller_Boiler",
1063
+ DOAS_Radiant_Chiller_ASHP = "DOAS_Radiant_Chiller_ASHP",
1064
+ DOAS_Radiant_Chiller_DHW = "DOAS_Radiant_Chiller_DHW",
1065
+ DOAS_Radiant_ACChiller_Boiler = "DOAS_Radiant_ACChiller_Boiler",
1066
+ DOAS_Radiant_ACChiller_ASHP = "DOAS_Radiant_ACChiller_ASHP",
1067
+ DOAS_Radiant_ACChiller_DHW = "DOAS_Radiant_ACChiller_DHW",
1068
+ DOAS_Radiant_DCW_Boiler = "DOAS_Radiant_DCW_Boiler",
1069
+ DOAS_Radiant_DCW_ASHP = "DOAS_Radiant_DCW_ASHP",
1070
+ DOAS_Radiant_DCW_DHW = "DOAS_Radiant_DCW_DHW"
1071
+ }
1072
+
1073
+ /** An enumeration. */
1074
+ declare enum ResidentialEquipmentType {
1075
+ ResidentialAC_ElectricBaseboard = "ResidentialAC_ElectricBaseboard",
1076
+ ResidentialAC_BoilerBaseboard = "ResidentialAC_BoilerBaseboard",
1077
+ ResidentialAC_ASHPBaseboard = "ResidentialAC_ASHPBaseboard",
1078
+ ResidentialAC_DHWBaseboard = "ResidentialAC_DHWBaseboard",
1079
+ ResidentialAC_ResidentialFurnace = "ResidentialAC_ResidentialFurnace",
1080
+ ResidentialAC = "ResidentialAC",
1081
+ ResidentialHP = "ResidentialHP",
1082
+ ResidentialHPNoCool = "ResidentialHPNoCool",
1083
+ ResidentialFurnace = "ResidentialFurnace"
1084
+ }
1085
+
1086
+ /** Relative roughness of a particular material layer. */
1087
+ declare enum Roughness {
1088
+ VeryRough = "VeryRough",
1089
+ Rough = "Rough",
1090
+ MediumRough = "MediumRough",
1091
+ MediumSmooth = "MediumSmooth",
1092
+ Smooth = "Smooth",
1093
+ VerySmooth = "VerySmooth"
1094
+ }
1095
+
1096
+ /** Designates how the range values are validated. */
1097
+ declare enum ScheduleNumericType {
1098
+ Continuous = "Continuous",
1099
+ Discrete = "Discrete"
1100
+ }
1101
+
1102
+ /** An enumeration. */
1103
+ declare enum ScheduleUnitType {
1104
+ Dimensionless = "Dimensionless",
1105
+ Temperature = "Temperature",
1106
+ DeltaTemperature = "DeltaTemperature",
1107
+ PrecipitationRate = "PrecipitationRate",
1108
+ Angle = "Angle",
1109
+ ConvectionCoefficient = "ConvectionCoefficient",
1110
+ ActivityLevel = "ActivityLevel",
1111
+ Velocity = "Velocity",
1112
+ Capacity = "Capacity",
1113
+ Power = "Power",
1114
+ Availability = "Availability",
1115
+ Percent = "Percent",
1116
+ Control = "Control",
1117
+ Mode = "Mode"
1118
+ }
1119
+
1120
+ /** Choices for where a shade material is located in a window assembly. */
1121
+ declare enum ShadeLocation {
1122
+ Interior = "Interior",
1123
+ Between = "Between",
1124
+ Exterior = "Exterior"
1125
+ }
1126
+
1127
+ /** An enumeration. */
1128
+ declare enum SHWEquipmentType {
1129
+ Gas_WaterHeater = "Gas_WaterHeater",
1130
+ Electric_WaterHeater = "Electric_WaterHeater",
1131
+ HeatPump_WaterHeater = "HeatPump_WaterHeater",
1132
+ Gas_TanklessHeater = "Gas_TanklessHeater",
1133
+ Electric_TanklessHeater = "Electric_TanklessHeater",
1134
+ District_WaterHeater = "District_WaterHeater",
1135
+ District_TanklessHeater = "District_TanklessHeater"
1136
+ }
1137
+
1138
+ /** An enumeration. */
1139
+ declare enum SlatOrientation {
1140
+ Horizontal = "Horizontal",
1141
+ Vertical = "Vertical"
1142
+ }
1143
+
1144
+ /** An enumeration. */
1145
+ declare enum VAVEquipmentType {
1146
+ VAV_Chiller_Boiler = "VAV_Chiller_Boiler",
1147
+ VAV_Chiller_ASHP = "VAV_Chiller_ASHP",
1148
+ VAV_Chiller_DHW = "VAV_Chiller_DHW",
1149
+ VAV_Chiller_PFP = "VAV_Chiller_PFP",
1150
+ VAV_Chiller_GasCoil = "VAV_Chiller_GasCoil",
1151
+ VAV_ACChiller_Boiler = "VAV_ACChiller_Boiler",
1152
+ VAV_ACChiller_ASHP = "VAV_ACChiller_ASHP",
1153
+ VAV_ACChiller_DHW = "VAV_ACChiller_DHW",
1154
+ VAV_ACChiller_PFP = "VAV_ACChiller_PFP",
1155
+ VAV_ACChiller_GasCoil = "VAV_ACChiller_GasCoil",
1156
+ VAV_DCW_Boiler = "VAV_DCW_Boiler",
1157
+ VAV_DCW_ASHP = "VAV_DCW_ASHP",
1158
+ VAV_DCW_DHW = "VAV_DCW_DHW",
1159
+ VAV_DCW_PFP = "VAV_DCW_PFP",
1160
+ VAV_DCW_GasCoil = "VAV_DCW_GasCoil"
1161
+ }
1162
+
1163
+ /** An enumeration. */
1164
+ declare enum VentilationMethod {
1165
+ Sum = "Sum",
1166
+ Max = "Max"
1167
+ }
1168
+
1169
+ /** An enumeration. */
1170
+ declare enum VentilationType {
1171
+ Exhaust = "Exhaust",
1172
+ Intake = "Intake",
1173
+ Balanced = "Balanced"
1174
+ }
1175
+
1176
+ /** An enumeration. */
1177
+ declare enum Vintages {
1178
+ ASHRAE_2019 = "ASHRAE_2019",
1179
+ ASHRAE_2016 = "ASHRAE_2016",
1180
+ ASHRAE_2013 = "ASHRAE_2013",
1181
+ ASHRAE_2010 = "ASHRAE_2010",
1182
+ ASHRAE_2007 = "ASHRAE_2007",
1183
+ ASHRAE_2004 = "ASHRAE_2004",
1184
+ DOE_Ref_1980_2004 = "DOE_Ref_1980_2004",
1185
+ DOE_Ref_Pre_1980 = "DOE_Ref_Pre_1980"
1186
+ }
1187
+
1188
+ /** An enumeration. */
1189
+ declare enum VRFEquipmentType {
1190
+ VRF = "VRF"
1191
+ }
1192
+
1193
+ /** An enumeration. */
1194
+ declare enum VRFwithDOASEquipmentType {
1195
+ DOAS_VRF = "DOAS_VRF"
1196
+ }
1197
+
1198
+ /** An enumeration. */
1199
+ declare enum WindowACEquipmentType {
1200
+ WindowAC_ElectricBaseboard = "WindowAC_ElectricBaseboard",
1201
+ WindowAC_BoilerBaseboard = "WindowAC_BoilerBaseboard",
1202
+ WindowAC_ASHPBaseboard = "WindowAC_ASHPBaseboard",
1203
+ WindowAC_DHWBaseboard = "WindowAC_DHWBaseboard",
1204
+ WindowAC_Furnace = "WindowAC_Furnace",
1205
+ WindowAC_GasHeaters = "WindowAC_GasHeaters",
1206
+ WindowAC = "WindowAC"
1207
+ }
1208
+
1209
+ /** An enumeration. */
1210
+ declare enum WSHPEquipmentType {
1211
+ WSHP_FluidCooler_Boiler = "WSHP_FluidCooler_Boiler",
1212
+ WSHP_CoolingTower_Boiler = "WSHP_CoolingTower_Boiler",
1213
+ WSHP_GSHP = "WSHP_GSHP",
1214
+ WSHP_DCW_DHW = "WSHP_DCW_DHW"
1215
+ }
1216
+
1217
+ /** An enumeration. */
1218
+ declare enum WSHPwithDOASEquipmentType {
1219
+ DOAS_WSHP_FluidCooler_Boiler = "DOAS_WSHP_FluidCooler_Boiler",
1220
+ DOAS_WSHP_CoolingTower_Boiler = "DOAS_WSHP_CoolingTower_Boiler",
1221
+ DOAS_WSHP_GSHP = "DOAS_WSHP_GSHP",
1222
+ DOAS_WSHP_DCW_DHW = "DOAS_WSHP_DCW_DHW"
1223
+ }
1224
+
806
1225
  declare function IsNestedNumberArray(validationOptions?: ValidationOptions): (object: Object, propertyName: string) => void;
807
1226
  declare function IsNestedIntegerArray(validationOptions?: ValidationOptions): (object: Object, propertyName: string) => void;
808
1227
  declare function IsNestedStringArray(validationOptions?: ValidationOptions): (object: Object, propertyName: string) => void;
809
1228
 
810
- export { Building, BuildingEnergyPropertiesAbridged, BuildingPropertiesAbridged, BuildingRadiancePropertiesAbridged, ContextShade, ContextShadeEnergyPropertiesAbridged, ContextShadePropertiesAbridged, ContextShadeRadiancePropertiesAbridged, DetailedSkylights, DetailedWindows, ExteriorApertureGridParameter, ExteriorApertureType, ExteriorFaceGridParameter, ExteriorFaceType, ExtrudedBorder, GriddedSkylightArea, GriddedSkylightRatio, IsNestedIntegerArray, IsNestedNumberArray, IsNestedStringArray, LouversByCount, LouversByDistance, Model, ModelComparisonProperties, ModelDoe2Properties, ModelEnergyProperties, ModelProperties, ModelRadianceProperties, Overhang, RectangularWindows, RepeatingWindowRatio, RoofSpecification, Room2D, Room2DComparisonProperties, Room2DDoe2Properties, Room2DEnergyPropertiesAbridged, Room2DPropertiesAbridged, Room2DRadiancePropertiesAbridged, RoomGridParameter, RoomRadialGridParameter, SimpleWindowArea, SimpleWindowRatio, SingleWindow, Story, StoryEnergyPropertiesAbridged, StoryPropertiesAbridged, StoryRadiancePropertiesAbridged, StoryType, _GridParameterBase, _LouversBase, _OpenAPIGenBaseModel, _WindowParameterBase };
1229
+ export { AllAirEconomizerType, BaseboardEquipmentType, Building, BuildingEnergyPropertiesAbridged, BuildingPropertiesAbridged, BuildingRadiancePropertiesAbridged, ContextShade, ContextShadeEnergyPropertiesAbridged, ContextShadePropertiesAbridged, ContextShadeRadiancePropertiesAbridged, ControlType, DetailedClearstory, DetailedSkylights, DetailedWindows, EconomizerType, EvaporativeCoolerEquipmentType, ExteriorApertureGridParameter, ExteriorApertureType, ExteriorFaceGridParameter, ExteriorFaceType, ExtrudedBorder, FCUEquipmentType, FCUwithDOASEquipmentType, FaceType, FuelTypes, FurnaceEquipmentType, GasType, GasUnitHeaterEquipmentType, GriddedSkylightArea, GriddedSkylightRatio, IsNestedIntegerArray, IsNestedNumberArray, IsNestedStringArray, LouversByCount, LouversByDistance, Model, ModelComparisonProperties, ModelDoe2Properties, ModelEnergyProperties, ModelProperties, ModelRadianceProperties, ModuleType, MoistureDiffusionModel, MountingType, Overhang, PSZEquipmentType, PTACEquipmentType, PVAVEquipmentType, RadiantEquipmentType, RadiantFaceTypes, RadiantwithDOASEquipmentType, RectangularWindows, RepeatingWindowRatio, ResidentialEquipmentType, RoofSpecification, Room2D, Room2DComparisonProperties, Room2DDoe2Properties, Room2DEnergyPropertiesAbridged, Room2DPropertiesAbridged, Room2DRadiancePropertiesAbridged, RoomGridParameter, RoomRadialGridParameter, Roughness, SHWEquipmentType, ScheduleNumericType, ScheduleUnitType, ShadeLocation, SimpleWindowArea, SimpleWindowRatio, SingleWindow, SlatOrientation, Story, StoryEnergyPropertiesAbridged, StoryPropertiesAbridged, StoryRadiancePropertiesAbridged, StoryType, Units, VAVEquipmentType, VRFEquipmentType, VRFwithDOASEquipmentType, VentilationMethod, VentilationType, Vintages, WSHPEquipmentType, WSHPwithDOASEquipmentType, WindowACEquipmentType, _GridParameterBase, _LouversBase, _OpenAPIGenBaseModel, _WindowParameterBase };