IDD

class epquery.IDD(idd_path)

IDD parser.

get_field_ids(obj_type)

Returns field identificators of the object (A1, A2, …, N1, N2, …).

Parameters:obj_type (str) – Object name
Return type:listr(str)
get_field_names(obj_type)

Returns field names of the object, i.e. ‘field’ descriptions of fields A1, A2, …, N1, N2, …

Parameters:obj_type (str) – Object type
Return type:list(str)
get_group(obj)

Returns group name of the object or None if object does not exist.

Parameters:obj (str) – Object name
Return type:str or None
get_groups()
Returns (list(str)):
 
get_object_info(obj_type, full=True)

Returns formatted string with object documentation.

Parameters:
  • obj_type (str) – Object type (e.g. ‘Schedule:File’)
  • full (bool) – If True, all field descriptors are included
Return type:

str

get_objects(group=None)

Returns object names from IDD belonging to group or all if group=None.

Parameters:group (str or None) – Group name, returns all objects if None
Return type:list(str)