BH.oM.Test.Results.InputOutputComparisonSummary¶
Class structure¶
Implemented interfaces and base types¶
The InputOutputComparisonSummary is inheriting from the following base type(s) and implements the following interfaces:
- BH.oM.Analytical.Results.IObjectIdResult
- BH.oM.Analytical.Results.IResult
- BH.oM.Base.IObject
- IComparable<BH.oM.Analytical.Results.IResult>
- BH.oM.Base.IImmutable
- BH.oM.Analytical.Results.ICasedResult
- BH.oM.Analytical.Results.ITimeStepResult
Properties¶
Defining properties¶
The following properties are defined on the class
| Name | Type | Description | Quantity |
|---|---|---|---|
| ObjectId | IComparable | The hashes of the item being evaluated, comma separated | - |
| ResultCase | IComparable | The sets the result belongs to, comma separated. | - |
| ObjectType | Type | The type of the object being evaluated. | - |
| TimeStep | double | Not in use | - |
| ResultType | InputOutputComparisonType | - | - |
| Occurrences | int | Number of times a particular difference has been registred. | - |
| PropertyId | string | The name of the evaluated property. Only applicable for ResultType 'Difference'. | - |
| AverageDifference | double | Average difference between the input and returned item. Only applicable for Results of type 'Difference' for numerical values. | - |
| MaximumDifference | double | Maximum difference between the input and returned item. Only applicable for Results of type 'Difference' for numerical values. | - |
| MaximumDifferenceInputItem | double | Value of the input item for the maximum difference. Only applicable for Results of type 'Difference' for numerical values. | - |
| MaximumDifferenceReturnedItem | double | Value of the returned item for the maximum difference. Only applicable for Results of type 'Difference' for numerical values. | - |
Derived properties¶
The following properties are defined as extension methods in one of the BHoM_Engines
| Name | Type | Description | Quantity | Engine |
|---|---|---|---|---|
| AllIdentifierProperties | List<string> | Gets the name of all properties of the result that are of identifier types. This is all properties tagged with any IdentifierAttribute. | - | Results_Engine |
| IsNull | bool | Checks if a Result is null and outputs relevant error message. | - | Results_Engine |
| ObjectIdentifierProperties | List<string> | Gets the name of all properties of the result that are of ObjectIdentifier types. This is all properties tagged with the ObjectIdentifierAttribute. | - | Results_Engine |
| ResultPropertyKeys | List<string> | Returns the result value carrying properties available for the result type provided. Currently only supported for IResultItem and IResultCollection<IResultItem> type results. | - | Results_Engine |
| ScenarioIdentifierProperties | List<string> | Gets the name of all properties of the result that are of Scenario types. This is all properties tagged with the ScenarioIdentifierAttribute. | - | Results_Engine |
Code and Schema¶
C# implementation¶
C#
public class InputOutputComparisonSummary : BH.oM.Analytical.Results.IObjectIdResult,
BH.oM.Analytical.Results.IResult,
BH.oM.Base.IObject,
System.IComparable<BH.oM.Analytical.Results.IResult>,
BH.oM.Base.IImmutable,
BH.oM.Analytical.Results.ICasedResult,
BH.oM.Analytical.Results.ITimeStepResult
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/Results/InputOutputComparisonSummary.json"
}
The JSON Schema is available on github here: