BH.oM.Adapters.SAP2000.SAP2000PushConfig¶
This Config can be specified in the ActionConfig
input of any Adapter Action (e.g. Push).
Class structure¶
Implemented interfaces and base types¶
The SAP2000PushConfig 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 |
---|---|---|---|
ReplaceLoads | bool | Sets whether the loads being pushed should overwrite existing loads on the same object within the same loadcase | - |
UpdateOnlyBarPropAssigns | bool | If true, only Bar property assignments will be updated, ignoring changes to property definitions, geometry or other Bar assigns such as offsets, releases, etc. Non-existing objects will still be pushed. | - |
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: SAP2000_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/SAP2000_oM/SAP2000PushConfig.json"
}
The JSON Schema is available on github here: