Skip to content

BH.oM.Adapter.ActionConfig

Configurations specific for an Adapter Action (Push, Pull, etc). Consider that your tookit might have a more specific implementation available. Try to look for [your toolkit name]ActionConfig.

Class structure

Implemented interfaces and base types

The ActionConfig is inheriting from the following base type(s) and implements the following interfaces:

Classes inheriting from this class

The following classes are inheriting from this class:

Properties

Defining properties

The following properties are defined on the class

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

C#
public class ActionConfig : BH.oM.Base.IObject

Assembly: Adapter_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/Adapter_oM/ActionConfig.json"
}

The JSON Schema is available on github here: