pyidf.user_defined_hvac_and_plant_component_models module¶

Data objects in group “User Defined HVAC and Plant Component Models”

class pyidf.user_defined_hvac_and_plant_component_models.AirTerminalSingleDuctUserDefined¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirTerminal:SingleDuct:UserDefined Defines a generic single duct air terminal unit for custom modeling using Energy Management System or External Interface

ambient_zone_name¶

field Ambient Zone Name

Used for modeling device losses to surrounding zone

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

collection_outlet_water_storage_tank_name¶

field Collection Outlet Water Storage Tank Name

Water use storage tank for collection of condensate by device

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

model_setup_and_sizing_program_calling_manager_name¶

field Model Setup and Sizing Program Calling Manager Name

Parameters:	value (str) – value for IDD Field Model Setup and Sizing Program Calling Manager Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of model_setup_and_sizing_program_calling_manager_name or None if not set
Return type:	str

name¶

field Name

This is the name of the air terminal

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

number_of_plant_loop_connections¶

field Number of Plant Loop Connections

value <= 2

Parameters:	value (int) – value for IDD Field Number of Plant Loop Connections
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of number_of_plant_loop_connections or None if not set
Return type:	int

overall_model_simulation_program_calling_manager_name¶

field Overall Model Simulation Program Calling Manager Name

Parameters:	value (str) – value for IDD Field Overall Model Simulation Program Calling Manager Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of overall_model_simulation_program_calling_manager_name or None if not set
Return type:	str

plant_connection_1_inlet_node_name¶

field Plant Connection 1 Inlet Node Name

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

plant_connection_1_outlet_node_name¶

field Plant Connection 1 Outlet Node Name

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

plant_connection_2_inlet_node_name¶

field Plant Connection 2 Inlet Node Name

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

plant_connection_2_outlet_node_name¶

field Plant Connection 2 Outlet Node Name

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

primary_air_inlet_node_name¶

field Primary Air Inlet Node Name

Air inlet node for the unit must be a zone splitter outlet.

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

primary_air_outlet_node_name¶

field Primary Air Outlet Node Name

Air outlet node for the unit must be a zone air inlet node.

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

secondary_air_inlet_node_name¶

field Secondary Air Inlet Node Name

Inlet air used for heat rejection or air source

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

secondary_air_outlet_node_name¶

field Secondary Air Outlet Node Name

Outlet air used for heat rejection or air source

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

supply_inlet_water_storage_tank_name¶

field Supply Inlet Water Storage Tank Name

Water use storage tank for alternate source of water consumed by device

Parameters:	value (str) – value for IDD Field Supply Inlet Water Storage Tank Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of supply_inlet_water_storage_tank_name or None if not set
Return type:	str

class pyidf.user_defined_hvac_and_plant_component_models.CoilUserDefined¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object Coil:UserDefined Defines a generic air system component for custom modeling using Energy Management System or External Interface

air_connection_1_inlet_node_name¶

field Air Connection 1 Inlet Node Name

Inlet air for primary air stream

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

air_connection_1_outlet_node_name¶

field Air Connection 1 Outlet Node Name

Outlet air for primary air stream

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

air_connection_2_inlet_node_name¶

field Air Connection 2 Inlet Node Name

Inlet air for secondary air stream

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

air_connection_2_outlet_node_name¶

field Air Connection 2 Outlet Node Name

Outlet air for secondary air stream

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

ambient_zone_name¶

field Ambient Zone Name

Used for modeling device losses to surrounding zone

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

collection_outlet_water_storage_tank_name¶

field Collection Outlet Water Storage Tank Name

Water use storage tank for collection of condensate by device

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

model_setup_and_sizing_program_calling_manager_name¶

field Model Setup and Sizing Program Calling Manager Name

Parameters:	value (str) – value for IDD Field Model Setup and Sizing Program Calling Manager Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of model_setup_and_sizing_program_calling_manager_name or None if not set
Return type:	str

name¶

field Name

This is the name of the coil

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

number_of_air_connections¶

field Number of Air Connections

value >= 1

value <= 2

Parameters:	value (int) – value for IDD Field Number of Air Connections
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of number_of_air_connections or None if not set
Return type:	int

overall_model_simulation_program_calling_manager_name¶

field Overall Model Simulation Program Calling Manager Name

Parameters:	value (str) – value for IDD Field Overall Model Simulation Program Calling Manager Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of overall_model_simulation_program_calling_manager_name or None if not set
Return type:	str

plant_connection_inlet_node_name¶

field Plant Connection Inlet Node Name

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

plant_connection_is_used¶

field Plant Connection is Used

Parameters:	value (str) – value for IDD Field Plant Connection is Used
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of plant_connection_is_used or None if not set
Return type:	str

plant_connection_outlet_node_name¶

field Plant Connection Outlet Node Name

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

supply_inlet_water_storage_tank_name¶

field Supply Inlet Water Storage Tank Name

Water use storage tank for alternate source of water consumed by device

Parameters:	value (str) – value for IDD Field Supply Inlet Water Storage Tank Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of supply_inlet_water_storage_tank_name or None if not set
Return type:	str

class pyidf.user_defined_hvac_and_plant_component_models.PlantComponentUserDefined¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object PlantComponent:UserDefined Defines a generic plant component for custom modeling using Energy Management System or External Interface

air_connection_inlet_node_name¶

field Air Connection Inlet Node Name

Inlet air used for heat rejection or air source

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

air_connection_outlet_node_name¶

field Air Connection Outlet Node Name

Outlet air used for heat rejection or air source

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

ambient_zone_name¶

field Ambient Zone Name

Used for modeling device losses to surrounding zone

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

collection_outlet_water_storage_tank_name¶

field Collection Outlet Water Storage Tank Name

Water use storage tank for collection of condensate by device

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

main_model_program_calling_manager_name¶

field Main Model Program Calling Manager Name

Parameters:	value (str) – value for IDD Field Main Model Program Calling Manager Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of main_model_program_calling_manager_name or None if not set
Return type:	str

name¶

field Name

This is the name of the plant component

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

number_of_plant_loop_connections¶

field Number of Plant Loop Connections

value >= 1

value <= 4

Parameters:	value (int) – value for IDD Field Number of Plant Loop Connections
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of number_of_plant_loop_connections or None if not set
Return type:	int

plant_connection_1_initialization_program_calling_manager_name¶

field Plant Connection 1 Initialization Program Calling Manager Name

Parameters:	value (str) – value for IDD Field Plant Connection 1 Initialization Program Calling Manager Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of plant_connection_1_initialization_program_calling_manager_name or None if not set
Return type:	str

plant_connection_1_inlet_node_name¶

field Plant Connection 1 Inlet Node Name

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

plant_connection_1_loading_mode¶

field Plant Connection 1 Loading Mode

Parameters:	value (str) – value for IDD Field Plant Connection 1 Loading Mode
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of plant_connection_1_loading_mode or None if not set
Return type:	str

plant_connection_1_loop_flow_request_mode¶

field Plant Connection 1 Loop Flow Request Mode

Parameters:	value (str) – value for IDD Field Plant Connection 1 Loop Flow Request Mode
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of plant_connection_1_loop_flow_request_mode or None if not set
Return type:	str

plant_connection_1_outlet_node_name¶

field Plant Connection 1 Outlet Node Name

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

plant_connection_1_simulation_program_calling_manager_name¶

field Plant Connection 1 Simulation Program Calling Manager Name

Parameters:	value (str) – value for IDD Field Plant Connection 1 Simulation Program Calling Manager Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of plant_connection_1_simulation_program_calling_manager_name or None if not set
Return type:	str

plant_connection_2_initialization_program_calling_manager_name¶

field Plant Connection 2 Initialization Program Calling Manager Name

Parameters:	value (str) – value for IDD Field Plant Connection 2 Initialization Program Calling Manager Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of plant_connection_2_initialization_program_calling_manager_name or None if not set
Return type:	str

plant_connection_2_inlet_node_name¶

field Plant Connection 2 Inlet Node Name

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

plant_connection_2_loading_mode¶

field Plant Connection 2 Loading Mode

Parameters:	value (str) – value for IDD Field Plant Connection 2 Loading Mode
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of plant_connection_2_loading_mode or None if not set
Return type:	str

plant_connection_2_loop_flow_request_mode¶

field Plant Connection 2 Loop Flow Request Mode

Parameters:	value (str) – value for IDD Field Plant Connection 2 Loop Flow Request Mode
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of plant_connection_2_loop_flow_request_mode or None if not set
Return type:	str

plant_connection_2_outlet_node_name¶

field Plant Connection 2 Outlet Node Name

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

plant_connection_2_simulation_program_calling_manager_name¶

field Plant Connection 2 Simulation Program Calling Manager Name

Parameters:	value (str) – value for IDD Field Plant Connection 2 Simulation Program Calling Manager Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of plant_connection_2_simulation_program_calling_manager_name or None if not set
Return type:	str

plant_connection_3_initialization_program_calling_manager_name¶

field Plant Connection 3 Initialization Program Calling Manager Name

Parameters:	value (str) – value for IDD Field Plant Connection 3 Initialization Program Calling Manager Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of plant_connection_3_initialization_program_calling_manager_name or None if not set
Return type:	str

plant_connection_3_inlet_node_name¶

field Plant Connection 3 Inlet Node Name

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

plant_connection_3_loading_mode¶

field Plant Connection 3 Loading Mode

Parameters:	value (str) – value for IDD Field Plant Connection 3 Loading Mode
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of plant_connection_3_loading_mode or None if not set
Return type:	str

plant_connection_3_loop_flow_request_mode¶

field Plant Connection 3 Loop Flow Request Mode

Parameters:	value (str) – value for IDD Field Plant Connection 3 Loop Flow Request Mode
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of plant_connection_3_loop_flow_request_mode or None if not set
Return type:	str

plant_connection_3_outlet_node_name¶

field Plant Connection 3 Outlet Node Name

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

plant_connection_3_simulation_program_calling_manager_name¶

field Plant Connection 3 Simulation Program Calling Manager Name

Parameters:	value (str) – value for IDD Field Plant Connection 3 Simulation Program Calling Manager Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of plant_connection_3_simulation_program_calling_manager_name or None if not set
Return type:	str

plant_connection_4_initialization_program_calling_manager_name¶

field Plant Connection 4 Initialization Program Calling Manager Name

Parameters:	value (str) – value for IDD Field Plant Connection 4 Initialization Program Calling Manager Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of plant_connection_4_initialization_program_calling_manager_name or None if not set
Return type:	str

plant_connection_4_inlet_node_name¶

field Plant Connection 4 Inlet Node Name

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

plant_connection_4_loading_mode¶

field Plant Connection 4 Loading Mode

Parameters:	value (str) – value for IDD Field Plant Connection 4 Loading Mode
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of plant_connection_4_loading_mode or None if not set
Return type:	str

plant_connection_4_loop_flow_request_mode¶

field Plant Connection 4 Loop Flow Request Mode

Parameters:	value (str) – value for IDD Field Plant Connection 4 Loop Flow Request Mode
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of plant_connection_4_loop_flow_request_mode or None if not set
Return type:	str

plant_connection_4_outlet_node_name¶

field Plant Connection 4 Outlet Node Name

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

plant_connection_4_simulation_program_calling_manager_name¶

field Plant Connection 4 Simulation Program Calling Manager Name

Parameters:	value (str) – value for IDD Field Plant Connection 4 Simulation Program Calling Manager Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of plant_connection_4_simulation_program_calling_manager_name or None if not set
Return type:	str

supply_inlet_water_storage_tank_name¶

field Supply Inlet Water Storage Tank Name

Water use storage tank for alternate source of water consumed by device

Parameters:	value (str) – value for IDD Field Supply Inlet Water Storage Tank Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of supply_inlet_water_storage_tank_name or None if not set
Return type:	str

class pyidf.user_defined_hvac_and_plant_component_models.PlantEquipmentOperationUserDefined¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object PlantEquipmentOperation:UserDefined Defines a generic plant operation scheme for custom supervisory control using Energy Management System or External Interface to dispatch loads

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

initialization_program_calling_manager_name¶

field Initialization Program Calling Manager Name

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

main_model_program_calling_manager_name¶

field Main Model Program Calling Manager Name

Parameters:	value (str) – value for IDD Field Main Model Program Calling Manager Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of main_model_program_calling_manager_name or None if not set
Return type:	str

name¶

field Name

This is the name of the plant operation scheme

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.user_defined_hvac_and_plant_component_models.ZoneHvacForcedAirUserDefined¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneHVAC:ForcedAir:UserDefined Defines a generic zone air unit for custom modeling using Energy Management System or External Interface

ambient_zone_name¶

field Ambient Zone Name

Used for modeling device losses to surrounding zone

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

collection_outlet_water_storage_tank_name¶

field Collection Outlet Water Storage Tank Name

Water use storage tank for collection of condensate by device

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

model_setup_and_sizing_program_calling_manager_name¶

field Model Setup and Sizing Program Calling Manager Name

Parameters:	value (str) – value for IDD Field Model Setup and Sizing Program Calling Manager Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of model_setup_and_sizing_program_calling_manager_name or None if not set
Return type:	str

name¶

field Name

This is the name of the zone unit

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

number_of_plant_loop_connections¶

field Number of Plant Loop Connections

value <= 3

Parameters:	value (int) – value for IDD Field Number of Plant Loop Connections
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of number_of_plant_loop_connections or None if not set
Return type:	int

overall_model_simulation_program_calling_manager_name¶

field Overall Model Simulation Program Calling Manager Name

Parameters:	value (str) – value for IDD Field Overall Model Simulation Program Calling Manager Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of overall_model_simulation_program_calling_manager_name or None if not set
Return type:	str

plant_connection_1_inlet_node_name¶

field Plant Connection 1 Inlet Node Name

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

plant_connection_1_outlet_node_name¶

field Plant Connection 1 Outlet Node Name

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

plant_connection_2_inlet_node_name¶

field Plant Connection 2 Inlet Node Name

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

plant_connection_2_outlet_node_name¶

field Plant Connection 2 Outlet Node Name

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

plant_connection_3_inlet_node_name¶

field Plant Connection 3 Inlet Node Name

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

plant_connection_3_outlet_node_name¶

field Plant Connection 3 Outlet Node Name

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

primary_air_inlet_node_name¶

field Primary Air Inlet Node Name

Air inlet node for the unit must be a zone air exhaust Node.

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

primary_air_outlet_node_name¶

field Primary Air Outlet Node Name

Air outlet node for the unit must be a zone air inlet node.

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

secondary_air_inlet_node_name¶

field Secondary Air Inlet Node Name

Inlet air used for heat rejection or air source

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

secondary_air_outlet_node_name¶

field Secondary Air Outlet Node Name

Outlet air used for heat rejection or air source

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

supply_inlet_water_storage_tank_name¶

field Supply Inlet Water Storage Tank Name

Water use storage tank for alternate source of water consumed by device

Parameters:	value (str) – value for IDD Field Supply Inlet Water Storage Tank Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of supply_inlet_water_storage_tank_name or None if not set
Return type:	str

pyidf.user_defined_hvac_and_plant_component_models module¶

Related Topics

This Page