Skip to content

BH.oM.LifeCycleAssessment.Results.IElementResult<T>

Base interface for Life Cycle Assessment results for a particular element..

Interface structure

Generic parameters

The IElementResult contains the following generic paramters:

T

Constrained by the following arguments:

Implemented interfaces and base types

The IElementResult`1 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
Scope ScopeType Scope the object this result was generated from belongs to, e.g. Foundation or Facade -
Category ObjectCategory Category of the object this result was generated from, e.g. Beam or Wall -
MaterialResults IReadOnlyList<T> Result breakdown per material type. -

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
ATotal double Gets the total sum of values from all A-phases (A1-A5) with a set value (all values not NaN). - LifeCycleAssessment_Engine
BTotal double Gets the total sum of values from all B-phases (B1-B7) with a set value (all values not NaN). - LifeCycleAssessment_Engine
CTotal double Gets the total sum of values from all C-phases (C1-C4) with a set value (all values not NaN). - LifeCycleAssessment_Engine
IPhaseDataValues List<double> Gets the values corresponding to the values of all phases as a list of doubles. - LifeCycleAssessment_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
Total double Gets the total sum of values from all phases with a set value (all values not NaN). - LifeCycleAssessment_Engine

Code and Schema

C# implementation

C#
public interface IElementResult`1 : BH.oM.Analytical.Results.IObjectResult,
BH.oM.Analytical.Results.IResult,
BH.oM.Base.IObject,
System.IComparable<BH.oM.Analytical.Results.IResult>,
BH.oM.Base.IImmutable,
BH.oM.Analytical.Results.IObjectIdResult,
BH.oM.Analytical.Results.IResultItem,
BH.oM.LifeCycleAssessment.Results.IEnvironmentalResult,
BH.oM.LifeCycleAssessment.ILifeCycleAssessmentPhaseData

Assembly: LifeCycleAssessment_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/LifeCycleAssessment_oM/Results/IElementResult`1.json"
}

The JSON Schema is available on github here:

  • [IElementResult1.json](https://github.com/BHoM/BHoM_JSONSchema/blob/develop/LifeCycleAssessment_oM/Results/IElementResult1.json)