Skip to content

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

Class structure

Generic parameters

The ElementResult contains the following generic paramters:

T

Constrained by the following arguments:

Implemented interfaces and base types

The ElementResult`1 is inheriting from the following base type(s) and implements the following interfaces:

Classes inheriting from this class

The following classes are inheriting from this class:

Properties

Defining properties

The following properties are defined on the class

Name Type Description Quantity
ObjectId IComparable Id of the BHoMObject that this result belongs to. -
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. -
Indicators ReadOnlyDictionary<Module, double> Resulting indicators per evaluated module. -

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-modules (A1-A5) with a set value (all values not NaN). - LifeCycleAssessment_Engine
BTotal double Gets the total sum of values from all B-modules (B1-B7) with a set value (all values not NaN). - LifeCycleAssessment_Engine
CTotal double Gets the total sum of values from all C-modules (C1-C4) with a set value (all values not NaN). - LifeCycleAssessment_Engine
IMetricType MetricType - - LifeCycleAssessment_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
ResultValuePropertiesItem Dictionary<string, Tuple<Func<T, double>, QuantityAttribute>> Extract all potential result carrying property getters from a result class, i.e. properties of type double that is defined on the class. Properties defined on a base class are ignored.
Also extracts methods returning a double that has the result type as the only argument.
Func<T,double> returned together with corresponding QuantityAttribute in a Dictionary with the property or method name as the Key.		 - 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 modules with a set value (all values not NaN). - LifeCycleAssessment_Engine

Code and Schema

C# implementation

C#
public abstract class ElementResult`1 : BH.oM.LifeCycleAssessment.Results.IElementResult<>,
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.Interfaces.ILifeCycleAssessmentModuleData<System.Collections.ObjectModel.ReadOnlyDictionary<BH.oM.LifeCycleAssessment.Module, System.Double>>,
BH.oM.LifeCycleAssessment.Interfaces.ILifeCycleAssessmentIndicator

Assembly: LifeCycleAssessment_oM.dll

The C# abstract 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/LifeCycleAssessment_oM/Results/ElementResult`1.json"
}

The JSON Schema is available on github here:

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