dragonfly-schema 1.1500.0 → 1.1501.2

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.cts CHANGED
@@ -3,11 +3,12 @@ import { ValidationOptions } from 'class-validator';
3
3
 
4
4
  declare abstract class _OpenAPIGenBaseModel {
5
5
  /** A base class to use when there is no baseclass available to fall on. */
6
- type?: string;
6
+ type: string;
7
7
  constructor();
8
8
  init(_data?: any): void;
9
9
  static fromJS(data: any): _OpenAPIGenBaseModel;
10
- toJSON(data?: any): any;
10
+ toJSON(data?: any): Record<string, any>;
11
+ validate(): Promise<boolean>;
11
12
  }
12
13
 
13
14
  /** Base object for all GridParameters. */
@@ -15,9 +16,9 @@ declare class _GridParameterBase extends _OpenAPIGenBaseModel {
15
16
  /** The dimension of the grid cells as a number. */
16
17
  dimension: number;
17
18
  /** A boolean to note whether the resulting SensorGrid should include the mesh. */
18
- include_mesh?: boolean;
19
- /** Type */
20
- type?: string;
19
+ includeMesh: boolean;
20
+ /** type */
21
+ type: string;
21
22
  constructor();
22
23
  init(_data?: any): void;
23
24
  static fromJS(data: any): _GridParameterBase;
@@ -30,15 +31,15 @@ declare class _LouversBase extends _OpenAPIGenBaseModel {
30
31
  /** A number for the depth to extrude the louvers. */
31
32
  depth: number;
32
33
  /** A number for the distance to louvers from the wall. */
33
- offset?: number;
34
+ offset: number;
34
35
  /** A number between -90 and 90 for the for an angle to rotate the louvers in degrees. 0 indicates louvers perpendicular to the wall. Positive values indicate a downward rotation. Negative values indicate an upward rotation. */
35
- angle?: number;
36
+ angle: number;
36
37
  /** A list of two float values representing the (x, y) of a 2D vector for the direction along which contours are generated. (0, 1) will generate horizontal contours, (1, 0) will generate vertical contours, and (1, 1) will generate diagonal contours. */
37
- contour_vector?: number[];
38
+ contourVector: number[];
38
39
  /** Boolean to note whether the side the louvers start from should be flipped. Default is False to have contours on top or right. Setting to True will start contours on the bottom or left. */
39
- flip_start_side?: boolean;
40
- /** Type */
41
- type?: string;
40
+ flipStartSide: boolean;
41
+ /** type */
42
+ type: string;
42
43
  constructor();
43
44
  init(_data?: any): void;
44
45
  static fromJS(data: any): _LouversBase;
@@ -49,9 +50,9 @@ declare class _LouversBase extends _OpenAPIGenBaseModel {
49
50
  /** Base class for all window parameters. */
50
51
  declare class _WindowParameterBase extends _OpenAPIGenBaseModel {
51
52
  /** Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list). When a list is used, each item in the list will be assigned to the generated Honeybee apertures. */
52
- user_data?: Object;
53
- /** Type */
54
- type?: string;
53
+ userData?: Object;
54
+ /** type */
55
+ type: string;
55
56
  constructor();
56
57
  init(_data?: any): void;
57
58
  static fromJS(data: any): _WindowParameterBase;
@@ -61,14 +62,14 @@ declare class _WindowParameterBase extends _OpenAPIGenBaseModel {
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
64
  declare class BuildingEnergyPropertiesAbridged extends _OpenAPIGenBaseModel {
64
- /** Type */
65
- type?: string;
65
+ /** type */
66
+ type: string;
66
67
  /** Name of a ConstructionSet to specify all constructions for the Building. If None, the Model global_construction_set will be used. */
67
- construction_set?: string;
68
+ constructionSet?: string;
68
69
  /** Identifier of an OpaqueConstruction for the bottoms of ceiling plenums. Materials should be ordered from the plenum side to the room side. By default, this is a simple acoustic tile construction. */
69
- ceiling_plenum_construction?: string;
70
+ ceilingPlenumConstruction?: string;
70
71
  /** Identifier of an OpaqueConstruction for the tops of floor plenums. Materials should be ordered from the plenum side to the room side. By default, this is a simple wood plank construction. */
71
- floor_plenum_construction?: string;
72
+ floorPlenumConstruction?: string;
72
73
  constructor();
73
74
  init(_data?: any): void;
74
75
  static fromJS(data: any): BuildingEnergyPropertiesAbridged;
@@ -78,10 +79,10 @@ declare class BuildingEnergyPropertiesAbridged extends _OpenAPIGenBaseModel {
78
79
 
79
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. */
80
81
  declare class BuildingRadiancePropertiesAbridged extends _OpenAPIGenBaseModel {
81
- /** Type */
82
- type?: string;
82
+ /** type */
83
+ type: string;
83
84
  /** Name of a ModifierSet to specify all modifiers for the Building. If None, the Model global_modifier_set will be used. */
84
- modifier_set?: string;
85
+ modifierSet?: string;
85
86
  constructor();
86
87
  init(_data?: any): void;
87
88
  static fromJS(data: any): BuildingRadiancePropertiesAbridged;
@@ -90,11 +91,11 @@ declare class BuildingRadiancePropertiesAbridged extends _OpenAPIGenBaseModel {
90
91
  }
91
92
 
92
93
  declare class BuildingPropertiesAbridged extends _OpenAPIGenBaseModel {
93
- /** Type */
94
- type?: string;
95
- /** Energy */
94
+ /** type */
95
+ type: string;
96
+ /** energy */
96
97
  energy?: BuildingEnergyPropertiesAbridged;
97
- /** Radiance */
98
+ /** radiance */
98
99
  radiance?: BuildingRadiancePropertiesAbridged;
99
100
  constructor();
100
101
  init(_data?: any): void;
@@ -107,8 +108,8 @@ declare class BuildingPropertiesAbridged extends _OpenAPIGenBaseModel {
107
108
  declare class RoofSpecification extends _OpenAPIGenBaseModel {
108
109
  /** An array of Face3D objects representing the geometry of the Roof. None of these geometries should overlap in plan and, together, these Face3D should either completely cover or skip each Room2D of the Story to which the RoofSpecification is assigned. */
109
110
  geometry: Face3D[];
110
- /** Type */
111
- type?: string;
111
+ /** type */
112
+ type: string;
112
113
  constructor();
113
114
  init(_data?: any): void;
114
115
  static fromJS(data: any): RoofSpecification;
@@ -120,10 +121,10 @@ declare class RoofSpecification extends _OpenAPIGenBaseModel {
120
121
  declare class DetailedSkylights extends _OpenAPIGenBaseModel {
121
122
  /** An array of arrays with each sub-array representing a polygonal boundary of a skylight. Each sub-array should consist of arrays representing points, which contain 2 values for 2D coordinates in the world XY system. These coordinate values should lie within the parent Room2D Polygon. */
122
123
  polygons: number[][][];
123
- /** Type */
124
- type?: string;
124
+ /** type */
125
+ type: string;
125
126
  /** An array of booleans that align with the polygons and note whether each of the polygons represents an overhead door (True) or a skylight (False). If None, it will be assumed that all polygons represent skylights and they will be translated to Apertures in any resulting Honeybee model. */
126
- are_doors?: boolean[];
127
+ areDoors?: boolean[];
127
128
  constructor();
128
129
  init(_data?: any): void;
129
130
  static fromJS(data: any): DetailedSkylights;
@@ -135,10 +136,10 @@ declare class DetailedSkylights extends _OpenAPIGenBaseModel {
135
136
  declare class DetailedWindows extends _WindowParameterBase {
136
137
  /** An array of arrays with each sub-array representing a polygonal boundary of a window. Each sub-array should consist of arrays representing points, which can either contain 2 values (indicating they are 2D vertices within the plane of a parent wall segment) or they can contain 3 values (indicating they are 3D world coordinates). For 2D points, the wall plane is assumed to have an origin at the first point of the wall segment and an X-axis extending along the length of the segment. The wall plane Y-axis always points upwards. Therefore, both X and Y values of each point in the polygon should always be positive. Some sample code to convert from 2D vertices to 2D vertices in the plane of the wall can be found here: https://www.ladybug.tools/dragonfly-core/docs/dragonfly.windowparameter.html#dragonfly.windowparameter.DetailedWindows */
137
138
  polygons: number[][][];
138
- /** Type */
139
- type?: string;
139
+ /** type */
140
+ type: string;
140
141
  /** An array of booleans that align with the polygons and note whether each of the polygons represents a door (True) or a 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. */
141
- are_doors?: boolean[];
142
+ areDoors?: boolean[];
142
143
  constructor();
143
144
  init(_data?: any): void;
144
145
  static fromJS(data: any): DetailedWindows;
@@ -150,8 +151,8 @@ declare class DetailedWindows extends _WindowParameterBase {
150
151
  declare class ExtrudedBorder extends _OpenAPIGenBaseModel {
151
152
  /** A number for the depth of the border. */
152
153
  depth: number;
153
- /** Type */
154
- type?: string;
154
+ /** type */
155
+ type: string;
155
156
  constructor();
156
157
  init(_data?: any): void;
157
158
  static fromJS(data: any): ExtrudedBorder;
@@ -162,11 +163,11 @@ declare class ExtrudedBorder extends _OpenAPIGenBaseModel {
162
163
  /** Gridded skylights defined by an absolute area. */
163
164
  declare class GriddedSkylightArea extends _OpenAPIGenBaseModel {
164
165
  /** A number for the skylight area in current model units. If this area is larger than the area of the roof that it is applied to, the skylight will fill the parent roof at a 99 percent ratio. */
165
- skylight_area: number;
166
- /** Type */
167
- type?: string;
166
+ skylightArea: number;
167
+ /** type */
168
+ type: string;
168
169
  /** A number for the spacing between the centers of each grid cell. This should be less than a third of the dimension of the Roof geometry if multiple, evenly-spaced skylights are desired. If Autocalculate, a spacing of one third the smaller dimension of the parent Roof will be automatically assumed. */
169
- spacing?: (Autocalculate | number);
170
+ spacing: (Autocalculate | number);
170
171
  constructor();
171
172
  init(_data?: any): void;
172
173
  static fromJS(data: any): GriddedSkylightArea;
@@ -177,11 +178,11 @@ declare class GriddedSkylightArea extends _OpenAPIGenBaseModel {
177
178
  /** Gridded skylights derived from an area ratio with the roof. */
178
179
  declare class GriddedSkylightRatio extends _OpenAPIGenBaseModel {
179
180
  /** A number between 0 and 1 for the ratio between the skylight area and the total Roof face area. */
180
- skylight_ratio: number;
181
- /** Type */
182
- type?: string;
181
+ skylightRatio: number;
182
+ /** type */
183
+ type: string;
183
184
  /** A number for the spacing between the centers of each grid cell. This should be less than a third of the dimension of the Roof geometry if multiple, evenly-spaced skylights are desired. If Autocalculate, a spacing of one third the smaller dimension of the parent Roof will be automatically assumed. */
184
- spacing?: (Autocalculate | number);
185
+ spacing: (Autocalculate | number);
185
186
  constructor();
186
187
  init(_data?: any): void;
187
188
  static fromJS(data: any): GriddedSkylightRatio;
@@ -192,9 +193,9 @@ declare class GriddedSkylightRatio extends _OpenAPIGenBaseModel {
192
193
  /** A specific number of louvered Shades over a wall. */
193
194
  declare class LouversByCount extends _LouversBase {
194
195
  /** A positive integer for the number of louvers to generate. */
195
- louver_count: number;
196
- /** Type */
197
- type?: string;
196
+ louverCount: number;
197
+ /** type */
198
+ type: string;
198
199
  constructor();
199
200
  init(_data?: any): void;
200
201
  static fromJS(data: any): LouversByCount;
@@ -206,8 +207,8 @@ declare class LouversByCount extends _LouversBase {
206
207
  declare class LouversByDistance extends _LouversBase {
207
208
  /** A number for the approximate distance between each louver. */
208
209
  distance: number;
209
- /** Type */
210
- type?: string;
210
+ /** type */
211
+ type: string;
211
212
  constructor();
212
213
  init(_data?: any): void;
213
214
  static fromJS(data: any): LouversByDistance;
@@ -219,10 +220,10 @@ declare class LouversByDistance extends _LouversBase {
219
220
  declare class Overhang extends _OpenAPIGenBaseModel {
220
221
  /** A number for the overhang depth. */
221
222
  depth: number;
222
- /** Type */
223
- type?: string;
223
+ /** type */
224
+ type: string;
224
225
  /** A number between -90 and 90 for the for an angle to rotate the overhang in degrees. 0 indicates an overhang perpendicular to the wall. Positive values indicate a downward rotation. Negative values indicate an upward rotation. */
225
- angle?: number;
226
+ angle: number;
226
227
  constructor();
227
228
  init(_data?: any): void;
228
229
  static fromJS(data: any): Overhang;
@@ -238,10 +239,10 @@ declare class RectangularWindows extends _WindowParameterBase {
238
239
  widths: number[];
239
240
  /** An array of positive numbers for the window heights. The length of this list must match the length of the origins. */
240
241
  heights: number[];
241
- /** Type */
242
- type?: string;
242
+ /** type */
243
+ type: string;
243
244
  /** An array of booleans that align with the origins and note whether each of the geometries represents a door (True) or a window (False). If None, it will be assumed that all geometries represent windows and they will be translated to Apertures in any resulting Honeybee model. */
244
- are_doors?: boolean[];
245
+ areDoors?: boolean[];
245
246
  constructor();
246
247
  init(_data?: any): void;
247
248
  static fromJS(data: any): RectangularWindows;
@@ -252,17 +253,17 @@ declare class RectangularWindows extends _WindowParameterBase {
252
253
  /** Repeating windows derived from an area ratio with the base wall. */
253
254
  declare class RepeatingWindowRatio extends _WindowParameterBase {
254
255
  /** A number between 0 and 1 for the ratio between the window area and the parent wall surface area. */
255
- window_ratio: number;
256
+ windowRatio: number;
256
257
  /** A number for the target height of the windows. Note that, if the window ratio is too large for the height, the ratio will take precedence and the actual window_height will be larger than this value. */
257
- window_height: number;
258
+ windowHeight: number;
258
259
  /** 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. */
259
- sill_height: number;
260
+ sillHeight: number;
260
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. */
261
- horizontal_separation: number;
262
- /** Type */
263
- type?: string;
262
+ horizontalSeparation: number;
263
+ /** type */
264
+ type: string;
264
265
  /** An optional number to create a single vertical separation between top and bottom windows. */
265
- vertical_separation?: number;
266
+ verticalSeparation: number;
266
267
  constructor();
267
268
  init(_data?: any): void;
268
269
  static fromJS(data: any): RepeatingWindowRatio;
@@ -273,11 +274,11 @@ declare class RepeatingWindowRatio extends _WindowParameterBase {
273
274
  /** A single window defined by an absolute area. */
274
275
  declare class SimpleWindowArea extends _WindowParameterBase {
275
276
  /** A number for the window area in current model units. If this area is larger than the area of the Wall that it is appliedto, the window will fill the parent Wall at a 99 percent ratio. */
276
- window_area: number;
277
- /** Type */
278
- type?: string;
277
+ windowArea: number;
278
+ /** type */
279
+ type: string;
279
280
  /** Boolean to note whether rectangular portions of base Face should be extracted before scaling them to create apertures. For pentagonal gabled geometries, this results in one rectangle and one triangle, which can often look more realistic and is a better input for engines like EnergyPlus that cannot model windows with more than 4 vertices. However, if a single pentagonal window is desired for such a gabled shape, this input can be set to False to produce such a result. */
280
- rect_split?: boolean;
281
+ rectSplit: boolean;
281
282
  constructor();
282
283
  init(_data?: any): void;
283
284
  static fromJS(data: any): SimpleWindowArea;
@@ -288,11 +289,11 @@ declare class SimpleWindowArea extends _WindowParameterBase {
288
289
  /** A single window defined by an area ratio with the base surface. */
289
290
  declare class SimpleWindowRatio extends _WindowParameterBase {
290
291
  /** A number between 0 and 1 for the ratio between the window area and the parent wall surface area. */
291
- window_ratio: number;
292
- /** Type */
293
- type?: string;
292
+ windowRatio: number;
293
+ /** type */
294
+ type: string;
294
295
  /** Boolean to note whether rectangular portions of base Face should be extracted before scaling them to create apertures. For pentagonal gabled geometries, this results in one rectangle and one triangle, which can often look more realistic and is a better input for engines like EnergyPlus that cannot model windows with more than 4 vertices. However, if a single pentagonal window is desired for such a gabled shape, this input can be set to False to produce such a result. */
295
- rect_split?: boolean;
296
+ rectSplit: boolean;
296
297
  constructor();
297
298
  init(_data?: any): void;
298
299
  static fromJS(data: any): SimpleWindowRatio;
@@ -306,10 +307,10 @@ declare class SingleWindow extends _WindowParameterBase {
306
307
  width: number;
307
308
  /** A number for the window height. Note that, if this height is applied to a wall that is too short for this height, the generated window will automatically be shortened when it is applied to the wall. */
308
309
  height: number;
309
- /** Type */
310
- type?: string;
310
+ /** type */
311
+ type: string;
311
312
  /** A number for the window sill height. */
312
- sill_height?: number;
313
+ sillHeight: number;
313
314
  constructor();
314
315
  init(_data?: any): void;
315
316
  static fromJS(data: any): SingleWindow;
@@ -319,16 +320,16 @@ declare class SingleWindow extends _WindowParameterBase {
319
320
 
320
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. */
321
322
  declare class Room2DComparisonProperties extends _OpenAPIGenBaseModel {
322
- /** Type */
323
- type?: string;
323
+ /** type */
324
+ type: string;
324
325
  /** A list of 2D points representing the outer boundary vertices of the Room2D to which the host Room2D is being compared. The list should include at least 3 points and each point should be a list of 2 (x, y) values. */
325
- floor_boundary?: number[][];
326
+ floorBoundary?: number[][];
326
327
  /** Optional list of lists with one list for each hole in the floor plate of the Room2D to which the host Room2D is being compared. Each hole should be a list of at least 2 points and each point a list of 2 (x, y) values. If None, it will be assumed that there are no holes in the floor plate. */
327
- floor_holes?: number[][][];
328
+ floorHoles?: number[][][];
328
329
  /** A list of WindowParameter objects that dictate the window geometries of the Room2D to which the host Room2D is being compared. */
329
- comparison_windows?: (SingleWindow | SimpleWindowArea | SimpleWindowRatio | RepeatingWindowRatio | RectangularWindows | DetailedWindows)[];
330
+ comparisonWindows?: (SingleWindow | SimpleWindowArea | SimpleWindowRatio | RepeatingWindowRatio | RectangularWindows | DetailedWindows)[];
330
331
  /** A SkylightParameter object for the Room2D to which the host Room2D is being compared. */
331
- comparison_skylight?: (GriddedSkylightArea | GriddedSkylightRatio | DetailedSkylights);
332
+ comparisonSkylight?: (GriddedSkylightArea | GriddedSkylightRatio | DetailedSkylights);
332
333
  constructor();
333
334
  init(_data?: any): void;
334
335
  static fromJS(data: any): Room2DComparisonProperties;
@@ -336,24 +337,45 @@ declare class Room2DComparisonProperties extends _OpenAPIGenBaseModel {
336
337
  validate(): Promise<boolean>;
337
338
  }
338
339
 
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
+ declare class Room2DDoe2Properties extends _OpenAPIGenBaseModel {
342
+ /** type */
343
+ type: string;
344
+ /** A number for the design supply air flow rate for the zone the Room is assigned to (cfm). This establishes the minimum allowed design air flow. Note that the actual design flow may be larger. If Autocalculate, this parameter will not be written into the INP. */
345
+ assignedFlow: (Autocalculate | number);
346
+ /** A number for the design supply air flow rate to the zone per unit floor area (cfm/ft2). If Autocalculate, this parameter will not be written into the INP. */
347
+ flowPerArea: (Autocalculate | number);
348
+ /** A number between 0 and 1 for the minimum allowable zone air supply flow rate, expressed as a fraction of design flow rate. Applicable to variable-volume type systems only. If Autocalculate, this parameter will not be written into the INP. */
349
+ minFlowRatio: (Autocalculate | number);
350
+ /** A number for the minimum air flow per square foot of floor area (cfm/ft2). This is an alternative way of specifying the min_flow_ratio. If Autocalculate, this parameter will not be written into the INP. */
351
+ minFlowPerArea: (Autocalculate | number);
352
+ /** A number between 0 and 1 for the ratio of the maximum (or fixed) heating airflow to the cooling airflow. The specific meaning varies according to the type of zone terminal. If Autocalculate, this parameter will not be written into the INP. */
353
+ hmaxFlowRatio: (Autocalculate | number);
354
+ constructor();
355
+ init(_data?: any): void;
356
+ static fromJS(data: any): Room2DDoe2Properties;
357
+ toJSON(data?: any): Record<string, any>;
358
+ validate(): Promise<boolean>;
359
+ }
360
+
339
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. */
340
362
  declare class Room2DEnergyPropertiesAbridged extends _OpenAPIGenBaseModel {
341
- /** Type */
342
- type?: string;
363
+ /** type */
364
+ type: string;
343
365
  /** Name of a ConstructionSet to specify all constructions for the Room2D. If None, the Room2D will use the Story or Building construction_set or the Model global_construction_set. Any ConstructionSet assigned here will override those assigned to these objects. */
344
- construction_set?: string;
366
+ constructionSet?: string;
345
367
  /** Name of a ProgramType to specify all schedules and loads for the Room2D. If None, the Room2D will have no loads or setpoints. */
346
- program_type?: string;
368
+ programType?: string;
347
369
  /** An optional identifier of a HVAC system (such as an IdealAirSystem) that specifies how the Room2D is conditioned. If None, it will be assumed that the Room2D is not conditioned. */
348
370
  hvac?: string;
349
371
  /** 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. */
350
372
  shw?: string;
351
373
  /** An optional VentilationControl object to dictate the opening of windows. If None, the windows will never open. */
352
- window_vent_control?: VentilationControlAbridged;
374
+ windowVentControl?: VentilationControlAbridged;
353
375
  /** An optional VentilationOpening to specify the operable portion of all windows of the Room2D. If None, the windows will never open. */
354
- window_vent_opening?: VentilationOpening;
376
+ windowVentOpening?: VentilationOpening;
355
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. */
356
- process_loads?: ProcessAbridged[];
378
+ processLoads?: ProcessAbridged[];
357
379
  constructor();
358
380
  init(_data?: any): void;
359
381
  static fromJS(data: any): Room2DEnergyPropertiesAbridged;
@@ -370,12 +392,12 @@ declare enum ExteriorApertureType {
370
392
 
371
393
  /** Instructions for a SensorGrid generated from exterior Aperture. */
372
394
  declare class ExteriorApertureGridParameter extends _GridParameterBase {
373
- /** Type */
374
- type?: string;
395
+ /** type */
396
+ type: string;
375
397
  /** A number for how far to offset the grid from the Apertures. (Default: 0.1, suitable for Models in Meters). */
376
- offset?: number;
398
+ offset: number;
377
399
  /** Text to specify the type of Aperture that will be used to generate grids. Window indicates Apertures in Walls. Skylights are in parent Roof faces. */
378
- aperture_type?: ExteriorApertureType;
400
+ apertureType: ExteriorApertureType;
379
401
  constructor();
380
402
  init(_data?: any): void;
381
403
  static fromJS(data: any): ExteriorApertureGridParameter;
@@ -393,14 +415,14 @@ declare enum ExteriorFaceType {
393
415
 
394
416
  /** Instructions for a SensorGrid generated from exterior Faces. */
395
417
  declare class ExteriorFaceGridParameter extends _GridParameterBase {
396
- /** Type */
397
- type?: string;
418
+ /** type */
419
+ type: string;
398
420
  /** A number for how far to offset the grid from the Faces. (Default: 0.1, suitable for Models in Meters). */
399
- offset?: number;
421
+ offset: number;
400
422
  /** Text to specify the type of face that will be used to generate grids. Note that only Faces with Outdoors boundary conditions will be used, meaning that most Floors will typically be excluded unless they represent the underside of a cantilever. */
401
- face_type?: ExteriorFaceType;
423
+ faceType: ExteriorFaceType;
402
424
  /** A boolean to note whether the punched_geometry of the faces should be used (True) with the areas of sub-faces removed from the grid or the full geometry should be used (False). */
403
- punched_geometry?: boolean;
425
+ punchedGeometry: boolean;
404
426
  constructor();
405
427
  init(_data?: any): void;
406
428
  static fromJS(data: any): ExteriorFaceGridParameter;
@@ -410,12 +432,12 @@ declare class ExteriorFaceGridParameter extends _GridParameterBase {
410
432
 
411
433
  /** Instructions for a SensorGrid generated from a Room2D's floors. */
412
434
  declare class RoomGridParameter extends _GridParameterBase {
413
- /** Type */
414
- type?: string;
435
+ /** type */
436
+ type: string;
415
437
  /** A number for how far to offset the grid from the Room2D floors. (Default: 1.0, suitable for Models in Meters). */
416
- offset?: number;
438
+ offset: number;
417
439
  /** 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. */
418
- wall_offset?: number;
440
+ wallOffset: number;
419
441
  constructor();
420
442
  init(_data?: any): void;
421
443
  static fromJS(data: any): RoomGridParameter;
@@ -426,13 +448,13 @@ declare class RoomGridParameter extends _GridParameterBase {
426
448
  /** 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. */
427
449
  declare class RoomRadialGridParameter extends RoomGridParameter {
428
450
  /** A positive integer for the number of radial directions to be generated around each position. */
429
- dir_count?: number;
451
+ dirCount: number;
430
452
  /** 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. */
431
- start_vector?: number[];
453
+ startVector?: number[];
432
454
  /** An optional number to override the radius of the meshes generated around each sensor. If Autocalculate, it will be equal to 45 percent of the grid dimension. */
433
- mesh_radius?: (Autocalculate | number);
434
- /** Type */
435
- type?: string;
455
+ meshRadius: (Autocalculate | number);
456
+ /** type */
457
+ type: string;
436
458
  constructor();
437
459
  init(_data?: any): void;
438
460
  static fromJS(data: any): RoomRadialGridParameter;
@@ -442,12 +464,12 @@ declare class RoomRadialGridParameter extends RoomGridParameter {
442
464
 
443
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. */
444
466
  declare class Room2DRadiancePropertiesAbridged extends _OpenAPIGenBaseModel {
445
- /** Type */
446
- type?: string;
467
+ /** type */
468
+ type: string;
447
469
  /** Identifier of a ModifierSet to specify all modifiers for the Room2D. If None, the Room2D will use the Story or Building modifier_set or the Model global_modifier_set. Any ModifierSet assigned here will override those assigned to the parent objects. */
448
- modifier_set?: string;
470
+ modifierSet?: string;
449
471
  /** An optional list of GridParameter objects to describe how sensor grids should be generated for the Room2D. */
450
- grid_parameters?: (RoomGridParameter | RoomRadialGridParameter | ExteriorFaceGridParameter | ExteriorApertureGridParameter)[];
472
+ gridParameters?: (RoomGridParameter | RoomRadialGridParameter | ExteriorFaceGridParameter | ExteriorApertureGridParameter)[];
451
473
  constructor();
452
474
  init(_data?: any): void;
453
475
  static fromJS(data: any): Room2DRadiancePropertiesAbridged;
@@ -456,13 +478,15 @@ declare class Room2DRadiancePropertiesAbridged extends _OpenAPIGenBaseModel {
456
478
  }
457
479
 
458
480
  declare class Room2DPropertiesAbridged extends _OpenAPIGenBaseModel {
459
- /** Type */
460
- type?: string;
461
- /** Energy */
481
+ /** type */
482
+ type: string;
483
+ /** energy */
462
484
  energy?: Room2DEnergyPropertiesAbridged;
463
- /** Radiance */
485
+ /** radiance */
464
486
  radiance?: Room2DRadiancePropertiesAbridged;
465
- /** Comparison */
487
+ /** doe2 */
488
+ doe2?: Room2DDoe2Properties;
489
+ /** comparison */
466
490
  comparison?: Room2DComparisonProperties;
467
491
  constructor();
468
492
  init(_data?: any): void;
@@ -474,41 +498,41 @@ declare class Room2DPropertiesAbridged extends _OpenAPIGenBaseModel {
474
498
  /** Base class for all objects requiring a identifiers acceptable for all engines. */
475
499
  declare class Room2D extends IDdBaseModel {
476
500
  /** 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. */
477
- floor_boundary: number[][];
501
+ floorBoundary: number[][];
478
502
  /** A number to indicate the height of the floor plane in the Z axis. */
479
- floor_height: number;
503
+ floorHeight: number;
480
504
  /** A number for the distance between the floor and the ceiling. */
481
- floor_to_ceiling_height: number;
505
+ floorToCeilingHeight: number;
482
506
  /** Extension properties for particular simulation engines (Radiance, EnergyPlus). */
483
507
  properties: Room2DPropertiesAbridged;
484
- /** Type */
485
- type?: string;
508
+ /** type */
509
+ type: string;
486
510
  /** Optional list of lists with one list for each hole in the floor plate. Each hole should be a list of at least 2 points and each point a list of 2 (x, y) values. If None, it will be assumed that there are no holes in the floor plate. */
487
- floor_holes?: number[][][];
511
+ floorHoles?: number[][][];
488
512
  /** A boolean noting whether this Room2D has its floor in contact with the ground. */
489
- is_ground_contact?: boolean;
513
+ isGroundContact: boolean;
490
514
  /** A boolean noting whether this Room2D has its ceiling exposed to the outdoors. */
491
- is_top_exposed?: boolean;
515
+ isTopExposed: boolean;
492
516
  /** A boolean for whether the room has a Floor (True) or an AirBoundary (False). If False, this property will only be meaningful if the model is translated to Honeybee with ceiling adjacency solved and there is a Room2D below this one with a has_ceiling property set to False. */
493
- has_floor?: boolean;
517
+ hasFloor: boolean;
494
518
  /** A boolean for whether the room has a RoofCeiling (True) or an AirBoundary (False). If False, this property will only be meaningful if the model is translated to Honeybee with ceiling adjacency solved and there is a Room2D above this one with a has_floor property set to False. */
495
- has_ceiling?: boolean;
519
+ hasCeiling: boolean;
496
520
  /** A number for the depth that a ceiling plenum extends into the room. Setting this to a positive value will result in a separate plenum room being split off of the Room2D volume during translation from Dragonfly to Honeybee. The bottom of this ceiling plenum will always be at this Room2D ceiling height minus the value specified here. Setting this to zero indicates that the room has no ceiling plenum. */
497
- ceiling_plenum_depth?: number;
521
+ ceilingPlenumDepth: number;
498
522
  /** A number for the depth that a floor plenum extends into the room. Setting this to a positive value will result in a separate plenum room being split off of the Room2D volume during translation from Dragonfly to Honeybee. The top of this floor plenum will always be at this Room2D floor height plus the value specified here. Setting this to zero indicates that the room has no floor plenum. */
499
- floor_plenum_depth?: number;
523
+ floorPlenumDepth: number;
500
524
  /** Text string for for the zone identifier to which this Room2D belongs. Room2Ds sharing the same zone identifier are considered part of the same zone in a Building. If the zone identifier has not been specified, it will be the same as the Room2D identifier in the destination engine. Note that this property has no character restrictions. */
501
525
  zone?: string;
502
526
  /** A list of boundary conditions that match the number of segments in the input floor_geometry + floor_holes. These will be used to assign boundary conditions to each of the walls of the Room in the resulting model. Their order should align with the order of segments in the floor_boundary and then with each hole segment. If None, all boundary conditions will be Outdoors or Ground depending on whether ceiling height of the room is at or below 0 (the assumed ground plane). */
503
- boundary_conditions?: (Ground | Outdoors | Surface | Adiabatic | OtherSideTemperature)[];
527
+ boundaryConditions?: (Ground | Outdoors | Surface | Adiabatic | OtherSideTemperature)[];
504
528
  /** A list of WindowParameter objects that dictate how the window geometries will be generated for each of the walls. If None, no windows will exist over the entire Room2D. */
505
- window_parameters?: (SingleWindow | SimpleWindowArea | SimpleWindowRatio | RepeatingWindowRatio | RectangularWindows | DetailedWindows)[];
529
+ windowParameters?: (SingleWindow | SimpleWindowArea | SimpleWindowRatio | RepeatingWindowRatio | RectangularWindows | DetailedWindows)[];
506
530
  /** A list of ShadingParameter objects that dictate how the shade geometries will be generated for each of the walls. If None, no shades will exist over the entire Room2D. */
507
- shading_parameters?: (ExtrudedBorder | Overhang | LouversByDistance | LouversByCount)[];
531
+ shadingParameters?: (ExtrudedBorder | Overhang | LouversByDistance | LouversByCount)[];
508
532
  /** A list of booleans for whether each wall has an air boundary type. False values indicate a standard opaque type while True values indicate an AirBoundary type. All walls will be False by default. Note that any walls with a True air boundary must have a Surface boundary condition without any windows. */
509
- air_boundaries?: boolean[];
533
+ airBoundaries?: boolean[];
510
534
  /** A SkylightParameter object describing how to generate skylights. If None, no skylights will exist on the Room2D. */
511
- skylight_parameters?: (GriddedSkylightArea | GriddedSkylightRatio | DetailedSkylights);
535
+ skylightParameters?: (GriddedSkylightArea | GriddedSkylightRatio | DetailedSkylights);
512
536
  constructor();
513
537
  init(_data?: any): void;
514
538
  static fromJS(data: any): Room2D;
@@ -518,10 +542,10 @@ declare class Room2D extends IDdBaseModel {
518
542
 
519
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. */
520
544
  declare class StoryEnergyPropertiesAbridged extends _OpenAPIGenBaseModel {
521
- /** Type */
522
- type?: string;
545
+ /** type */
546
+ type: string;
523
547
  /** Name of a ConstructionSet to specify all constructions for the Story. If None, the Story will use the Building construction_set or the Model global_construction_set. Any ConstructionSet assigned here will override those assigned to these objects. */
524
- construction_set?: string;
548
+ constructionSet?: string;
525
549
  constructor();
526
550
  init(_data?: any): void;
527
551
  static fromJS(data: any): StoryEnergyPropertiesAbridged;
@@ -531,10 +555,10 @@ declare class StoryEnergyPropertiesAbridged extends _OpenAPIGenBaseModel {
531
555
 
532
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. */
533
557
  declare class StoryRadiancePropertiesAbridged extends _OpenAPIGenBaseModel {
534
- /** Type */
535
- type?: string;
558
+ /** type */
559
+ type: string;
536
560
  /** Name of a ModifierSet to specify all modifiers for the Story. If None, the Story will use the Building modifier_set or the Model global_modifier_set. Any ModifierSet assigned here will override those assigned to the parent objects. */
537
- modifier_set?: string;
561
+ modifierSet?: string;
538
562
  constructor();
539
563
  init(_data?: any): void;
540
564
  static fromJS(data: any): StoryRadiancePropertiesAbridged;
@@ -543,11 +567,11 @@ declare class StoryRadiancePropertiesAbridged extends _OpenAPIGenBaseModel {
543
567
  }
544
568
 
545
569
  declare class StoryPropertiesAbridged extends _OpenAPIGenBaseModel {
546
- /** Type */
547
- type?: string;
548
- /** Energy */
570
+ /** type */
571
+ type: string;
572
+ /** energy */
549
573
  energy?: StoryEnergyPropertiesAbridged;
550
- /** Radiance */
574
+ /** radiance */
551
575
  radiance?: StoryRadiancePropertiesAbridged;
552
576
  constructor();
553
577
  init(_data?: any): void;
@@ -566,21 +590,21 @@ declare enum StoryType {
566
590
  /** Base class for all objects requiring a identifiers acceptable for all engines. */
567
591
  declare class Story extends IDdBaseModel {
568
592
  /** An array of dragonfly Room2D objects that together form an entire story of a building. */
569
- room_2ds: Room2D[];
593
+ room2ds: Room2D[];
570
594
  /** Extension properties for particular simulation engines (Radiance, EnergyPlus). */
571
595
  properties: StoryPropertiesAbridged;
572
- /** Type */
573
- type?: string;
596
+ /** type */
597
+ type: string;
574
598
  /** A number for the distance from the floor plate of this story to the floor of the story above this one (if it exists). If Autocalculate, this value will be the maximum floor_to_ceiling_height of the input room_2ds. */
575
- floor_to_floor_height?: (Autocalculate | number);
599
+ floorToFloorHeight: (Autocalculate | number);
576
600
  /** A number to indicate the height of the floor plane in the Z axis.If Autocalculate, this will be the minimum floor height of all the room_2ds, which is suitable for cases where there are no floor plenums. */
577
- floor_height?: (Autocalculate | number);
601
+ floorHeight: (Autocalculate | number);
578
602
  /** An integer that denotes the number of times that this Story is repeated over the height of the building. */
579
- multiplier?: number;
603
+ multiplier: number;
580
604
  /** An optional RoofSpecification object containing geometry for generating sloped roofs over the Story. The RoofSpecification will only affect the child Room2Ds that have a True is_top_exposed property and it will only be utilized in translation to Honeybee when the Story multiplier is 1. If None, all Room2D ceilings will be flat. */
581
605
  roof?: RoofSpecification;
582
606
  /** Text to indicate the type of story. Stories that are plenums are translated to Honeybee with excluded floor areas. */
583
- story_type?: StoryType;
607
+ storyType: StoryType;
584
608
  constructor();
585
609
  init(_data?: any): void;
586
610
  static fromJS(data: any): Story;
@@ -592,12 +616,12 @@ declare class Story extends IDdBaseModel {
592
616
  declare class Building extends IDdBaseModel {
593
617
  /** Extension properties for particular simulation engines (Radiance, EnergyPlus). */
594
618
  properties: BuildingPropertiesAbridged;
595
- /** Type */
596
- type?: string;
619
+ /** type */
620
+ type: string;
597
621
  /** An array of unique dragonfly Story objects that together form the entire building. Stories should generally be ordered from lowest floor to highest floor, though this is not required. Note that, if a given Story is repeated several times over the height of the building and this is represented by the multiplier, the unique story included in this list should be the first (lowest) story of the repeated floors. */
598
- unique_stories?: Story[];
622
+ uniqueStories?: Story[];
599
623
  /** An optional array of 3D Honeybee Room objects for additional Rooms that are a part of the Building but are not represented within the unique_stories. This is useful when there are parts of the Building geometry that cannot easily be represented with the extruded floor plate and sloped roof assumptions that underlie Dragonfly Room2Ds and RoofSpecification. Cases where this input is most useful include sloped walls and certain types of domed roofs that become tedious to implement with RoofSpecification. Matching the Honeybee Room.story property to the Dragonfly Story.display_name of an object within the unique_stories will effectively place the Honeybee Room on that Story for the purposes of floor_area, exterior_wall_area, etc. However, note that the Honeybee Room.multiplier property takes precedence over whatever multiplier is assigned to the Dragonfly Story that the Room.story may reference. (Default: None). */
600
- room_3ds?: Room[];
624
+ room3ds?: Room[];
601
625
  /** An optional RoofSpecification object that provides an alternative way to describe roof geometry over rooms (instead of specifying roofs on each story). If trying to decide between the two, specifying geometry on each story is closer to how dragonfly natively works with roof geometry as it relates to rooms. However, when it is unknown which roof geometries correspond to which stories, this Building-level attribute may be used and each roof geometry will automatically be added to the best Story in the Building upon serialization to Python. This automatic assignment will happen by checking for overlaps between the Story Room2Ds and the Roof geometry in plan. When a given roof geometry overlaps with several Stories, the top-most Story will get the roof geometry assigned to it unless this top Story has a floor_height above the roof geometry, in which case the next highest story will be checked until a compatible one is found. */
602
626
  roof?: RoofSpecification;
603
627
  constructor();
@@ -609,12 +633,12 @@ declare class Building extends IDdBaseModel {
609
633
 
610
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. */
611
635
  declare class ContextShadeEnergyPropertiesAbridged extends _OpenAPIGenBaseModel {
612
- /** Type */
613
- type?: string;
636
+ /** type */
637
+ type: string;
614
638
  /** Name of a ShadeConstruction to set the reflectance and specularity of the ContextShade. If None, the the EnergyPlus default of 0.2 diffuse reflectance will be used. */
615
639
  construction?: string;
616
640
  /** Name of a schedule to set the transmittance of the ContextShade, which can vary throughout the simulation. If None, the ContextShade will be completely opaque. */
617
- transmittance_schedule?: string;
641
+ transmittanceSchedule?: string;
618
642
  constructor();
619
643
  init(_data?: any): void;
620
644
  static fromJS(data: any): ContextShadeEnergyPropertiesAbridged;
@@ -624,8 +648,8 @@ declare class ContextShadeEnergyPropertiesAbridged extends _OpenAPIGenBaseModel
624
648
 
625
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. */
626
650
  declare class ContextShadeRadiancePropertiesAbridged extends _OpenAPIGenBaseModel {
627
- /** Type */
628
- type?: string;
651
+ /** type */
652
+ type: string;
629
653
  /** Name of a Modifier to set the reflectance and specularity of the ContextShade. If None, the the default of 0.2 diffuse reflectance will be used. */
630
654
  modifier?: string;
631
655
  constructor();
@@ -636,11 +660,11 @@ declare class ContextShadeRadiancePropertiesAbridged extends _OpenAPIGenBaseMode
636
660
  }
637
661
 
638
662
  declare class ContextShadePropertiesAbridged extends _OpenAPIGenBaseModel {
639
- /** Type */
640
- type?: string;
641
- /** Energy */
663
+ /** type */
664
+ type: string;
665
+ /** energy */
642
666
  energy?: ContextShadeEnergyPropertiesAbridged;
643
- /** Radiance */
667
+ /** radiance */
644
668
  radiance?: ContextShadeRadiancePropertiesAbridged;
645
669
  constructor();
646
670
  init(_data?: any): void;
@@ -655,10 +679,10 @@ declare class ContextShade extends IDdBaseModel {
655
679
  geometry: (Face3D | Mesh3D)[];
656
680
  /** Extension properties for particular simulation engines (Radiance, EnergyPlus). */
657
681
  properties: ContextShadePropertiesAbridged;
658
- /** Type */
659
- type?: string;
682
+ /** type */
683
+ type: string;
660
684
  /** Boolean to note whether this shade is detached from any of the other geometry in the model. Cases where this should be True include shade representing surrounding buildings or context. */
661
- is_detached?: boolean;
685
+ isDetached: boolean;
662
686
  constructor();
663
687
  init(_data?: any): void;
664
688
  static fromJS(data: any): ContextShade;
@@ -668,8 +692,8 @@ declare class ContextShade extends IDdBaseModel {
668
692
 
669
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. */
670
694
  declare class ModelComparisonProperties extends _OpenAPIGenBaseModel {
671
- /** Type */
672
- type?: string;
695
+ /** type */
696
+ type: string;
673
697
  constructor();
674
698
  init(_data?: any): void;
675
699
  static fromJS(data: any): ModelComparisonProperties;
@@ -677,14 +701,25 @@ declare class ModelComparisonProperties extends _OpenAPIGenBaseModel {
677
701
  validate(): Promise<boolean>;
678
702
  }
679
703
 
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
+ declare class ModelDoe2Properties extends _OpenAPIGenBaseModel {
706
+ /** type */
707
+ type: string;
708
+ constructor();
709
+ init(_data?: any): void;
710
+ static fromJS(data: any): ModelDoe2Properties;
711
+ toJSON(data?: any): Record<string, any>;
712
+ validate(): Promise<boolean>;
713
+ }
714
+
680
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. */
681
716
  declare class ModelEnergyProperties extends _OpenAPIGenBaseModel {
682
- /** Type */
683
- type?: string;
717
+ /** type */
718
+ type: string;
684
719
  /** Global Energy construction set. */
685
- global_construction_set?: GlobalConstructionSet;
720
+ globalConstructionSet: GlobalConstructionSet;
686
721
  /** List of all ConstructionSets in the Model. */
687
- construction_sets?: (ConstructionSetAbridged | ConstructionSet)[];
722
+ constructionSets?: (ConstructionSetAbridged | ConstructionSet)[];
688
723
  /** A list of all unique constructions in the model. This includes constructions across all the Model construction_sets. */
689
724
  constructions?: (OpaqueConstructionAbridged | WindowConstructionAbridged | ShadeConstruction | AirBoundaryConstructionAbridged | OpaqueConstruction | WindowConstruction | AirBoundaryConstruction)[];
690
725
  /** A list of all unique materials in the model. This includes materials needed to make the Model constructions. */
@@ -694,11 +729,11 @@ declare class ModelEnergyProperties extends _OpenAPIGenBaseModel {
694
729
  /** List of all Service Hot Water (SHW) systems in the Model. */
695
730
  shws?: SHWSystem[];
696
731
  /** List of all ProgramTypes in the Model. */
697
- program_types?: (ProgramTypeAbridged | ProgramType)[];
732
+ programTypes?: (ProgramTypeAbridged | ProgramType)[];
698
733
  /** A list of all unique schedules in the model. This includes schedules across all HVAC systems, ProgramTypes and ContextShades. */
699
734
  schedules?: (ScheduleRulesetAbridged | ScheduleFixedIntervalAbridged | ScheduleRuleset | ScheduleFixedInterval)[];
700
735
  /** A list of all unique ScheduleTypeLimits in the model. This all ScheduleTypeLimits needed to make the Model schedules. */
701
- schedule_type_limits?: ScheduleTypeLimit[];
736
+ scheduleTypeLimits?: ScheduleTypeLimit[];
702
737
  constructor();
703
738
  init(_data?: any): void;
704
739
  static fromJS(data: any): ModelEnergyProperties;
@@ -708,12 +743,12 @@ declare class ModelEnergyProperties extends _OpenAPIGenBaseModel {
708
743
 
709
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. */
710
745
  declare class ModelRadianceProperties extends _OpenAPIGenBaseModel {
711
- /** Type */
712
- type?: string;
746
+ /** type */
747
+ type: string;
713
748
  /** Global Radiance modifier set. */
714
- global_modifier_set?: GlobalModifierSet;
749
+ globalModifierSet: GlobalModifierSet;
715
750
  /** List of all ModifierSets in the Model. */
716
- modifier_sets?: (ModifierSet | ModifierSetAbridged)[];
751
+ modifierSets?: (ModifierSet | ModifierSetAbridged)[];
717
752
  /** A list of all unique modifiers in the model. This includes modifiers across all the Model modifier_sets. */
718
753
  modifiers?: (Plastic | Glass | BSDF | Glow | Light | Trans | Metal | Void | Mirror)[];
719
754
  constructor();
@@ -724,13 +759,15 @@ declare class ModelRadianceProperties extends _OpenAPIGenBaseModel {
724
759
  }
725
760
 
726
761
  declare class ModelProperties extends _OpenAPIGenBaseModel {
727
- /** Type */
728
- type?: string;
729
- /** Energy */
762
+ /** type */
763
+ type: string;
764
+ /** energy */
730
765
  energy?: ModelEnergyProperties;
731
- /** Radiance */
766
+ /** radiance */
732
767
  radiance?: ModelRadianceProperties;
733
- /** Comparison */
768
+ /** doe2 */
769
+ doe2?: ModelDoe2Properties;
770
+ /** comparison */
734
771
  comparison?: ModelComparisonProperties;
735
772
  constructor();
736
773
  init(_data?: any): void;
@@ -743,20 +780,22 @@ declare class ModelProperties extends _OpenAPIGenBaseModel {
743
780
  declare class Model extends IDdBaseModel {
744
781
  /** Extension properties for particular simulation engines (Radiance, EnergyPlus). */
745
782
  properties: ModelProperties;
746
- /** Type */
747
- type?: string;
783
+ /** type */
784
+ type: string;
748
785
  /** Text string for the current version of the schema. */
749
- version?: string;
786
+ version: string;
750
787
  /** A list of Buildings in the model. */
751
788
  buildings?: Building[];
752
789
  /** A list of ContextShades in the model. */
753
- context_shades?: ContextShade[];
790
+ contextShades?: ContextShade[];
754
791
  /** Text indicating the units in which the model geometry exists. This is used to scale the geometry to the correct units for simulation engines like EnergyPlus, which requires all geometry be in meters. */
755
- units?: Units;
792
+ units: Units;
756
793
  /** The maximum difference between x, y, and z values at which vertices are considered equivalent. This value should be in the Model units and is used in a variety of checks and operations. A value of 0 will result in bypassing all checks so it is recommended that this always be a positive number when checks have not already been performed on a Model. The default of 0.01 is suitable for models in meters. */
757
- tolerance?: number;
794
+ tolerance: number;
758
795
  /** The max angle difference in degrees that vertices are allowed to differ from one another in order to consider them colinear. This value is used in a variety of checks and operations that can be performed on geometry. A value of 0 will result in no checks and an inability to perform certain operations so it is recommended that this always be a positive number when checks have not already been performed on a given Model. */
759
- angle_tolerance?: number;
796
+ angleTolerance: number;
797
+ /** A n optional list of 3 (x, y, z) values that describe a Vector3D relating the model to an original source coordinate system. Setting a value here is useful if the model has been moved from its original location and there may be future operations of merging geometry from the original source system. */
798
+ referenceVector?: number[];
760
799
  constructor();
761
800
  init(_data?: any): void;
762
801
  static fromJS(data: any): Model;
@@ -768,4 +807,4 @@ declare function IsNestedNumberArray(validationOptions?: ValidationOptions): (ob
768
807
  declare function IsNestedIntegerArray(validationOptions?: ValidationOptions): (object: Object, propertyName: string) => void;
769
808
  declare function IsNestedStringArray(validationOptions?: ValidationOptions): (object: Object, propertyName: string) => void;
770
809
 
771
- 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, ModelEnergyProperties, ModelProperties, ModelRadianceProperties, Overhang, RectangularWindows, RepeatingWindowRatio, RoofSpecification, Room2D, Room2DComparisonProperties, Room2DEnergyPropertiesAbridged, Room2DPropertiesAbridged, Room2DRadiancePropertiesAbridged, RoomGridParameter, RoomRadialGridParameter, SimpleWindowArea, SimpleWindowRatio, SingleWindow, Story, StoryEnergyPropertiesAbridged, StoryPropertiesAbridged, StoryRadiancePropertiesAbridged, StoryType, _GridParameterBase, _LouversBase, _OpenAPIGenBaseModel, _WindowParameterBase };
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 };