BH.oM.Environment.SAP.XML.SAPReport¶
Class structure¶
Implemented interfaces and base types¶
The SAPReport is inheriting from the following base type(s) and implements the following interfaces:
- BH.oM.Base.BHoMObject
- BH.oM.Base.IBHoMObject
- BH.oM.Base.IObject
Properties¶
Defining properties¶
The following properties are defined on the class
| Name | Type | Description | Quantity |
|---|---|---|---|
| SchemaVersionOriginal | string | The schema version that the data conformed to when it was lodged. | - |
| SchemaVersionCurrent | string | The schema version that the data conformed to when it was lodged. | - |
| SAPVersion | string | SAP version that was used for the calculation. | - |
| SAPDataVersion | string | Version of SAP that was used to define the input data for the calculation. | - |
| PCDFRevisionNumber | string | Revision Number of the PCDF file used for the calculations. | - |
| CalculationSoftwareName | string | Name of the software used to perform the SAP calculation. | - |
| CalculationSoftwareVersion | string | Version of the software used to perform the SAP calculation. | - |
| UserInterfaceName | string | . | - |
| UserInterfaceVersion | string | . | - |
| ReportHeader | ReportHeader | . | - |
| EnergyAssessment | EnergyAssessment | . | - |
| SAP10Data | SAP10Data | . | - |
| InsuranceDetails | InsuranceDetails | Details of the Professional Indemnity Insurance policy used to provide cover against a compensation claim against any particular Home Condition Report. | - |
| ExternalDefinitionsRevisionNumber | string | A number indicating the version of related ExternalDefinitions. | - |
Inherited properties¶
The following properties are inherited from the base class of the object
| Name | Type | Description | Quantity |
|---|---|---|---|
| BHoM_Guid | Guid | - | - |
| Name | string | - | - |
| Fragments | FragmentSet | - | - |
| Tags | HashSet<string> | - | - |
| CustomData | Dictionary<string, object> | - | - |
Code and Schema¶
C# implementation¶
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/XML/SAPReport.json"
}
The JSON Schema is available on github here: