UnitModel#
- class UnitModel#
Bases:
BASEBase unit.
- __init__(frameIDs, N_orders, needed_folders=None)#
- is_storage_type(store_type)#
- find_index_of(frameID)#
- classmethod load_from_disk(root_path)#
- merge_with(new_unit)#
- Return type:
None
- add_relative_path(path_name, relative_structure)#
- add_to_status(new_flag)#
- classmethod config_help()#
Prints a message to terminal, showing all possible configurations and their constraints
- classmethod control_parameters()#
- property disk_save_enabled: bool#
True if there is any sort of disk savings active.
- Return type:
bool
- property disk_save_level: DISK_SAVE_MODE#
Return the current disk save level for this object.
- Return type:
DISK_SAVE_MODE
- generate_root_path(storage_path, no_logs=True)#
- is_object_type(type_to_check)#
Check if this object is of a given type
- Parameters:
type_to_check (
str) –- Return type:
bool
- property is_valid: bool#
- Return type:
bool
- json_ready()#
Concerts the current class into a json entry that can be easily saved/loaded to/from disk
- Return type:
Dict[str,Any]
- load_from_file(root_path, loading_path)#
- Return type:
None
- property name: str#
- Return type:
str
- property storage_name: str#
- Return type:
str
- trigger_data_storage(*args, **kwargs)#
- update_disk_saving_level(level)#
Update the work level of the current object.
- Return type:
None
- update_work_mode_level(level)#
Update the disk save level.
- Return type:
None
- property work_mode: WORKING_MODE#
Return the current working mode for this object.
- Return type:
WORKING_MODE