BH.oM.Adapters.Revit.RevitPushConfig¶
Configuration used for adapter interaction with Revit on Push action.
Class structure¶
Implemented interfaces and base types¶
The RevitPushConfig is inheriting from the following base type(s) and implements the following interfaces:
- BH.oM.Adapter.ActionConfig
- BH.oM.Base.IObject
Properties¶
Defining properties¶
The following properties are defined on the class
Name | Type | Description | Quantity |
---|---|---|---|
SuppressFailureMessages | bool | If true, Revit warnings and failure messages will be suppressed (not shown to the user). Whilst this option may speed the pushing process up in case of multiple warnings, it may lead to important issues. | - |
IncludeClosedWorksets | bool | Elements from closed worksets will be processed if true. | - |
SetLocationOnUpdate | bool | If false, only parameters of a Revit element will be updated. | - |
Inherited properties¶
The following properties are inherited from the base class of the object
Name | Type | Description | Quantity |
---|---|---|---|
WrapNonBHoMObjects | bool | If true, the Push action wraps any non-BHoM type into a BH.oM.Adapter.ObjectWrapper, allowing them to make use of the full Adapter workflow. | - |
AllowHashForComparing | bool | If true and if no specific EqualityComparer is found for the type, Diffing hashes are computed and used to compare the objects. | - |
DiffingConfig | DiffingConfig | Configurations for the Diffing hashing. Requires AllowHashForComparing to be set to true. |
- |
Code and Schema¶
C# implementation¶
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/RevitPushConfig.json"
}
The JSON Schema is available on github here: