Skip to content

BH.oM.Verification.Conditions.IValueCondition

Interface for conditions that evaluate a value derived from an object against certain criteria.

Interface structure

Implemented interfaces and base types

The IValueCondition is inheriting from the following base type(s) and implements the following interfaces:

Classes implementing this interface

The following classes are implementing this interface:

Properties

Defining properties

The following properties are defined on the interface

Name Type Description Quantity
ValueSource IValueSource Object defining how to extract a value from an object. -

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 interface IValueCondition : BH.oM.Verification.Conditions.ICondition, BH.oM.Base.IObject

Assembly: Verification_oM.dll

The C# interface 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/IValueCondition.json"
}

The JSON Schema is available on github here: