Skip to content

BH.oM.Ground.ContaminantSample

A representation of a contaminant sample defined by the depth of the sample, the chemical code and name based on the AGS schema.

Class structure

Implemented interfaces and base types

The ContaminantSample 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 relating the borehole to the strata (LOCA_ID). -
Top double Depth to the top of the sample, measured from the top of the borehole (SAMP_TOP). Length [m]
Chemical string Chemical code for the contaminant (ERES_CODE). -
Result double The amount of the chemical present (ERES_RTXT). MassFraction [kg/kg]
Type string The type of sample (SAMP_TYPE). -
ResultQuantity Type The quantity of the Result as a QuantityType such as Concentration, Molality, Molarity. -
ContaminantProperties List<IContaminantProperty> A list of different properties including references, tests, analysis, results and detection. -

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 ContaminantSample or its defining properties are valid and outputs relevant error message. - Ground_Engine

Code and Schema

C# implementation

C#
public class ContaminantSample : 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/ContaminantSample.json"
}

The JSON Schema is available on github here: