BH.oM.Adapters.OpenStreetMap.Relation¶
A relation is a group of elements (Members) used to model logical (and usually local) or geographic relationships between objects.
Class structure¶
Implemented interfaces and base types¶
The Relation is inheriting from the following base type(s) and implements the following interfaces:
- BH.oM.Base.BHoMObject
- BH.oM.Base.IBHoMObject
- BH.oM.Base.IObject
- BH.oM.Adapters.OpenStreetMap.IOpenStreetMapElement
Properties¶
Defining properties¶
The following properties are defined on the class
Name | Type | Description | Quantity |
---|---|---|---|
OsmID | long | The unique OpenStreetMap id for the Relation. | - |
KeyValues | Dictionary<string, string> | The KeyValue tags describing the geographic attributes of this Relation. | - |
Members | List<IOpenStreetMapElement> | The IOpenStreetMapElement that define this Relation. | - |
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 Relation : BH.oM.Base.BHoMObject, BH.oM.Base.IBHoMObject, BH.oM.Base.IObject, BH.oM.Adapters.OpenStreetMap.IOpenStreetMapElement
Assembly: OpenStreetMap_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/OpenStreetMap_oM/Relation.json"
}
The JSON Schema is available on github here: