Notes on Reading APS files
The ResultsReader API has many references to variables and variable levels. This section will explain Variables and their details a bit further.
Variables have 2 names:
- An internal name which is used in the APS file. Pass this name to the various reading APIs that are part of the ResultsReader class
- A display name, which is shown in Vista / VistaPro. Attempting to read this from an APS will normally result in an error; there are certain exceptions to this however – see get_room_results() for more details.
The variable level (also known as model level flag) is represented by a single character as shown in the table below, together with the corresponding API for reading the data.
Surface level results are available only for those rooms that have detailed output switched on for a surface-level result (Apache Simulation output options: Surface temperatures, External / internal incident solar flux)
Opening level results are available only if Macroflo was included in simulation.
For more information on reading APS data, and information on how to map a Vista / VistaPro display string to a variable, see the sample on reading APS data.
|
Valid Model Level flags (character)
|
API for reading data at this level
|
|
w = weather
|
get_weather_results
|
|
z = room level (zone)
|
get_room_results
|
|
v = apache systems misc
|
get_apache_system_results
|
|
j = apache systems energy
|
get_apache_system_results
|
|
r = apache systems carbon
|
get_apache_system_results
|
|
l = building loads
|
get_results
|
|
e = building energy
|
get_results
|
|
c = building carbon
|
get_results
|
|
s = surface level
|
get_surface_results
|
|
o = opening level
|
get_opening_results
|
|
n = HVAC node level
|
get_hvac_node_results
|
|
h = HVAC component level
|
get_hvac_component_results
|