Skip to content

BH.oM.Diffing.IPropertyDifference

Represents a difference found between a Previous and Following version of an object.

Interface structure

Implemented interfaces and base types

The IPropertyDifference 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
Name string The human-friendly name associated with this property difference. This may differ from the actual property name: see FullName. -
Description string A human-friendly description associated with this property difference. -
PastValue object The older value of this property (associated with the past version of the object). -
FollowingValue object The newer value of this property (associated with the following version of the object). -
FullName string Actual Full Name of the object's property whose value is different. -

Code and Schema

C# implementation

C#
public interface IPropertyDifference : BH.oM.Base.IObject

Assembly: Diffing_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/Diffing_oM/IPropertyDifference.json"
}

The JSON Schema is available on github here: