Skip to content

BH.oM.Environment.SAP.ProcessResultsCommand

Class structure

Implemented interfaces and base types

The ProcessResultsCommand 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
ResultFiles List<FileSettings> Paths to the XML results files that will be calculated. -
SaveFileDirectory string Directory to save the results file(s) to. -
DwellingSchedules List<DwellingSchedule> List of dwelling schedules containing information about each individual dwelling in the report. -
TargetDERTERImprovement double Provide the target DER/TER improvement as a % between 0 and 100. -
TargetDPERTPERImprovement double Provide the target DPER/TPER improvement as a % between 0 and 100. -
TargetDFEETFEEImprovement double Provide the target DFEE/TFEE improvement as a % between 0 and 100. -

Code and Schema

C# implementation

C#
public class ProcessResultsCommand : BH.oM.Adapter.IExecuteCommand, BH.oM.Base.IObject

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/ProcessResultsCommand.json"
}

The JSON Schema is available on github here: