BH.oM.Spatial.ShapeProfiles.CellularOpenings.CircularCellularOpening¶
Class structure¶
Implemented interfaces and base types¶
The CircularCellularOpening is inheriting from the following base type(s) and implements the following interfaces:
- BH.oM.Base.BHoMObject
- BH.oM.Base.IBHoMObject
- BH.oM.Base.IObject
- BH.oM.Spatial.ShapeProfiles.CellularOpenings.ICellularOpening
- BH.oM.Base.IImmutable
Properties¶
Defining properties¶
The following properties are defined on the class
Name | Type | Description | Quantity |
---|---|---|---|
Diameter | double | Diameter of the opening. | Length [m] |
WidthWebPost | double | Clear distance between openings. | Length [m] |
Spacing | double | Centre to centre distance between openings. | Length [m] |
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> | - | - |
Derived properties¶
The following properties are defined as extension methods in one of the BHoM_Engines
Name | Type | Description | Quantity | Engine |
---|---|---|---|---|
IOpeningArea | double | Returns the area of a single opening. | Area [m²] | Spatial_Engine |
IOpeningCurve | ICurve | Returns the curve of a single opening in the XY plane. | - | Spatial_Engine |
OpeningArea | double | Returns the area of a single opening. | Area [m²] | Spatial_Engine |
OpeningCurve | ICurve | Returns the curve of a single opening in the XY plane. | - | Spatial_Engine |
Code and Schema¶
C# implementation¶
C#
public class CircularCellularOpening : BH.oM.Base.BHoMObject,
BH.oM.Base.IBHoMObject,
BH.oM.Base.IObject,
BH.oM.Spatial.ShapeProfiles.CellularOpenings.ICellularOpening,
BH.oM.Base.IImmutable
Assembly: Spatial_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/Spatial_oM/ShapeProfiles/CellularOpenings/CircularCellularOpening.json"
}
The JSON Schema is available on github here: