pyidf.plant module¶

Data objects in group “Plant”

class pyidf.plant.CondenserEquipmentList¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object CondenserEquipmentList List condenser equipment in order of operating priority, 1st in list will be used 1st, etc Use only condenser equipment in this list. If no equipment object types and equipment names are specified, then the corresponding PlantEquipmentOperation:* object will assume all available condenser equipment for the loop should be OFF (not operate) within the specified lower/upper limit.

equipment_10_name¶

field Equipment 10 Name

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

equipment_10_object_type¶

field Equipment 10 Object Type

Parameters:	value (str) – value for IDD Field Equipment 10 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of equipment_10_object_type or None if not set
Return type:	str

equipment_1_name¶

field Equipment 1 Name

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

equipment_1_object_type¶

field Equipment 1 Object Type

Parameters:	value (str) – value for IDD Field Equipment 1 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of equipment_1_object_type or None if not set
Return type:	str

equipment_2_name¶

field Equipment 2 Name

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

equipment_2_object_type¶

field Equipment 2 Object Type

Parameters:	value (str) – value for IDD Field Equipment 2 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of equipment_2_object_type or None if not set
Return type:	str

equipment_3_name¶

field Equipment 3 Name

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

equipment_3_object_type¶

field Equipment 3 Object Type

Parameters:	value (str) – value for IDD Field Equipment 3 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of equipment_3_object_type or None if not set
Return type:	str

equipment_4_name¶

field Equipment 4 Name

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

equipment_4_object_type¶

field Equipment 4 Object Type

Parameters:	value (str) – value for IDD Field Equipment 4 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of equipment_4_object_type or None if not set
Return type:	str

equipment_5_name¶

field Equipment 5 Name

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

equipment_5_object_type¶

field Equipment 5 Object Type

Parameters:	value (str) – value for IDD Field Equipment 5 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of equipment_5_object_type or None if not set
Return type:	str

equipment_6_name¶

field Equipment 6 Name

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

equipment_6_object_type¶

field Equipment 6 Object Type

Parameters:	value (str) – value for IDD Field Equipment 6 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of equipment_6_object_type or None if not set
Return type:	str

equipment_7_name¶

field Equipment 7 Name

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

equipment_7_object_type¶

field Equipment 7 Object Type

Parameters:	value (str) – value for IDD Field Equipment 7 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of equipment_7_object_type or None if not set
Return type:	str

equipment_8_name¶

field Equipment 8 Name

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

equipment_8_object_type¶

field Equipment 8 Object Type

Parameters:	value (str) – value for IDD Field Equipment 8 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of equipment_8_object_type or None if not set
Return type:	str

equipment_9_name¶

field Equipment 9 Name

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

equipment_9_object_type¶

field Equipment 9 Object Type

Parameters:	value (str) – value for IDD Field Equipment 9 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of equipment_9_object_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

class pyidf.plant.CondenserEquipmentOperationSchemes¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object CondenserEquipmentOperationSchemes Operation schemes are listed in “priority” order. Note that each scheme must address the entire load and/or condition ranges for the simulation. The actual one selected for use will be the first that is “Scheduled” on. That is, if control scheme 1 is not “on” and control scheme 2 is – then control scheme 2 is selected. Only condenser equipment should be listed on a Control Scheme for this item.

control_scheme_1_name¶

field Control Scheme 1 Name

Parameters:	value (str) – value for IDD Field Control Scheme 1 Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of control_scheme_1_name or None if not set
Return type:	str

control_scheme_1_object_type¶

field Control Scheme 1 Object Type

Parameters:	value (str) – value for IDD Field Control Scheme 1 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of control_scheme_1_object_type or None if not set
Return type:	str

control_scheme_1_schedule_name¶

field Control Scheme 1 Schedule Name

Parameters:	value (str) – value for IDD Field Control Scheme 1 Schedule Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of control_scheme_1_schedule_name or None if not set
Return type:	str

control_scheme_2_name¶

field Control Scheme 2 Name

Parameters:	value (str) – value for IDD Field Control Scheme 2 Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of control_scheme_2_name or None if not set
Return type:	str

control_scheme_2_object_type¶

field Control Scheme 2 Object Type

Parameters:	value (str) – value for IDD Field Control Scheme 2 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of control_scheme_2_object_type or None if not set
Return type:	str

control_scheme_2_schedule_name¶

field Control Scheme 2 Schedule Name

Parameters:	value (str) – value for IDD Field Control Scheme 2 Schedule Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of control_scheme_2_schedule_name or None if not set
Return type:	str

control_scheme_3_name¶

field Control Scheme 3 Name

Parameters:	value (str) – value for IDD Field Control Scheme 3 Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of control_scheme_3_name or None if not set
Return type:	str

control_scheme_3_object_type¶

field Control Scheme 3 Object Type

Parameters:	value (str) – value for IDD Field Control Scheme 3 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of control_scheme_3_object_type or None if not set
Return type:	str

control_scheme_3_schedule_name¶

field Control Scheme 3 Schedule Name

Parameters:	value (str) – value for IDD Field Control Scheme 3 Schedule Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of control_scheme_3_schedule_name or None if not set
Return type:	str

control_scheme_4_name¶

field Control Scheme 4 Name

Parameters:	value (str) – value for IDD Field Control Scheme 4 Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of control_scheme_4_name or None if not set
Return type:	str

control_scheme_4_object_type¶

field Control Scheme 4 Object Type

Parameters:	value (str) – value for IDD Field Control Scheme 4 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of control_scheme_4_object_type or None if not set
Return type:	str

control_scheme_4_schedule_name¶

field Control Scheme 4 Schedule Name

Parameters:	value (str) – value for IDD Field Control Scheme 4 Schedule Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of control_scheme_4_schedule_name or None if not set
Return type:	str

control_scheme_5_name¶

field Control Scheme 5 Name

Parameters:	value (str) – value for IDD Field Control Scheme 5 Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of control_scheme_5_name or None if not set
Return type:	str

control_scheme_5_object_type¶

field Control Scheme 5 Object Type

Parameters:	value (str) – value for IDD Field Control Scheme 5 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of control_scheme_5_object_type or None if not set
Return type:	str

control_scheme_5_schedule_name¶

field Control Scheme 5 Schedule Name

Parameters:	value (str) – value for IDD Field Control Scheme 5 Schedule Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of control_scheme_5_schedule_name or None if not set
Return type:	str

control_scheme_6_name¶

field Control Scheme 6 Name

Parameters:	value (str) – value for IDD Field Control Scheme 6 Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of control_scheme_6_name or None if not set
Return type:	str

control_scheme_6_object_type¶

field Control Scheme 6 Object Type

Parameters:	value (str) – value for IDD Field Control Scheme 6 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of control_scheme_6_object_type or None if not set
Return type:	str

control_scheme_6_schedule_name¶

field Control Scheme 6 Schedule Name

Parameters:	value (str) – value for IDD Field Control Scheme 6 Schedule Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of control_scheme_6_schedule_name or None if not set
Return type:	str

control_scheme_7_name¶

field Control Scheme 7 Name

Parameters:	value (str) – value for IDD Field Control Scheme 7 Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of control_scheme_7_name or None if not set
Return type:	str

control_scheme_7_object_type¶

field Control Scheme 7 Object Type

Parameters:	value (str) – value for IDD Field Control Scheme 7 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of control_scheme_7_object_type or None if not set
Return type:	str

control_scheme_7_schedule_name¶

field Control Scheme 7 Schedule Name

Parameters:	value (str) – value for IDD Field Control Scheme 7 Schedule Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of control_scheme_7_schedule_name or None if not set
Return type:	str

control_scheme_8_name¶

field Control Scheme 8 Name

Parameters:	value (str) – value for IDD Field Control Scheme 8 Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of control_scheme_8_name or None if not set
Return type:	str

control_scheme_8_object_type¶

field Control Scheme 8 Object Type

Parameters:	value (str) – value for IDD Field Control Scheme 8 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of control_scheme_8_object_type or None if not set
Return type:	str

control_scheme_8_schedule_name¶

field Control Scheme 8 Schedule Name

Parameters:	value (str) – value for IDD Field Control Scheme 8 Schedule Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of control_scheme_8_schedule_name 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

class pyidf.plant.CondenserLoop¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object CondenserLoop Defines a central plant condenser loop. CondenserLoop and PlantLoop are nearly identical except some components and operation schemes are applicable to only one loop type or the other.

condenser_demand_side_branch_list_name¶

field Condenser Demand Side Branch List Name

Parameters:	value (str) – value for IDD Field Condenser Demand Side Branch List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of condenser_demand_side_branch_list_name or None if not set
Return type:	str

condenser_demand_side_connector_list_name¶

field Condenser Demand Side Connector List Name

Parameters:	value (str) – value for IDD Field Condenser Demand Side Connector List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of condenser_demand_side_connector_list_name or None if not set
Return type:	str

condenser_equipment_operation_scheme_name¶

field Condenser Equipment Operation Scheme Name

Parameters:	value (str) – value for IDD Field Condenser Equipment Operation Scheme Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of condenser_equipment_operation_scheme_name or None if not set
Return type:	str

condenser_loop_temperature_setpoint_node_name¶

field Condenser Loop Temperature Setpoint Node Name

Parameters:	value (str) – value for IDD Field Condenser Loop Temperature Setpoint Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of condenser_loop_temperature_setpoint_node_name or None if not set
Return type:	str

condenser_loop_volume¶

field Condenser Loop Volume

Units: m3
IP-Units: gal
Default value: “Autocalculate”

Parameters:	value (float or “Autocalculate”) – value for IDD Field Condenser Loop Volume
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of condenser_loop_volume or None if not set
Return type:	float or “Autocalculate”

condenser_side_branch_list_name¶

field Condenser Side Branch List Name

Parameters:	value (str) – value for IDD Field Condenser Side Branch List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of condenser_side_branch_list_name or None if not set
Return type:	str

condenser_side_connector_list_name¶

field Condenser Side Connector List Name

Parameters:	value (str) – value for IDD Field Condenser Side Connector List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of condenser_side_connector_list_name or None if not set
Return type:	str

condenser_side_inlet_node_name¶

field Condenser Side Inlet Node Name

Parameters:	value (str) – value for IDD Field Condenser Side Inlet Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of condenser_side_inlet_node_name or None if not set
Return type:	str

condenser_side_outlet_node_name¶

field Condenser Side Outlet Node Name

Parameters:	value (str) – value for IDD Field Condenser Side Outlet Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of condenser_side_outlet_node_name or None if not set
Return type:	str

demand_side_inlet_node_name¶

field Demand Side Inlet Node Name

Parameters:	value (str) – value for IDD Field Demand Side Inlet Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of demand_side_inlet_node_name or None if not set
Return type:	str

demand_side_outlet_node_name¶

field Demand Side Outlet Node Name

Parameters:	value (str) – value for IDD Field Demand Side Outlet Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of demand_side_outlet_node_name or None if not set
Return type:	str

fluid_type¶

field Fluid Type

Default value: Water

Parameters:	value (str) – value for IDD Field Fluid Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of fluid_type or None if not set
Return type:	str

load_distribution_scheme¶

field Load Distribution Scheme

Default value: SequentialLoad

Parameters:	value (str) – value for IDD Field Load Distribution Scheme
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of load_distribution_scheme or None if not set
Return type:	str

maximum_loop_flow_rate¶

field Maximum Loop Flow Rate

Units: m3/s

IP-Units: gal/min

Parameters:	value (float or “Autosize”) – value for IDD Field Maximum Loop Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of maximum_loop_flow_rate or None if not set
Return type:	float or “Autosize”

maximum_loop_temperature¶

field Maximum Loop Temperature

Units: C

Parameters:	value (float) – value for IDD Field Maximum Loop Temperature
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of maximum_loop_temperature or None if not set
Return type:	float

minimum_loop_flow_rate¶

field Minimum Loop Flow Rate

Units: m3/s

IP-Units: gal/min

Parameters:	value (float) – value for IDD Field Minimum Loop Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of minimum_loop_flow_rate or None if not set
Return type:	float

minimum_loop_temperature¶

field Minimum Loop Temperature

Units: C

Parameters:	value (float) – value for IDD Field Minimum Loop Temperature
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of minimum_loop_temperature or None if not set
Return type:	float

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

pressure_simulation_type¶

field Pressure Simulation Type

Default value: None

Parameters:	value (str) – value for IDD Field Pressure Simulation Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of pressure_simulation_type or None if not set
Return type:	str

user_defined_fluid_type¶

field User Defined Fluid Type

This field is only required when Fluid Type is UserDefinedFluidType

Parameters:	value (str) – value for IDD Field User Defined Fluid Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of user_defined_fluid_type or None if not set
Return type:	str

class pyidf.plant.PlantEquipmentList¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object PlantEquipmentList List plant equipment in order of operating priority, 1st in list will be used 1st, etc Use only plant equipment in this list. If no equipment object types and equipment names are specified, then the corresponding PlantEquipmentOperation:* object will assume all available plant equipment for the loop should be OFF (not operate) within the specified lower/upper limit.

equipment_10_name¶

field Equipment 10 Name

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

equipment_10_object_type¶

field Equipment 10 Object Type

Parameters:	value (str) – value for IDD Field Equipment 10 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of equipment_10_object_type or None if not set
Return type:	str

equipment_1_name¶

field Equipment 1 Name

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

equipment_1_object_type¶

field Equipment 1 Object Type

Parameters:	value (str) – value for IDD Field Equipment 1 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of equipment_1_object_type or None if not set
Return type:	str

equipment_2_name¶

field Equipment 2 Name

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

equipment_2_object_type¶

field Equipment 2 Object Type

Parameters:	value (str) – value for IDD Field Equipment 2 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of equipment_2_object_type or None if not set
Return type:	str

equipment_3_name¶

field Equipment 3 Name

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

equipment_3_object_type¶

field Equipment 3 Object Type

Parameters:	value (str) – value for IDD Field Equipment 3 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of equipment_3_object_type or None if not set
Return type:	str

equipment_4_name¶

field Equipment 4 Name

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

equipment_4_object_type¶

field Equipment 4 Object Type

Parameters:	value (str) – value for IDD Field Equipment 4 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of equipment_4_object_type or None if not set
Return type:	str

equipment_5_name¶

field Equipment 5 Name

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

equipment_5_object_type¶

field Equipment 5 Object Type

Parameters:	value (str) – value for IDD Field Equipment 5 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of equipment_5_object_type or None if not set
Return type:	str

equipment_6_name¶

field Equipment 6 Name

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

equipment_6_object_type¶

field Equipment 6 Object Type

Parameters:	value (str) – value for IDD Field Equipment 6 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of equipment_6_object_type or None if not set
Return type:	str

equipment_7_name¶

field Equipment 7 Name

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

equipment_7_object_type¶

field Equipment 7 Object Type

Parameters:	value (str) – value for IDD Field Equipment 7 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of equipment_7_object_type or None if not set
Return type:	str

equipment_8_name¶

field Equipment 8 Name

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

equipment_8_object_type¶

field Equipment 8 Object Type

Parameters:	value (str) – value for IDD Field Equipment 8 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of equipment_8_object_type or None if not set
Return type:	str

equipment_9_name¶

field Equipment 9 Name

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

equipment_9_object_type¶

field Equipment 9 Object Type

Parameters:	value (str) – value for IDD Field Equipment 9 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of equipment_9_object_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

class pyidf.plant.PlantEquipmentOperationComponentSetpoint¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object PlantEquipmentOperation:ComponentSetpoint Plant equipment operation scheme for component setpoint operation. Specifies one or pieces of equipment which are controlled to meet the temperature setpoint at the component outlet node.

component_10_flow_rate¶

field Component 10 Flow Rate

Units: m3/s

Parameters:	value (float or “Autosize”) – value for IDD Field Component 10 Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_10_flow_rate or None if not set
Return type:	float or “Autosize”

component_1_flow_rate¶

field Component 1 Flow Rate

Units: m3/s

Parameters:	value (float or “Autosize”) – value for IDD Field Component 1 Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_1_flow_rate or None if not set
Return type:	float or “Autosize”

component_2_flow_rate¶

field Component 2 Flow Rate

Units: m3/s

Parameters:	value (float or “Autosize”) – value for IDD Field Component 2 Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_2_flow_rate or None if not set
Return type:	float or “Autosize”

component_3_flow_rate¶

field Component 3 Flow Rate

Units: m3/s

Parameters:	value (float or “Autosize”) – value for IDD Field Component 3 Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_3_flow_rate or None if not set
Return type:	float or “Autosize”

component_4_flow_rate¶

field Component 4 Flow Rate

Units: m3/s

Parameters:	value (float or “Autosize”) – value for IDD Field Component 4 Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_4_flow_rate or None if not set
Return type:	float or “Autosize”

component_5_flow_rate¶

field Component 5 Flow Rate

Units: m3/s

Parameters:	value (float or “Autosize”) – value for IDD Field Component 5 Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_5_flow_rate or None if not set
Return type:	float or “Autosize”

component_6_flow_rate¶

field Component 6 Flow Rate

Units: m3/s

Parameters:	value (float or “Autosize”) – value for IDD Field Component 6 Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_6_flow_rate or None if not set
Return type:	float or “Autosize”

component_7_flow_rate¶

field Component 7 Flow Rate

Units: m3/s

Parameters:	value (float or “Autosize”) – value for IDD Field Component 7 Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_7_flow_rate or None if not set
Return type:	float or “Autosize”

component_8_flow_rate¶

field Component 8 Flow Rate

Units: m3/s

Parameters:	value (float or “Autosize”) – value for IDD Field Component 8 Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_8_flow_rate or None if not set
Return type:	float or “Autosize”

component_9_flow_rate¶

field Component 9 Flow Rate

Units: m3/s

Parameters:	value (float or “Autosize”) – value for IDD Field Component 9 Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_9_flow_rate or None if not set
Return type:	float or “Autosize”

demand_calculation_10_node_name¶

field Demand Calculation 10 Node Name

Parameters:	value (str) – value for IDD Field Demand Calculation 10 Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of demand_calculation_10_node_name or None if not set
Return type:	str

demand_calculation_1_node_name¶

field Demand Calculation 1 Node Name

Parameters:	value (str) – value for IDD Field Demand Calculation 1 Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of demand_calculation_1_node_name or None if not set
Return type:	str

demand_calculation_2_node_name¶

field Demand Calculation 2 Node Name

Parameters:	value (str) – value for IDD Field Demand Calculation 2 Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of demand_calculation_2_node_name or None if not set
Return type:	str

demand_calculation_3_node_name¶

field Demand Calculation 3 Node Name

Parameters:	value (str) – value for IDD Field Demand Calculation 3 Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of demand_calculation_3_node_name or None if not set
Return type:	str

demand_calculation_4_node_name¶

field Demand Calculation 4 Node Name

Parameters:	value (str) – value for IDD Field Demand Calculation 4 Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of demand_calculation_4_node_name or None if not set
Return type:	str

demand_calculation_5_node_name¶

field Demand Calculation 5 Node Name

Parameters:	value (str) – value for IDD Field Demand Calculation 5 Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of demand_calculation_5_node_name or None if not set
Return type:	str

demand_calculation_6_node_name¶

field Demand Calculation 6 Node Name

Parameters:	value (str) – value for IDD Field Demand Calculation 6 Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of demand_calculation_6_node_name or None if not set
Return type:	str

demand_calculation_7_node_name¶

field Demand Calculation 7 Node Name

Parameters:	value (str) – value for IDD Field Demand Calculation 7 Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of demand_calculation_7_node_name or None if not set
Return type:	str

demand_calculation_8_node_name¶

field Demand Calculation 8 Node Name

Parameters:	value (str) – value for IDD Field Demand Calculation 8 Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of demand_calculation_8_node_name or None if not set
Return type:	str

demand_calculation_9_node_name¶

field Demand Calculation 9 Node Name

Parameters:	value (str) – value for IDD Field Demand Calculation 9 Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of demand_calculation_9_node_name or None if not set
Return type:	str

equipment_10_name¶

field Equipment 10 Name

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

equipment_10_object_type¶

field Equipment 10 Object Type

Parameters:	value (str) – value for IDD Field Equipment 10 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of equipment_10_object_type or None if not set
Return type:	str

equipment_1_name¶

field Equipment 1 Name

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

equipment_1_object_type¶

field Equipment 1 Object Type

Parameters:	value (str) – value for IDD Field Equipment 1 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of equipment_1_object_type or None if not set
Return type:	str

equipment_2_name¶

field Equipment 2 Name

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

equipment_2_object_type¶

field Equipment 2 Object Type

Parameters:	value (str) – value for IDD Field Equipment 2 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of equipment_2_object_type or None if not set
Return type:	str

equipment_3_name¶

field Equipment 3 Name

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

equipment_3_object_type¶

field Equipment 3 Object Type

Parameters:	value (str) – value for IDD Field Equipment 3 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of equipment_3_object_type or None if not set
Return type:	str

equipment_4_name¶

field Equipment 4 Name

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

equipment_4_object_type¶

field Equipment 4 Object Type

Parameters:	value (str) – value for IDD Field Equipment 4 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of equipment_4_object_type or None if not set
Return type:	str

equipment_5_name¶

field Equipment 5 Name

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

equipment_5_object_type¶

field Equipment 5 Object Type

Parameters:	value (str) – value for IDD Field Equipment 5 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of equipment_5_object_type or None if not set
Return type:	str

equipment_6_name¶

field Equipment 6 Name

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

equipment_6_object_type¶

field Equipment 6 Object Type

Parameters:	value (str) – value for IDD Field Equipment 6 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of equipment_6_object_type or None if not set
Return type:	str

equipment_7_name¶

field Equipment 7 Name

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

equipment_7_object_type¶

field Equipment 7 Object Type

Parameters:	value (str) – value for IDD Field Equipment 7 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of equipment_7_object_type or None if not set
Return type:	str

equipment_8_name¶

field Equipment 8 Name

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

equipment_8_object_type¶

field Equipment 8 Object Type

Parameters:	value (str) – value for IDD Field Equipment 8 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of equipment_8_object_type or None if not set
Return type:	str

equipment_9_name¶

field Equipment 9 Name

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

equipment_9_object_type¶

field Equipment 9 Object Type

Parameters:	value (str) – value for IDD Field Equipment 9 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of equipment_9_object_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

operation_10_type¶

field Operation 10 Type

Parameters:	value (str) – value for IDD Field Operation 10 Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of operation_10_type or None if not set
Return type:	str

operation_1_type¶

field Operation 1 Type

Parameters:	value (str) – value for IDD Field Operation 1 Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of operation_1_type or None if not set
Return type:	str

operation_2_type¶

field Operation 2 Type

Parameters:	value (str) – value for IDD Field Operation 2 Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of operation_2_type or None if not set
Return type:	str

operation_3_type¶

field Operation 3 Type

Parameters:	value (str) – value for IDD Field Operation 3 Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of operation_3_type or None if not set
Return type:	str

operation_4_type¶

field Operation 4 Type

Parameters:	value (str) – value for IDD Field Operation 4 Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of operation_4_type or None if not set
Return type:	str

operation_5_type¶

field Operation 5 Type

Parameters:	value (str) – value for IDD Field Operation 5 Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of operation_5_type or None if not set
Return type:	str

operation_6_type¶

field Operation 6 Type

Parameters:	value (str) – value for IDD Field Operation 6 Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of operation_6_type or None if not set
Return type:	str

operation_7_type¶

field Operation 7 Type

Parameters:	value (str) – value for IDD Field Operation 7 Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of operation_7_type or None if not set
Return type:	str

operation_8_type¶

field Operation 8 Type

Parameters:	value (str) – value for IDD Field Operation 8 Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of operation_8_type or None if not set
Return type:	str

operation_9_type¶

field Operation 9 Type

Parameters:	value (str) – value for IDD Field Operation 9 Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of operation_9_type or None if not set
Return type:	str

setpoint_10_node_name¶

field Setpoint 10 Node Name

Parameters:	value (str) – value for IDD Field Setpoint 10 Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of setpoint_10_node_name or None if not set
Return type:	str

setpoint_1_node_name¶

field Setpoint 1 Node Name

Parameters:	value (str) – value for IDD Field Setpoint 1 Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of setpoint_1_node_name or None if not set
Return type:	str

setpoint_2_node_name¶

field Setpoint 2 Node Name

Parameters:	value (str) – value for IDD Field Setpoint 2 Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of setpoint_2_node_name or None if not set
Return type:	str

setpoint_3_node_name¶

field Setpoint 3 Node Name

Parameters:	value (str) – value for IDD Field Setpoint 3 Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of setpoint_3_node_name or None if not set
Return type:	str

setpoint_4_node_name¶

field Setpoint 4 Node Name

Parameters:	value (str) – value for IDD Field Setpoint 4 Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of setpoint_4_node_name or None if not set
Return type:	str

setpoint_5_node_name¶

field Setpoint 5 Node Name

Parameters:	value (str) – value for IDD Field Setpoint 5 Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of setpoint_5_node_name or None if not set
Return type:	str

setpoint_6_node_name¶

field Setpoint 6 Node Name

Parameters:	value (str) – value for IDD Field Setpoint 6 Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of setpoint_6_node_name or None if not set
Return type:	str

setpoint_7_node_name¶

field Setpoint 7 Node Name

Parameters:	value (str) – value for IDD Field Setpoint 7 Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of setpoint_7_node_name or None if not set
Return type:	str

setpoint_8_node_name¶

field Setpoint 8 Node Name

Parameters:	value (str) – value for IDD Field Setpoint 8 Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of setpoint_8_node_name or None if not set
Return type:	str

setpoint_9_node_name¶

field Setpoint 9 Node Name

Parameters:	value (str) – value for IDD Field Setpoint 9 Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of setpoint_9_node_name or None if not set
Return type:	str

class pyidf.plant.PlantEquipmentOperationCoolingLoad¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object PlantEquipmentOperation:CoolingLoad Plant equipment operation scheme for cooling load range operation. Specifies one or more groups of equipment which are available to operate for successive cooling load ranges.

load_range_10_lower_limit¶

field Load Range 10 Lower Limit

Units: W

Parameters:	value (float) – value for IDD Field Load Range 10 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of load_range_10_lower_limit or None if not set
Return type:	float

load_range_10_upper_limit¶

field Load Range 10 Upper Limit

Units: W

Parameters:	value (float) – value for IDD Field Load Range 10 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of load_range_10_upper_limit or None if not set
Return type:	float

load_range_1_lower_limit¶

field Load Range 1 Lower Limit

Units: W

Parameters:	value (float) – value for IDD Field Load Range 1 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of load_range_1_lower_limit or None if not set
Return type:	float

load_range_1_upper_limit¶

field Load Range 1 Upper Limit

Units: W

Parameters:	value (float) – value for IDD Field Load Range 1 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of load_range_1_upper_limit or None if not set
Return type:	float

load_range_2_lower_limit¶

field Load Range 2 Lower Limit

Units: W

Parameters:	value (float) – value for IDD Field Load Range 2 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of load_range_2_lower_limit or None if not set
Return type:	float

load_range_2_upper_limit¶

field Load Range 2 Upper Limit

Units: W

Parameters:	value (float) – value for IDD Field Load Range 2 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of load_range_2_upper_limit or None if not set
Return type:	float

load_range_3_lower_limit¶

field Load Range 3 Lower Limit

Units: W

Parameters:	value (float) – value for IDD Field Load Range 3 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of load_range_3_lower_limit or None if not set
Return type:	float

load_range_3_upper_limit¶

field Load Range 3 Upper Limit

Units: W

Parameters:	value (float) – value for IDD Field Load Range 3 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of load_range_3_upper_limit or None if not set
Return type:	float

load_range_4_lower_limit¶

field Load Range 4 Lower Limit

Units: W

Parameters:	value (float) – value for IDD Field Load Range 4 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of load_range_4_lower_limit or None if not set
Return type:	float

load_range_4_upper_limit¶

field Load Range 4 Upper Limit

Units: W

Parameters:	value (float) – value for IDD Field Load Range 4 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of load_range_4_upper_limit or None if not set
Return type:	float

load_range_5_lower_limit¶

field Load Range 5 Lower Limit

Units: W

Parameters:	value (float) – value for IDD Field Load Range 5 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of load_range_5_lower_limit or None if not set
Return type:	float

load_range_5_upper_limit¶

field Load Range 5 Upper Limit

Units: W

Parameters:	value (float) – value for IDD Field Load Range 5 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of load_range_5_upper_limit or None if not set
Return type:	float

load_range_6_lower_limit¶

field Load Range 6 Lower Limit

Units: W

Parameters:	value (float) – value for IDD Field Load Range 6 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of load_range_6_lower_limit or None if not set
Return type:	float

load_range_6_upper_limit¶

field Load Range 6 Upper Limit

Units: W

Parameters:	value (float) – value for IDD Field Load Range 6 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of load_range_6_upper_limit or None if not set
Return type:	float

load_range_7_lower_limit¶

field Load Range 7 Lower Limit

Units: W

Parameters:	value (float) – value for IDD Field Load Range 7 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of load_range_7_lower_limit or None if not set
Return type:	float

load_range_7_upper_limit¶

field Load Range 7 Upper Limit

Units: W

Parameters:	value (float) – value for IDD Field Load Range 7 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of load_range_7_upper_limit or None if not set
Return type:	float

load_range_8_lower_limit¶

field Load Range 8 Lower Limit

Units: W

Parameters:	value (float) – value for IDD Field Load Range 8 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of load_range_8_lower_limit or None if not set
Return type:	float

load_range_8_upper_limit¶

field Load Range 8 Upper Limit

Units: W

Parameters:	value (float) – value for IDD Field Load Range 8 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of load_range_8_upper_limit or None if not set
Return type:	float

load_range_9_lower_limit¶

field Load Range 9 Lower Limit

Units: W

Parameters:	value (float) – value for IDD Field Load Range 9 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of load_range_9_lower_limit or None if not set
Return type:	float

load_range_9_upper_limit¶

field Load Range 9 Upper Limit

Units: W

Parameters:	value (float) – value for IDD Field Load Range 9 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of load_range_9_upper_limit or None if not set
Return type:	float

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

range_10_equipment_list_name¶

field Range 10 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 10 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_10_equipment_list_name or None if not set
Return type:	str

range_1_equipment_list_name¶

field Range 1 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 1 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_1_equipment_list_name or None if not set
Return type:	str

range_2_equipment_list_name¶

field Range 2 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 2 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_2_equipment_list_name or None if not set
Return type:	str

range_3_equipment_list_name¶

field Range 3 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 3 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_3_equipment_list_name or None if not set
Return type:	str

range_4_equipment_list_name¶

field Range 4 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 4 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_4_equipment_list_name or None if not set
Return type:	str

range_5_equipment_list_name¶

field Range 5 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 5 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_5_equipment_list_name or None if not set
Return type:	str

range_6_equipment_list_name¶

field Range 6 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 6 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_6_equipment_list_name or None if not set
Return type:	str

range_7_equipment_list_name¶

field Range 7 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 7 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_7_equipment_list_name or None if not set
Return type:	str

range_8_equipment_list_name¶

field Range 8 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 8 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_8_equipment_list_name or None if not set
Return type:	str

range_9_equipment_list_name¶

field Range 9 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 9 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_9_equipment_list_name or None if not set
Return type:	str

class pyidf.plant.PlantEquipmentOperationHeatingLoad¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object PlantEquipmentOperation:HeatingLoad Plant equipment operation scheme for heating load range operation. Specifies one or more groups of equipment which are available to operate for successive heating load ranges.

load_range_10_lower_limit¶

field Load Range 10 Lower Limit

Units: W

Parameters:	value (float) – value for IDD Field Load Range 10 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of load_range_10_lower_limit or None if not set
Return type:	float

load_range_10_upper_limit¶

field Load Range 10 Upper Limit

Units: W

Parameters:	value (float) – value for IDD Field Load Range 10 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of load_range_10_upper_limit or None if not set
Return type:	float

load_range_1_lower_limit¶

field Load Range 1 Lower Limit

Units: W

Parameters:	value (float) – value for IDD Field Load Range 1 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of load_range_1_lower_limit or None if not set
Return type:	float

load_range_1_upper_limit¶

field Load Range 1 Upper Limit

Units: W

Parameters:	value (float) – value for IDD Field Load Range 1 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of load_range_1_upper_limit or None if not set
Return type:	float

load_range_2_lower_limit¶

field Load Range 2 Lower Limit

Units: W

Parameters:	value (float) – value for IDD Field Load Range 2 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of load_range_2_lower_limit or None if not set
Return type:	float

load_range_2_upper_limit¶

field Load Range 2 Upper Limit

Units: W

Parameters:	value (float) – value for IDD Field Load Range 2 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of load_range_2_upper_limit or None if not set
Return type:	float

load_range_3_lower_limit¶

field Load Range 3 Lower Limit

Units: W

Parameters:	value (float) – value for IDD Field Load Range 3 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of load_range_3_lower_limit or None if not set
Return type:	float

load_range_3_upper_limit¶

field Load Range 3 Upper Limit

Units: W

Parameters:	value (float) – value for IDD Field Load Range 3 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of load_range_3_upper_limit or None if not set
Return type:	float

load_range_4_lower_limit¶

field Load Range 4 Lower Limit

Units: W

Parameters:	value (float) – value for IDD Field Load Range 4 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of load_range_4_lower_limit or None if not set
Return type:	float

load_range_4_upper_limit¶

field Load Range 4 Upper Limit

Units: W

Parameters:	value (float) – value for IDD Field Load Range 4 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of load_range_4_upper_limit or None if not set
Return type:	float

load_range_5_lower_limit¶

field Load Range 5 Lower Limit

Units: W

Parameters:	value (float) – value for IDD Field Load Range 5 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of load_range_5_lower_limit or None if not set
Return type:	float

load_range_5_upper_limit¶

field Load Range 5 Upper Limit

Units: W

Parameters:	value (float) – value for IDD Field Load Range 5 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of load_range_5_upper_limit or None if not set
Return type:	float

load_range_6_lower_limit¶

field Load Range 6 Lower Limit

Units: W

Parameters:	value (float) – value for IDD Field Load Range 6 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of load_range_6_lower_limit or None if not set
Return type:	float

load_range_6_upper_limit¶

field Load Range 6 Upper Limit

Units: W

Parameters:	value (float) – value for IDD Field Load Range 6 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of load_range_6_upper_limit or None if not set
Return type:	float

load_range_7_lower_limit¶

field Load Range 7 Lower Limit

Units: W

Parameters:	value (float) – value for IDD Field Load Range 7 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of load_range_7_lower_limit or None if not set
Return type:	float

load_range_7_upper_limit¶

field Load Range 7 Upper Limit

Units: W

Parameters:	value (float) – value for IDD Field Load Range 7 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of load_range_7_upper_limit or None if not set
Return type:	float

load_range_8_lower_limit¶

field Load Range 8 Lower Limit

Units: W

Parameters:	value (float) – value for IDD Field Load Range 8 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of load_range_8_lower_limit or None if not set
Return type:	float

load_range_8_upper_limit¶

field Load Range 8 Upper Limit

Units: W

Parameters:	value (float) – value for IDD Field Load Range 8 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of load_range_8_upper_limit or None if not set
Return type:	float

load_range_9_lower_limit¶

field Load Range 9 Lower Limit

Units: W

Parameters:	value (float) – value for IDD Field Load Range 9 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of load_range_9_lower_limit or None if not set
Return type:	float

load_range_9_upper_limit¶

field Load Range 9 Upper Limit

Units: W

Parameters:	value (float) – value for IDD Field Load Range 9 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of load_range_9_upper_limit or None if not set
Return type:	float

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

range_10_equipment_list_name¶

field Range 10 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 10 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_10_equipment_list_name or None if not set
Return type:	str

range_1_equipment_list_name¶

field Range 1 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 1 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_1_equipment_list_name or None if not set
Return type:	str

range_2_equipment_list_name¶

field Range 2 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 2 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_2_equipment_list_name or None if not set
Return type:	str

range_3_equipment_list_name¶

field Range 3 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 3 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_3_equipment_list_name or None if not set
Return type:	str

range_4_equipment_list_name¶

field Range 4 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 4 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_4_equipment_list_name or None if not set
Return type:	str

range_5_equipment_list_name¶

field Range 5 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 5 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_5_equipment_list_name or None if not set
Return type:	str

range_6_equipment_list_name¶

field Range 6 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 6 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_6_equipment_list_name or None if not set
Return type:	str

range_7_equipment_list_name¶

field Range 7 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 7 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_7_equipment_list_name or None if not set
Return type:	str

range_8_equipment_list_name¶

field Range 8 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 8 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_8_equipment_list_name or None if not set
Return type:	str

range_9_equipment_list_name¶

field Range 9 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 9 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_9_equipment_list_name or None if not set
Return type:	str

class pyidf.plant.PlantEquipmentOperationOutdoorDewpoint¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object PlantEquipmentOperation:OutdoorDewpoint Plant equipment operation scheme for outdoor dewpoint temperature range operation. Specifies one or more groups of equipment which are available to operate for successive outdoor dewpoint temperature ranges.

dewpoint_temperature_range_10_lower_limit¶

field Dewpoint Temperature Range 10 Lower Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Dewpoint Temperature Range 10 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of dewpoint_temperature_range_10_lower_limit or None if not set
Return type:	float

dewpoint_temperature_range_10_upper_limit¶

field Dewpoint Temperature Range 10 Upper Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Dewpoint Temperature Range 10 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of dewpoint_temperature_range_10_upper_limit or None if not set
Return type:	float

dewpoint_temperature_range_1_lower_limit¶

field Dewpoint Temperature Range 1 Lower Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Dewpoint Temperature Range 1 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of dewpoint_temperature_range_1_lower_limit or None if not set
Return type:	float

dewpoint_temperature_range_1_upper_limit¶

field Dewpoint Temperature Range 1 Upper Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Dewpoint Temperature Range 1 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of dewpoint_temperature_range_1_upper_limit or None if not set
Return type:	float

dewpoint_temperature_range_2_lower_limit¶

field Dewpoint Temperature Range 2 Lower Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Dewpoint Temperature Range 2 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of dewpoint_temperature_range_2_lower_limit or None if not set
Return type:	float

dewpoint_temperature_range_2_upper_limit¶

field Dewpoint Temperature Range 2 Upper Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Dewpoint Temperature Range 2 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of dewpoint_temperature_range_2_upper_limit or None if not set
Return type:	float

dewpoint_temperature_range_3_lower_limit¶

field Dewpoint Temperature Range 3 Lower Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Dewpoint Temperature Range 3 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of dewpoint_temperature_range_3_lower_limit or None if not set
Return type:	float

dewpoint_temperature_range_3_upper_limit¶

field Dewpoint Temperature Range 3 Upper Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Dewpoint Temperature Range 3 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of dewpoint_temperature_range_3_upper_limit or None if not set
Return type:	float

dewpoint_temperature_range_4_lower_limit¶

field Dewpoint Temperature Range 4 Lower Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Dewpoint Temperature Range 4 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of dewpoint_temperature_range_4_lower_limit or None if not set
Return type:	float

dewpoint_temperature_range_4_upper_limit¶

field Dewpoint Temperature Range 4 Upper Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Dewpoint Temperature Range 4 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of dewpoint_temperature_range_4_upper_limit or None if not set
Return type:	float

dewpoint_temperature_range_5_lower_limit¶

field Dewpoint Temperature Range 5 Lower Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Dewpoint Temperature Range 5 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of dewpoint_temperature_range_5_lower_limit or None if not set
Return type:	float

dewpoint_temperature_range_5_upper_limit¶

field Dewpoint Temperature Range 5 Upper Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Dewpoint Temperature Range 5 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of dewpoint_temperature_range_5_upper_limit or None if not set
Return type:	float

dewpoint_temperature_range_6_lower_limit¶

field Dewpoint Temperature Range 6 Lower Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Dewpoint Temperature Range 6 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of dewpoint_temperature_range_6_lower_limit or None if not set
Return type:	float

dewpoint_temperature_range_6_upper_limit¶

field Dewpoint Temperature Range 6 Upper Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Dewpoint Temperature Range 6 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of dewpoint_temperature_range_6_upper_limit or None if not set
Return type:	float

dewpoint_temperature_range_7_lower_limit¶

field Dewpoint Temperature Range 7 Lower Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Dewpoint Temperature Range 7 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of dewpoint_temperature_range_7_lower_limit or None if not set
Return type:	float

dewpoint_temperature_range_7_upper_limit¶

field Dewpoint Temperature Range 7 Upper Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Dewpoint Temperature Range 7 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of dewpoint_temperature_range_7_upper_limit or None if not set
Return type:	float

dewpoint_temperature_range_8_lower_limit¶

field Dewpoint Temperature Range 8 Lower Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Dewpoint Temperature Range 8 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of dewpoint_temperature_range_8_lower_limit or None if not set
Return type:	float

dewpoint_temperature_range_8_upper_limit¶

field Dewpoint Temperature Range 8 Upper Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Dewpoint Temperature Range 8 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of dewpoint_temperature_range_8_upper_limit or None if not set
Return type:	float

dewpoint_temperature_range_9_lower_limit¶

field Dewpoint Temperature Range 9 Lower Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Dewpoint Temperature Range 9 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of dewpoint_temperature_range_9_lower_limit or None if not set
Return type:	float

dewpoint_temperature_range_9_upper_limit¶

field Dewpoint Temperature Range 9 Upper Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Dewpoint Temperature Range 9 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of dewpoint_temperature_range_9_upper_limit or None if not set
Return type:	float

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

range_10_equipment_list_name¶

field Range 10 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 10 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_10_equipment_list_name or None if not set
Return type:	str

range_1_equipment_list_name¶

field Range 1 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 1 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_1_equipment_list_name or None if not set
Return type:	str

range_2_equipment_list_name¶

field Range 2 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 2 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_2_equipment_list_name or None if not set
Return type:	str

range_3_equipment_list_name¶

field Range 3 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 3 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_3_equipment_list_name or None if not set
Return type:	str

range_4_equipment_list_name¶

field Range 4 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 4 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_4_equipment_list_name or None if not set
Return type:	str

range_5_equipment_list_name¶

field Range 5 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 5 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_5_equipment_list_name or None if not set
Return type:	str

range_6_equipment_list_name¶

field Range 6 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 6 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_6_equipment_list_name or None if not set
Return type:	str

range_7_equipment_list_name¶

field Range 7 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 7 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_7_equipment_list_name or None if not set
Return type:	str

range_8_equipment_list_name¶

field Range 8 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 8 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_8_equipment_list_name or None if not set
Return type:	str

range_9_equipment_list_name¶

field Range 9 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 9 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_9_equipment_list_name or None if not set
Return type:	str

class pyidf.plant.PlantEquipmentOperationOutdoorDewpointDifference¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object PlantEquipmentOperation:OutdoorDewpointDifference Plant equipment operation scheme for outdoor dewpoint temperature difference operation. Specifies one or more groups of equipment which are available to operate for successive ranges based the difference between a reference node temperature and the outdoor dewpoint temperature.

dewpoint_temperature_difference_range_10_lower_limit¶

field Dewpoint Temperature Difference Range 10 Lower Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Dewpoint Temperature Difference Range 10 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of dewpoint_temperature_difference_range_10_lower_limit or None if not set
Return type:	float

dewpoint_temperature_difference_range_10_upper_limit¶

field Dewpoint Temperature Difference Range 10 Upper Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Dewpoint Temperature Difference Range 10 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of dewpoint_temperature_difference_range_10_upper_limit or None if not set
Return type:	float

dewpoint_temperature_difference_range_1_lower_limit¶

field Dewpoint Temperature Difference Range 1 Lower Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Dewpoint Temperature Difference Range 1 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of dewpoint_temperature_difference_range_1_lower_limit or None if not set
Return type:	float

dewpoint_temperature_difference_range_1_upper_limit¶

field Dewpoint Temperature Difference Range 1 Upper Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Dewpoint Temperature Difference Range 1 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of dewpoint_temperature_difference_range_1_upper_limit or None if not set
Return type:	float

dewpoint_temperature_difference_range_2_lower_limit¶

field Dewpoint Temperature Difference Range 2 Lower Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Dewpoint Temperature Difference Range 2 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of dewpoint_temperature_difference_range_2_lower_limit or None if not set
Return type:	float

dewpoint_temperature_difference_range_2_upper_limit¶

field Dewpoint Temperature Difference Range 2 Upper Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Dewpoint Temperature Difference Range 2 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of dewpoint_temperature_difference_range_2_upper_limit or None if not set
Return type:	float

dewpoint_temperature_difference_range_3_lower_limit¶

field Dewpoint Temperature Difference Range 3 Lower Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Dewpoint Temperature Difference Range 3 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of dewpoint_temperature_difference_range_3_lower_limit or None if not set
Return type:	float

dewpoint_temperature_difference_range_3_upper_limit¶

field Dewpoint Temperature Difference Range 3 Upper Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Dewpoint Temperature Difference Range 3 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of dewpoint_temperature_difference_range_3_upper_limit or None if not set
Return type:	float

dewpoint_temperature_difference_range_4_lower_limit¶

field Dewpoint Temperature Difference Range 4 Lower Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Dewpoint Temperature Difference Range 4 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of dewpoint_temperature_difference_range_4_lower_limit or None if not set
Return type:	float

dewpoint_temperature_difference_range_4_upper_limit¶

field Dewpoint Temperature Difference Range 4 Upper Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Dewpoint Temperature Difference Range 4 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of dewpoint_temperature_difference_range_4_upper_limit or None if not set
Return type:	float

dewpoint_temperature_difference_range_5_lower_limit¶

field Dewpoint Temperature Difference Range 5 Lower Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Dewpoint Temperature Difference Range 5 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of dewpoint_temperature_difference_range_5_lower_limit or None if not set
Return type:	float

dewpoint_temperature_difference_range_5_upper_limit¶

field Dewpoint Temperature Difference Range 5 Upper Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Dewpoint Temperature Difference Range 5 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of dewpoint_temperature_difference_range_5_upper_limit or None if not set
Return type:	float

dewpoint_temperature_difference_range_6_lower_limit¶

field Dewpoint Temperature Difference Range 6 Lower Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Dewpoint Temperature Difference Range 6 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of dewpoint_temperature_difference_range_6_lower_limit or None if not set
Return type:	float

dewpoint_temperature_difference_range_6_upper_limit¶

field Dewpoint Temperature Difference Range 6 Upper Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Dewpoint Temperature Difference Range 6 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of dewpoint_temperature_difference_range_6_upper_limit or None if not set
Return type:	float

dewpoint_temperature_difference_range_7_lower_limit¶

field Dewpoint Temperature Difference Range 7 Lower Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Dewpoint Temperature Difference Range 7 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of dewpoint_temperature_difference_range_7_lower_limit or None if not set
Return type:	float

dewpoint_temperature_difference_range_7_upper_limit¶

field Dewpoint Temperature Difference Range 7 Upper Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Dewpoint Temperature Difference Range 7 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of dewpoint_temperature_difference_range_7_upper_limit or None if not set
Return type:	float

dewpoint_temperature_difference_range_8_lower_limit¶

field Dewpoint Temperature Difference Range 8 Lower Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Dewpoint Temperature Difference Range 8 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of dewpoint_temperature_difference_range_8_lower_limit or None if not set
Return type:	float

dewpoint_temperature_difference_range_8_upper_limit¶

field Dewpoint Temperature Difference Range 8 Upper Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Dewpoint Temperature Difference Range 8 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of dewpoint_temperature_difference_range_8_upper_limit or None if not set
Return type:	float

dewpoint_temperature_difference_range_9_lower_limit¶

field Dewpoint Temperature Difference Range 9 Lower Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Dewpoint Temperature Difference Range 9 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of dewpoint_temperature_difference_range_9_lower_limit or None if not set
Return type:	float

dewpoint_temperature_difference_range_9_upper_limit¶

field Dewpoint Temperature Difference Range 9 Upper Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Dewpoint Temperature Difference Range 9 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of dewpoint_temperature_difference_range_9_upper_limit or None if not set
Return type:	float

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

range_10_equipment_list_name¶

field Range 10 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 10 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_10_equipment_list_name or None if not set
Return type:	str

range_1_equipment_list_name¶

field Range 1 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 1 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_1_equipment_list_name or None if not set
Return type:	str

range_2_equipment_list_name¶

field Range 2 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 2 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_2_equipment_list_name or None if not set
Return type:	str

range_3_equipment_list_name¶

field Range 3 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 3 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_3_equipment_list_name or None if not set
Return type:	str

range_4_equipment_list_name¶

field Range 4 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 4 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_4_equipment_list_name or None if not set
Return type:	str

range_5_equipment_list_name¶

field Range 5 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 5 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_5_equipment_list_name or None if not set
Return type:	str

range_6_equipment_list_name¶

field Range 6 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 6 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_6_equipment_list_name or None if not set
Return type:	str

range_7_equipment_list_name¶

field Range 7 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 7 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_7_equipment_list_name or None if not set
Return type:	str

range_8_equipment_list_name¶

field Range 8 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 8 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_8_equipment_list_name or None if not set
Return type:	str

range_9_equipment_list_name¶

field Range 9 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 9 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_9_equipment_list_name or None if not set
Return type:	str

reference_temperature_node_name¶

field Reference Temperature Node Name

Parameters:	value (str) – value for IDD Field Reference Temperature Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of reference_temperature_node_name or None if not set
Return type:	str

class pyidf.plant.PlantEquipmentOperationOutdoorDryBulb¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object PlantEquipmentOperation:OutdoorDryBulb Plant equipment operation scheme for outdoor dry-bulb temperature range operation. Specifies one or more groups of equipment which are available to operate for successive outdoor dry-bulb temperature ranges.

drybulb_temperature_range_10_lower_limit¶

field Dry-Bulb Temperature Range 10 Lower Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Dry-Bulb Temperature Range 10 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of drybulb_temperature_range_10_lower_limit or None if not set
Return type:	float

drybulb_temperature_range_10_upper_limit¶

field Dry-Bulb Temperature Range 10 Upper Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Dry-Bulb Temperature Range 10 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of drybulb_temperature_range_10_upper_limit or None if not set
Return type:	float

drybulb_temperature_range_1_lower_limit¶

field Dry-Bulb Temperature Range 1 Lower Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Dry-Bulb Temperature Range 1 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of drybulb_temperature_range_1_lower_limit or None if not set
Return type:	float

drybulb_temperature_range_1_upper_limit¶

field Dry-Bulb Temperature Range 1 Upper Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Dry-Bulb Temperature Range 1 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of drybulb_temperature_range_1_upper_limit or None if not set
Return type:	float

drybulb_temperature_range_2_lower_limit¶

field Dry-Bulb Temperature Range 2 Lower Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Dry-Bulb Temperature Range 2 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of drybulb_temperature_range_2_lower_limit or None if not set
Return type:	float

drybulb_temperature_range_2_upper_limit¶

field Dry-Bulb Temperature Range 2 Upper Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Dry-Bulb Temperature Range 2 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of drybulb_temperature_range_2_upper_limit or None if not set
Return type:	float

drybulb_temperature_range_3_lower_limit¶

field Dry-Bulb Temperature Range 3 Lower Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Dry-Bulb Temperature Range 3 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of drybulb_temperature_range_3_lower_limit or None if not set
Return type:	float

drybulb_temperature_range_3_upper_limit¶

field Dry-Bulb Temperature Range 3 Upper Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Dry-Bulb Temperature Range 3 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of drybulb_temperature_range_3_upper_limit or None if not set
Return type:	float

drybulb_temperature_range_4_lower_limit¶

field Dry-Bulb Temperature Range 4 Lower Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Dry-Bulb Temperature Range 4 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of drybulb_temperature_range_4_lower_limit or None if not set
Return type:	float

drybulb_temperature_range_4_upper_limit¶

field Dry-Bulb Temperature Range 4 Upper Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Dry-Bulb Temperature Range 4 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of drybulb_temperature_range_4_upper_limit or None if not set
Return type:	float

drybulb_temperature_range_5_lower_limit¶

field Dry-Bulb Temperature Range 5 Lower Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Dry-Bulb Temperature Range 5 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of drybulb_temperature_range_5_lower_limit or None if not set
Return type:	float

drybulb_temperature_range_5_upper_limit¶

field Dry-Bulb Temperature Range 5 Upper Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Dry-Bulb Temperature Range 5 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of drybulb_temperature_range_5_upper_limit or None if not set
Return type:	float

drybulb_temperature_range_6_lower_limit¶

field Dry-Bulb Temperature Range 6 Lower Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Dry-Bulb Temperature Range 6 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of drybulb_temperature_range_6_lower_limit or None if not set
Return type:	float

drybulb_temperature_range_6_upper_limit¶

field Dry-Bulb Temperature Range 6 Upper Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Dry-Bulb Temperature Range 6 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of drybulb_temperature_range_6_upper_limit or None if not set
Return type:	float

drybulb_temperature_range_7_lower_limit¶

field Dry-Bulb Temperature Range 7 Lower Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Dry-Bulb Temperature Range 7 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of drybulb_temperature_range_7_lower_limit or None if not set
Return type:	float

drybulb_temperature_range_7_upper_limit¶

field Dry-Bulb Temperature Range 7 Upper Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Dry-Bulb Temperature Range 7 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of drybulb_temperature_range_7_upper_limit or None if not set
Return type:	float

drybulb_temperature_range_8_lower_limit¶

field Dry-Bulb Temperature Range 8 Lower Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Dry-Bulb Temperature Range 8 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of drybulb_temperature_range_8_lower_limit or None if not set
Return type:	float

drybulb_temperature_range_8_upper_limit¶

field Dry-Bulb Temperature Range 8 Upper Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Dry-Bulb Temperature Range 8 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of drybulb_temperature_range_8_upper_limit or None if not set
Return type:	float

drybulb_temperature_range_9_lower_limit¶

field Dry-Bulb Temperature Range 9 Lower Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Dry-Bulb Temperature Range 9 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of drybulb_temperature_range_9_lower_limit or None if not set
Return type:	float

drybulb_temperature_range_9_upper_limit¶

field Dry-Bulb Temperature Range 9 Upper Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Dry-Bulb Temperature Range 9 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of drybulb_temperature_range_9_upper_limit or None if not set
Return type:	float

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

range_10_equipment_list_name¶

field Range 10 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 10 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_10_equipment_list_name or None if not set
Return type:	str

range_1_equipment_list_name¶

field Range 1 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 1 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_1_equipment_list_name or None if not set
Return type:	str

range_2_equipment_list_name¶

field Range 2 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 2 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_2_equipment_list_name or None if not set
Return type:	str

range_3_equipment_list_name¶

field Range 3 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 3 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_3_equipment_list_name or None if not set
Return type:	str

range_4_equipment_list_name¶

field Range 4 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 4 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_4_equipment_list_name or None if not set
Return type:	str

range_5_equipment_list_name¶

field Range 5 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 5 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_5_equipment_list_name or None if not set
Return type:	str

range_6_equipment_list_name¶

field Range 6 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 6 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_6_equipment_list_name or None if not set
Return type:	str

range_7_equipment_list_name¶

field Range 7 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 7 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_7_equipment_list_name or None if not set
Return type:	str

range_8_equipment_list_name¶

field Range 8 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 8 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_8_equipment_list_name or None if not set
Return type:	str

range_9_equipment_list_name¶

field Range 9 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 9 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_9_equipment_list_name or None if not set
Return type:	str

class pyidf.plant.PlantEquipmentOperationOutdoorDryBulbDifference¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object PlantEquipmentOperation:OutdoorDryBulbDifference Plant equipment operation scheme for outdoor dry-bulb temperature difference operation. Specifies one or more groups of equipment which are available to operate for successive ranges based the difference between a reference node temperature and the outdoor dry-bulb temperature.

drybulb_temperature_difference_range_10_lower_limit¶

field Dry-Bulb Temperature Difference Range 10 Lower Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Dry-Bulb Temperature Difference Range 10 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of drybulb_temperature_difference_range_10_lower_limit or None if not set
Return type:	float

drybulb_temperature_difference_range_10_upper_limit¶

field Dry-Bulb Temperature Difference Range 10 Upper Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Dry-Bulb Temperature Difference Range 10 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of drybulb_temperature_difference_range_10_upper_limit or None if not set
Return type:	float

drybulb_temperature_difference_range_1_lower_limit¶

field Dry-Bulb Temperature Difference Range 1 Lower Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Dry-Bulb Temperature Difference Range 1 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of drybulb_temperature_difference_range_1_lower_limit or None if not set
Return type:	float

drybulb_temperature_difference_range_1_upper_limit¶

field Dry-Bulb Temperature Difference Range 1 Upper Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Dry-Bulb Temperature Difference Range 1 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of drybulb_temperature_difference_range_1_upper_limit or None if not set
Return type:	float

drybulb_temperature_difference_range_2_lower_limit¶

field Dry-Bulb Temperature Difference Range 2 Lower Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Dry-Bulb Temperature Difference Range 2 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of drybulb_temperature_difference_range_2_lower_limit or None if not set
Return type:	float

drybulb_temperature_difference_range_2_upper_limit¶

field Dry-Bulb Temperature Difference Range 2 Upper Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Dry-Bulb Temperature Difference Range 2 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of drybulb_temperature_difference_range_2_upper_limit or None if not set
Return type:	float

drybulb_temperature_difference_range_3_lower_limit¶

field Dry-Bulb Temperature Difference Range 3 Lower Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Dry-Bulb Temperature Difference Range 3 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of drybulb_temperature_difference_range_3_lower_limit or None if not set
Return type:	float

drybulb_temperature_difference_range_3_upper_limit¶

field Dry-Bulb Temperature Difference Range 3 Upper Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Dry-Bulb Temperature Difference Range 3 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of drybulb_temperature_difference_range_3_upper_limit or None if not set
Return type:	float

drybulb_temperature_difference_range_4_lower_limit¶

field Dry-Bulb Temperature Difference Range 4 Lower Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Dry-Bulb Temperature Difference Range 4 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of drybulb_temperature_difference_range_4_lower_limit or None if not set
Return type:	float

drybulb_temperature_difference_range_4_upper_limit¶

field Dry-Bulb Temperature Difference Range 4 Upper Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Dry-Bulb Temperature Difference Range 4 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of drybulb_temperature_difference_range_4_upper_limit or None if not set
Return type:	float

drybulb_temperature_difference_range_5_lower_limit¶

field Dry-Bulb Temperature Difference Range 5 Lower Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Dry-Bulb Temperature Difference Range 5 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of drybulb_temperature_difference_range_5_lower_limit or None if not set
Return type:	float

drybulb_temperature_difference_range_5_upper_limit¶

field Dry-Bulb Temperature Difference Range 5 Upper Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Dry-Bulb Temperature Difference Range 5 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of drybulb_temperature_difference_range_5_upper_limit or None if not set
Return type:	float

drybulb_temperature_difference_range_6_lower_limit¶

field Dry-Bulb Temperature Difference Range 6 Lower Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Dry-Bulb Temperature Difference Range 6 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of drybulb_temperature_difference_range_6_lower_limit or None if not set
Return type:	float

drybulb_temperature_difference_range_6_upper_limit¶

field Dry-Bulb Temperature Difference Range 6 Upper Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Dry-Bulb Temperature Difference Range 6 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of drybulb_temperature_difference_range_6_upper_limit or None if not set
Return type:	float

drybulb_temperature_difference_range_7_lower_limit¶

field Dry-Bulb Temperature Difference Range 7 Lower Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Dry-Bulb Temperature Difference Range 7 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of drybulb_temperature_difference_range_7_lower_limit or None if not set
Return type:	float

drybulb_temperature_difference_range_7_upper_limit¶

field Dry-Bulb Temperature Difference Range 7 Upper Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Dry-Bulb Temperature Difference Range 7 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of drybulb_temperature_difference_range_7_upper_limit or None if not set
Return type:	float

drybulb_temperature_difference_range_8_lower_limit¶

field Dry-Bulb Temperature Difference Range 8 Lower Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Dry-Bulb Temperature Difference Range 8 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of drybulb_temperature_difference_range_8_lower_limit or None if not set
Return type:	float

drybulb_temperature_difference_range_8_upper_limit¶

field Dry-Bulb Temperature Difference Range 8 Upper Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Dry-Bulb Temperature Difference Range 8 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of drybulb_temperature_difference_range_8_upper_limit or None if not set
Return type:	float

drybulb_temperature_difference_range_9_lower_limit¶

field Dry-Bulb Temperature Difference Range 9 Lower Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Dry-Bulb Temperature Difference Range 9 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of drybulb_temperature_difference_range_9_lower_limit or None if not set
Return type:	float

drybulb_temperature_difference_range_9_upper_limit¶

field Dry-Bulb Temperature Difference Range 9 Upper Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Dry-Bulb Temperature Difference Range 9 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of drybulb_temperature_difference_range_9_upper_limit or None if not set
Return type:	float

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

range_10_equipment_list_name¶

field Range 10 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 10 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_10_equipment_list_name or None if not set
Return type:	str

range_1_equipment_list_name¶

field Range 1 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 1 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_1_equipment_list_name or None if not set
Return type:	str

range_2_equipment_list_name¶

field Range 2 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 2 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_2_equipment_list_name or None if not set
Return type:	str

range_3_equipment_list_name¶

field Range 3 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 3 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_3_equipment_list_name or None if not set
Return type:	str

range_4_equipment_list_name¶

field Range 4 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 4 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_4_equipment_list_name or None if not set
Return type:	str

range_5_equipment_list_name¶

field Range 5 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 5 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_5_equipment_list_name or None if not set
Return type:	str

range_6_equipment_list_name¶

field Range 6 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 6 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_6_equipment_list_name or None if not set
Return type:	str

range_7_equipment_list_name¶

field Range 7 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 7 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_7_equipment_list_name or None if not set
Return type:	str

range_8_equipment_list_name¶

field Range 8 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 8 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_8_equipment_list_name or None if not set
Return type:	str

range_9_equipment_list_name¶

field Range 9 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 9 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_9_equipment_list_name or None if not set
Return type:	str

reference_temperature_node_name¶

field Reference Temperature Node Name

Parameters:	value (str) – value for IDD Field Reference Temperature Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of reference_temperature_node_name or None if not set
Return type:	str

class pyidf.plant.PlantEquipmentOperationOutdoorRelativeHumidity¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object PlantEquipmentOperation:OutdoorRelativeHumidity Plant equipment operation scheme for outdoor relative humidity range operation. Specifies one or more groups of equipment which are available to operate for successive outdoor relative humidity ranges.

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

range_10_equipment_list_name¶

field Range 10 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 10 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_10_equipment_list_name or None if not set
Return type:	str

range_1_equipment_list_name¶

field Range 1 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 1 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_1_equipment_list_name or None if not set
Return type:	str

range_2_equipment_list_name¶

field Range 2 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 2 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_2_equipment_list_name or None if not set
Return type:	str

range_3_equipment_list_name¶

field Range 3 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 3 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_3_equipment_list_name or None if not set
Return type:	str

range_4_equipment_list_name¶

field Range 4 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 4 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_4_equipment_list_name or None if not set
Return type:	str

range_5_equipment_list_name¶

field Range 5 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 5 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_5_equipment_list_name or None if not set
Return type:	str

range_6_equipment_list_name¶

field Range 6 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 6 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_6_equipment_list_name or None if not set
Return type:	str

range_7_equipment_list_name¶

field Range 7 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 7 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_7_equipment_list_name or None if not set
Return type:	str

range_8_equipment_list_name¶

field Range 8 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 8 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_8_equipment_list_name or None if not set
Return type:	str

range_9_equipment_list_name¶

field Range 9 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 9 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_9_equipment_list_name or None if not set
Return type:	str

relative_humidity_range_10_lower_limit¶

field Relative Humidity Range 10 Lower Limit

Units: percent

value <= 100.0

Parameters:	value (float) – value for IDD Field Relative Humidity Range 10 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of relative_humidity_range_10_lower_limit or None if not set
Return type:	float

relative_humidity_range_10_upper_limit¶

field Relative Humidity Range 10 Upper Limit

Units: percent

value <= 100.0

Parameters:	value (float) – value for IDD Field Relative Humidity Range 10 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of relative_humidity_range_10_upper_limit or None if not set
Return type:	float

relative_humidity_range_1_lower_limit¶

field Relative Humidity Range 1 Lower Limit

Units: percent

value <= 100.0

Parameters:	value (float) – value for IDD Field Relative Humidity Range 1 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of relative_humidity_range_1_lower_limit or None if not set
Return type:	float

relative_humidity_range_1_upper_limit¶

field Relative Humidity Range 1 Upper Limit

Units: percent

value <= 100.0

Parameters:	value (float) – value for IDD Field Relative Humidity Range 1 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of relative_humidity_range_1_upper_limit or None if not set
Return type:	float

relative_humidity_range_2_lower_limit¶

field Relative Humidity Range 2 Lower Limit

Units: percent

value <= 100.0

Parameters:	value (float) – value for IDD Field Relative Humidity Range 2 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of relative_humidity_range_2_lower_limit or None if not set
Return type:	float

relative_humidity_range_2_upper_limit¶

field Relative Humidity Range 2 Upper Limit

Units: percent

value <= 100.0

Parameters:	value (float) – value for IDD Field Relative Humidity Range 2 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of relative_humidity_range_2_upper_limit or None if not set
Return type:	float

relative_humidity_range_3_lower_limit¶

field Relative Humidity Range 3 Lower Limit

Units: percent

value <= 100.0

Parameters:	value (float) – value for IDD Field Relative Humidity Range 3 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of relative_humidity_range_3_lower_limit or None if not set
Return type:	float

relative_humidity_range_3_upper_limit¶

field Relative Humidity Range 3 Upper Limit

Units: percent

value <= 100.0

Parameters:	value (float) – value for IDD Field Relative Humidity Range 3 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of relative_humidity_range_3_upper_limit or None if not set
Return type:	float

relative_humidity_range_4_lower_limit¶

field Relative Humidity Range 4 Lower Limit

Units: percent

value <= 100.0

Parameters:	value (float) – value for IDD Field Relative Humidity Range 4 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of relative_humidity_range_4_lower_limit or None if not set
Return type:	float

relative_humidity_range_4_upper_limit¶

field Relative Humidity Range 4 Upper Limit

Units: percent

value <= 100.0

Parameters:	value (float) – value for IDD Field Relative Humidity Range 4 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of relative_humidity_range_4_upper_limit or None if not set
Return type:	float

relative_humidity_range_5_lower_limit¶

field Relative Humidity Range 5 Lower Limit

Units: percent

value <= 100.0

Parameters:	value (float) – value for IDD Field Relative Humidity Range 5 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of relative_humidity_range_5_lower_limit or None if not set
Return type:	float

relative_humidity_range_5_upper_limit¶

field Relative Humidity Range 5 Upper Limit

Units: percent

value <= 100.0

Parameters:	value (float) – value for IDD Field Relative Humidity Range 5 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of relative_humidity_range_5_upper_limit or None if not set
Return type:	float

relative_humidity_range_6_lower_limit¶

field Relative Humidity Range 6 Lower Limit

Units: percent

value <= 100.0

Parameters:	value (float) – value for IDD Field Relative Humidity Range 6 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of relative_humidity_range_6_lower_limit or None if not set
Return type:	float

relative_humidity_range_6_upper_limit¶

field Relative Humidity Range 6 Upper Limit

Units: percent

value <= 100.0

Parameters:	value (float) – value for IDD Field Relative Humidity Range 6 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of relative_humidity_range_6_upper_limit or None if not set
Return type:	float

relative_humidity_range_7_lower_limit¶

field Relative Humidity Range 7 Lower Limit

Units: percent

value <= 100.0

Parameters:	value (float) – value for IDD Field Relative Humidity Range 7 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of relative_humidity_range_7_lower_limit or None if not set
Return type:	float

relative_humidity_range_7_upper_limit¶

field Relative Humidity Range 7 Upper Limit

Units: percent

value <= 100.0

Parameters:	value (float) – value for IDD Field Relative Humidity Range 7 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of relative_humidity_range_7_upper_limit or None if not set
Return type:	float

relative_humidity_range_8_lower_limit¶

field Relative Humidity Range 8 Lower Limit

Units: percent

value <= 100.0

Parameters:	value (float) – value for IDD Field Relative Humidity Range 8 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of relative_humidity_range_8_lower_limit or None if not set
Return type:	float

relative_humidity_range_8_upper_limit¶

field Relative Humidity Range 8 Upper Limit

Units: percent

value <= 100.0

Parameters:	value (float) – value for IDD Field Relative Humidity Range 8 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of relative_humidity_range_8_upper_limit or None if not set
Return type:	float

relative_humidity_range_9_lower_limit¶

field Relative Humidity Range 9 Lower Limit

Units: percent

value <= 100.0

Parameters:	value (float) – value for IDD Field Relative Humidity Range 9 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of relative_humidity_range_9_lower_limit or None if not set
Return type:	float

relative_humidity_range_9_upper_limit¶

field Relative Humidity Range 9 Upper Limit

Units: percent

value <= 100.0

Parameters:	value (float) – value for IDD Field Relative Humidity Range 9 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of relative_humidity_range_9_upper_limit or None if not set
Return type:	float

class pyidf.plant.PlantEquipmentOperationOutdoorWetBulb¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object PlantEquipmentOperation:OutdoorWetBulb Plant equipment operation scheme for outdoor wet-bulb temperature range operation. Specifies one or more groups of equipment which are available to operate for successive outdoor wet-bulb temperature ranges.

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

range_10_equipment_list_name¶

field Range 10 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 10 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_10_equipment_list_name or None if not set
Return type:	str

range_1_equipment_list_name¶

field Range 1 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 1 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_1_equipment_list_name or None if not set
Return type:	str

range_2_equipment_list_name¶

field Range 2 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 2 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_2_equipment_list_name or None if not set
Return type:	str

range_3_equipment_list_name¶

field Range 3 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 3 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_3_equipment_list_name or None if not set
Return type:	str

range_4_equipment_list_name¶

field Range 4 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 4 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_4_equipment_list_name or None if not set
Return type:	str

range_5_equipment_list_name¶

field Range 5 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 5 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_5_equipment_list_name or None if not set
Return type:	str

range_6_equipment_list_name¶

field Range 6 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 6 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_6_equipment_list_name or None if not set
Return type:	str

range_7_equipment_list_name¶

field Range 7 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 7 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_7_equipment_list_name or None if not set
Return type:	str

range_8_equipment_list_name¶

field Range 8 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 8 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_8_equipment_list_name or None if not set
Return type:	str

range_9_equipment_list_name¶

field Range 9 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 9 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_9_equipment_list_name or None if not set
Return type:	str

wetbulb_temperature_range_10_lower_limit¶

field Wet-Bulb Temperature Range 10 Lower Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Wet-Bulb Temperature Range 10 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of wetbulb_temperature_range_10_lower_limit or None if not set
Return type:	float

wetbulb_temperature_range_10_upper_limit¶

field Wet-Bulb Temperature Range 10 Upper Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Wet-Bulb Temperature Range 10 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of wetbulb_temperature_range_10_upper_limit or None if not set
Return type:	float

wetbulb_temperature_range_1_lower_limit¶

field Wet-Bulb Temperature Range 1 Lower Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Wet-Bulb Temperature Range 1 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of wetbulb_temperature_range_1_lower_limit or None if not set
Return type:	float

wetbulb_temperature_range_1_upper_limit¶

field Wet-Bulb Temperature Range 1 Upper Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Wet-Bulb Temperature Range 1 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of wetbulb_temperature_range_1_upper_limit or None if not set
Return type:	float

wetbulb_temperature_range_2_lower_limit¶

field Wet-Bulb Temperature Range 2 Lower Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Wet-Bulb Temperature Range 2 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of wetbulb_temperature_range_2_lower_limit or None if not set
Return type:	float

wetbulb_temperature_range_2_upper_limit¶

field Wet-Bulb Temperature Range 2 Upper Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Wet-Bulb Temperature Range 2 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of wetbulb_temperature_range_2_upper_limit or None if not set
Return type:	float

wetbulb_temperature_range_3_lower_limit¶

field Wet-Bulb Temperature Range 3 Lower Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Wet-Bulb Temperature Range 3 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of wetbulb_temperature_range_3_lower_limit or None if not set
Return type:	float

wetbulb_temperature_range_3_upper_limit¶

field Wet-Bulb Temperature Range 3 Upper Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Wet-Bulb Temperature Range 3 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of wetbulb_temperature_range_3_upper_limit or None if not set
Return type:	float

wetbulb_temperature_range_4_lower_limit¶

field Wet-Bulb Temperature Range 4 Lower Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Wet-Bulb Temperature Range 4 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of wetbulb_temperature_range_4_lower_limit or None if not set
Return type:	float

wetbulb_temperature_range_4_upper_limit¶

field Wet-Bulb Temperature Range 4 Upper Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Wet-Bulb Temperature Range 4 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of wetbulb_temperature_range_4_upper_limit or None if not set
Return type:	float

wetbulb_temperature_range_5_lower_limit¶

field Wet-Bulb Temperature Range 5 Lower Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Wet-Bulb Temperature Range 5 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of wetbulb_temperature_range_5_lower_limit or None if not set
Return type:	float

wetbulb_temperature_range_5_upper_limit¶

field Wet-Bulb Temperature Range 5 Upper Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Wet-Bulb Temperature Range 5 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of wetbulb_temperature_range_5_upper_limit or None if not set
Return type:	float

wetbulb_temperature_range_6_lower_limit¶

field Wet-Bulb Temperature Range 6 Lower Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Wet-Bulb Temperature Range 6 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of wetbulb_temperature_range_6_lower_limit or None if not set
Return type:	float

wetbulb_temperature_range_6_upper_limit¶

field Wet-Bulb Temperature Range 6 Upper Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Wet-Bulb Temperature Range 6 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of wetbulb_temperature_range_6_upper_limit or None if not set
Return type:	float

wetbulb_temperature_range_7_lower_limit¶

field Wet-Bulb Temperature Range 7 Lower Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Wet-Bulb Temperature Range 7 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of wetbulb_temperature_range_7_lower_limit or None if not set
Return type:	float

wetbulb_temperature_range_7_upper_limit¶

field Wet-Bulb Temperature Range 7 Upper Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Wet-Bulb Temperature Range 7 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of wetbulb_temperature_range_7_upper_limit or None if not set
Return type:	float

wetbulb_temperature_range_8_lower_limit¶

field Wet-Bulb Temperature Range 8 Lower Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Wet-Bulb Temperature Range 8 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of wetbulb_temperature_range_8_lower_limit or None if not set
Return type:	float

wetbulb_temperature_range_8_upper_limit¶

field Wet-Bulb Temperature Range 8 Upper Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Wet-Bulb Temperature Range 8 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of wetbulb_temperature_range_8_upper_limit or None if not set
Return type:	float

wetbulb_temperature_range_9_lower_limit¶

field Wet-Bulb Temperature Range 9 Lower Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Wet-Bulb Temperature Range 9 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of wetbulb_temperature_range_9_lower_limit or None if not set
Return type:	float

wetbulb_temperature_range_9_upper_limit¶

field Wet-Bulb Temperature Range 9 Upper Limit

Units: C
value >= -70.0
value <= 70.0

Parameters:	value (float) – value for IDD Field Wet-Bulb Temperature Range 9 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of wetbulb_temperature_range_9_upper_limit or None if not set
Return type:	float

class pyidf.plant.PlantEquipmentOperationOutdoorWetBulbDifference¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object PlantEquipmentOperation:OutdoorWetBulbDifference Plant equipment operation scheme for outdoor wet-bulb temperature difference operation. Specifies one or more groups of equipment which are available to operate for successive ranges based the difference between a reference node temperature and the outdoor wet-bulb temperature.

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

range_10_equipment_list_name¶

field Range 10 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 10 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_10_equipment_list_name or None if not set
Return type:	str

range_1_equipment_list_name¶

field Range 1 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 1 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_1_equipment_list_name or None if not set
Return type:	str

range_2_equipment_list_name¶

field Range 2 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 2 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_2_equipment_list_name or None if not set
Return type:	str

range_3_equipment_list_name¶

field Range 3 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 3 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_3_equipment_list_name or None if not set
Return type:	str

range_4_equipment_list_name¶

field Range 4 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 4 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_4_equipment_list_name or None if not set
Return type:	str

range_5_equipment_list_name¶

field Range 5 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 5 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_5_equipment_list_name or None if not set
Return type:	str

range_6_equipment_list_name¶

field Range 6 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 6 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_6_equipment_list_name or None if not set
Return type:	str

range_7_equipment_list_name¶

field Range 7 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 7 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_7_equipment_list_name or None if not set
Return type:	str

range_8_equipment_list_name¶

field Range 8 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 8 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_8_equipment_list_name or None if not set
Return type:	str

range_9_equipment_list_name¶

field Range 9 Equipment List Name

Parameters:	value (str) – value for IDD Field Range 9 Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of range_9_equipment_list_name or None if not set
Return type:	str

reference_temperature_node_name¶

field Reference Temperature Node Name

Parameters:	value (str) – value for IDD Field Reference Temperature Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of reference_temperature_node_name or None if not set
Return type:	str

wetbulb_temperature_difference_range_10_lower_limit¶

field Wet-Bulb Temperature Difference Range 10 Lower Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Wet-Bulb Temperature Difference Range 10 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of wetbulb_temperature_difference_range_10_lower_limit or None if not set
Return type:	float

wetbulb_temperature_difference_range_10_upper_limit¶

field Wet-Bulb Temperature Difference Range 10 Upper Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Wet-Bulb Temperature Difference Range 10 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of wetbulb_temperature_difference_range_10_upper_limit or None if not set
Return type:	float

wetbulb_temperature_difference_range_1_lower_limit¶

field Wet-Bulb Temperature Difference Range 1 Lower Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Wet-Bulb Temperature Difference Range 1 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of wetbulb_temperature_difference_range_1_lower_limit or None if not set
Return type:	float

wetbulb_temperature_difference_range_1_upper_limit¶

field Wet-Bulb Temperature Difference Range 1 Upper Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Wet-Bulb Temperature Difference Range 1 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of wetbulb_temperature_difference_range_1_upper_limit or None if not set
Return type:	float

wetbulb_temperature_difference_range_2_lower_limit¶

field Wet-Bulb Temperature Difference Range 2 Lower Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Wet-Bulb Temperature Difference Range 2 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of wetbulb_temperature_difference_range_2_lower_limit or None if not set
Return type:	float

wetbulb_temperature_difference_range_2_upper_limit¶

field Wet-Bulb Temperature Difference Range 2 Upper Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Wet-Bulb Temperature Difference Range 2 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of wetbulb_temperature_difference_range_2_upper_limit or None if not set
Return type:	float

wetbulb_temperature_difference_range_3_lower_limit¶

field Wet-Bulb Temperature Difference Range 3 Lower Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Wet-Bulb Temperature Difference Range 3 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of wetbulb_temperature_difference_range_3_lower_limit or None if not set
Return type:	float

wetbulb_temperature_difference_range_3_upper_limit¶

field Wet-Bulb Temperature Difference Range 3 Upper Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Wet-Bulb Temperature Difference Range 3 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of wetbulb_temperature_difference_range_3_upper_limit or None if not set
Return type:	float

wetbulb_temperature_difference_range_4_lower_limit¶

field Wet-Bulb Temperature Difference Range 4 Lower Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Wet-Bulb Temperature Difference Range 4 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of wetbulb_temperature_difference_range_4_lower_limit or None if not set
Return type:	float

wetbulb_temperature_difference_range_4_upper_limit¶

field Wet-Bulb Temperature Difference Range 4 Upper Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Wet-Bulb Temperature Difference Range 4 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of wetbulb_temperature_difference_range_4_upper_limit or None if not set
Return type:	float

wetbulb_temperature_difference_range_5_lower_limit¶

field Wet-Bulb Temperature Difference Range 5 Lower Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Wet-Bulb Temperature Difference Range 5 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of wetbulb_temperature_difference_range_5_lower_limit or None if not set
Return type:	float

wetbulb_temperature_difference_range_5_upper_limit¶

field Wet-Bulb Temperature Difference Range 5 Upper Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Wet-Bulb Temperature Difference Range 5 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of wetbulb_temperature_difference_range_5_upper_limit or None if not set
Return type:	float

wetbulb_temperature_difference_range_6_lower_limit¶

field Wet-Bulb Temperature Difference Range 6 Lower Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Wet-Bulb Temperature Difference Range 6 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of wetbulb_temperature_difference_range_6_lower_limit or None if not set
Return type:	float

wetbulb_temperature_difference_range_6_upper_limit¶

field Wet-Bulb Temperature Difference Range 6 Upper Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Wet-Bulb Temperature Difference Range 6 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of wetbulb_temperature_difference_range_6_upper_limit or None if not set
Return type:	float

wetbulb_temperature_difference_range_7_lower_limit¶

field Wet-Bulb Temperature Difference Range 7 Lower Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Wet-Bulb Temperature Difference Range 7 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of wetbulb_temperature_difference_range_7_lower_limit or None if not set
Return type:	float

wetbulb_temperature_difference_range_7_upper_limit¶

field Wet-Bulb Temperature Difference Range 7 Upper Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Wet-Bulb Temperature Difference Range 7 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of wetbulb_temperature_difference_range_7_upper_limit or None if not set
Return type:	float

wetbulb_temperature_difference_range_8_lower_limit¶

field Wet-Bulb Temperature Difference Range 8 Lower Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Wet-Bulb Temperature Difference Range 8 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of wetbulb_temperature_difference_range_8_lower_limit or None if not set
Return type:	float

wetbulb_temperature_difference_range_8_upper_limit¶

field Wet-Bulb Temperature Difference Range 8 Upper Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Wet-Bulb Temperature Difference Range 8 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of wetbulb_temperature_difference_range_8_upper_limit or None if not set
Return type:	float

wetbulb_temperature_difference_range_9_lower_limit¶

field Wet-Bulb Temperature Difference Range 9 Lower Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Wet-Bulb Temperature Difference Range 9 Lower Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of wetbulb_temperature_difference_range_9_lower_limit or None if not set
Return type:	float

wetbulb_temperature_difference_range_9_upper_limit¶

field Wet-Bulb Temperature Difference Range 9 Upper Limit

Units: deltaC
value >= -50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Wet-Bulb Temperature Difference Range 9 Upper Limit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of wetbulb_temperature_difference_range_9_upper_limit or None if not set
Return type:	float

class pyidf.plant.PlantEquipmentOperationSchemes¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object PlantEquipmentOperationSchemes Operation schemes are listed in “priority” order. Note that each scheme must address the entire load and/or condition ranges for the simulation. The actual one selected for use will be the first that is “Scheduled” on. That is, if control scheme 1 is not “on” and control scheme 2 is – then control scheme 2 is selected. Only plant equipment should be listed on a Control Scheme for this item.

control_scheme_1_name¶

field Control Scheme 1 Name

Parameters:	value (str) – value for IDD Field Control Scheme 1 Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of control_scheme_1_name or None if not set
Return type:	str

control_scheme_1_object_type¶

field Control Scheme 1 Object Type

Parameters:	value (str) – value for IDD Field Control Scheme 1 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of control_scheme_1_object_type or None if not set
Return type:	str

control_scheme_1_schedule_name¶

field Control Scheme 1 Schedule Name

Parameters:	value (str) – value for IDD Field Control Scheme 1 Schedule Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of control_scheme_1_schedule_name or None if not set
Return type:	str

control_scheme_2_name¶

field Control Scheme 2 Name

Parameters:	value (str) – value for IDD Field Control Scheme 2 Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of control_scheme_2_name or None if not set
Return type:	str

control_scheme_2_object_type¶

field Control Scheme 2 Object Type

Parameters:	value (str) – value for IDD Field Control Scheme 2 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of control_scheme_2_object_type or None if not set
Return type:	str

control_scheme_2_schedule_name¶

field Control Scheme 2 Schedule Name

Parameters:	value (str) – value for IDD Field Control Scheme 2 Schedule Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of control_scheme_2_schedule_name or None if not set
Return type:	str

control_scheme_3_name¶

field Control Scheme 3 Name

Parameters:	value (str) – value for IDD Field Control Scheme 3 Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of control_scheme_3_name or None if not set
Return type:	str

control_scheme_3_object_type¶

field Control Scheme 3 Object Type

Parameters:	value (str) – value for IDD Field Control Scheme 3 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of control_scheme_3_object_type or None if not set
Return type:	str

control_scheme_3_schedule_name¶

field Control Scheme 3 Schedule Name

Parameters:	value (str) – value for IDD Field Control Scheme 3 Schedule Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of control_scheme_3_schedule_name or None if not set
Return type:	str

control_scheme_4_name¶

field Control Scheme 4 Name

Parameters:	value (str) – value for IDD Field Control Scheme 4 Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of control_scheme_4_name or None if not set
Return type:	str

control_scheme_4_object_type¶

field Control Scheme 4 Object Type

Parameters:	value (str) – value for IDD Field Control Scheme 4 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of control_scheme_4_object_type or None if not set
Return type:	str

control_scheme_4_schedule_name¶

field Control Scheme 4 Schedule Name

Parameters:	value (str) – value for IDD Field Control Scheme 4 Schedule Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of control_scheme_4_schedule_name or None if not set
Return type:	str

control_scheme_5_name¶

field Control Scheme 5 Name

Parameters:	value (str) – value for IDD Field Control Scheme 5 Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of control_scheme_5_name or None if not set
Return type:	str

control_scheme_5_object_type¶

field Control Scheme 5 Object Type

Parameters:	value (str) – value for IDD Field Control Scheme 5 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of control_scheme_5_object_type or None if not set
Return type:	str

control_scheme_5_schedule_name¶

field Control Scheme 5 Schedule Name

Parameters:	value (str) – value for IDD Field Control Scheme 5 Schedule Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of control_scheme_5_schedule_name or None if not set
Return type:	str

control_scheme_6_name¶

field Control Scheme 6 Name

Parameters:	value (str) – value for IDD Field Control Scheme 6 Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of control_scheme_6_name or None if not set
Return type:	str

control_scheme_6_object_type¶

field Control Scheme 6 Object Type

Parameters:	value (str) – value for IDD Field Control Scheme 6 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of control_scheme_6_object_type or None if not set
Return type:	str

control_scheme_6_schedule_name¶

field Control Scheme 6 Schedule Name

Parameters:	value (str) – value for IDD Field Control Scheme 6 Schedule Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of control_scheme_6_schedule_name or None if not set
Return type:	str

control_scheme_7_name¶

field Control Scheme 7 Name

Parameters:	value (str) – value for IDD Field Control Scheme 7 Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of control_scheme_7_name or None if not set
Return type:	str

control_scheme_7_object_type¶

field Control Scheme 7 Object Type

Parameters:	value (str) – value for IDD Field Control Scheme 7 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of control_scheme_7_object_type or None if not set
Return type:	str

control_scheme_7_schedule_name¶

field Control Scheme 7 Schedule Name

Parameters:	value (str) – value for IDD Field Control Scheme 7 Schedule Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of control_scheme_7_schedule_name or None if not set
Return type:	str

control_scheme_8_name¶

field Control Scheme 8 Name

Parameters:	value (str) – value for IDD Field Control Scheme 8 Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of control_scheme_8_name or None if not set
Return type:	str

control_scheme_8_object_type¶

field Control Scheme 8 Object Type

Parameters:	value (str) – value for IDD Field Control Scheme 8 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of control_scheme_8_object_type or None if not set
Return type:	str

control_scheme_8_schedule_name¶

field Control Scheme 8 Schedule Name

Parameters:	value (str) – value for IDD Field Control Scheme 8 Schedule Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of control_scheme_8_schedule_name 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

class pyidf.plant.PlantEquipmentOperationThermalEnergyStorage¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object PlantEquipmentOperation:ThermalEnergyStorage Plant equipment operation scheme for simpler input to control thermal (ice) energy storage systems. It replaces a host of setpoint managers with simple, single input values. For more complex controls, use the ComponentSetpoint scheme.

charging_availability_schedule¶

field Charging Availability Schedule

Parameters:	value (str) – value for IDD Field Charging Availability Schedule
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of charging_availability_schedule or None if not set
Return type:	str

charging_chilled_water_temperature¶

field Charging Chilled Water Temperature

Single temperature for chiller outlet when off-peak during cooling
season (charging)
Units: C

Parameters:	value (float) – value for IDD Field Charging Chilled Water Temperature
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of charging_chilled_water_temperature or None if not set
Return type:	float

component_10_demand_calculation_node_name¶

field Component 10 Demand Calculation Node Name

Parameters:	value (str) – value for IDD Field Component 10 Demand Calculation Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_10_demand_calculation_node_name or None if not set
Return type:	str

component_10_flow_rate¶

field Component 10 Flow Rate

Units: m3/s

Parameters:	value (float or “Autosize”) – value for IDD Field Component 10 Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_10_flow_rate or None if not set
Return type:	float or “Autosize”

component_10_name¶

field Component 10 Name

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

component_10_object_type¶

field Component 10 Object Type

Parameters:	value (str) – value for IDD Field Component 10 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_10_object_type or None if not set
Return type:	str

component_10_operation_type¶

field Component 10 Operation Type

Parameters:	value (str) – value for IDD Field Component 10 Operation Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_10_operation_type or None if not set
Return type:	str

component_10_setpoint_node_name¶

field Component 10 Setpoint Node Name

Parameters:	value (str) – value for IDD Field Component 10 Setpoint Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_10_setpoint_node_name or None if not set
Return type:	str

component_1_demand_calculation_node_name¶

field Component 1 Demand Calculation Node Name

This field is the name of the inlet node for the component defined in

the two previous input fields.

Parameters:	value (str) – value for IDD Field Component 1 Demand Calculation Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_1_demand_calculation_node_name or None if not set
Return type:	str

component_1_flow_rate¶

field Component 1 Flow Rate

This field is the flow rate for the component listed above.

Units: m3/s

Parameters:	value (float or “Autosize”) – value for IDD Field Component 1 Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_1_flow_rate or None if not set
Return type:	float or “Autosize”

component_1_name¶

field Component 1 Name

This field is the name of either the chiller or ice storage equipment

on the loop.

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

component_1_object_type¶

field Component 1 Object Type

This field is the type of object and should either be a chiller or some

ice storage equipment.

Parameters:	value (str) – value for IDD Field Component 1 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_1_object_type or None if not set
Return type:	str

component_1_operation_type¶

field Component 1 Operation Type

This field is the operation type for the component listed above.  For this
plant equipment operation scheme, “Cooling” should be selected for chiller
equipment while ice storage equipment should be defined as “Dual”.

Parameters:	value (str) – value for IDD Field Component 1 Operation Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_1_operation_type or None if not set
Return type:	str

component_1_setpoint_node_name¶

field Component 1 Setpoint Node Name

This field is the name of the outlet node for the component listed above.

Parameters:	value (str) – value for IDD Field Component 1 Setpoint Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_1_setpoint_node_name or None if not set
Return type:	str

component_2_demand_calculation_node_name¶

field Component 2 Demand Calculation Node Name

Parameters:	value (str) – value for IDD Field Component 2 Demand Calculation Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_2_demand_calculation_node_name or None if not set
Return type:	str

component_2_flow_rate¶

field Component 2 Flow Rate

Units: m3/s

Parameters:	value (float or “Autosize”) – value for IDD Field Component 2 Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_2_flow_rate or None if not set
Return type:	float or “Autosize”

component_2_name¶

field Component 2 Name

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

component_2_object_type¶

field Component 2 Object Type

Parameters:	value (str) – value for IDD Field Component 2 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_2_object_type or None if not set
Return type:	str

component_2_operation_type¶

field Component 2 Operation Type

Parameters:	value (str) – value for IDD Field Component 2 Operation Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_2_operation_type or None if not set
Return type:	str

component_2_setpoint_node_name¶

field Component 2 Setpoint Node Name

Parameters:	value (str) – value for IDD Field Component 2 Setpoint Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_2_setpoint_node_name or None if not set
Return type:	str

component_3_demand_calculation_node_name¶

field Component 3 Demand Calculation Node Name

Parameters:	value (str) – value for IDD Field Component 3 Demand Calculation Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_3_demand_calculation_node_name or None if not set
Return type:	str

component_3_flow_rate¶

field Component 3 Flow Rate

Units: m3/s

Parameters:	value (float or “Autosize”) – value for IDD Field Component 3 Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_3_flow_rate or None if not set
Return type:	float or “Autosize”

component_3_name¶

field Component 3 Name

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

component_3_object_type¶

field Component 3 Object Type

Parameters:	value (str) – value for IDD Field Component 3 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_3_object_type or None if not set
Return type:	str

component_3_operation_type¶

field Component 3 Operation Type

Parameters:	value (str) – value for IDD Field Component 3 Operation Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_3_operation_type or None if not set
Return type:	str

component_3_setpoint_node_name¶

field Component 3 Setpoint Node Name

Parameters:	value (str) – value for IDD Field Component 3 Setpoint Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_3_setpoint_node_name or None if not set
Return type:	str

component_4_demand_calculation_node_name¶

field Component 4 Demand Calculation Node Name

Parameters:	value (str) – value for IDD Field Component 4 Demand Calculation Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_4_demand_calculation_node_name or None if not set
Return type:	str

component_4_flow_rate¶

field Component 4 Flow Rate

Units: m3/s

Parameters:	value (float or “Autosize”) – value for IDD Field Component 4 Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_4_flow_rate or None if not set
Return type:	float or “Autosize”

component_4_name¶

field Component 4 Name

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

component_4_object_type¶

field Component 4 Object Type

Parameters:	value (str) – value for IDD Field Component 4 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_4_object_type or None if not set
Return type:	str

component_4_operation_type¶

field Component 4 Operation Type

Parameters:	value (str) – value for IDD Field Component 4 Operation Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_4_operation_type or None if not set
Return type:	str

component_4_setpoint_node_name¶

field Component 4 Setpoint Node Name

Parameters:	value (str) – value for IDD Field Component 4 Setpoint Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_4_setpoint_node_name or None if not set
Return type:	str

component_5_demand_calculation_node_name¶

field Component 5 Demand Calculation Node Name

Parameters:	value (str) – value for IDD Field Component 5 Demand Calculation Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_5_demand_calculation_node_name or None if not set
Return type:	str

component_5_flow_rate¶

field Component 5 Flow Rate

Units: m3/s

Parameters:	value (float or “Autosize”) – value for IDD Field Component 5 Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_5_flow_rate or None if not set
Return type:	float or “Autosize”

component_5_name¶

field Component 5 Name

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

component_5_object_type¶

field Component 5 Object Type

Parameters:	value (str) – value for IDD Field Component 5 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_5_object_type or None if not set
Return type:	str

component_5_operation_type¶

field Component 5 Operation Type

Parameters:	value (str) – value for IDD Field Component 5 Operation Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_5_operation_type or None if not set
Return type:	str

component_5_setpoint_node_name¶

field Component 5 Setpoint Node Name

Parameters:	value (str) – value for IDD Field Component 5 Setpoint Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_5_setpoint_node_name or None if not set
Return type:	str

component_6_demand_calculation_node_name¶

field Component 6 Demand Calculation Node Name

Parameters:	value (str) – value for IDD Field Component 6 Demand Calculation Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_6_demand_calculation_node_name or None if not set
Return type:	str

component_6_flow_rate¶

field Component 6 Flow Rate

Units: m3/s

Parameters:	value (float or “Autosize”) – value for IDD Field Component 6 Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_6_flow_rate or None if not set
Return type:	float or “Autosize”

component_6_name¶

field Component 6 Name

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

component_6_object_type¶

field Component 6 Object Type

Parameters:	value (str) – value for IDD Field Component 6 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_6_object_type or None if not set
Return type:	str

component_6_operation_type¶

field Component 6 Operation Type

Parameters:	value (str) – value for IDD Field Component 6 Operation Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_6_operation_type or None if not set
Return type:	str

component_6_setpoint_node_name¶

field Component 6 Setpoint Node Name

Parameters:	value (str) – value for IDD Field Component 6 Setpoint Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_6_setpoint_node_name or None if not set
Return type:	str

component_7_demand_calculation_node_name¶

field Component 7 Demand Calculation Node Name

Parameters:	value (str) – value for IDD Field Component 7 Demand Calculation Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_7_demand_calculation_node_name or None if not set
Return type:	str

component_7_flow_rate¶

field Component 7 Flow Rate

Units: m3/s

Parameters:	value (float or “Autosize”) – value for IDD Field Component 7 Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_7_flow_rate or None if not set
Return type:	float or “Autosize”

component_7_name¶

field Component 7 Name

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

component_7_object_type¶

field Component 7 Object Type

Parameters:	value (str) – value for IDD Field Component 7 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_7_object_type or None if not set
Return type:	str

component_7_operation_type¶

field Component 7 Operation Type

Parameters:	value (str) – value for IDD Field Component 7 Operation Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_7_operation_type or None if not set
Return type:	str

component_7_setpoint_node_name¶

field Component 7 Setpoint Node Name

Parameters:	value (str) – value for IDD Field Component 7 Setpoint Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_7_setpoint_node_name or None if not set
Return type:	str

component_8_demand_calculation_node_name¶

field Component 8 Demand Calculation Node Name

Parameters:	value (str) – value for IDD Field Component 8 Demand Calculation Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_8_demand_calculation_node_name or None if not set
Return type:	str

component_8_flow_rate¶

field Component 8 Flow Rate

Units: m3/s

Parameters:	value (float or “Autosize”) – value for IDD Field Component 8 Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_8_flow_rate or None if not set
Return type:	float or “Autosize”

component_8_name¶

field Component 8 Name

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

component_8_object_type¶

field Component 8 Object Type

Parameters:	value (str) – value for IDD Field Component 8 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_8_object_type or None if not set
Return type:	str

component_8_operation_type¶

field Component 8 Operation Type

Parameters:	value (str) – value for IDD Field Component 8 Operation Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_8_operation_type or None if not set
Return type:	str

component_8_setpoint_node_name¶

field Component 8 Setpoint Node Name

Parameters:	value (str) – value for IDD Field Component 8 Setpoint Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_8_setpoint_node_name or None if not set
Return type:	str

component_9_demand_calculation_node_name¶

field Component 9 Demand Calculation Node Name

Parameters:	value (str) – value for IDD Field Component 9 Demand Calculation Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_9_demand_calculation_node_name or None if not set
Return type:	str

component_9_flow_rate¶

field Component 9 Flow Rate

Units: m3/s

Parameters:	value (float or “Autosize”) – value for IDD Field Component 9 Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_9_flow_rate or None if not set
Return type:	float or “Autosize”

component_9_name¶

field Component 9 Name

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

component_9_object_type¶

field Component 9 Object Type

Parameters:	value (str) – value for IDD Field Component 9 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_9_object_type or None if not set
Return type:	str

component_9_operation_type¶

field Component 9 Operation Type

Parameters:	value (str) – value for IDD Field Component 9 Operation Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_9_operation_type or None if not set
Return type:	str

component_9_setpoint_node_name¶

field Component 9 Setpoint Node Name

Parameters:	value (str) – value for IDD Field Component 9 Setpoint Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of component_9_setpoint_node_name 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

noncharging_chilled_water_temperature¶

field Non-Charging Chilled Water Temperature

Single temperature for chiller outlet when not in cooling season
or during on-peak cooling (discharge)
Units: C

Parameters:	value (float) – value for IDD Field Non-Charging Chilled Water Temperature
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of noncharging_chilled_water_temperature or None if not set
Return type:	float

onpeak_schedule¶

field On-Peak Schedule

Parameters:	value (str) – value for IDD Field On-Peak Schedule
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of onpeak_schedule or None if not set
Return type:	str

class pyidf.plant.PlantEquipmentOperationUncontrolled¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object PlantEquipmentOperation:Uncontrolled Plant equipment operation scheme for uncontrolled operation. Specifies a group of equipment that runs if the loop is active, unless turned off by the loop flow resolver to maintain continuity in the fluid loop.

equipment_list_name¶

field Equipment List Name

Parameters:	value (str) – value for IDD Field Equipment List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of equipment_list_name 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

class pyidf.plant.PlantLoop¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object PlantLoop Defines a central plant loop.

availability_manager_list_name¶

field Availability Manager List Name

Parameters:	value (str) – value for IDD Field Availability Manager List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of availability_manager_list_name or None if not set
Return type:	str

common_pipe_simulation¶

field Common Pipe Simulation

Specifies a primary-secondary loop configuration. The plant side is the
primary loop, and the demand side is the secondary loop.
A secondary supply pump is required on the demand side.
None = Primary-only, no secondary simulation
CommonPipe = Primary-secondary with no temperature control at primary-secondary interface
TwoWayCommonPipe = Primary-secondary with control of secondary supply temperature or
primary return temperature (requires a setpoint be placed on the
plant side or demand side inlet node).
Default value: None

Parameters:	value (str) – value for IDD Field Common Pipe Simulation
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of common_pipe_simulation or None if not set
Return type:	str

demand_side_branch_list_name¶

field Demand Side Branch List Name

Parameters:	value (str) – value for IDD Field Demand Side Branch List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of demand_side_branch_list_name or None if not set
Return type:	str

demand_side_connector_list_name¶

field Demand Side Connector List Name

Parameters:	value (str) – value for IDD Field Demand Side Connector List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of demand_side_connector_list_name or None if not set
Return type:	str

demand_side_inlet_node_name¶

field Demand Side Inlet Node Name

Parameters:	value (str) – value for IDD Field Demand Side Inlet Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of demand_side_inlet_node_name or None if not set
Return type:	str

demand_side_outlet_node_name¶

field Demand Side Outlet Node Name

Parameters:	value (str) – value for IDD Field Demand Side Outlet Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of demand_side_outlet_node_name or None if not set
Return type:	str

fluid_type¶

field Fluid Type

Default value: Water

Parameters:	value (str) – value for IDD Field Fluid Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of fluid_type or None if not set
Return type:	str

load_distribution_scheme¶

field Load Distribution Scheme

Default value: SequentialLoad

Parameters:	value (str) – value for IDD Field Load Distribution Scheme
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of load_distribution_scheme or None if not set
Return type:	str

loop_temperature_setpoint_node_name¶

field Loop Temperature Setpoint Node Name

Parameters:	value (str) – value for IDD Field Loop Temperature Setpoint Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of loop_temperature_setpoint_node_name or None if not set
Return type:	str

maximum_loop_flow_rate¶

field Maximum Loop Flow Rate

Units: m3/s

IP-Units: gal/min

Parameters:	value (float or “Autosize”) – value for IDD Field Maximum Loop Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of maximum_loop_flow_rate or None if not set
Return type:	float or “Autosize”

maximum_loop_temperature¶

field Maximum Loop Temperature

Units: C

Parameters:	value (float) – value for IDD Field Maximum Loop Temperature
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of maximum_loop_temperature or None if not set
Return type:	float

minimum_loop_flow_rate¶

field Minimum Loop Flow Rate

Units: m3/s

IP-Units: gal/min

Parameters:	value (float) – value for IDD Field Minimum Loop Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of minimum_loop_flow_rate or None if not set
Return type:	float

minimum_loop_temperature¶

field Minimum Loop Temperature

Units: C

Parameters:	value (float) – value for IDD Field Minimum Loop Temperature
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of minimum_loop_temperature or None if not set
Return type:	float

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

plant_equipment_operation_scheme_name¶

field Plant Equipment Operation Scheme Name

Parameters:	value (str) – value for IDD Field Plant Equipment Operation Scheme Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of plant_equipment_operation_scheme_name or None if not set
Return type:	str

plant_loop_demand_calculation_scheme¶

field Plant Loop Demand Calculation Scheme

Default value: SingleSetpoint

Parameters:	value (str) – value for IDD Field Plant Loop Demand Calculation Scheme
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of plant_loop_demand_calculation_scheme or None if not set
Return type:	str

plant_loop_volume¶

field Plant Loop Volume

Units: m3
IP-Units: gal
Default value: “Autocalculate”

Parameters:	value (float or “Autocalculate”) – value for IDD Field Plant Loop Volume
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of plant_loop_volume or None if not set
Return type:	float or “Autocalculate”

plant_side_branch_list_name¶

field Plant Side Branch List Name

Parameters:	value (str) – value for IDD Field Plant Side Branch List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of plant_side_branch_list_name or None if not set
Return type:	str

plant_side_connector_list_name¶

field Plant Side Connector List Name

Parameters:	value (str) – value for IDD Field Plant Side Connector List Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of plant_side_connector_list_name or None if not set
Return type:	str

plant_side_inlet_node_name¶

field Plant Side Inlet Node Name

Parameters:	value (str) – value for IDD Field Plant Side Inlet Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of plant_side_inlet_node_name or None if not set
Return type:	str

plant_side_outlet_node_name¶

field Plant Side Outlet Node Name

Parameters:	value (str) – value for IDD Field Plant Side Outlet Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of plant_side_outlet_node_name or None if not set
Return type:	str

pressure_simulation_type¶

field Pressure Simulation Type

Default value: None

Parameters:	value (str) – value for IDD Field Pressure Simulation Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of pressure_simulation_type or None if not set
Return type:	str

user_defined_fluid_type¶

field User Defined Fluid Type

This field is only required when Fluid Type is UserDefinedFluidType

Parameters:	value (str) – value for IDD Field User Defined Fluid Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of user_defined_fluid_type or None if not set
Return type:	str

class pyidf.plant.TemperingValve¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object TemperingValve Temperature-controlled diversion valve used to divert flow around one or more plant components such as a hot water heater. It can only be used on one of two branches between a Splitter and a Mixer.

inlet_node_name¶

field Inlet Node Name

Name of a Node

Parameters:	value (str) – value for IDD Field Inlet Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of inlet_node_name 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

outlet_node_name¶

field Outlet Node Name

Name of a Node

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

pump_outlet_node_name¶

field Pump Outlet Node Name

Parameters:	value (str) – value for IDD Field Pump Outlet Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of pump_outlet_node_name or None if not set
Return type:	str

stream_2_source_node_name¶

field Stream 2 Source Node Name

Name of a Node

Parameters:	value (str) – value for IDD Field Stream 2 Source Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of stream_2_source_node_name or None if not set
Return type:	str

temperature_setpoint_node_name¶

field Temperature Setpoint Node Name

Name of a Node

Parameters:	value (str) – value for IDD Field Temperature Setpoint Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of temperature_setpoint_node_name or None if not set
Return type:	str

pyidf.plant module¶

Related Topics

This Page