Skip to content

BH.oM.Environment.SAP.SAPMarkUpPullConfig

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 SAPMarkUpPullConfig 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
SAPMarkupFile FileSettings Set the location of the Bluebeam SAP XML markup file. -
ExcelFile FileSettings Set the location of the Excel schedules definitions file. -
BluebeamConfig BluebeamConfig Set the Bluebeam configuration options to define how information should be pulled from the Bluebeam SAP XML markups. -
HeatingFileDirectory string Set the directory where heating file template XMLs can be found. -
FloorDefinitionsRequest CellContentsRequest Provide the location within the Excel schedules definitions files for pulling Floor Schedule information. -
RoofDefinitionsRequest CellContentsRequest Provide the location within the Excel schedules definitions files for pulling Roof Schedule information. -
WallDefinitionsRequest CellContentsRequest Provide the location within the Excel schedules definitions files for pulling Wall Schedule information. -
PsiValuesRequest CellContentsRequest Provide the location within the Excel schedules definitions files for pulling PSI Value information. -
OpeningDefinitionsRequest CellContentsRequest Provide the location within the Excel schedules definitions files for pulling Opening Schedule information. -
OpeningPsiValuesRequest CellContentsRequest Provide the location within the Excel schedules definitions files for pulling Opening PSI Value information. -
DwellingSchedulesRequest CellContentsRequest Provide the location within the Excel schedules definitions files for pulling Dwelling Schedule information. -

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 SAPMarkUpPullConfig : BH.oM.Adapter.ActionConfig, BH.oM.Base.IObject, BH.oM.Environment.SAP.ISAPPullConfig

Assembly: SAP_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/SAP_oM/SAP/SAPMarkUpPullConfig.json"
}

The JSON Schema is available on github here: