Skip to content

BH.oM.Verification.Requirements.Requirement

Object representing a single, condition-based requirement to run against each object in a set filtered based on Specification.ExtractionAlso contains the config required to represent the verification results in a human friendly form.

Class structure

Implemented interfaces and base types

The Requirement 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
Clause string Human readable identifier to reference the Requirement. -
Source Source Source material for this Requirement. E.g. Codes, best practices, guidelines, etc. -
Comment string Any additional notes. -
FailureMessage string General, human-readable message explaining what does the failure mean to the user. -
Severity FailureSeverity Severity of Requirement failure, originating from the concept that not all conditions are necessarily errors. -
Condition ICondition Condition to be met for an object to pass a Requirement. -
ReportingConfig IConditionReportingConfig Reporting config containing settings needed to present the verification results in a human friendly form. -

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> - -

Code and Schema

C# implementation

C#
public class Requirement : BH.oM.Base.BHoMObject, BH.oM.Base.IBHoMObject, BH.oM.Base.IObject, BH.oM.Verification.Requirements.IRequirement

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

The JSON Schema is available on github here: