Interface SaplingV16

The top-level data structure for processed Sapling format version 16. Contains the Seed data plus simulation outputs and helper data.

interface SaplingV16 {
    abstract?: NumberObject;
    helpers: ContentObject;
    house: RecursiveIntersectPropertiesOfType<
        HouseV16,
        SeedObject,
        { helpers: ContentObject },
    > & { weather: ContentObject[] };
    meta: MetaV16;
    output: OutputV16;
}

Properties

abstract?: NumberObject

Optional abstract representation of key building values

helpers: ContentObject

Global helper data used throughout the simulation process

house: RecursiveIntersectPropertiesOfType<
    HouseV16,
    SeedObject,
    { helpers: ContentObject },
> & { weather: ContentObject[] }

Complete description of the physical building and its systems, enhanced with helper data

Type declaration

  • weather: ContentObject[]

    Contains weather data for the house. Will be automatically generated. Project address must be provided for this to work.

meta: MetaV16

Metadata, context information, and processing instructions

output: OutputV16

Comprehensive simulation results and analysis