BH.oM.Verification.Conditions.IsInSet¶
Condition that verifies if a value extracted from an object is included in the given set of values.
Class structure¶
Implemented interfaces and base types¶
The IsInSet is inheriting from the following base type(s) and implements the following interfaces:
- BH.oM.Verification.Conditions.IValueCondition
- BH.oM.Verification.Conditions.ICondition
- BH.oM.Base.IObject
Properties¶
Defining properties¶
The following properties are defined on the class
Name | Type | Description | Quantity |
---|---|---|---|
ValueSource | IValueSource | Object defining the source of a value to evaluate. | - |
Set | List<object> | Set of values for the extracted value to compare against. | - |
ComparisonConfig | ComparisonConfig | Options as per how the comparison is computed. | - |
Derived properties¶
The following properties are defined as extension methods in one of the BHoM_Engines
Name | Type | Description | Quantity | Engine |
---|---|---|---|---|
INestedConditions | IEnumerable<ICondition> | Extracts the conditions nested inside a given condition, e.g. conditions nested inside logical conditions. | - | Verification_Engine |
ValueSourceLabel | string | Generates a human readable label for a value source embedded in a value condition, based on provided value condition reporting config. | - | Verification_Engine |
Code and Schema¶
C# implementation¶
C#
public class IsInSet : BH.oM.Verification.Conditions.IValueCondition, BH.oM.Verification.Conditions.ICondition, 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/Conditions/IsInSet.json"
}
The JSON Schema is available on github here: