BH.oM.Environment.Elements.Space¶
A space object is an analytical depiction of a room defined by its environmental conditions (internal gains)
Class structure¶
Implemented interfaces and base types¶
The Space 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.Environment.IEnvironmentObject
- BH.oM.Analytical.Elements.IRegion
- BH.oM.Analytical.IAnalytical
- BH.oM.Dimensional.IElement2D
- BH.oM.Dimensional.IElement
Properties¶
Defining properties¶
The following properties are defined on the class
Name | Type | Description | Quantity |
---|---|---|---|
Zones | List<string> | Zones denotes the list of zones that this particular space is associated with. Zones are collections of spaces with similar internal gains and exterior envelope conditions. | - |
LightingGain | List<Lighting> | Lighting gains are objects that are defined as the amount of heat contributed by light fixtures within the space | - |
EquipmentGain | List<Equipment> | Equipment gains are objects that are defined as the amount of heat contributed by equipment within the space | - |
PeopleGain | List<People> | People gains are objects that are defined as the amount of heat contributed by people based on their assumed activity level within the space (dancing, sitting, etc) | - |
Infiltration | List<Infiltration> | Infiltration gains are objects that are defined as the amount of heat or heat loss contributed by cracks in the exterior envelope of the building which allow unconditioned outside air to be introduced to the space | - |
Ventilation | List<Ventilation> | Ventilation are objects that define the amount of outside air that should be introduced to a space, which is typically based on the number of occupants breathing the air and the area of the space. | - |
Exhaust | List<Exhaust> | Exhaust are objects that define the amount of air that should be extracted from a space, which is either based on the objects within the space (toilets, showers) or the space type (kitchen, bathroom). | - |
OccupantDensity | Occupancy | Occupant Density is an object that defines the area occupied by each individual in a space (2 m2 per person). | - |
Acoustics | Acoustics | Acoustics for an Environments Space define the noise within the space, by noise created by the velocity of the air within the ducts in the space, the Noise Rating, and decibel. | - |
Plumbing | Plumbing | The plumbing attributes of a space are indicative of the amount of cold water, hot water and waste required by a space, as well as requirements for vent, floor drains, hose bibs or natural gas. | - |
FireProtection | FireProtection | The fire protection attributes of a space are indicative of the hazard level of the space (which influences the sprinkler count), the sprinkler system type required, and the presence of combustible materials or sloped ceilings. | - |
ProjectSpaceType | string | Project Space Type is a string that defines how the space is used on a given project (Museum, Corridor, etc) | - |
SpaceType | SpaceType | Space Type is an enum that defines how the space is used (Museum, Corridor, etc) | - |
Location | Point | A point in 3D space providing a location point of the space | - |
Perimeter | ICurve | A 2D curve defining the external boundaries of the floor of the space | - |
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 |
---|---|---|---|---|
Altitude | double | Returns the minimum altitude of an Environment Object as the minimum z value from the bounding box of the geometry | - | Environment_Engine |
AltitudeRange | double | Returns the range of altitude of an Environment Object taken as the maximum z value minus minimum z value from the bounding box of the geometry | - | Environment_Engine |
Area | double | Queries the IElement2Ds area defined as the area confined by the outline curves subtracting the area of the internal elements. | Area [m²] | Spatial_Engine |
Bottom | ICurve | Returns the bottom of a given environment object. | - | Environment_Engine |
Bounds | BoundingBox | Queries the IElement2Ds BoundingBox. Acts on the element curve definition of the IElement2D through the Geometry_Engine. | - | Spatial_Engine |
Centroid | Point | Queries the centre of area for a IElement2Ds surface representation. For an IElement2D with homogeneous material and thickness this will also be the centre of weight. | - | Spatial_Engine |
ControlPoints | List<Point> | Queries the control points of the element curve representation of the IElement2D. | - | Spatial_Engine |
DominantVector | Vector | Gets the the dominant vector (orientation) of an Element2D based on its lines lengths. | - | Spatial_Engine |
ElementCurves | List<ICurve> | Queries the geometricly defining curves of the IElement2Ds surface. | - | Spatial_Engine |
ElementVertices | List<Point> | Returns the discontinuity points from the defining ICurves of the IElement2D. | - | Spatial_Engine |
ExplodeToParts | Output<List<ICurve>, List<ICurve>, List<ICurve>> | Returns the sides, top and bottom of a given environment object. | - | Environment_Engine |
ExternalElementCurves | List<ICurve> | Queries the geometricly defining external curves of the IElement2Ds surface. | - | Spatial_Engine |
Geometry | ICurve | Gets the geometry of a IRegion as its Perimiter curve. Method required for automatic display in UI packages. | - | Analytical_Engine |
Height | double | Returns the height of a generic Environment Object | - | Environment_Engine |
IArea | double | Queries the area of the geometrical representation of an IElement. | Area [m²] | Spatial_Engine |
IBounds | BoundingBox | Queries the IElements BoundingBox. Acts on the elements geometrical definition of the IElement through the Geometry_Engine. | - | Spatial_Engine |
ICentroid | Point | Queries the centre of weight for the homogeneous geometrical representation of an IElement. | - | Spatial_Engine |
IControlPoints | List<Point> | Queries the control points of the geometrical representation of an IElement. | - | Spatial_Engine |
IElementCurves | List<ICurve> | Queries the geometricly defining curves of the IElements geometry. | - | Spatial_Engine |
IElementVertices | List<Point> | Returns the discontinuity points from the defining ICurves of the IElement. | - | Spatial_Engine |
IInternalElements2D | List<IElement2D> | Queries the IElement2Ds internal IElement2Ds. Returns a empty list for objects without definied internal elements | - | Spatial_Engine |
IIsPlanar | bool | Checks whether all control points of an element lie in a single plane. | - | Spatial_Engine |
IIsSelfIntersecting | bool | Checks if any of the curves defining an IElement is closer to itself than the tolerance at any two points (is self intersecting). In case of IElement2D, does not check for intersections between external and internal curves, or between different internal curves. | - | Spatial_Engine |
Inclination | double | Returns the inclination of a generic Environment Object | - | Environment_Engine |
INewInternalElement2D | IElement2D | Creates a IElement2D of a type which can be assigned to the IElement2D. | - | Spatial_Engine |
InternalElementCurves | List<ICurve> | Queries the geometricly defining internal curves, such as Openings, of the IElement2Ds surface. | - | Spatial_Engine |
InternalOutlineCurves | List<PolyCurve> | Queries the IElement2Ds internal IElement2Ds outline curves. | - | Spatial_Engine |
IOutlineElements1D | List<IElement1D> | Returns every IElement1D which makes up the exterior perimeter of the IElement2D. | - | Spatial_Engine |
IPrimaryPropertyName | string | Returns the name of an elements primary defining construction property | - | Facade_Engine |
IsPlanar | bool | Checks whether all control points of an element lie in a single plane. | - | Spatial_Engine |
IsSelfIntersecting | bool | Checks if any of the element curves of the IElement2D is closer to itself than the tolerance at any two points. Does not check for intersections between external and internal curves, or between different internal curves. | - | Spatial_Engine |
Normal | Vector | Returns the normal to the IElement2D which is perpendicular to its plane and oriented according to the right hand rule in relation to the outline curve. | - | Spatial_Engine |
Orientation | Nullable<double> | Returns the angle to north of a given environmental object on an xyPlane | - | Environment_Engine |
OutlineCurve | PolyCurve | Returns a single polycurve outline created from the external elements. | - | Spatial_Engine |
OutlineElements1D | List<IElement1D> | Gets the boundary from an IRegion defining the boundary of the element as the subparts of the perimiter curve. Method required for all IElement2Ds. | - | Analytical_Engine |
OutlineElements1D | List<IElement1D> | Returns the outline 1D elements of an Environments Space | - | Environment_Engine |
Polyline | Polyline | Returns the external boundary from a generic Environment Object | - | Environment_Engine |
Polyline | Polyline | Returns the external boundary from an Environment Space as a BHoM Geometry Polyline | - | Environment_Engine |
Sides | List<ICurve> | Returns the sides of a given environment object. | - | Environment_Engine |
Tilt | double | Returns the tilt of an Environment Object | - | Environment_Engine |
ToLines | List<Line> | Returns the external boundary from a generic Environment Object | - | Environment_Engine |
Top | ICurve | Returns the top of a given environment object. | - | Environment_Engine |
Width | double | Returns the width of a generic Environment Object | - | Environment_Engine |
Code and Schema¶
C# implementation¶
C#
public class Space : BH.oM.Base.BHoMObject,
BH.oM.Base.IBHoMObject,
BH.oM.Base.IObject,
BH.oM.Environment.IEnvironmentObject,
BH.oM.Analytical.Elements.IRegion,
BH.oM.Analytical.IAnalytical,
BH.oM.Dimensional.IElement2D,
BH.oM.Dimensional.IElement
Assembly: Environment_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/Environment_oM/Elements/Space.json"
}
The JSON Schema is available on github here: