Skip to content

BH.oM.Environment.Results.Illuminance.Lux

Lux contains results for Lux analysis. Inherits from MeshElementResult which provides properties related to which node this Lux is recorded for

Class structure

Implemented interfaces and base types

The Lux is inheriting from the following base type(s) and implements the following interfaces:

Properties

Defining properties

The following properties are defined on the class

Name Type Description Quantity
LuxLevel double The amount of lux recorded for the given analysis node Illuminance [lux]

Inherited properties

The following properties are inherited from the base class of the object

Name Type Description Quantity
ObjectId IComparable ID of the AnalysisGrid that this result belongs to -
NodeID IComparable ID of the Node in the Analysis Grid that this result belongs to -
ResultCase IComparable Identifier for the Analysis Case that the result belongs to. Is generally name or number of the analysis -
TimeStep double Time step for time history results. Typically this will be hour intervals for most Environment Analysis -

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 class Lux : BH.oM.Environment.Results.Mesh.MeshElementResult,
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: Environment_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/Environment_oM/Results/Illuminance/Lux.json"
}

The JSON Schema is available on github here: