Skip to content

BH.oM.Quantities.Attributes.QuantityAttribute

Dimensional quantity as defined by the International System of Quantities

Properties

Defining properties

The following properties are defined on the base quantity attribute, to be overridden by the subclasses to indicate the dimensionality and SI units that make up the quantities.

Name Type Description
L int Length dimension
M int Mass dimension
T int Time dimension
I int Electric current dimension
Θ int Temperature dimension
N int Amount of substance dimension
J int Luminous intensity dimension
SIUnit string SI derived unit symbol

Inherited properties

The following properties are inherited from the base class of the object. These properties are framework related, and helps associate the quantity with specific targets.

Name Type Description
Name string Name of the method parameter this attribute corresponds to (not relevant in case of object properties).
TypeId object -

Derived properties

The following properties are defined as extension methods in one of the BHoM_Engines

Name Type Description Engine
Description string Return the custom description of a quantity attribute. Reflection_Engine
IDescription string Return the custom description of a classification attribute. Reflection_Engine

Class structure

Implemented interfaces and base types

The QuantityAttribute 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:

Code and Schema

C# implementation

C#
public abstract class QuantityAttribute : BH.oM.Base.Attributes.ClassificationAttribute, System.Attribute, BH.oM.Base.IImmutable, BH.oM.Base.IObject

Assembly: Quantities_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/Quantities_oM/Attributes/QuantityAttribute.json"
}

The JSON Schema is available on github here: