pyidf.parametrics module

Data objects in group “Parametrics”

class pyidf.parametrics.ParametricFileNameSuffix

Bases: pyidf.helper.DataObject

Corresponds to IDD object Parametric:FileNameSuffix Defines the suffixes to be appended to the idf and output file names for each parametric run. If this object is omitted, the suffix will default to the run number.

add_extensible(suffix_for_file_name_in_run_1=None)

Add values for extensible fields

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

extensibles

Get list of all extensibles

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.parametrics.ParametricLogic

Bases: pyidf.helper.DataObject

Corresponds to IDD object Parametric:Logic This object allows some types of objects to be included for some parametric cases and not for others. For example, you might want an overhang on a window in some parametric runs and not others. A single Parametric:Logic object is allowed per file. Consult the Input Output Reference for available commands and syntax.

add_extensible(parametric_logic_line_1=None)

Add values for extensible fields

Parameters:parametric_logic_line_1 (str) – value for IDD Field Parametric Logic Line 1 if value is None it will not be checked against the specification and is assumed to be a missing value

extensibles

Get list of all extensibles

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.parametrics.ParametricRunControl

Bases: pyidf.helper.DataObject

Corresponds to IDD object Parametric:RunControl Controls which parametric runs are simulated. This object is optional. If it is not included, then all parametric runs are performed.

add_extensible(perform_run_1='Yes')

Add values for extensible fields

Parameters:perform_run_1 (str) – value for IDD Field Perform Run 1 Default value: Yes if value is None it will not be checked against the specification and is assumed to be a missing value

extensibles

Get list of all extensibles

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.parametrics.ParametricSetValueForRun

Bases: pyidf.helper.DataObject

Corresponds to IDD object Parametric:SetValueForRun Parametric objects allow a set of multiple simulations to be defined in a single idf file. The parametric preprocessor scans the idf for Parametric:* objects then creates and runs multiple idf files, one for each defined simulation. The core parametric object is Parametric:SetValueForRun which defines the name of a parameters and sets the parameter to different values depending on which run is being simulated.

add_extensible(value_for_run_1=None)

Add values for extensible fields

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

extensibles

Get list of all extensibles

name

field Name

Parameter Name

Must begin with the dollar sign character. The second character must be a letter.

Remaining characters may only be letters or numbers. No spaces allowed.

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