Skip to content

BH.oM.Analytical.Graph.Relation

Base class for all Relation classes.

Class structure

Implemented interfaces and base types

The Relation 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
Source Guid Reference Guid to source entity. -
Target Guid Reference Guid to target entity. -
Subgraph Graph This Relation's sub Graph. -
Weight double Weight of the Relation. -
Curve ICurve Curve that represents the link between the source and target entities. -

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> - -

Derived properties

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

Name Type Description Quantity Engine
RelationArrow CompositeGeometry Returns arrow geometry used to represent a Relation. - Analytical_Engine

Code and Schema

C# implementation

C#
public class Relation : BH.oM.Base.BHoMObject, BH.oM.Base.IBHoMObject, BH.oM.Base.IObject, BH.oM.Analytical.Graph.IRelation

Assembly: Analytical_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/Analytical_oM/Graph/Relation.json"
}

The JSON Schema is available on github here: