BH.oM.Ground.Stratum¶
A stratum containing the geological information based on the AGS schema.
Class structure¶
Implemented interfaces and base types¶
The Stratum 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
Properties¶
Defining properties¶
The following properties are defined on the class
Name | Type | Description | Quantity |
---|---|---|---|
Id | string | Location identifier relating the borehole to the strata (LOCA_ID). | - |
Top | double | Depth to the top of the strata based on the datum provided on the Borehole (GEOL_TOP). | Length [m] |
Bottom | double | Depth to the bottom of the strata based on the datum provided on the Borehole (GEOL_BOT). | Length [m] |
LogDescription | string | General description of the strata (GEOL_DESC). | - |
Legend | string | The legend code summarising the LogDescription (GEOL_LEG). | - |
ObservedGeology | string | The observed geology expressed as a GeologicalUnit (GEOL_GEOL). | - |
InterpretedGeology | string | The interpreted geology expressed as an engineering material (GEOL_GEO2). | - |
OptionalInterpretedGeology | string | The optional interpreted geology expressed as an engineering material (GEOL_GEO3). | - |
Properties | List<IStratumProperty> | The optional stratum properties. | - |
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 Strata or its defining properties are valid and outputs relevant error message. | - | Ground_Engine |
Code and Schema¶
C# implementation¶
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/Stratum.json"
}
The JSON Schema is available on github here: