Skip to content

BH.oM.Ground.Borehole

A representation of a borehole defined by a coordinate system, start point and end point based on the AGS schema.

Class structure

Implemented interfaces and base types

The Borehole 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
Id string Location identifier for the borehole unique to the project (LOCA_ID). -
Top Point The top of the borehole within the coordinate system provided (LOCA_NATE, LOCA_NATEN, LOCA_GL). -
Bottom Point The bottom of the borehole within the coordinate system provided (LOCA_ETRV, LOCA_NTRV, LOCA_FDEP). -
CoordinateSystem Cartesian The coordinate system referenced by the top and bottom point. (LOCA_GREF, LOCA_NATD). -
Strata List<Stratum> A list of objects containing the strata found within the borehole, based on the GEOL table. -
ContaminantSamples List<ContaminantSample> A list of objects containing the contaminant samples found within the borehole, based on the ERES table. -
GeotechnicalTestResults List<ITest> A list of objects containing the geotechnical results found within the borehole. -
BoreholeProperties List<IBoreholeProperty> A list of properties related to the borehole. -

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
DistinctSuites List<string> Returns a distinct list of suites from a Borehole using the sample reference, test name or top depth (in order of priority). - Ground_Engine
IsValid bool Checks if a Borehole or its defining properties are valid and outputs relevant error message. - Ground_Engine
StrataLines List<Line> Generates a list of lines relating to the strata within the Borehole which can be used for visualisation purposes. - Ground_Engine

Code and Schema

C# implementation

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

Assembly: Ground_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/Ground_oM/Borehole.json"
}

The JSON Schema is available on github here: