ExtInterface

class epquery.edit.ExtInterface(idf_path, idd_path)

Bases: epquery.basicedit.BasicEdit

add_external_interface()

Adds external interface object IN PLACE. The object is added at the end of the current IDF. Returns the copy of this object.

Returns:A copy of external interface object
Return type:list(str)
output_to_interface(mask, key_values, inplace=True)

Returns external interface objects for Output:Variable.

Warning

Currently, the method only supports Output:Variable objects defined in IDF with key value = *. The argument key_values is used to expand the interface to all needed objects.

Parameters:
  • mask (list(bool)) – Mask with selected outputs
  • key_values (list(str)) – Key values from Output:Variable after expanding *
  • inplace (bool) – If True, original schedules are commented and new are added in place
Returns:

Schedules interface objects
Return type:

list(list(str))
schedule_to_interface(mask, init_val=0, inplace=True)

Returns external interface objects for schedules. Adds the objects to the IDF if inplace is True.

Warning

The method does not check if the objects selected in the mask are valid schedules. It’s the user responsibility.

Parameters:
  • mask (list(bool)) – Mask with selected schedules
  • init_val (float) – Initial value of the schedule
  • inplace (bool) – If True, original schedules are commented and new are added in place
Returns:

Schedules interface objects
Return type:

list(list(str))