Skip to content

BH.oM.Verification.Requirements.IRequirement

Top interface for all kinds of Requirements.

Interface structure

Implemented interfaces and base types

The IRequirement 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
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. -

Code and Schema

C# implementation

C#
public interface IRequirement : BH.oM.Base.IBHoMObject, 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/Requirements/IRequirement.json"
}

The JSON Schema is available on github here: