Skip to content

BH.oM.Base.NamedSignificantFigures

Significant digits used for specific numerical objects or properties with a specific name.When computing Hash or the property Diffing, if the analysed object or property name is found in this collection, the corresponding SignificantFigures approximation is applied.

Class structure

Implemented interfaces and base types

The NamedSignificantFigures 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
Name string When computing Hash or the property Diffing, if the analysed object name or property name is found in this collection, the corresponding SignificantFigures approximation is applied.
Supports * wildcard in the property name matching. Examples:
- BH.oM.Geometry.Vector: applies the corresponding tolerance to all numerical properties of Vectors, i.e. X, Y, Z;
- BH.oM.Structure.Elements.*.Position: applies the corresponding tolerance to all numerical properties of properties named Position under any Structural Element,
e.g. Bar.Position.X, Bar.Position.Y, Bar.Position.Z. and at the same time also Node.Position.X, Node.Position.Y, Node.Position.Z.		 -
SignificantFigures int Significant figures to be taken for this property. -

Code and Schema

C# implementation

C#
public class NamedSignificantFigures : BH.oM.Base.IObject

Assembly: BHoM.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/BHoM/NamedSignificantFigures.json"
}

The JSON Schema is available on github here: