Skip to content

BH.oM.Adapters.XML.Settings.GBXMLSettings

Class structure

Implemented interfaces and base types

The GBXMLSettings 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
ReplaceCurtainWalls bool Set to true if you want to replace curtain walls to have openings the same size as the wall. This is useful for IES exports. Default false -
ReplaceSolidOpeningsIntoDoors bool Set to true if you want to replace an opening which is marked as solid into a door. Useful for IES exports. Default false -
IncludeConstructions bool Set to true if you want to include construction and material data in the export. Default false -
FixIncorrectAirTypes bool Set to true if you want air types with one adjacent space (i.e. external air walls) to have their type fixed based on their tilt. Default false -
NewFile bool Set to false if you want to append to a file when pushing XML. If set to true then a file will be created. If a file exists, it will be overwritten. Default true -
ResultsUnitType UnitType Set the unit type for the results to be either SI or Imperial. Default SI -
ExportDetail ExportDetail Set the detail of your export to be either full (whole building), shell (exterior walls only), or spaces (each individual space as its own XML file). Default full -
DistanceTolerance double Set the tolerance for distance between points to define a 'short' segment which should be removed from export, default is set to BH.oM.Geometry.Tolerance.Distance -
PlanarTolerance double Set tolerance for planar surfaces, default is set to BH.oM.Geometry.Tolerance.Distance -
OffsetDistance double Set a distance to offset openings that have a area >= the area of the host panel. Value should be negative. Defaults to -0.001 -
AngleTolerance double Set the tolerance for angle calculations when exporting to XML. Default is set to BH.oM.Geometry.Tolerance.Angle -
RoundingSettings RoundingSettings Set the rounding options for numerical outputs to be used within gbXML creation. Default is per the Rounding Settings defaults -
UnitSetUp GBXMLUnitSetUp Set the units to be used for the export of a gbXML file. Default units will be in SI using the defaults of the GBXMLSetUp object if none are provided -

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 GBXMLSettings : BH.oM.Base.BHoMObject, BH.oM.Base.IBHoMObject, BH.oM.Base.IObject, BH.oM.Adapters.XML.Settings.IXMLSettings

Assembly: XML_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/XML_oM/Settings/GBXMLSettings.json"
}

The JSON Schema is available on github here: