Skip to content

BH.oM.Verification.Specifications.Specification

A top level object in verification workflow. Contains the information about the whole workflow, from extraction, to checking, to reporting.

Class structure

Implemented interfaces and base types

The Specification 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 Specification. -
Description string Description of the Specification. -
Extraction IExtraction Object describing how to extract the objects to be verify against Requirements. -
Requirements List<IRequirement> A collection of objects, each containing an atomic check together with reporting config and metadata. -

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 Specification : BH.oM.Base.BHoMObject, BH.oM.Base.IBHoMObject, BH.oM.Base.IObject, BH.oM.Base.ISpecification

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/Specifications/Specification.json"
}

The JSON Schema is available on github here: