Skip to content

BH.oM.Ground.ResultProperties

Properties related to the results based on the tests of the contaminant.

Class structure

Implemented interfaces and base types

The ResultProperties 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
Type string The result type for the contaminant sample (ERES_RTCD). -
Qualifier string The interepreted qualifier that shows whether a Result was lower than a detection threshold (ERES_IQLF). -
Reportable bool Is the result reportable (ERES_RRES). -
DetectFlag bool Detect flag (ERES_DETF). -
Organic bool Is the contaminant sample organic (ERES_ORG). -

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

Code and Schema

C# implementation

C#
public class ResultProperties : BH.oM.Base.BHoMObject, BH.oM.Base.IBHoMObject, BH.oM.Base.IObject, BH.oM.Ground.IContaminantProperty

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

The JSON Schema is available on github here: