Skip to content

BH.oM.Environment.SAP.XML.PropertyDetails

Class structure

Implemented interfaces and base types

The PropertyDetails 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
EnergySource EnergySource . -
Heating Heating . -
BuildingParts BuildingParts Details of the significant building parts that comprise the main habitable building in the property. -
Ventilation Ventilation Details of the means by which the building is ventilated -
OpeningTypes OpeningTypes Types of exposed openings that make up a particular property. -
PropertyType string The type of Property, such as House, Flat, Mansion, Maisonette etc. -
BuiltForm string The building type of the Property e.g. Detached, Semi-Detached, Terrace etc. Together with the Property Type, the Built Form provides a structured description of the property. -
LivingArea string The size of the living area in square metres. The living area is the room marked on a plan as the lounge or living room, or the largest public room (irrespective of usage by particular occupants), together with any rooms not separated from the lounge or living room by doors, and including any cupboards directly accessed from the lounge or living room. Living area does not, however, extend over more than one storey, even when stairs enter the living area directly. -
LowestStoreyArea string The Area of the lowest storey in square meters including unheated or communal areas such as garages or corridors. -
Orientation string The orientation of the front of the property. -
ColdWaterSource string What is the cold water source? Either mains or header tank. -
WindowsOvershading string Average amount of overshading of windows. -
ThermalMassParameter string Average thermal mass parameter for the dwelling in kJ/m�K. If omitted it is calculated using the kappa values of each element. -
IsInSmokeControlArea string Is property in a smoke control area? Only if a solid fuel appliance is used. -
Lighting Lighting Details of the main lighting for the property -
ConservatoryType string Type of conservatory. -
TerrainType string Terrain type. Needed for wind-turbines and for applying measures. -
HasSpecialFeature Nullable<bool> For backwards compatibility only, do not use. -
SpecialFeatureDescription string For backwards compatibility only, do not use. -
EnergySavedOrGenerated string For backwards compatibility only, do not use. -
SavedOrGeneratedFuel string For backwards compatibility only, do not use. -
EnergyUsed string For backwards compatibility only, do not use. -
EnergyUsedFuel string For backwards compatibility only, do not use. -
AdditionalAllowableElectricityGeneration string Additional allowable electricity generation applicable to this dwelling in kWh per square metre; only if Zero Carbon Home assessment. -
IsDwellingExportCapable Nullable<bool> . -
GasSmartMeterPresent Nullable<bool> . -
ElectricitySmartMeterPresent Nullable<bool> . -
PVConnection string . -
PVDiverter Nullable<bool> Diverter present. -
BatteryCapacity string Battery capacity capacity if diverter present -
IsWindTurbineConnectedToDwellingMeter Nullable<bool> Whether the wind turbine is connected to the Dwelling's meter. -
DeselectedImprovements DeselectedImprovements . -
FlatDetails FlatDetails Detials of location of flat in building -
SpecialFeatures SpecialFeatures . -
DesignWaterUse string Design limit for total water use. -
Cooling Cooling . -

Inherited properties

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

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

Code and Schema

C# implementation

C#
public class PropertyDetails : BH.oM.Base.BHoMObject, BH.oM.Base.IBHoMObject, BH.oM.Base.IObject

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/PropertyDetails.json"
}

The JSON Schema is available on github here: