×
Menu
Index

6.1.5.1 Methods Defined Here

get ( ) -> dictionary
Returns a dictionary containing the data for the internal gain.
 
EnergyGain:
 
allow_profile_saturate
(bool) True if profile saturate allowed, False otherwise
energy_source
(string) Fuel name
id
(string) ID
max_latent_gain
(float) see units_str / units_val for units
max_power_consumption
(float) see units_str / units_val for units
max_sensible_gain
(float) see units_str / units_val for units
name
(string) Gain name
pc_convective_gain
(float) Percentage convective gain, between 0 and 100
radiant_fraction
(float)  Radiant fraction
type_str
(string) Gain type: 'Machinery', 'Miscellaneous', 'Cooking', 'Computers'
type_val
(enum: EnergyGain_type) see below for valid enum values
units_str
(string) 'W/m²' or 'W'
units_val
(int) 0 = W/m², 1 = W
variation_profile
(string) profile ID
 
LightingGain:
 
allow_profile_saturate
(bool) True if profile saturate allowed, False otherwise
ballast
(float) Ballast
design_illuminance
(float) Design Illuminance
dimming_profile
(string) profile ID
diversity_factor
(float) Diversity factor
energy_source
(string) Fuel name
id
(string) ID
is_non_regulated_load
(bool) True if non-regulated load, False otherwise
maximum_illuminance
(float) Maximum Illuminance
max_power_consumption
(float) see units_str / units_val for units
max_sensible_gain
(float) see units_str / units_val for units
minimum_illuminance
(float) Minimum Illuminance
name
(string) Gain name
pc_convective_gain
(float) Percentage convective gain, between 0 and 100
radiant_fraction
(float) Radiant fraction
type_str
(string) 'Fluorescent Lighting' or 'Tungsten Lighting'
type_val
(enum: LightingGain_type) see below for valid enum values
units_str
(string) 'W/m²', 'W', 'lux'
units_val
(int) 0 = W/m², 1 = W, 2 = lux
variation_profile
(string) profile ID
 
PeopleGain:
 
allow_profile_saturate
(bool) True if profile saturate allowed, False otherwise
diversity_factor
(float) Diversity factor
id
(string) ID
max_latent_gain
(float, W) Maximum latent gain
max_sensible_gain
(float)  Maximum sensible gain
name
(string) Gain name
number_of_people
(float) only valid/present if units_str / units_val are: people
occupancy_density
(float) only valid/present if units_str / units_val are: m²/person
pc_convective_gain
(float) Percentage convective gain, between 0 and 100
type_str
(string) 'People'
type_val
(enum: PeopleGain_type) see below for valid enum values
units_str
(string) 'm²/person', 'people'
units_val
(int) 0 = m²/person, 1 = people
variation_profile
(string) profile ID
 
is_ncm() -> bool
True if ncm gain, False otherwise.
 
set(data)
Sets casual gain data with the provided dictionary. Possible values are:
 
EnergyGain:
 
allow_profile_saturate
(bool) True if profile saturate allowed, False otherwise
energy_source
(string) Fuel name
max_latent_gain
(float) see units_str / units_val for units
max_power_consumption
(float) see units_str / units_val for units
max_sensible_gain
(float) see units_str / units_val for units
name
(string) Gain name
pc_convective_gain
(float) Percentage convective gain, between 0 and 100
radiant_fraction
(float) Radiant fraction
type_val
(enum: EnergyGain_type) see below for valid enum values
units_val
(int) 0 = W/m², 1 = W
variation_profile
(string) profile ID
 
 
 
LightingGain:
 
allow_profile_saturate
(bool) True if profile saturate allowed, False otherwise
ballast
(float) Ballast
design_illuminance
(float) Design Illuminance
dimming_profile
(string) profile ID
diversity_factor
(float) Diversity factor
energy_source
(string) Fuel name
is_non_regulated_load
(bool) True if non-regulated load, False otherwise
maximum_illuminance
(float) Maximum Illuminance
max_power_consumption
(float) see units_str / units_val for units
max_sensible_gain
(float) see units_str / units_val for units
minimum_illuminance
(float) Minimum Illuminance
name
(string) Name
pc_convective_gain
(float) Percentage convective gain, between 0 and 100
radiant_fraction
(float) Radiant fraction
type_val
(enum: LightingGain_type) see below for valid enum values
units_val
(int) 0 = W/m², 1 = W, 2 = lux
variation_profile
(string) profile ID
 
 
 
PeopleGain:
 
allow_profile_saturate
(bool) True if profile saturate allowed, False otherwise
diversity_factor
(float) Diversity factor
max_latent_gain
(float, W)  Maximum latent gain
max_sensible_gain
(float) Maximum sensible gain
name
(string) Gain name
number_of_people
(float) only valid if units_val is 1
occupancy_density
(float) only valid units_val is 0
pc_convective_gain
(float) Percentage convective gain, between 0 and 100
type_val
(enum: PeopleGain_type) see below for valid enum values
units_val
(int) 0 = m²/person, 1 = people
variation_profile
(string) profile ID