Skip to content

BH.oM.Ground.BoreholeReference

References to associated files, storage links or previous boreholes.

Class structure

Implemented interfaces and base types

The BoreholeReference 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
StartDate DateTime Start date of the activity (LOCA_STAR). -
EndDate DateTime End date of the activity (LOCA_ENDD). -
File string Associated file reference including instructions and photographs (FILE_FSET). -
URL string Link to storage of borehole data. -
OriginalId string Original hole id (LOCA_ORID). -
OriginalReference string Original job reference (LOCA_ORJO). -
OriginalCompany string Originating company (LOCA_ORCO). -

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
IsValid bool Checks if a IBoreholeProperty is valid and outputs relevant error message. - Ground_Engine

Code and Schema

C# implementation

C#
public class BoreholeReference : BH.oM.Base.BHoMObject, BH.oM.Base.IBHoMObject, BH.oM.Base.IObject, BH.oM.Ground.IBoreholeProperty

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/BoreholeReference.json"
}

The JSON Schema is available on github here: