BH.oM.Test.UnitTests.TestData¶
Defines input data and expected output data for one run of a particular unit test.
Class structure¶
Implemented interfaces and base types¶
The TestData is inheriting from the following base type(s) and implements the following interfaces:
- BH.oM.Base.BHoMObject
- BH.oM.Base.IBHoMObject
- BH.oM.Base.IObject
- BH.oM.Base.IImmutable
Properties¶
Defining properties¶
The following properties are defined on the class
Name | Type | Description | Quantity |
---|---|---|---|
Inputs | ReadOnlyCollection<object> | Inputs to the method. Inputs are matched based on index in the list, i.e. index 0 in this list will be used as the first parameter of the method tested. | - |
Outputs | ReadOnlyCollection<object> | The expected outputs from the method for the provided inputs. The length of this collection will only be greater than one if the method being tested returns an Output<T1,..,Tn>, for which the indices will match the ones of the Output<>. This means methods returning a collection will be seen as returning one object, where the object is the collection. |
- |
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 TestData : BH.oM.Base.BHoMObject, BH.oM.Base.IBHoMObject, BH.oM.Base.IObject, BH.oM.Base.IImmutable
Assembly: Test_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/Test_oM/UnitTests/TestData.json"
}
The JSON Schema is available on github here: