×
Menu
Index

6.1.7.7.1.1 Methods Defined Here

 
get_cooling_design_load(layer number) -> float
Gets the cooling design load
 
get_cooling_design_load_per_area(layer number) -> float
Gets the cooling design load per area
 
get_cooling_design_load_per_area_inversed(layer number) -> float
Gets the cooling design load per area inversed
 
get_cooling_max_primary_airflow(layer number) -> float
Gets the cooling maximum primary airflow
 
get_heating_design_load(layer number) -> float
Gets the heating design load
 
get_heating_design_load_per_area(layer number) -> float
Gets the heating design load per area
 
get_heating_design_load_per_area_inversed(layer number) -> float
Gets the heating design load per area inversed
 
get_heating_max_primary_airflow(layer number) -> float
Gets the heating maximum primary airflow
 
get_node_data() -> dict
Gets a dictionary of node data. layer_number is required for single zone systems,
not provide one will produce an error. For sinlge zone systems this arg will be ignored.
Possible dictionary keys are:
 
multiplex_inner_supply_node
(list) Multiplex inner supply node list
multiplex_outer_supply_node
(list) Multiplex outer supply node list
multiplex_return_node
(list) Multiplex return node list
ptu_inlet_node
(int) PTU inlet node
return_node
(int) Return node
 
get_oa_percentage_of_max_cooling_primary_sa(layer number) -> float
Gets the outdoor airflow of maximum cooling primary supply air percentage
 
get_oa_percentage_of_max_heating_primary_sa(layer number) -> float
Gets the outdoor airflow of maximum heating primary supply air percentage
 
get_peak_data(layer number) -> dict
Gets a dictionary of peak data. Possible dictionary keys are:
 
room_peak_device_type_cooling
(int) Room peak device cooling
room_peak_device_type_heating
(int) Room peak device heating
room_peak_devices_cooling
(list) List of room peak device cooling values
room_peak_devices_heating
(list) List of room peak device heating values
system_peak_device_type_cooling
(int) System peak device cooling
system_peak_device_type_heating
(int) System peak device heating
system_peak_devices_cooling
(list) List of peak devices cooling
system_peak_devices_heating
(list) List of peak devices heating
zone_peak_device_type_cooling
(int) Zone peak device cooling
zone_peak_device_type_heating
(int) Zone peak device heating
zone_peak_devices_cooling
(list) List of zone peak devices cooling values
zone_peak_devices_heating
(list) List of zone peak devices heating values
 
get_room_cooling_peak_month(layer number) -> string
Gets the room cooling peak month
 
get_room_cooling_peak_time(layer number) -> string
Gets the room cooling peak time
 
get_room_heating_peak_month(layer number) -> string
Gets the room heating peak month
 
get_room_heating_peak_time(layer number) -> string
Gets the room heating peak time
 
get_room_id_for_umlh(layer number) -> string
Gets the ID of the assigned space for the specified multiplex layer. If this ID is an HVAC zone, it will instead return the master room ID.
 
get_room_occupancy_data () -> dict
Gets the room occupancy for each room assocuated with prototype system. Room ID used as key for dict
 
get_room_or_zone (layer number : int) -> Optional[HVACRoom | HVACZone]
Gets the assigned principle HVAC Zone or Room component for the prototype system if Zones or rooms is used.
 
get_space_id(layer number) -> string
Gets the ID of the assigned space for the specified multiplex layer. This is the ID of the assigned HVAC zone if the prototype system uses HVAC zones, or the room ID if the prototype system uses rooms.
 
get_space_ids(layer number) -> list
Gets a list of IDs for the assigned space for the specified multiplex layer. This is the IDs of the zoned rooms if the prototype system uses HVAC zones, or a single room ID if the prototype system uses rooms.
 
get_system_configuration_option () -> SystemConfigurationOptions (enum)
 
get_system_parameters() -> SystemParameters
Gets the system parameters for this system