pyidf.exterior_equipment module

Data objects in group “Exterior Equipment”

class pyidf.exterior_equipment.ExteriorFuelEquipment

Bases: pyidf.helper.DataObject

Corresponds to IDD object Exterior:FuelEquipment only used for Meter type reporting, does not affect building loads

design_level

field Design Level

Units: W
IP-Units: W
Parameters:value (float) – value for IDD Field Design Level
Raises:ValueError – if value is not a valid value
Returns:the value of design_level or None if not set
Return type:float
enduse_subcategory

field End-Use Subcategory

Default value: General
Parameters:value (str) – value for IDD Field End-Use Subcategory
Raises:ValueError – if value is not a valid value
Returns:the value of enduse_subcategory or None if not set
Return type:str
fuel_use_type

field Fuel Use Type

Parameters:value (str) – value for IDD Field Fuel Use Type
Raises:ValueError – if value is not a valid value
Returns:the value of fuel_use_type or None if not set
Return type:str
name

field Name

Parameters:value (str) – value for IDD Field Name
Raises:ValueError – if value is not a valid value
Returns:the value of name or None if not set
Return type:str
schedule_name

field Schedule Name

units in schedule should be fraction applied to capacity of the exterior fuel equipment, generally (0.0 - 1.0)
Parameters:value (str) – value for IDD Field Schedule Name
Raises:ValueError – if value is not a valid value
Returns:the value of schedule_name or None if not set
Return type:str
class pyidf.exterior_equipment.ExteriorLights

Bases: pyidf.helper.DataObject

Corresponds to IDD object Exterior:Lights only used for Meter type reporting, does not affect building loads

control_option

field Control Option

Astronomical Clock option overrides schedule to turn lights off when sun is up
Parameters:value (str) – value for IDD Field Control Option
Raises:ValueError – if value is not a valid value
Returns:the value of control_option or None if not set
Return type:str
design_level

field Design Level

Units: W
IP-Units: W
Parameters:value (float) – value for IDD Field Design Level
Raises:ValueError – if value is not a valid value
Returns:the value of design_level or None if not set
Return type:float
enduse_subcategory

field End-Use Subcategory

Default value: General
Parameters:value (str) – value for IDD Field End-Use Subcategory
Raises:ValueError – if value is not a valid value
Returns:the value of enduse_subcategory or None if not set
Return type:str
name

field Name

Parameters:value (str) – value for IDD Field Name
Raises:ValueError – if value is not a valid value
Returns:the value of name or None if not set
Return type:str
schedule_name

field Schedule Name

units in schedule should be fraction applied to capacity of the exterior lights equipment, generally (0.0 - 1.0)
Parameters:value (str) – value for IDD Field Schedule Name
Raises:ValueError – if value is not a valid value
Returns:the value of schedule_name or None if not set
Return type:str
class pyidf.exterior_equipment.ExteriorWaterEquipment

Bases: pyidf.helper.DataObject

Corresponds to IDD object Exterior:WaterEquipment only used for Meter type reporting, does not affect building loads

design_level

field Design Level

Units: m3/s
Parameters:value (float) – value for IDD Field Design Level
Raises:ValueError – if value is not a valid value
Returns:the value of design_level or None if not set
Return type:float
enduse_subcategory

field End-Use Subcategory

Default value: General
Parameters:value (str) – value for IDD Field End-Use Subcategory
Raises:ValueError – if value is not a valid value
Returns:the value of enduse_subcategory or None if not set
Return type:str
fuel_use_type

field Fuel Use Type

Default value: Water
Parameters:value (str) – value for IDD Field Fuel Use Type
Raises:ValueError – if value is not a valid value
Returns:the value of fuel_use_type or None if not set
Return type:str
name

field Name

Parameters:value (str) – value for IDD Field Name
Raises:ValueError – if value is not a valid value
Returns:the value of name or None if not set
Return type:str
schedule_name

field Schedule Name

units in Schedule should be fraction applied to capacity of the exterior water equipment, generally (0.0 - 1.0)
Parameters:value (str) – value for IDD Field Schedule Name
Raises:ValueError – if value is not a valid value
Returns:the value of schedule_name or None if not set
Return type:str