BH.oM.Ground.AnalysisProperties¶
Properties related to the analysis undertaken on the contaminant.
Class structure¶
Implemented interfaces and base types¶
The AnalysisProperties 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
- BH.oM.Ground.IContaminantProperty
Properties¶
Defining properties¶
The following properties are defined on the class
Name | Type | Description | Quantity |
---|---|---|---|
TotalOrDissolved | string | Whether the specimen is total or dissolved (ERES_TORD). | - |
AccreditingBody | string | Accrediting body and reference number (when appropriate) (ERES_CRED). | - |
LabName | string | Name of testing labratory or organisation (ERES_LAB). | - |
PercentageRemoved | double | Percentage of material removed (ERES_PERP). | - |
SizeRemoved | double | Size of material removed prior to test. Value represents lowest sized material removed (ERES_SIZE). | Length [m] |
InstrumentReference | string | Instrument reference number or identifier (ERES_IREF). | - |
LeachateDate | DateTime | Leachate preperation date and time (ERES_LDTM). | - |
LeachateMethod | string | Leachate preperation method (ERES_LMTH). | - |
DilutionFactor | int | Dilution factor (ERES_DIL). | - |
Basis | string | Basis (ERES_BAS). | - |
Location | string | Analysis location (ERES_LOCN). | - |
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 AnalysisProperties : 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/AnalysisProperties.json"
}
The JSON Schema is available on github here: