Skip to content

BH.oM.Environment.SAP.XML.FloorIteration

Describe a single UValue change for floors within the SAP context.

Class structure

Implemented interfaces and base types

The FloorIteration 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
UValue double New UValue to use for the Floor(s). Must be a positive number. Measured in Watts per Meter Squared Kelvin (W/m2K). -
Include List<string> A list of Floor names to make changes to. If this is left blank, then all floors in the SAP Report will be updated to have this UValue. -
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 FloorIteration : 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/XML/FloorIteration.json"
}

The JSON Schema is available on github here: