Energos: Use Record Formats to define energy analysis data
.VectorScript|VectorScript ..VS:Function Reference|Function Reference ..VS:Function_Reference_Appendix|Appendix
Records can be attached to any object to define energy analysis data to be used. Depending on the record the object is identified and used as the corresponding energy analysis element.
Note that these records/formats don't define the full set of properties. They are designed for simplicity to allow any Vectorworks object to be setup to participate in the energy analysis.
if you are integrating custom parametric objects with the energy analysis feature see:
Here is the definition of the formats that are recognized by the feature (all noted units are units defined by the energy analysis units settings):
Formats
Note: that all the format names and fields are localized. This means that in localized versions of Vectorworks, they will be in the corresponding language. Note the information of how to read the resource containing the localized strings, or look at the scripts below.
Wall
Attach a record of this format to define the energy properties of a wall
Format name: Energos Wall
- .vwstring key: 'EnergyAnalysis/Strings/FormatDef_W.vwallstrings', 'FormatName'
Field name | Unit | Description | .vwstring key |
---|---|---|---|
Sort Index | Integer | Index used to order the elements | FieldInt_SortIndex |
Name | Text | Name of wall | FieldText_Name |
Area | Number | Area value in document units | FieldDim_Area |
UValue | Number | U - value in document units | FieldReal_UValue |
Orientation | Integer | Orientation values:
|
FieldInt_Orientation |
Inclination | Integer | Orientation inclination degrees:
|
FieldInt_OrientInclination |
Reduction Factor Shading | Number | The shading reduction factor indicates how much solar radiation is blocked by shading objects | FieldReal_ReductionFactorShading |
Wall Type | Integer |
|
FieldInt_WallType |
Note: strings are localizable via 'FormatDef_Wall.vwstrings' of the EnergyAnalysis.vwr
Thermal Bridge
Attach a record of this format to define the energy properties of a thermal-bridge
Format name: Energos Thermal Bridge
- .vwstring key: 'EnergyAnalysis/Strings/FormatDef_ThermalBridge.vwstrings', 'FormatName'
Field name | Unit | Description | .vwstring key |
---|---|---|---|
Sort Index | Integer | Index used to order the elements | FieldInt_SortIndex |
Name | Text | Name of thermal bridge | FieldText_Name |
Quantity | Integer | Number of thermal bridges | FieldLong_Quantity |
Location | Integer | Location values:
|
FieldLong_Location |
Length | Number | thermal bridge length in document units | FieldDim_Length |
PSI | Number | Measure of linear thermal heat transmittance usually at a junction in a dwelling | FieldReal_PSI |
Note: strings are localizable via 'FormatDef_ThermalBridge.vwstrings' of the EnergyAnalysis.vwr
Window
Attach a record of this format to define the energy properties of a window
Format name: Energos Window
- .vwstring key: 'EnergyAnalysis/Strings/FormatDef_WinDoor.vwstrings', 'FormatNameWindow'
Field name | Unit | Description | .vwstring key |
---|---|---|---|
Sort Index | Integer | Index used to order the elements | FieldInt_SortIndex |
Name | Text | Name of window | FieldText_Name |
Area | Number | Area value in document units(This is area of whole window) | FieldDim_Area |
UValue | Number | U - value in document units | FieldReal_UValue |
Orientation | Integer | Orientation values:
|
FieldInt_Orientation |
Inclination | Integer | Orientation inclination degrees:
|
FieldInt_OrientInclination |
Width | Number | Width in document units(This is width of whole window) | FieldDim_Width |
Glazing Area | Number | Glazing area in document units | FieldDim_GlazingArea |
Glazing Length | Number | Glazing length in document units(This is glazing perimeter) | FieldDim_GlazingLength |
Frame Length | Number | Frame length in document units(This is installation length) | FieldDim_FrameLength |
Light Transmission Glazing | Number | This is visible transmittance. Transmittance refers to the percentage of radiation that can pass through glazing.Transmission of visible light determines the effectiveness of a type of glass in providing daylight and a clear view through the window. | FieldReal_LightTrasmGlazing |
General Shading | Number | Shading values:
|
FieldReal_ShadingGeneral |
Surrounding Shading | Number | Same values as general shading | FieldReal_ShadingSurrounding |
Summer Shading | Number | Same values as general shading | FieldReal_ShadingSummer |
Additional Shading | Number | Same values as general shading | FieldReal_ShadingAdditional |
Note: strings are localizable via 'FormatDef_WinDoor.vwstrings' of the EnergyAnalysis.vwr
Door
Attach a record of this format to define the energy properties of a door
Format name: Energos Door
- .vwstring key: 'EnergyAnalysis/Strings/FormatDef_WinDoor.vwstrings', 'FormatNameDoor'
Field name | Unit | Description | .vwstring key |
---|---|---|---|
Sort Index | Integer | Index used to order the elements | FieldInt_SortIndex |
Name | Text | Name of door | FieldText_Name |
Area | Number | Area value in document units(This is area of whole door) | FieldDim_Area |
UValue | Number | U - value in document units | FieldReal_UValue |
Orientation | Integer | Orientation values:
|
FieldInt_Orientation |
Inclination | Integer | Orientation inclination degrees:
|
FieldInt_OrientInclination |
Width | Number | Width in document units(This is width of whole door) | FieldDim_Width |
Glazing Area | Number | Glazing area in document units | FieldDim_GlazingArea |
Glazing Length | Number | Glazing length in document units(This is glazing perimeter) | FieldDim_GlazingLength |
Frame Length | Number | Frame length in document units(This is installation length) | FieldDim_FrameLength |
Light Transmission Glazing | Number | This is visible transmittance. Transmittance refers to the percentage of radiation that can pass through glazing. Transmission of visible light determines the effectiveness of a type of glass in providing daylight and a clear view through the door. | FieldReal_LightTrasmGlazing |
General Shading | Number | Shading values:
|
FieldReal_ShadingGeneral |
Surrounding Shading | Number | Same values as general shading | FieldReal_ShadingSurrounding |
Summer Shading | Number | Same values as general shading | FieldReal_ShadingSummer |
Additional Shading | Number | Same values as general shading | FieldReal_ShadingAdditional |
Note: strings are localizable via 'FormatDef_WinDoor.vwstrings' of the EnergyAnalysis.vwr
Space
Attach a record of this format to define the energy properties of a space
Format name: Energos Space
- .vwstring key: 'EnergyAnalysis/Strings/FormatDef_Space.vwstrings', 'FormatName'
Field name | Unit | Description | .vwstring key |
---|---|---|---|
Name | Text | Name of space | FieldText_Name |
Area | Number | Area value in document units | FieldDim_Area |
Volume | Number | Volume value in document units | FieldDim_Volume |
Orientation | Integer | Orientation values:
|
FieldInt_Orientation |
Width | Number | Width in document units | FieldDim_Width |
Depth | Number | Depth in document units | FieldDim_Depth |
Height | Number | Height in document units | FieldDim_Height |
Lintel Height | Number | Height in document units | FieldDim_LintelHeight |
Window Width | Number | Width in document units | FieldDim_WindowWidth |
Light Transmission Glazing Percent | Number | FieldReal_LightTransmissionGlazingPercent | |
Lighting Full Load Hours | Number | h/a | FieldReal_LightingFullLoadHours |
Installer Light Power | Number | Document unit for W/m2 | FieldReal_InstalledLightPower |
Lighting Control | Integer | Lighting Control Values:
|
FieldInt_LightingControl |
Motion Detector | Boolean | FieldBool_MotionDetector | |
Extract Air Room Type | Integer | Extract Air Room Type Value:
|
FieldInt_ExtractAirRoomType |
Extract Air Requirement Volume | Number | Document volume/h | FieldDim_ExtractAirRequirement |
Note: strings are localizable via 'FormatDef_Space.vwstrings' of the EnergyAnalysis.vwr
Slab
Attach a record of this format to define the energy properties of a slab
Format name: Energos Slab
- .vwstring key: 'EnergyAnalysis/Strings/FormatDef_Slab.vwstrings', 'FormatName'
Field name | Unit | Description | .vwstring key |
---|---|---|---|
Sort Index | Integer | Index used to order the elements | FieldInt_SortIndex |
Name | Text | FieldText_Name | |
Area | Number | Area value in document units | FieldDim_Area |
UValue | Number | U - value in document units | FieldReal_UValue |
Orientation | Integer | Orientation values:
|
FieldInt_Orientation |
Inclination | Integer | Orientation inclination degrees:
|
FieldInt_OrientInclination |
RS Internal | Number | FieldReal_RSInternal | |
RS External | Number | FieldReal_RSExternal | |
Exposed Perimeter To Open | Number | FieldReal_ExposedPerimToOpen |
Note: strings are localizable via 'FormatDef_Slab.vwstrings' of the EnergyAnalysis.vwr
Roof
Attach a record of this format to define the energy properties of a roof
Format name: Energos Roof
- .vwstring key: 'EnergyAnalysis/Strings/FormatDef_Roof.vwstrings', 'FormatName'
Field name | Unit | Description | .vwstring key |
---|---|---|---|
Sort Index | Integer | Index used to order the elements | FieldInt_SortIndex |
Name | Text | FieldText_Name | |
Area | Number | Area value in document units | FieldDim_Area |
UValue | Number | U - value in document units | FieldReal_UValue |
Orientation | Integer | values:
|
FieldInt_Orientation |
Inclination | Integer | Orientation inclination degrees:
|
FieldInt_OrientInclination |
Reduction Factor Shading | Number | FieldReal_ReductionFactorShading |
Note: strings are localizable via 'FormatDef_Roof.vwstrings' of the EnergyAnalysis.vwr
Example Scripts - Python Script
You can use the following scripts to create the formats:
Wall
# Energos Thermal Bridge vwr = 'EnergyAnalysis/Strings/FormatDef_Wall.vwstrings' formatName = vs.GetVWRString(vwr, 'FormatName' ) vs.NewField(formatName, vs.GetVWRString(vwr, "FieldInt_SortIndex" ), '0', 1, 0 ) #int vs.NewField(formatName, vs.GetVWRString(vwr, "FieldText_Name" ), '', 4, 0 ) #text vs.NewField(formatName, vs.GetVWRString(vwr, "FieldDim_Area" ), '0', 3, 0 ) #real vs.NewField(formatName, vs.GetVWRString(vwr, "FieldReal_UValue" ), '0', 3, 0 ) #real vs.NewField(formatName, vs.GetVWRString(vwr, "FieldInt_Orientation" ), '0', 1, 0 ) #int vs.NewField(formatName, vs.GetVWRString(vwr, "FieldInt_OrientInclination" ), '0', 1, 0 ) #int vs.NewField(formatName, vs.GetVWRString(vwr, "FieldReal_ReductionFactorShading"), '0', 3, 0 ) #real vs.NewField(formatName, vs.GetVWRString(vwr, "FieldInt_WallType" ), '0', 1, 0 ) #int
Thermal Bridge
# Energos Thermal Bridge vwr = 'EnergyAnalysis/Strings/FormatDef_ThermalBridge.vwstrings' formatName = vs.GetVWRString(vwr, 'FormatName' ) vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldInt_SortIndex'), '0', 1, 0 ) #int vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldText_Name' ), '', 4, 0 ) #text vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldLong_Quantity'), '0', 1, 0 ) #int vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldLong_Location'), '0', 1, 0 ) #int vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldDim_Length' ), '0', 3, 0 ) #real vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldReal_PSI' ), '0', 3, 0 ) #real
Window
# Energos Window vwr = 'EnergyAnalysis/Strings/FormatDef_WinDoor.vwstrings' formatName = vs.GetVWRString(vwr, 'FormatNameWindow' ) vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldInt_SortIndex' ), '0', 1, 0 ) #int vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldText_Name' ), '', 4, 0 ) #text vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldDim_Area' ), '0', 3, 0 ) #real vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldReal_UValue' ), '0', 3, 0 ) #real vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldInt_Orientation' ), '0', 1, 0 ) #int vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldInt_OrientInclination' ), '0', 1, 0 ) #int vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldDim_Width' ), '0', 3, 0 ) #real vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldDim_GlazingArea' ), '0', 3, 0 ) #real vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldDim_GlazingLength' ), '0', 3, 0 ) #real vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldDim_FrameLength' ), '0', 3, 0 ) #real vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldReal_LightTrasmGlazing' ), '0', 3, 0 ) #real vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldReal_ShadingGeneral' ), '0', 3, 0 ) #real vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldReal_ShadingSurrounding'), '0', 3, 0 ) #real vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldReal_ShadingSummer' ), '0', 3, 0 ) #real vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldReal_ShadingAdditional' ), '0', 3, 0 ) #real
Door
# Energos Door vwr = 'EnergyAnalysis/Strings/FormatDef_WinDoor.vwstrings' formatName = vs.GetVWRString(vwr, 'FormatNameDoor' ) vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldInt_SortIndex' ), '0', 1, 0 ) #int vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldText_Name' ), '', 4, 0 ) #text vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldDim_Area' ), '0', 3, 0 ) #real vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldReal_UValue' ), '0', 3, 0 ) #real vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldInt_Orientation' ), '0', 1, 0 ) #int vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldInt_OrientInclination' ), '0', 1, 0 ) #int vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldDim_Width' ), '0', 3, 0 ) #real vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldDim_GlazingArea' ), '0', 3, 0 ) #real vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldDim_GlazingLength' ), '0', 3, 0 ) #real vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldDim_FrameLength' ), '0', 3, 0 ) #real vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldReal_LightTrasmGlazing' ), '0', 3, 0 ) #real vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldReal_ShadingGeneral' ), '0', 3, 0 ) #real vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldReal_ShadingSurrounding'), '0', 3, 0 ) #real vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldReal_ShadingSummer' ), '0', 3, 0 ) #real vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldReal_ShadingAdditional' ), '0', 3, 0 ) #real
Space
# Energos Space vwr = 'EnergyAnalysis/Strings/FormatDef_Space.vwstrings' formatName = vs.GetVWRString(vwr, 'FormatName' ) vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldText_Name' ), '', 4, 0 ) #text vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldDim_Area' ), '0', 3, 0 ) #real vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldDim_Volume' ), '0', 3, 0 ) #real vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldInt_Orientation' ), '0', 1, 0 ) #int vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldDim_Width' ), '0', 3, 0 ) #real vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldDim_Depth' ), '0', 3, 0 ) #real vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldDim_Height' ), '0', 3, 0 ) #real vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldDim_LintelHeight' ), '0', 3, 0 ) #real vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldDim_WindowWidth' ), '0', 3, 0 ) #real vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldReal_LightTransmissionGlazingPercent'), '0', 3, 0 ) #real vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldReal_LightingFullLoadHours' ), '0', 3, 0 ) #real vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldReal_InstalledLightPower' ), '0', 3, 0 ) #real vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldInt_LightingControl' ), '0', 1, 0 ) #int vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldBool_MotionDetector' ), '0', 2, 0 ) #bool vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldInt_ExtractAirRoomType' ), '0', 1, 0 ) #int vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldDim_ExtractAirRequirement' ), '0', 3, 0 ) #real
Slab
# Energos Slab vwr = 'EnergyAnalysis/Strings/FormatDef_Slab.vwstrings' formatName = vs.GetVWRString(vwr, 'FormatName' ) vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldInt_SortIndex' ), '0', 1, 0 ) #real vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldText_Name' ), '', 4, 0 ) #text vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldDim_Area' ), '0', 3, 0 ) #real vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldReal_UValue' ), '0', 3, 0 ) #real vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldInt_Orientation' ), '0', 1, 0 ) #int vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldInt_OrientInclination' ), '0', 1, 0 ) #int vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldReal_RSInternal' ), '0', 3, 0 ) #real vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldReal_RSExternal' ), '0', 3, 0 ) #real vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldReal_ExposedPerimToOpen'), '0', 3, 0 ) #real
Roof
# Energos Roof vwr = 'EnergyAnalysis/Strings/FormatDef_Roof.vwstrings' formatName = vs.GetVWRString(vwr, 'FormatName' ) vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldInt_SortIndex' ), '0', 1, 0 ) #int vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldText_Name' ), '', 4, 0 ) #text vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldDim_Area' ), '0', 3, 0 ) #real vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldReal_UValue' ), '0', 3, 0 ) #real vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldInt_Orientation' ), '0', 1, 0 ) #int vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldInt_OrientInclination' ), '0', 1, 0 ) #int vs.NewField(formatName, vs.GetVWRString(vwr, 'FieldReal_ReductionFactorShading'), '0', 3, 0 ) #real