BH.oM.Adapters.Revit.Parameters.RevitIdentifiers¶
An entity containing identifiers of Revit element correspondent to the BHoM object that carries it.
Class structure¶
Implemented interfaces and base types¶
The RevitIdentifiers is inheriting from the following base type(s) and implements the following interfaces:
- BH.oM.Base.IPersistentAdapterId
- BH.oM.Base.IFragment
- BH.oM.Base.IObject
- BH.oM.Base.IImmutable
Properties¶
Defining properties¶
The following properties are defined on the class
Name | Type | Description | Quantity |
---|---|---|---|
PersistentId | object | The PersistentId property stores the UniqueId of the Revit element correspondent to the BHoM object that owns this fragment. The PersistentId can be used for Diffing purposes. | - |
ElementId | int | ElementId of the Revit element correspondent to the BHoM object that carries this fragment. | - |
CategoryName | string | Category of the Revit element correspondent to the BHoM object that carries this fragment. | - |
FamilyName | string | Family of the Revit element correspondent to the BHoM object that carries this fragment. | - |
FamilyTypeName | string | Family type of the Revit element correspondent to the BHoM object that carries this fragment. | - |
FamilyTypeId | int | ElementId of family type of the Revit element correspondent to the BHoM object that carries this fragment. | - |
Workset | string | Name of the parent workset of the Revit element correspondent to the BHoM object that carries this fragment. Empty if the Revit model is not shared. | - |
OwnerViewId | int | ElementId of view that owns the Revit element correspondent to the BHoM object that carries this fragment. -1 if the Revit element is not view-dependent. | - |
ParentElementId | int | ElementId of the parent element of the Revit element correspondent to the BHoM object that carries this fragment. -1 if the Revit element is not a nested element. | - |
LinkDocument | string | Name of the link document containing the Revit element correspondent to the BHoM object that carries this fragment. Empty if the Revit element is not a link element. | - |
Code and Schema¶
C# implementation¶
C#
public class RevitIdentifiers : BH.oM.Base.IPersistentAdapterId, BH.oM.Base.IFragment, BH.oM.Base.IObject, BH.oM.Base.IImmutable
Assembly: Revit_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/Revit_oM/Parameters/RevitIdentifiers.json"
}
The JSON Schema is available on github here: