Skip to content

BH.oM.Verification.Reporting.NumberConditionReportingConfig

Config object containing settings for reporting results of checks against numerical value conditions.

Class structure

Implemented interfaces and base types

The NumberConditionReportingConfig 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
UnitLabel string Text to be used as a label for units expressing the extracted value. -
ValueMultiplier double Multiplier to be applied to the extracted value prior to reporting. -
RoundingAccuracy double Rounding accuracy to be used when reporting the extracted value. -

Inherited properties

The following properties are inherited from the base class of the object

Name Type Description Quantity
ValueSourceLabelOverride string Override text to be used as a label for value source. -

Code and Schema

C# implementation

C#
public class NumberConditionReportingConfig : BH.oM.Verification.Reporting.ValueConditionReportingConfig,
BH.oM.Verification.Reporting.IValueConditionReportingConfig,
BH.oM.Verification.Reporting.IConditionReportingConfig,
BH.oM.Base.IObject

Assembly: Verification_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/Verification_oM/Reporting/NumberConditionReportingConfig.json"
}

The JSON Schema is available on github here: