Skip to content

BH.oM.Ground.StratumReference

References to associated files, remarks or lexicon codes.

Class structure

Implemented interfaces and base types

The StratumReference 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
Remarks string General remarks for the investigation (GEOL_REF). -
LexiconCode string BGS Lexicon code for the strata (GEOL_BGS). -
Files string Associated file reference including instructions and photographs (FILE_FSET). -

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 IStratumProperties is valid and outputs relevant error message. - Ground_Engine

Code and Schema

C# implementation

C#
public class StratumReference : BH.oM.Base.BHoMObject, BH.oM.Base.IBHoMObject, BH.oM.Base.IObject, BH.oM.Ground.IStratumProperty

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

The JSON Schema is available on github here: