Skip to content

BH.oM.Diffing.Revision

Class structure

Implemented interfaces and base types

The Revision 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
StreamID Guid ID of the Stream that owns this Revision. -
RevisionID Guid Unique GUID of this Revision. -
RevisionName string Name assigned to this Revision. It may be descriptive of the changes included in this Revision, e.g. AddedBasementColumns. -
Timestamp long In UTC.Now ticks. Automatically defined when creating a new Revision. -
Author string Author of the Stream Revision. Automatically calculated as it should be univocally defined. -
Comment string Any comment to be added on this this Revision. -
Objects IEnumerable<object> Objects to be included in this Revision. -
RevisionDiffConfing DiffingConfig Diffing settings for this Revision. Hashes of objects contained in this stream will be computed based on these configs. -

Inherited properties

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

Name Type Description Quantity
BHoM_Guid Guid - -
Name string - -
Fragments FragmentSet - -
Tags HashSet<string> - -
CustomData Dictionary<string, object> - -

Code and Schema

C# implementation

C#
public class Revision : BH.oM.Base.BHoMObject, BH.oM.Base.IBHoMObject, BH.oM.Base.IObject, BH.oM.Base.IImmutable

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

The JSON Schema is available on github here: