BH.oM.Spatial.ShapeProfiles.CellularOpenings.ICellularOpening¶
Interface structure¶
Implemented interfaces and base types¶
The ICellularOpening is inheriting from the following base type(s) and implements the following interfaces:
- BH.oM.Base.IBHoMObject
- BH.oM.Base.IObject
Classes implementing this interface¶
The following classes are implementing this interface:
- BH.oM.Spatial.ShapeProfiles.CellularOpenings.CircularCellularOpening
- BH.oM.Spatial.ShapeProfiles.CellularOpenings.HexagonalCellularOpening
- BH.oM.Spatial.ShapeProfiles.CellularOpenings.SinusoidalCellularOpening
Properties¶
Defining properties¶
The following properties are defined on the interface
Name | Type | Description | Quantity |
---|---|---|---|
WidthWebPost | double | Clear distance between openings. | Length [m] |
Spacing | double | Centre to centre distance between openings. | Length [m] |
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 |
Code and Schema¶
C# implementation¶
Assembly: Spatial_oM.dll
The C# interface 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/ICellularOpening.json"
}
The JSON Schema is available on github here: