pyidf.demand_limiting_controls module¶

Data objects in group “Demand Limiting Controls”

class pyidf.demand_limiting_controls.DemandManagerAssignmentList¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object DemandManagerAssignmentList a list of meters that can be reported are available after a run on the meter dictionary file (.mdd) if the Output:VariableDictionary has been requested.

add_extensible(demandmanager_1_object_type=None, demandmanager_1_name=None)¶

Add values for extensible fields

Parameters:	demandmanager_1_object_type (str) – value for IDD Field DemandManager 1 Object Type if value is None it will not be checked against the specification and is assumed to be a missing value demandmanager_1_name (str) – value for IDD Field DemandManager 1 Name if value is None it will not be checked against the specification and is assumed to be a missing value

billing_period_schedule_name¶

field Billing Period Schedule Name

This field should reference the same schedule as the month schedule name field of the
UtilityCost:Tariff object, if used.
If blank, defaults to regular divisions between months.

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

demand_limit_safety_fraction¶

field Demand Limit Safety Fraction

Parameters:	value (float) – value for IDD Field Demand Limit Safety Fraction
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of demand_limit_safety_fraction or None if not set
Return type:	float

demand_limit_schedule_name¶

field Demand Limit Schedule Name

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

demand_manager_priority¶

field Demand Manager Priority

Parameters:	value (str) – value for IDD Field Demand Manager Priority
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of demand_manager_priority or None if not set
Return type:	str

demand_window_length¶

field Demand Window Length

Units: minutes

Parameters:	value (int) – value for IDD Field Demand Window Length
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of demand_window_length or None if not set
Return type:	int

extensibles¶: Get list of all extensibles

meter_name¶

field Meter Name

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

peak_period_schedule_name¶

field Peak Period Schedule Name

This field should reference the same schedule as the period schedule name field of the
UtilityCost:Tariff object, if used.
If blank, defaults to always on peak.

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

class pyidf.demand_limiting_controls.DemandManagerElectricEquipment¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object DemandManager:ElectricEquipment used for demand limiting ElectricEquipment objects.

add_extensible(electric_equipment_1_name=None)¶

Add values for extensible fields

Parameters:	electric_equipment_1_name (str) – value for IDD Field Electric Equipment 1 Name if value is None it will not be checked against the specification and is assumed to be a missing value

availability_schedule_name¶

field Availability Schedule Name

Availability schedule name for this system. Schedule value > 0 means the system is available.

If this field is blank, the system is always available.

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

extensibles¶: Get list of all extensibles

limit_control¶

field Limit Control

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

limit_step_change¶

field Limit Step Change

Not yet implemented

Parameters:	value (float) – value for IDD Field Limit Step Change
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of limit_step_change or None if not set
Return type:	float

maximum_limit_fraction¶

field Maximum Limit Fraction

value <= 1.0

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

minimum_limit_duration¶

field Minimum Limit Duration

If blank, duration defaults to the timestep

Units: minutes

Parameters:	value (int) – value for IDD Field Minimum Limit Duration
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of minimum_limit_duration or None if not set
Return type:	int

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

rotation_duration¶

field Rotation Duration

If blank, duration defaults to the timestep

Units: minutes

Parameters:	value (int) – value for IDD Field Rotation Duration
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of rotation_duration or None if not set
Return type:	int

selection_control¶

field Selection Control

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

class pyidf.demand_limiting_controls.DemandManagerExteriorLights¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object DemandManager:ExteriorLights used for demand limiting Exterior:Lights objects.

add_extensible(exterior_lights_1_name=None)¶

Add values for extensible fields

Parameters:	exterior_lights_1_name (str) – value for IDD Field Exterior Lights 1 Name if value is None it will not be checked against the specification and is assumed to be a missing value

availability_schedule_name¶

field Availability Schedule Name

Availability schedule name for this system. Schedule value > 0 means the system is available.

If this field is blank, the system is always available.

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

extensibles¶: Get list of all extensibles

limit_control¶

field Limit Control

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

limit_step_change¶

field Limit Step Change

Not yet implemented

Parameters:	value (float) – value for IDD Field Limit Step Change
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of limit_step_change or None if not set
Return type:	float

maximum_limit_fraction¶

field Maximum Limit Fraction

value <= 1.0

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

minimum_limit_duration¶

field Minimum Limit Duration

If blank, duration defaults to the timestep

Units: minutes

Parameters:	value (int) – value for IDD Field Minimum Limit Duration
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of minimum_limit_duration or None if not set
Return type:	int

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

rotation_duration¶

field Rotation Duration

If blank, duration defaults to the timestep

Units: minutes

Parameters:	value (int) – value for IDD Field Rotation Duration
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of rotation_duration or None if not set
Return type:	int

selection_control¶

field Selection Control

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

class pyidf.demand_limiting_controls.DemandManagerLights¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object DemandManager:Lights used for demand limiting Lights objects.

add_extensible(lights_1_name=None)¶

Add values for extensible fields

Parameters:	lights_1_name (str) – value for IDD Field Lights 1 Name if value is None it will not be checked against the specification and is assumed to be a missing value

availability_schedule_name¶

field Availability Schedule Name

Availability schedule name for this system. Schedule value > 0 means the system is available.

If this field is blank, the system is always available.

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

extensibles¶: Get list of all extensibles

limit_control¶

field Limit Control

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

limit_step_change¶

field Limit Step Change

Not yet implemented

Parameters:	value (float) – value for IDD Field Limit Step Change
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of limit_step_change or None if not set
Return type:	float

maximum_limit_fraction¶

field Maximum Limit Fraction

value <= 1.0

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

minimum_limit_duration¶

field Minimum Limit Duration

If blank, duration defaults to the timestep

Units: minutes

Parameters:	value (int) – value for IDD Field Minimum Limit Duration
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of minimum_limit_duration or None if not set
Return type:	int

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

rotation_duration¶

field Rotation Duration

If blank, duration defaults to the timestep

Units: minutes

Parameters:	value (int) – value for IDD Field Rotation Duration
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of rotation_duration or None if not set
Return type:	int

selection_control¶

field Selection Control

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

class pyidf.demand_limiting_controls.DemandManagerThermostats¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object DemandManager:Thermostats used for demand limiting ZoneControl:Thermostat objects.

add_extensible(thermostat_1_name=None)¶

Add values for extensible fields

Parameters:	thermostat_1_name (str) – value for IDD Field Thermostat 1 Name if value is None it will not be checked against the specification and is assumed to be a missing value

availability_schedule_name¶

field Availability Schedule Name

Availability schedule name for this system. Schedule value > 0 means the system is available.

If this field is blank, the system is always available.

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

extensibles¶: Get list of all extensibles

maximum_cooling_setpoint_reset¶

field Maximum Cooling Setpoint Reset

Units: C

Parameters:	value (float) – value for IDD Field Maximum Cooling Setpoint Reset
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of maximum_cooling_setpoint_reset or None if not set
Return type:	float

maximum_heating_setpoint_reset¶

field Maximum Heating Setpoint Reset

Units: C

Parameters:	value (float) – value for IDD Field Maximum Heating Setpoint Reset
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of maximum_heating_setpoint_reset or None if not set
Return type:	float

minimum_reset_duration¶

field Minimum Reset Duration

If blank, duration defaults to the timestep

Units: minutes

Parameters:	value (int) – value for IDD Field Minimum Reset Duration
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of minimum_reset_duration or None if not set
Return type:	int

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

reset_control¶

field Reset Control

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

reset_step_change¶

field Reset Step Change

Not yet implemented

Parameters:	value (float) – value for IDD Field Reset Step Change
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of reset_step_change or None if not set
Return type:	float

rotation_duration¶

field Rotation Duration

If blank, duration defaults to the timestep

Units: minutes

Parameters:	value (int) – value for IDD Field Rotation Duration
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of rotation_duration or None if not set
Return type:	int

selection_control¶

field Selection Control

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

class pyidf.demand_limiting_controls.DemandManagerVentilation¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object DemandManager:Ventilation used for demand limiting Controller:OutdoorAir objects.

add_extensible(controller_outdoor_air_1_name=None)¶

Add values for extensible fields

Parameters:	controller_outdoor_air_1_name (str) – value for IDD Field Controller Outdoor Air 1 Name if value is None it will not be checked against the specification and is assumed to be a missing value

availability_schedule_name¶

field Availability Schedule Name

Availability schedule name for this demand manager. Schedule value > 0 means the demand manager is available.

If this field is blank, the DR is always available.

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

extensibles¶: Get list of all extensibles

fixed_rate¶

field Fixed Rate

Units: m3/s

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

limit_control¶

field Limit Control

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

limit_step_change¶

field Limit Step Change

Not yet implemented

Parameters:	value (float) – value for IDD Field Limit Step Change
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of limit_step_change or None if not set
Return type:	float

minimum_limit_duration¶

field Minimum Limit Duration

If blank, duration defaults to the timestep

Units: minutes

Parameters:	value (int) – value for IDD Field Minimum Limit Duration
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of minimum_limit_duration or None if not set
Return type:	int

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

reduction_ratio¶

field Reduction Ratio

value <= 1.0

Parameters:	value (float) – value for IDD Field Reduction Ratio
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of reduction_ratio or None if not set
Return type:	float

rotation_duration¶

field Rotation Duration

If blank, duration defaults to the timestep

Units: minutes

Parameters:	value (int) – value for IDD Field Rotation Duration
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of rotation_duration or None if not set
Return type:	int

selection_control¶

field Selection Control

Default value: All

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

pyidf.demand_limiting_controls module¶

Related Topics

This Page