Interface SanitizedEntity

Optional descriptive text.

Additional information about the entity. Used for UI display and documentation.

Due to the naming constraints, there is no guarantee that the name can be given as-is to HOT2000 export.

Embodied carbon in kg CO2e per item unit.

Environmental impact measure for manufacturing the entity. Used in environmental impact assessments.

Sub-components that make up this entity. Such as the studs in a wall.

For composite entities, contains the individual elements. Used for detailed modeling and cost breakdowns.

Energy Factor for equipment entities. From 0 to 1.

Efficiency metric for DHW equipment. Used in energy consumption calculations.

General efficiency value (percentage).

Performance metric for mechanical systems. Used in energy consumption calculations.

Fuel type used by equipment entities.

Energy source for mechanical systems. Used to determine energy type, costs, and emissions.

A property in many foundation entities to help determine its insulation configuration. Often, multiple entities need to have their h2k_coverage set to show a configuration.

In F280 these correspond to insulation configurations that go in the BaseSimp model. In EnerGuide they map to insulation configurations that are available in foundation floor/wall construction.

The acceptable values for h2k_coverage depend on which entity is accepting them.

Slab-on-grade and crawl spaces

entity or slab_entity:

• none: No insulation under or above slab
• littleUnder: 0.6m (2ft) of insulation under the edges of the slab
• moreUnder: 0.85m to 1m (2.8ft to 3.3ft) insulation under the edges of the slab
• fullUnder: Full converage of insulation under the slab
• littleAbove: 0.6m (2ft) of insulation over the edges of the slab
• fullAbove: 1m (3.3ft) of insulation over the edges of the slab

feature_entity:

• none: No insulation skirt
• horiz: 0.6m (2ft) horizontal skirt extending from the edge of the slab under soil.
• vert: 0.6m (2ft) vertical skirt extending from the edge of the slab under soil.
• rim: Insulation only covering the rim of the slab without a skirt.
• footing: Insulation under the footing.

Basements

slab_entity:

• none: No insulation under or above slab
• littleUnder: 0.6m (2ft) of insulation under the edges of the slab
• fullUnder: Full converage of insulation under the slab
• littleAbove: 0.6m (2ft) of insulation over the edges of the slab
• fullAbove: 1m (3.3ft) of insulation over the edges of the slab

inside_entity:

• none: No insulation interior of the basement wall.
• little: 0.6m (2ft) of insulation from the ceiling on the interior side of the foundation wall
• mostly: Interior side of the foundation wall covered in insulation except for a 0.2m gap where the wall meets the slab.
• full: Interior side of the foundation wall covered in insulation

outside_entity:

• none: No insulation interior of the basement wall.
• mostly: Exterior surface of the foundation wall is covered in insulatin from the top to 0.6m (2ft) below grade
• underSoil: Exterior surface of the foundation wall is covered in insulation anywhere that it is below grade (no insulation where it is above grade)
• full: Exterior side of the foundation wall covered in insulation

Example

When Properate sees a basement that has:

• slab_entity.h2k_coverage = "fullAbove"
• inside_entity.h2k_coverage = "full"
• outside_entity.h2k_coverage = "mostly"

it selects the insulation configuration of "BCCA_7" for F280 and EnerGuide. This can be verified in the HOT2000 export.

Insulation R-value in metric units (m²·K/W).

For Entities such as a slab, the insulation r_value can be defined separately.

Labour cost in dollars per item unit.

Cost of installation labour for this entity. Used in construction/renovation cost calculations.

Geographic information about availability.

Indicates where this entity is applicable or available. Used for region-specific filtering.

Material cost in dollars per item unit.

Cost of materials for this entity. Used in construction/renovation cost calculations.

If you are making your own Entities, set this to false otherwise, for any Entities coming from the Properate's database, it is always advisable to set this to true. In Seeds that were generated a long time ago, remaking can change some of their properties with updates to details such as costs.

Display name of the entity.

Used for identification in the UI and the material database. This may not be human readable. Refer to "caption" and "nick" for that purpose.

Usually it is the "breed" of the entity and the "id" concatenated snake case.

R-value. Note that it is in METRIC units (m²·K/W).

Thermal resistance for opaque assemblies or fenestration. Used in heat loss calculations and for code compliance.

Solar Heat Gain Coefficient.

Fraction of solar radiation transmitted through fenestration. Used in solar gain calculations for windows and skylights.

Classification identifier for the entity.

Categorizes the entity for filtering and organization. Used in UI presentation and entity selection logic.

The origin of the Entity, this is a legacy value from StepWin and helps update older Entities but it is advisable to always define it. If you are making your own, use "generated".