dragonfly-schema 1.12.1-v10

package/models/SimpleWindowRatio.ts

@@ -0,0 +1,71 @@
+import { IsNumber, IsDefined, IsString, IsOptional, Matches, IsBoolean, validate, ValidationError as TsValidationError } from 'class-validator';
+import { Type, plainToClass, instanceToPlain } from 'class-transformer';
+import { _WindowParameterBase } from "./_WindowParameterBase";
+
+/** A single window defined by an area ratio with the base surface. */
+export class SimpleWindowRatio 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;
+	
+    @IsString()
+    @IsOptional()
+    @Matches(/^SimpleWindowRatio$/)
+    type?: string;
+	
+    @IsBoolean()
+    @IsOptional()
+    /** 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. */
+    rect_split?: boolean;
+	
+
+    constructor() {
+        super();
+        this.type = "SimpleWindowRatio";
+        this.rect_split = true;
+    }
+
+
+    override init(_data?: any) {
+        super.init(_data);
+        if (_data) {
+            const obj = plainToClass(SimpleWindowRatio, _data);
+            this.window_ratio = obj.window_ratio;
+            this.type = obj.type;
+            this.rect_split = obj.rect_split;
+        }
+    }
+
+
+    static override fromJS(data: any): SimpleWindowRatio {
+        data = typeof data === 'object' ? data : {};
+
+        let result = new SimpleWindowRatio();
+        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["type"] = this.type;
+        data["rect_split"] = this.rect_split;
+        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/SingleWindow.ts

@@ -0,0 +1,78 @@
+import { IsNumber, IsDefined, IsString, IsOptional, Matches, validate, ValidationError as TsValidationError } from 'class-validator';
+import { Type, plainToClass, instanceToPlain } from 'class-transformer';
+import { _WindowParameterBase } from "./_WindowParameterBase";
+
+/** A single window in the wall center defined by a width * height. */
+export class SingleWindow extends _WindowParameterBase {
+    @IsNumber()
+    @IsDefined()
+    /** A number for the window width. Note that, if this width is applied to a wall that is too narrow for this width, the generated window will automatically be shortened when it is applied to the wall. In this way, setting the width to be `float(""inf"")` will create parameters that always generate a ribbon window. */
+    width!: number;
+	
+    @IsNumber()
+    @IsDefined()
+    /** 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. */
+    height!: number;
+	
+    @IsString()
+    @IsOptional()
+    @Matches(/^SingleWindow$/)
+    type?: string;
+	
+    @IsNumber()
+    @IsOptional()
+    /** A number for the window sill height. */
+    sill_height?: number;
+	
+
+    constructor() {
+        super();
+        this.type = "SingleWindow";
+        this.sill_height = 1;
+    }
+
+
+    override init(_data?: any) {
+        super.init(_data);
+        if (_data) {
+            const obj = plainToClass(SingleWindow, _data);
+            this.width = obj.width;
+            this.height = obj.height;
+            this.type = obj.type;
+            this.sill_height = obj.sill_height;
+        }
+    }
+
+
+    static override fromJS(data: any): SingleWindow {
+        data = typeof data === 'object' ? data : {};
+
+        let result = new SingleWindow();
+        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["width"] = this.width;
+        data["height"] = this.height;
+        data["type"] = this.type;
+        data["sill_height"] = this.sill_height;
+        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/Story.ts

@@ -0,0 +1,111 @@
+import { IsArray, IsInstance, ValidateNested, IsDefined, IsString, IsOptional, Matches, IsInt, Min, validate, ValidationError as TsValidationError } from 'class-validator';
+import { Type, plainToClass, instanceToPlain } from 'class-transformer';
+import { Autocalculate } from "honeybee-schema";
+import { IDdBaseModel } from "honeybee-schema";
+import { RoofSpecification } from "./RoofSpecification";
+import { Room2D } from "./Room2D";
+import { StoryPropertiesAbridged } from "./StoryPropertiesAbridged";
+
+/** Base class for all objects requiring a identifiers acceptable for all engines. */
+export class Story extends IDdBaseModel {
+    @IsArray()
+    @IsInstance(Room2D, { each: true })
+    @Type(() => Room2D)
+    @ValidateNested({ each: true })
+    @IsDefined()
+    /** An array of dragonfly Room2D objects that together form an entire story of a building. */
+    room_2ds!: Room2D [];
+	
+    @IsInstance(StoryPropertiesAbridged)
+    @Type(() => StoryPropertiesAbridged)
+    @ValidateNested()
+    @IsDefined()
+    /** Extension properties for particular simulation engines (Radiance, EnergyPlus). */
+    properties!: StoryPropertiesAbridged;
+	
+    @IsString()
+    @IsOptional()
+    @Matches(/^Story$/)
+    type?: string;
+	
+    @IsOptional()
+    /** 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. */
+    floor_to_floor_height?: (Autocalculate | number);
+	
+    @IsOptional()
+    /** 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. */
+    floor_height?: (Autocalculate | number);
+	
+    @IsInt()
+    @IsOptional()
+    @Min(1)
+    /** An integer that denotes the number of times that this Story is repeated over the height of the building. */
+    multiplier?: number;
+	
+    @IsInstance(RoofSpecification)
+    @Type(() => RoofSpecification)
+    @ValidateNested()
+    @IsOptional()
+    /** 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. */
+    roof?: RoofSpecification;
+	
+
+    constructor() {
+        super();
+        this.type = "Story";
+        this.floor_to_floor_height = new Autocalculate();
+        this.floor_height = new Autocalculate();
+        this.multiplier = 1;
+    }
+
+
+    override init(_data?: any) {
+        super.init(_data);
+        if (_data) {
+            const obj = plainToClass(Story, _data);
+            this.room_2ds = obj.room_2ds;
+            this.properties = obj.properties;
+            this.type = obj.type;
+            this.floor_to_floor_height = obj.floor_to_floor_height;
+            this.floor_height = obj.floor_height;
+            this.multiplier = obj.multiplier;
+            this.roof = obj.roof;
+        }
+    }
+
+
+    static override fromJS(data: any): Story {
+        data = typeof data === 'object' ? data : {};
+
+        let result = new Story();
+        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["room_2ds"] = this.room_2ds;
+        data["properties"] = this.properties;
+        data["type"] = this.type;
+        data["floor_to_floor_height"] = this.floor_to_floor_height;
+        data["floor_height"] = this.floor_height;
+        data["multiplier"] = this.multiplier;
+        data["roof"] = this.roof;
+        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/StoryEnergyPropertiesAbridged.ts

@@ -0,0 +1,65 @@
+import { IsString, IsOptional, Matches, MinLength, MaxLength, validate, ValidationError as TsValidationError } from 'class-validator';
+import { Type, plainToClass, instanceToPlain } from 'class-transformer';
+import { _OpenAPIGenBaseModel } from "./_OpenAPIGenBaseModel";
+
+/** 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 StoryEnergyPropertiesAbridged extends _OpenAPIGenBaseModel {
+    @IsString()
+    @IsOptional()
+    @Matches(/^StoryEnergyPropertiesAbridged$/)
+    type?: string;
+	
+    @IsString()
+    @IsOptional()
+    @MinLength(1)
+    @MaxLength(100)
+    /** 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. */
+    construction_set?: string;
+	
+
+    constructor() {
+        super();
+        this.type = "StoryEnergyPropertiesAbridged";
+    }
+
+
+    override init(_data?: any) {
+        super.init(_data);
+        if (_data) {
+            const obj = plainToClass(StoryEnergyPropertiesAbridged, _data);
+            this.type = obj.type;
+            this.construction_set = obj.construction_set;
+        }
+    }
+
+
+    static override fromJS(data: any): StoryEnergyPropertiesAbridged {
+        data = typeof data === 'object' ? data : {};
+
+        let result = new StoryEnergyPropertiesAbridged();
+        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["construction_set"] = this.construction_set;
+        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/StoryPropertiesAbridged.ts

@@ -0,0 +1,73 @@
+import { IsString, IsOptional, Matches, IsInstance, ValidateNested, validate, ValidationError as TsValidationError } from 'class-validator';
+import { Type, plainToClass, instanceToPlain } from 'class-transformer';
+import { _OpenAPIGenBaseModel } from "./_OpenAPIGenBaseModel";
+import { StoryEnergyPropertiesAbridged } from "./StoryEnergyPropertiesAbridged";
+import { StoryRadiancePropertiesAbridged } from "./StoryRadiancePropertiesAbridged";
+
+export class StoryPropertiesAbridged extends _OpenAPIGenBaseModel {
+    @IsString()
+    @IsOptional()
+    @Matches(/^StoryPropertiesAbridged$/)
+    type?: string;
+	
+    @IsInstance(StoryEnergyPropertiesAbridged)
+    @Type(() => StoryEnergyPropertiesAbridged)
+    @ValidateNested()
+    @IsOptional()
+    energy?: StoryEnergyPropertiesAbridged;
+	
+    @IsInstance(StoryRadiancePropertiesAbridged)
+    @Type(() => StoryRadiancePropertiesAbridged)
+    @ValidateNested()
+    @IsOptional()
+    radiance?: StoryRadiancePropertiesAbridged;
+	
+
+    constructor() {
+        super();
+        this.type = "StoryPropertiesAbridged";
+    }
+
+
+    override init(_data?: any) {
+        super.init(_data);
+        if (_data) {
+            const obj = plainToClass(StoryPropertiesAbridged, _data);
+            this.type = obj.type;
+            this.energy = obj.energy;
+            this.radiance = obj.radiance;
+        }
+    }
+
+
+    static override fromJS(data: any): StoryPropertiesAbridged {
+        data = typeof data === 'object' ? data : {};
+
+        let result = new StoryPropertiesAbridged();
+        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["energy"] = this.energy;
+        data["radiance"] = this.radiance;
+        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/StoryRadiancePropertiesAbridged.ts

@@ -0,0 +1,63 @@
+import { IsString, IsOptional, Matches, validate, ValidationError as TsValidationError } from 'class-validator';
+import { Type, plainToClass, instanceToPlain } from 'class-transformer';
+import { _OpenAPIGenBaseModel } from "./_OpenAPIGenBaseModel";
+
+/** 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 StoryRadiancePropertiesAbridged extends _OpenAPIGenBaseModel {
+    @IsString()
+    @IsOptional()
+    @Matches(/^StoryRadiancePropertiesAbridged$/)
+    type?: string;
+	
+    @IsString()
+    @IsOptional()
+    /** 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. */
+    modifier_set?: string;
+	
+
+    constructor() {
+        super();
+        this.type = "StoryRadiancePropertiesAbridged";
+    }
+
+
+    override init(_data?: any) {
+        super.init(_data);
+        if (_data) {
+            const obj = plainToClass(StoryRadiancePropertiesAbridged, _data);
+            this.type = obj.type;
+            this.modifier_set = obj.modifier_set;
+        }
+    }
+
+
+    static override fromJS(data: any): StoryRadiancePropertiesAbridged {
+        data = typeof data === 'object' ? data : {};
+
+        let result = new StoryRadiancePropertiesAbridged();
+        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["modifier_set"] = this.modifier_set;
+        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/_GridParameterBase.ts

@@ -0,0 +1,71 @@
+import { IsNumber, IsDefined, IsBoolean, IsOptional, IsString, Matches, validate, ValidationError as TsValidationError } from 'class-validator';
+import { Type, plainToClass, instanceToPlain } from 'class-transformer';
+import { _OpenAPIGenBaseModel } from "./_OpenAPIGenBaseModel";
+
+/** Base object for all GridParameters. */
+export class _GridParameterBase extends _OpenAPIGenBaseModel {
+    @IsNumber()
+    @IsDefined()
+    /** The dimension of the grid cells as a number. */
+    dimension!: number;
+	
+    @IsBoolean()
+    @IsOptional()
+    /** A boolean to note whether the resulting SensorGrid should include the mesh. */
+    include_mesh?: boolean;
+	
+    @IsString()
+    @IsOptional()
+    @Matches(/^_GridParameterBase$/)
+    type?: string;
+	
+
+    constructor() {
+        super();
+        this.include_mesh = true;
+        this.type = "_GridParameterBase";
+    }
+
+
+    override init(_data?: any) {
+        super.init(_data);
+        if (_data) {
+            const obj = plainToClass(_GridParameterBase, _data);
+            this.dimension = obj.dimension;
+            this.include_mesh = obj.include_mesh;
+            this.type = obj.type;
+        }
+    }
+
+
+    static override fromJS(data: any): _GridParameterBase {
+        data = typeof data === 'object' ? data : {};
+
+        let result = new _GridParameterBase();
+        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["dimension"] = this.dimension;
+        data["include_mesh"] = this.include_mesh;
+        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;
+    }
+}

package/models/_LouversBase.ts

@@ -0,0 +1,99 @@
+import { IsNumber, IsDefined, IsOptional, Min, Max, IsArray, IsBoolean, IsString, Matches, validate, ValidationError as TsValidationError } from 'class-validator';
+import { Type, plainToClass, instanceToPlain } from 'class-transformer';
+import { _OpenAPIGenBaseModel } from "./_OpenAPIGenBaseModel";
+
+/** Base class for for a series of louvered shades over a wall. */
+export class _LouversBase extends _OpenAPIGenBaseModel {
+    @IsNumber()
+    @IsDefined()
+    /** A number for the depth to extrude the louvers. */
+    depth!: number;
+	
+    @IsNumber()
+    @IsOptional()
+    @Min(0)
+    /** A number for the distance to louvers from the wall. */
+    offset?: number;
+	
+    @IsNumber()
+    @IsOptional()
+    @Min(-90)
+    @Max(90)
+    /** 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. */
+    angle?: number;
+	
+    @IsArray()
+    @IsNumber({},{ each: true })
+    @IsOptional()
+    /** 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. */
+    contour_vector?: number [];
+	
+    @IsBoolean()
+    @IsOptional()
+    /** 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. */
+    flip_start_side?: boolean;
+	
+    @IsString()
+    @IsOptional()
+    @Matches(/^_LouversBase$/)
+    type?: string;
+	
+
+    constructor() {
+        super();
+        this.offset = 0;
+        this.angle = 0;
+        this.contour_vector = [0, 1];
+        this.flip_start_side = false;
+        this.type = "_LouversBase";
+    }
+
+
+    override init(_data?: any) {
+        super.init(_data);
+        if (_data) {
+            const obj = plainToClass(_LouversBase, _data);
+            this.depth = obj.depth;
+            this.offset = obj.offset;
+            this.angle = obj.angle;
+            this.contour_vector = obj.contour_vector;
+            this.flip_start_side = obj.flip_start_side;
+            this.type = obj.type;
+        }
+    }
+
+
+    static override fromJS(data: any): _LouversBase {
+        data = typeof data === 'object' ? data : {};
+
+        let result = new _LouversBase();
+        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["offset"] = this.offset;
+        data["angle"] = this.angle;
+        data["contour_vector"] = this.contour_vector;
+        data["flip_start_side"] = this.flip_start_side;
+        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;
+    }
+}

package/models/_OpenAPIGenBaseModel.ts

@@ -0,0 +1,38 @@
+import { IsString, IsOptional, validate, ValidationError as TsValidationError } from 'class-validator';
+import { Type, plainToClass, instanceToPlain } from 'class-transformer';
+
+export abstract class _OpenAPIGenBaseModel {
+    @IsString()
+    @IsOptional()
+    /** A base class to use when there is no baseclass available to fall on. */
+    type?: string;
+	
+
+    constructor() {
+        this.type = "InvalidType";
+    }
+
+
+    init(_data?: any) {
+    }
+
+
+    static fromJS(data: any): _OpenAPIGenBaseModel {
+        data = typeof data === 'object' ? data : {};
+
+        throw new Error("The abstract class '_OpenAPIGenBaseModel' cannot be instantiated.");
+    }
+
+	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;
+        return Object.fromEntries(
+            Object.entries(data).filter(([_, v]) => v !== undefined));
+    }
+
+}