dragonfly-schema 1.12.1-v10

package/models/ModelRadianceProperties.ts

@@ -0,0 +1,253 @@
+import { IsString, IsOptional, Matches, IsInstance, ValidateNested, IsArray, validate, ValidationError as TsValidationError } from 'class-validator';
+import { Type, plainToClass, instanceToPlain } from 'class-transformer';
+import { _OpenAPIGenBaseModel } from "./_OpenAPIGenBaseModel";
+import { BSDF } from "honeybee-schema";
+import { Glass } from "honeybee-schema";
+import { GlobalModifierSet } from "honeybee-schema";
+import { Glow } from "honeybee-schema";
+import { Light } from "honeybee-schema";
+import { Metal } from "honeybee-schema";
+import { Mirror } from "honeybee-schema";
+import { ModifierSet } from "honeybee-schema";
+import { ModifierSetAbridged } from "honeybee-schema";
+import { Plastic } from "honeybee-schema";
+import { Trans } from "honeybee-schema";
+import { Void } from "honeybee-schema";
+
+/** 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. */
+export class ModelRadianceProperties extends _OpenAPIGenBaseModel {
+    @IsString()
+    @IsOptional()
+    @Matches(/^ModelRadianceProperties$/)
+    type?: string;
+	
+    @IsInstance(GlobalModifierSet)
+    @Type(() => GlobalModifierSet)
+    @ValidateNested()
+    @IsOptional()
+    /** Global Radiance modifier set. */
+    global_modifier_set?: GlobalModifierSet;
+	
+    @IsArray()
+    @IsOptional()
+    /** List of all ModifierSets in the Model. */
+    modifier_sets?: (ModifierSet | ModifierSetAbridged) [];
+	
+    @IsArray()
+    @IsOptional()
+    /** A list of all unique modifiers in the model. This includes modifiers across all the Model modifier_sets. */
+    modifiers?: (Plastic | Glass | BSDF | Glow | Light | Trans | Metal | Void | Mirror) [];
+	
+
+    constructor() {
+        super();
+        this.type = "ModelRadianceProperties";
+        this.global_modifier_set = GlobalModifierSet.fromJS({
+  "type": "GlobalModifierSet",
+  "modifiers": [
+    {
+      "identifier": "generic_floor_0.20",
+      "display_name": null,
+      "type": "Plastic",
+      "modifier": null,
+      "dependencies": [],
+      "r_reflectance": 0.2,
+      "g_reflectance": 0.2,
+      "b_reflectance": 0.2,
+      "specularity": 0.0,
+      "roughness": 0.0
+    },
+    {
+      "identifier": "generic_wall_0.50",
+      "display_name": null,
+      "type": "Plastic",
+      "modifier": null,
+      "dependencies": [],
+      "r_reflectance": 0.5,
+      "g_reflectance": 0.5,
+      "b_reflectance": 0.5,
+      "specularity": 0.0,
+      "roughness": 0.0
+    },
+    {
+      "identifier": "generic_ceiling_0.80",
+      "display_name": null,
+      "type": "Plastic",
+      "modifier": null,
+      "dependencies": [],
+      "r_reflectance": 0.8,
+      "g_reflectance": 0.8,
+      "b_reflectance": 0.8,
+      "specularity": 0.0,
+      "roughness": 0.0
+    },
+    {
+      "identifier": "generic_opaque_door_0.50",
+      "display_name": null,
+      "type": "Plastic",
+      "modifier": null,
+      "dependencies": [],
+      "r_reflectance": 0.5,
+      "g_reflectance": 0.5,
+      "b_reflectance": 0.5,
+      "specularity": 0.0,
+      "roughness": 0.0
+    },
+    {
+      "identifier": "generic_interior_shade_0.50",
+      "display_name": null,
+      "type": "Plastic",
+      "modifier": null,
+      "dependencies": [],
+      "r_reflectance": 0.5,
+      "g_reflectance": 0.5,
+      "b_reflectance": 0.5,
+      "specularity": 0.0,
+      "roughness": 0.0
+    },
+    {
+      "identifier": "generic_exterior_shade_0.35",
+      "display_name": null,
+      "type": "Plastic",
+      "modifier": null,
+      "dependencies": [],
+      "r_reflectance": 0.35,
+      "g_reflectance": 0.35,
+      "b_reflectance": 0.35,
+      "specularity": 0.0,
+      "roughness": 0.0
+    },
+    {
+      "identifier": "generic_context_0.20",
+      "display_name": null,
+      "type": "Plastic",
+      "modifier": null,
+      "dependencies": [],
+      "r_reflectance": 0.2,
+      "g_reflectance": 0.2,
+      "b_reflectance": 0.2,
+      "specularity": 0.0,
+      "roughness": 0.0
+    },
+    {
+      "identifier": "generic_interior_window_vis_0.88",
+      "display_name": null,
+      "type": "Glass",
+      "modifier": null,
+      "dependencies": [],
+      "r_transmissivity": 0.9584154328610596,
+      "g_transmissivity": 0.9584154328610596,
+      "b_transmissivity": 0.9584154328610596,
+      "refraction_index": null
+    },
+    {
+      "identifier": "generic_exterior_window_vis_0.64",
+      "display_name": null,
+      "type": "Glass",
+      "modifier": null,
+      "dependencies": [],
+      "r_transmissivity": 0.6975761815384331,
+      "g_transmissivity": 0.6975761815384331,
+      "b_transmissivity": 0.6975761815384331,
+      "refraction_index": null
+    },
+    {
+      "identifier": "air_boundary",
+      "display_name": null,
+      "type": "Trans",
+      "modifier": null,
+      "dependencies": [],
+      "r_reflectance": 1.0,
+      "g_reflectance": 1.0,
+      "b_reflectance": 1.0,
+      "specularity": 0.0,
+      "roughness": 0.0,
+      "transmitted_diff": 1.0,
+      "transmitted_spec": 1.0
+    }
+  ],
+  "wall_set": {
+    "exterior_modifier": "generic_wall_0.50",
+    "interior_modifier": "generic_wall_0.50",
+    "type": "WallModifierSetAbridged"
+  },
+  "floor_set": {
+    "exterior_modifier": "generic_floor_0.20",
+    "interior_modifier": "generic_floor_0.20",
+    "type": "FloorModifierSetAbridged"
+  },
+  "roof_ceiling_set": {
+    "exterior_modifier": "generic_ceiling_0.80",
+    "interior_modifier": "generic_ceiling_0.80",
+    "type": "RoofCeilingModifierSetAbridged"
+  },
+  "aperture_set": {
+    "type": "ApertureModifierSetAbridged",
+    "window_modifier": "generic_exterior_window_vis_0.64",
+    "interior_modifier": "generic_interior_window_vis_0.88",
+    "skylight_modifier": "generic_exterior_window_vis_0.64",
+    "operable_modifier": "generic_exterior_window_vis_0.64"
+  },
+  "door_set": {
+    "exterior_modifier": "generic_opaque_door_0.50",
+    "interior_modifier": "generic_opaque_door_0.50",
+    "type": "DoorModifierSetAbridged",
+    "interior_glass_modifier": "generic_interior_window_vis_0.88",
+    "exterior_glass_modifier": "generic_exterior_window_vis_0.64",
+    "overhead_modifier": "generic_opaque_door_0.50"
+  },
+  "shade_set": {
+    "exterior_modifier": "generic_exterior_shade_0.35",
+    "interior_modifier": "generic_interior_shade_0.50",
+    "type": "ShadeModifierSetAbridged"
+  },
+  "air_boundary_modifier": "air_boundary",
+  "context_modifier": "generic_context_0.20"
+});
+    }
+
+
+    override init(_data?: any) {
+        super.init(_data);
+        if (_data) {
+            const obj = plainToClass(ModelRadianceProperties, _data);
+            this.type = obj.type;
+            this.global_modifier_set = obj.global_modifier_set;
+            this.modifier_sets = obj.modifier_sets;
+            this.modifiers = obj.modifiers;
+        }
+    }
+
+
+    static override fromJS(data: any): ModelRadianceProperties {
+        data = typeof data === 'object' ? data : {};
+
+        let result = new ModelRadianceProperties();
+        result.init(data);
+        return result;
+    }
+
+	override toJSON(data?: any) {
+        data = typeof data === 'object' ? data : {};
+        for (var property in this) {
+            if (this.hasOwnProperty(property))
+                data[property] = this[property];
+        }
+
+        data["type"] = this.type;
+        data["global_modifier_set"] = this.global_modifier_set;
+        data["modifier_sets"] = this.modifier_sets;
+        data["modifiers"] = this.modifiers;
+        data = super.toJSON(data);
+        return instanceToPlain(data);
+    }
+
+	async validate(): Promise<boolean> {
+        const errors = await validate(this);
+        if (errors.length > 0){
+			const errorMessages = errors.map((error: TsValidationError) => Object.values(error.constraints || [error]).join(', ')).join('; ');
+      		throw new Error(`Validation failed: ${errorMessages}`);
+		}
+        return true;
+    }
+}

package/models/Overhang.ts

@@ -0,0 +1,73 @@
+import { IsNumber, IsDefined, IsString, IsOptional, Matches, Min, Max, validate, ValidationError as TsValidationError } from 'class-validator';
+import { Type, plainToClass, instanceToPlain } from 'class-transformer';
+import { _OpenAPIGenBaseModel } from "./_OpenAPIGenBaseModel";
+
+/** A single overhang over an entire wall. */
+export class Overhang extends _OpenAPIGenBaseModel {
+    @IsNumber()
+    @IsDefined()
+    /** A number for the overhang depth. */
+    depth!: number;
+	
+    @IsString()
+    @IsOptional()
+    @Matches(/^Overhang$/)
+    type?: string;
+	
+    @IsNumber()
+    @IsOptional()
+    @Min(-90)
+    @Max(90)
+    /** 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. */
+    angle?: number;
+	
+
+    constructor() {
+        super();
+        this.type = "Overhang";
+        this.angle = 0;
+    }
+
+
+    override init(_data?: any) {
+        super.init(_data);
+        if (_data) {
+            const obj = plainToClass(Overhang, _data);
+            this.depth = obj.depth;
+            this.type = obj.type;
+            this.angle = obj.angle;
+        }
+    }
+
+
+    static override fromJS(data: any): Overhang {
+        data = typeof data === 'object' ? data : {};
+
+        let result = new Overhang();
+        result.init(data);
+        return result;
+    }
+
+	override toJSON(data?: any) {
+        data = typeof data === 'object' ? data : {};
+        for (var property in this) {
+            if (this.hasOwnProperty(property))
+                data[property] = this[property];
+        }
+
+        data["depth"] = this.depth;
+        data["type"] = this.type;
+        data["angle"] = this.angle;
+        data = super.toJSON(data);
+        return instanceToPlain(data);
+    }
+
+	async validate(): Promise<boolean> {
+        const errors = await validate(this);
+        if (errors.length > 0){
+			const errorMessages = errors.map((error: TsValidationError) => Object.values(error.constraints || [error]).join(', ')).join('; ');
+      		throw new Error(`Validation failed: ${errorMessages}`);
+		}
+        return true;
+    }
+}

package/models/RectangularWindows.ts

@@ -0,0 +1,89 @@
+import { IsArray, IsDefined, IsNumber, IsString, IsOptional, Matches, IsBoolean, validate, ValidationError as TsValidationError } from 'class-validator';
+import { Type, plainToClass, instanceToPlain } from 'class-transformer';
+import { IsNestedNumberArray } from "./../helpers/class-validator";
+import { _WindowParameterBase } from "./_WindowParameterBase";
+
+/** Several rectangular windows, defined by origin, width and height. */
+export class RectangularWindows extends _WindowParameterBase {
+    @IsArray()
+    @IsNestedNumberArray()
+    @IsDefined()
+    /** An array of 2D points within the plane of the wall for the origin of each window. Each point should be a list of 2 (x, y) values. 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 origin point should be positive. */
+    origins!: number [] [];
+	
+    @IsArray()
+    @IsNumber({},{ each: true })
+    @IsDefined()
+    /** An array of positive numbers for the window widths. The length of this list must match the length of the origins. */
+    widths!: number [];
+	
+    @IsArray()
+    @IsNumber({},{ each: true })
+    @IsDefined()
+    /** An array of positive numbers for the window heights. The length of this list must match the length of the origins. */
+    heights!: number [];
+	
+    @IsString()
+    @IsOptional()
+    @Matches(/^RectangularWindows$/)
+    type?: string;
+	
+    @IsArray()
+    @IsBoolean({ each: true })
+    @IsOptional()
+    /** 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. */
+    are_doors?: boolean [];
+	
+
+    constructor() {
+        super();
+        this.type = "RectangularWindows";
+    }
+
+
+    override init(_data?: any) {
+        super.init(_data);
+        if (_data) {
+            const obj = plainToClass(RectangularWindows, _data);
+            this.origins = obj.origins;
+            this.widths = obj.widths;
+            this.heights = obj.heights;
+            this.type = obj.type;
+            this.are_doors = obj.are_doors;
+        }
+    }
+
+
+    static override fromJS(data: any): RectangularWindows {
+        data = typeof data === 'object' ? data : {};
+
+        let result = new RectangularWindows();
+        result.init(data);
+        return result;
+    }
+
+	override toJSON(data?: any) {
+        data = typeof data === 'object' ? data : {};
+        for (var property in this) {
+            if (this.hasOwnProperty(property))
+                data[property] = this[property];
+        }
+
+        data["origins"] = this.origins;
+        data["widths"] = this.widths;
+        data["heights"] = this.heights;
+        data["type"] = this.type;
+        data["are_doors"] = this.are_doors;
+        data = super.toJSON(data);
+        return instanceToPlain(data);
+    }
+
+	async validate(): Promise<boolean> {
+        const errors = await validate(this);
+        if (errors.length > 0){
+			const errorMessages = errors.map((error: TsValidationError) => Object.values(error.constraints || [error]).join(', ')).join('; ');
+      		throw new Error(`Validation failed: ${errorMessages}`);
+		}
+        return true;
+    }
+}

package/models/RepeatingWindowRatio.ts

@@ -0,0 +1,94 @@
+import { IsNumber, IsDefined, Min, IsString, IsOptional, Matches, validate, ValidationError as TsValidationError } from 'class-validator';
+import { Type, plainToClass, instanceToPlain } from 'class-transformer';
+import { _WindowParameterBase } from "./_WindowParameterBase";
+
+/** Repeating windows derived from an area ratio with the base wall. */
+export class RepeatingWindowRatio extends _WindowParameterBase {
+    @IsNumber()
+    @IsDefined()
+    /** A number between 0 and 1 for the ratio between the window area and the parent wall surface area. */
+    window_ratio!: number;
+	
+    @IsNumber()
+    @IsDefined()
+    /** 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. */
+    window_height!: number;
+	
+    @IsNumber()
+    @IsDefined()
+    /** 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. */
+    sill_height!: number;
+	
+    @IsNumber()
+    @IsDefined()
+    @Min(0)
+    /** 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. */
+    horizontal_separation!: number;
+	
+    @IsString()
+    @IsOptional()
+    @Matches(/^RepeatingWindowRatio$/)
+    type?: string;
+	
+    @IsNumber()
+    @IsOptional()
+    @Min(0)
+    /** An optional number to create a single vertical separation between top and bottom windows. */
+    vertical_separation?: number;
+	
+
+    constructor() {
+        super();
+        this.type = "RepeatingWindowRatio";
+        this.vertical_separation = 0;
+    }
+
+
+    override init(_data?: any) {
+        super.init(_data);
+        if (_data) {
+            const obj = plainToClass(RepeatingWindowRatio, _data);
+            this.window_ratio = obj.window_ratio;
+            this.window_height = obj.window_height;
+            this.sill_height = obj.sill_height;
+            this.horizontal_separation = obj.horizontal_separation;
+            this.type = obj.type;
+            this.vertical_separation = obj.vertical_separation;
+        }
+    }
+
+
+    static override fromJS(data: any): RepeatingWindowRatio {
+        data = typeof data === 'object' ? data : {};
+
+        let result = new RepeatingWindowRatio();
+        result.init(data);
+        return result;
+    }
+
+	override toJSON(data?: any) {
+        data = typeof data === 'object' ? data : {};
+        for (var property in this) {
+            if (this.hasOwnProperty(property))
+                data[property] = this[property];
+        }
+
+        data["window_ratio"] = this.window_ratio;
+        data["window_height"] = this.window_height;
+        data["sill_height"] = this.sill_height;
+        data["horizontal_separation"] = this.horizontal_separation;
+        data["type"] = this.type;
+        data["vertical_separation"] = this.vertical_separation;
+        data = super.toJSON(data);
+        return instanceToPlain(data);
+    }
+
+	async validate(): Promise<boolean> {
+        const errors = await validate(this);
+        if (errors.length > 0){
+			const errorMessages = errors.map((error: TsValidationError) => Object.values(error.constraints || [error]).join(', ')).join('; ');
+      		throw new Error(`Validation failed: ${errorMessages}`);
+		}
+        return true;
+    }
+}

package/models/RoofSpecification.ts

@@ -0,0 +1,67 @@
+import { IsArray, IsInstance, ValidateNested, IsDefined, IsString, IsOptional, Matches, validate, ValidationError as TsValidationError } from 'class-validator';
+import { Type, plainToClass, instanceToPlain } from 'class-transformer';
+import { _OpenAPIGenBaseModel } from "./_OpenAPIGenBaseModel";
+import { Face3D } from "honeybee-schema";
+
+/** Geometry for specifying sloped roofs over a Story. */
+export class RoofSpecification extends _OpenAPIGenBaseModel {
+    @IsArray()
+    @IsInstance(Face3D, { each: true })
+    @Type(() => Face3D)
+    @ValidateNested({ each: true })
+    @IsDefined()
+    /** 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. */
+    geometry!: Face3D [];
+	
+    @IsString()
+    @IsOptional()
+    @Matches(/^RoofSpecification$/)
+    type?: string;
+	
+
+    constructor() {
+        super();
+        this.type = "RoofSpecification";
+    }
+
+
+    override init(_data?: any) {
+        super.init(_data);
+        if (_data) {
+            const obj = plainToClass(RoofSpecification, _data);
+            this.geometry = obj.geometry;
+            this.type = obj.type;
+        }
+    }
+
+
+    static override fromJS(data: any): RoofSpecification {
+        data = typeof data === 'object' ? data : {};
+
+        let result = new RoofSpecification();
+        result.init(data);
+        return result;
+    }
+
+	override toJSON(data?: any) {
+        data = typeof data === 'object' ? data : {};
+        for (var property in this) {
+            if (this.hasOwnProperty(property))
+                data[property] = this[property];
+        }
+
+        data["geometry"] = this.geometry;
+        data["type"] = this.type;
+        data = super.toJSON(data);
+        return instanceToPlain(data);
+    }
+
+	async validate(): Promise<boolean> {
+        const errors = await validate(this);
+        if (errors.length > 0){
+			const errorMessages = errors.map((error: TsValidationError) => Object.values(error.constraints || [error]).join(', ')).join('; ');
+      		throw new Error(`Validation failed: ${errorMessages}`);
+		}
+        return true;
+    }
+}