Skip to content

BH.oM.Environment.SAP.OpeningIteration

Describe a single opening iteration for all the openings within the SAP context.

Class structure

Implemented interfaces and base types

The OpeningIteration is inheriting from the following base type(s) and implements the following interfaces:

Properties

Defining properties

The following properties are defined on the class

Name Type Description Quantity
Width double New width of all the openings. Must be a positive number. If left blank, no changes to width will be made. Length [m]
Height double New height of the all the openings. Must be a positive number. If left blank, no changes to height will be made. Length [m]
Pitch string New pitch of all the openings. Set as the pitch of roof containing roof window. If left blank, no changes to pitch will be made. -
Include List<string> A list of Opening names to make changes to. If this is left blank, then all openings in the SAP report will be updated based on the values of this iteration. -
Name string Provide the name of this iteration. The name should be unique across all iterations in your model, and should match any coordination with other models (over heating, daylighting, etc.) you may be running parametrics on. -
Prefix string What value should be used to prefix the name of this iteration when combining with other iterations. -

Inherited properties

The following properties are inherited from the base class of the object

Name Type Description Quantity
BHoM_Guid Guid - -
Fragments FragmentSet - -
Tags HashSet<string> - -
CustomData Dictionary<string, object> - -

Code and Schema

C# implementation

C#
public class OpeningIteration : BH.oM.Base.BHoMObject, BH.oM.Base.IBHoMObject, BH.oM.Base.IObject, BH.oM.Environment.SAP.IIteration

Assembly: SAP_oM.dll

The C# class definition is available on github:

All history and changes of the class can be found by inspection the history.

JSON Schema implementation

The object is defined as a JSON schema. You can validate a JSON instance against this schema by reference. To do this, use the schema reference below in a validator like this one.

JSON Schema
{
 "$ref" : "https://raw.githubusercontent.com/BHoM/BHoM_JSONSchema/develop/SAP_oM/SAP/OpeningIteration.json"
}

The JSON Schema is available on github here: