Skip to content

BH.oM.Adapters.Revit.Parameters.ParameterDefinition

An object representing the definition of a Revit parameter (project parameter or shared parameter as such, not its value related to certain element or type).

Class structure

Implemented interfaces and base types

The ParameterDefinition 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
ParameterGroup string Parameter group, to which the Revit parameter represented by this object belongs. One of the dropdown values for project parameters, any value for shared parameter. -
ParameterType string Parameter type of the Revit parameter represented by this object. -
Discipline string Discipline, to which the Revit parameter represented by this object belongs. Only relevant in case if there is more than one types with the same name (e.g. piping, HVAC and structural Velocity).
Six sensible values can be applied: Common, Electrical, Energy, HVAC, Piping and Structural.		 -
Instance bool If true, the Revit parameter represented by this object is an instance parameter, otherwise it is a type parameter. -
Categories List<string> Categories, to which the Revit parameter represented by this object is bound. On Push, it will get bound to all categories if this value is null. -
Shared bool If true, the Revit parameter represented by this object is a shared parameter, otherwise it is a project parameter. -

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 ParameterDefinition : BH.oM.Base.BHoMObject, BH.oM.Base.IBHoMObject, BH.oM.Base.IObject

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/ParameterDefinition.json"
}

The JSON Schema is available on github here: