BH.oM.Environment.IES.PushConfigIES¶
Create a push config for IES for use with the IES Adapter.
Class structure¶
Implemented interfaces and base types¶
The PushConfigIES is inheriting from the following base type(s) and implements the following interfaces:
- BH.oM.Adapter.ActionConfig
- BH.oM.Base.IObject
- BH.oM.Environment.IES.IIESConfig
Properties¶
Defining properties¶
The following properties are defined on the class
| Name | Type | Description | Quantity |
|---|---|---|---|
| ShadesAs3D | bool | Determine whether or not shades should be pushed as 3D spaces or not. | - |
| PlanarTolerance | double | Set tolarance for planar surfaces, default is set to BH.oM.Geometry.Tolerance.Distance. | - |
| DecimalPlaces | int | Set how many decimal places coordinates should have on export, default is set to 6. | - |
| AngleTolerance | double | Set the tolerance to be used in angle calculations or wherever a Geometry method requires an Angle Tolerance to determine a zero number. | - |
| DistanceTolerance | double | Set the tolerance to be used in distance calculations or wherever a Geometry method requires an Distance Tolerance to determine a zero number. | - |
| File | FileSettings | Set the file location to push IES data to. | - |
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¶
C#
public class PushConfigIES : BH.oM.Adapter.ActionConfig, BH.oM.Base.IObject, BH.oM.Environment.IES.IIESConfig
Assembly: IES_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/IES_oM/IES/PushConfigIES.json"
}
The JSON Schema is available on github here: