BH.oM.Analytical.Results.IResultCollection<T>¶
Base interface for results classes that are a collection of individual results, for example IMeshResults.
Interface structure¶
Generic parameters¶
The IResultCollection contains the following generic paramters:
T¶
Constrained by the following arguments:
- BH.oM.Analytical.Results.IResult
Implemented interfaces and base types¶
The IResultCollection`1 is inheriting from the following base type(s) and implements the following interfaces:
- BH.oM.Analytical.Results.IResult
- BH.oM.Base.IObject
- IComparable<BH.oM.Analytical.Results.IResult>
- BH.oM.Base.IImmutable
Interfaces implementing this interface¶
The following interfaces are implementing this interface:
- BH.oM.Analytical.Results.IMeshResult<T>
Classes implementing this interface¶
The following classes are implementing this interface:
- BH.oM.Environment.Results.Mesh.MeshResult
- BH.oM.Lighting.Results.Mesh.MeshResult
- BH.oM.Structure.Results.MeshResult
- BH.oM.Test.Results.InputOutputComparison
Properties¶
Defining properties¶
The following properties are defined on the interface
| Name | Type | Description | Quantity |
|---|---|---|---|
| Results | IReadOnlyList<T> | - | - |
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 |
| 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 interface IResultCollection`1 : BH.oM.Analytical.Results.IResult,
BH.oM.Base.IObject,
System.IComparable<BH.oM.Analytical.Results.IResult>,
BH.oM.Base.IImmutable
Assembly: Analytical_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/Analytical_oM/Results/IResultCollection`1.json"
}
The JSON Schema is available on github here:
- [IResultCollection
1.json](https://github.com/BHoM/BHoM_JSONSchema/blob/develop/Analytical_oM/Results/IResultCollection1.json)