UnitModel

UnitModel#

class UnitModel#

Bases: BASE

Base unit.

__init__(frameIDs, N_orders, needed_folders=None)#
is_storage_type(store_type)#
find_index_of(frameID)#
classmethod load_from_disk(root_path)#
add_relative_path(path_name, relative_structure)#
add_to_status(new_flag)#
Return type:

NoReturn

classmethod config_help()#

Prints a message to terminal, showing all possible configurations and their constraints

classmethod control_parameters()#
generate_root_path(storage_path, no_logs=True)#
Return type:

NoReturn

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)#
Return type:

NoReturn