psr-factory 5.0.0b69__py3-none-manylinux_2_28_x86_64.whl

psr/factory/factorylib.py

@@ -0,0 +1,410 @@
+# PSR Factory. Copyright (C) PSR, Inc - All Rights Reserved
+# Unauthorized copying of this file, via any medium is strictly prohibited
+# Proprietary and confidential
+
+import ctypes
+import os
+import sys
+
+import psr.psrfcommon
+
+
+lib = None
+
+if sys.platform == "win32":
+    def get_lib_path() -> str:
+        return os.path.join(os.path.dirname(__file__), "factory.dll")
+    def load_lib():
+        return ctypes.cdll.LoadLibrary(get_lib_path())
+else:
+    def get_lib_path() -> str:
+        return os.path.join(os.path.dirname(__file__), "libfactory.so")
+    def load_lib():
+        with psr.psrfcommon.change_cwd(os.path.dirname(__file__)):
+            lib_path = "./libfactory.so"
+            return ctypes.cdll.LoadLibrary(lib_path)
+
+
+def initialize():
+    global lib
+    lib = load_lib()
+
+    lib.psrd_check_license.restype = ctypes.c_int
+    lib.psrd_check_license.argtypes = [ctypes.c_void_p]
+    lib.psrd_initialize_basic_data.restype = ctypes.c_int
+    lib.psrd_initialize_basic_data.argtypes = [ctypes.c_void_p]
+    lib.psrd_initialize_study_data.restype = ctypes.c_int
+    lib.psrd_initialize_study_data.argtypes = [ctypes.c_char_p, ctypes.c_long, ctypes.c_void_p]
+    lib.psrd_unload.restype = ctypes.c_int
+    lib.psrd_unload.argtypes = [ctypes.c_void_p]
+    lib.psrd_get_constant.restype = ctypes.c_int
+    lib.psrd_get_constant.argtypes = [ctypes.c_char_p, ctypes.c_long, ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_set_global_setting.restype = ctypes.c_int
+    lib.psrd_set_global_setting.argtypes = [ctypes.c_char_p, ctypes.c_long, ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_get_global_setting.restype = ctypes.c_int
+    lib.psrd_get_global_setting.argtypes = [ctypes.c_char_p, ctypes.c_long, ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_set_binding_property.restype = ctypes.c_int
+    lib.psrd_set_binding_property.argtypes = [ctypes.c_char_p, ctypes.c_long, ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_version_short.restype = ctypes.c_int
+    lib.psrd_version_short.argtypes = [ctypes.c_char_p, ctypes.c_long]
+    lib.psrd_version_long.restype = ctypes.c_int
+    lib.psrd_version_long.argtypes = [ctypes.c_char_p, ctypes.c_long]
+    lib.psrd_help.restype = ctypes.c_int
+    lib.psrd_help.argtypes = [ctypes.c_char_p, ctypes.c_long, ctypes.c_char_p, ctypes.c_long, ctypes.c_void_p]
+    lib.psrd_set_log_level.restype = ctypes.c_int
+    lib.psrd_set_log_level.argtypes = [ctypes.c_long]
+    lib.psrd_get_log_level.restype = ctypes.c_int
+    lib.psrd_get_log_level.argtypes = [ctypes.POINTER(ctypes.c_long)]
+    lib.psrd_get_log_file_path.restype = ctypes.c_int
+    lib.psrd_get_log_file_path.argtypes = [ctypes.c_char_p, ctypes.c_long, ctypes.c_void_p]
+    lib.psrd_set_diagnostics_mode.restype = ctypes.c_int
+    lib.psrd_set_diagnostics_mode.argtypes = [ctypes.c_long]
+    lib.psrd_diagnostics.restype = ctypes.c_int
+    lib.psrd_diagnostics.argtypes = [ctypes.c_char_p, ctypes.c_long, ctypes.c_char_p, ctypes.c_long, ctypes.c_void_p]
+    lib.psrd_get_default_context.restype = ctypes.c_void_p
+    lib.psrd_get_default_context.argtypes = [ctypes.c_void_p]
+    lib.psrd_new_error.restype = ctypes.c_void_p
+    lib.psrd_new_error.argtypes = []
+    lib.psrd_error_code.restype = ctypes.c_int
+    lib.psrd_error_code.argtypes = [ctypes.c_void_p]
+    lib.psrd_error_message.restype = ctypes.c_int
+    lib.psrd_error_message.argtypes = [ctypes.c_void_p, ctypes.c_char_p, ctypes.c_long]
+    lib.psrd_free_error.restype = ctypes.c_int
+    lib.psrd_free_error.argtypes = [ctypes.c_void_p]
+    lib.psrd_study_load.restype = ctypes.c_void_p
+    lib.psrd_study_load.argtypes = [ctypes.c_char_p, ctypes.c_long, ctypes.c_void_p, ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_study_save.restype = ctypes.c_int
+    lib.psrd_study_save.argtypes = [ctypes.c_void_p, ctypes.c_char_p, ctypes.c_long, ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_study_load_settings.restype = ctypes.c_void_p
+    lib.psrd_study_load_settings.argtypes = [ctypes.c_char_p, ctypes.c_long, ctypes.c_void_p, ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_study_save_settings.restype = ctypes.c_int
+    lib.psrd_study_save_settings.argtypes = [ctypes.c_void_p, ctypes.c_char_p, ctypes.c_long, ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_study_create.restype = ctypes.c_void_p
+    lib.psrd_study_create.argtypes = [ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_study_is_equals_to.restype = ctypes.c_int
+    lib.psrd_study_is_equals_to.argtypes = [ctypes.c_void_p, ctypes.c_void_p, ctypes.POINTER(ctypes.c_bool), ctypes.c_void_p]
+    lib.psrd_study_get_handler.restype = ctypes.c_longlong
+    lib.psrd_study_get_handler.argtypes = [ctypes.c_void_p]
+    lib.psrd_study_clone.restype = ctypes.c_void_p
+    lib.psrd_study_clone.argtypes = [ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_study_context.restype = ctypes.c_void_p
+    lib.psrd_study_context.argtypes = [ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_free_study.restype = ctypes.c_int
+    lib.psrd_free_study.argtypes = [ctypes.c_void_p]
+    lib.psrd_study_property_description_count.restype = ctypes.c_int
+    lib.psrd_study_property_description_count.argtypes = [ctypes.c_void_p, ctypes.POINTER(ctypes.c_long), ctypes.c_void_p]
+    lib.psrd_study_get_property_description.restype = ctypes.c_void_p
+    lib.psrd_study_get_property_description.argtypes = [ctypes.c_void_p, ctypes.c_long, ctypes.c_void_p]
+    lib.psrd_study_get_property_description_by_name.restype = ctypes.c_void_p
+    lib.psrd_study_get_property_description_by_name.argtypes = [ctypes.c_void_p, ctypes.c_char_p, ctypes.c_long, ctypes.c_void_p]
+    lib.psrd_study_set_value.restype = ctypes.c_int
+    lib.psrd_study_set_value.argtypes = [ctypes.c_void_p, ctypes.c_char_p, ctypes.c_long, ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_study_set_value_at.restype = ctypes.c_int
+    lib.psrd_study_set_value_at.argtypes = [ctypes.c_void_p, ctypes.c_char_p, ctypes.c_long, ctypes.c_void_p, ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_study_set_from_dict.restype = ctypes.c_int
+    lib.psrd_study_set_from_dict.argtypes = [ctypes.c_void_p, ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_study_get_value.restype = ctypes.c_int
+    lib.psrd_study_get_value.argtypes = [ctypes.c_void_p, ctypes.c_char_p, ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_study_get_value_at.restype = ctypes.c_int
+    lib.psrd_study_get_value_at.argtypes = [ctypes.c_void_p, ctypes.c_char_p, ctypes.c_void_p, ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_study_has_property.restype = ctypes.c_int
+    lib.psrd_study_has_property.argtypes = [ctypes.c_void_p, ctypes.c_char_p, ctypes.c_long, ctypes.POINTER(ctypes.c_bool), ctypes.c_void_p]
+    lib.psrd_study_get_as_dict.restype = ctypes.c_void_p
+    lib.psrd_study_get_as_dict.argtypes = [ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_study_get_table.restype = ctypes.c_int
+    lib.psrd_study_get_table.argtypes = [ctypes.c_void_p, ctypes.c_void_p, ctypes.c_char_p, ctypes.c_long, ctypes.c_void_p]
+    lib.psrd_study_set_table.restype = ctypes.c_int
+    lib.psrd_study_set_table.argtypes = [ctypes.c_void_p, ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_study_clear_values.restype = ctypes.c_int
+    lib.psrd_study_clear_values.argtypes = [ctypes.c_void_p, ctypes.c_char_p, ctypes.c_long, ctypes.c_void_p]
+    lib.psrd_study_get_objects_values.restype = ctypes.c_int
+    lib.psrd_study_get_objects_values.argtypes = [ctypes.c_void_p, ctypes.c_void_p, ctypes.c_char_p, ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_study_get_objects_values_at.restype = ctypes.c_int
+    lib.psrd_study_get_objects_values_at.argtypes = [ctypes.c_void_p, ctypes.c_void_p, ctypes.c_char_p, ctypes.c_void_p, ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_study_get_date_iterator_from_start.restype = ctypes.c_int
+    lib.psrd_study_get_date_iterator_from_start.argtypes = [ctypes.c_void_p, ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_create.restype = ctypes.c_void_p
+    lib.psrd_create.argtypes = [ctypes.c_char_p, ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_study_add.restype = ctypes.c_int
+    lib.psrd_study_add.argtypes = [ctypes.c_void_p, ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_study_remove.restype = ctypes.c_int
+    lib.psrd_study_remove.argtypes = [ctypes.c_void_p, ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_study_get_all_objects.restype = ctypes.c_void_p
+    lib.psrd_study_get_all_objects.argtypes = [ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_study_get_key_object_map.restype = ctypes.c_void_p
+    lib.psrd_study_get_key_object_map.argtypes = [ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_study_find.restype = ctypes.c_void_p
+    lib.psrd_study_find.argtypes = [ctypes.c_void_p, ctypes.c_char_p, ctypes.c_void_p]
+    lib.psrd_study_find_by_id.restype = ctypes.c_void_p
+    lib.psrd_study_find_by_id.argtypes = [ctypes.c_void_p, ctypes.c_char_p, ctypes.c_void_p]
+    lib.psrd_study_find_by_code.restype = ctypes.c_void_p
+    lib.psrd_study_find_by_code.argtypes = [ctypes.c_void_p, ctypes.c_char_p, ctypes.c_int, ctypes.c_void_p]
+    lib.psrd_free_object.restype = ctypes.c_int
+    lib.psrd_free_object.argtypes = [ctypes.c_void_p]
+    lib.psrd_object_is_equals_to.restype = ctypes.c_int
+    lib.psrd_object_is_equals_to.argtypes = [ctypes.c_void_p, ctypes.c_void_p, ctypes.POINTER(ctypes.c_bool), ctypes.c_void_p]
+    lib.psrd_object_get_handler.restype = ctypes.c_longlong
+    lib.psrd_object_get_handler.argtypes = [ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_object_clone.restype = ctypes.c_void_p
+    lib.psrd_object_clone.argtypes = [ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_object_context.restype = ctypes.c_void_p
+    lib.psrd_object_context.argtypes = [ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_object_get_parent.restype = ctypes.c_void_p
+    lib.psrd_object_get_parent.argtypes = [ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_object_get_type.restype = ctypes.c_int
+    lib.psrd_object_get_type.argtypes = [ctypes.c_void_p, ctypes.c_char_p, ctypes.c_long, ctypes.c_void_p]
+    lib.psrd_object_get_key.restype = ctypes.c_int
+    lib.psrd_object_get_key.argtypes = [ctypes.c_void_p, ctypes.c_char_p, ctypes.c_long, ctypes.c_void_p]
+    lib.psrd_object_set_key.restype = ctypes.c_int
+    lib.psrd_object_set_key.argtypes = [ctypes.c_void_p, ctypes.c_char_p, ctypes.c_long, ctypes.c_void_p]
+    lib.psrd_object_has_code.restype = ctypes.c_int
+    lib.psrd_object_has_code.argtypes = [ctypes.c_void_p, ctypes.POINTER(ctypes.c_bool), ctypes.c_void_p]
+    lib.psrd_object_get_code.restype = ctypes.c_int
+    lib.psrd_object_get_code.argtypes = [ctypes.c_void_p, ctypes.POINTER(ctypes.c_int), ctypes.c_void_p]
+    lib.psrd_object_set_code.restype = ctypes.c_int
+    lib.psrd_object_set_code.argtypes = [ctypes.c_void_p, ctypes.c_int, ctypes.c_void_p]
+    lib.psrd_object_has_name.restype = ctypes.c_int
+    lib.psrd_object_has_name.argtypes = [ctypes.c_void_p, ctypes.POINTER(ctypes.c_bool), ctypes.c_void_p]
+    lib.psrd_object_get_name.restype = ctypes.c_int
+    lib.psrd_object_get_name.argtypes = [ctypes.c_void_p, ctypes.c_char_p, ctypes.c_long, ctypes.c_void_p]
+    lib.psrd_object_set_name.restype = ctypes.c_int
+    lib.psrd_object_set_name.argtypes = [ctypes.c_void_p, ctypes.c_char_p, ctypes.c_long, ctypes.c_void_p]
+    lib.psrd_object_has_id.restype = ctypes.c_int
+    lib.psrd_object_has_id.argtypes = [ctypes.c_void_p, ctypes.POINTER(ctypes.c_bool), ctypes.c_void_p]
+    lib.psrd_object_get_id.restype = ctypes.c_int
+    lib.psrd_object_get_id.argtypes = [ctypes.c_void_p, ctypes.c_char_p, ctypes.c_long, ctypes.c_void_p]
+    lib.psrd_object_set_id.restype = ctypes.c_int
+    lib.psrd_object_set_id.argtypes = [ctypes.c_void_p, ctypes.c_char_p, ctypes.c_long, ctypes.c_void_p]
+    lib.psrd_object_property_description_count.restype = ctypes.c_int
+    lib.psrd_object_property_description_count.argtypes = [ctypes.c_void_p, ctypes.POINTER(ctypes.c_long), ctypes.c_void_p]
+    lib.psrd_object_get_property_description.restype = ctypes.c_void_p
+    lib.psrd_object_get_property_description.argtypes = [ctypes.c_void_p, ctypes.c_long, ctypes.c_void_p]
+    lib.psrd_object_get_property_description_by_name.restype = ctypes.c_void_p
+    lib.psrd_object_get_property_description_by_name.argtypes = [ctypes.c_void_p, ctypes.c_char_p, ctypes.c_long, ctypes.c_void_p]
+    lib.psrd_object_set_value.restype = ctypes.c_int
+    lib.psrd_object_set_value.argtypes = [ctypes.c_void_p, ctypes.c_char_p, ctypes.c_long, ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_object_set_value_at.restype = ctypes.c_int
+    lib.psrd_object_set_value_at.argtypes = [ctypes.c_void_p, ctypes.c_char_p, ctypes.c_long, ctypes.c_void_p, ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_object_set_from_dict.restype = ctypes.c_int
+    lib.psrd_object_set_from_dict.argtypes = [ctypes.c_void_p, ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_object_get_value.restype = ctypes.c_int
+    lib.psrd_object_get_value.argtypes = [ctypes.c_void_p, ctypes.c_char_p, ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_object_get_value_at.restype = ctypes.c_int
+    lib.psrd_object_get_value_at.argtypes = [ctypes.c_void_p, ctypes.c_char_p, ctypes.c_void_p, ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_object_has_property.restype = ctypes.c_int
+    lib.psrd_object_has_property.argtypes = [ctypes.c_void_p, ctypes.c_char_p, ctypes.c_long, ctypes.POINTER(ctypes.c_bool), ctypes.c_void_p]
+    lib.psrd_object_get_as_dict.restype = ctypes.c_void_p
+    lib.psrd_object_get_as_dict.argtypes = [ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_object_get_table.restype = ctypes.c_int
+    lib.psrd_object_get_table.argtypes = [ctypes.c_void_p, ctypes.c_void_p, ctypes.c_char_p, ctypes.c_long, ctypes.c_void_p]
+    lib.psrd_object_set_table.restype = ctypes.c_int
+    lib.psrd_object_set_table.argtypes = [ctypes.c_void_p, ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_object_clear_values.restype = ctypes.c_int
+    lib.psrd_object_clear_values.argtypes = [ctypes.c_void_p, ctypes.c_char_p, ctypes.c_long, ctypes.c_void_p]
+    lib.psrd_object_referenced_by.restype = ctypes.c_void_p
+    lib.psrd_object_referenced_by.argtypes = [ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_new_value.restype = ctypes.c_void_p
+    lib.psrd_new_value.argtypes = []
+    lib.psrd_free_value.restype = ctypes.c_int
+    lib.psrd_free_value.argtypes = [ctypes.c_void_p]
+    lib.psrd_value_get_type.restype = ctypes.c_int
+    lib.psrd_value_get_type.argtypes = [ctypes.c_void_p, ctypes.POINTER(ctypes.c_long), ctypes.c_void_p]
+    lib.psrd_value_get_int32.restype = ctypes.c_int
+    lib.psrd_value_get_int32.argtypes = [ctypes.c_void_p, ctypes.POINTER(ctypes.c_int), ctypes.c_void_p]
+    lib.psrd_value_set_int32.restype = ctypes.c_int
+    lib.psrd_value_set_int32.argtypes = [ctypes.c_void_p, ctypes.c_int, ctypes.c_void_p]
+    lib.psrd_value_get_int64.restype = ctypes.c_int
+    lib.psrd_value_get_int64.argtypes = [ctypes.c_void_p, ctypes.POINTER(ctypes.c_longlong), ctypes.c_void_p]
+    lib.psrd_value_set_int64.restype = ctypes.c_int
+    lib.psrd_value_set_int64.argtypes = [ctypes.c_void_p, ctypes.c_longlong, ctypes.c_void_p]
+    lib.psrd_value_get_bool.restype = ctypes.c_int
+    lib.psrd_value_get_bool.argtypes = [ctypes.c_void_p, ctypes.POINTER(ctypes.c_bool), ctypes.c_void_p]
+    lib.psrd_value_set_bool.restype = ctypes.c_int
+    lib.psrd_value_set_bool.argtypes = [ctypes.c_void_p, ctypes.c_short, ctypes.c_void_p]
+    lib.psrd_value_get_date.restype = ctypes.c_int
+    lib.psrd_value_get_date.argtypes = [ctypes.c_void_p, ctypes.POINTER(ctypes.c_longlong), ctypes.c_void_p]
+    lib.psrd_value_set_date.restype = ctypes.c_int
+    lib.psrd_value_set_date.argtypes = [ctypes.c_void_p, ctypes.c_longlong, ctypes.c_void_p]
+    lib.psrd_value_get_float32.restype = ctypes.c_int
+    lib.psrd_value_get_float32.argtypes = [ctypes.c_void_p, ctypes.POINTER(ctypes.c_float), ctypes.c_void_p]
+    lib.psrd_value_set_float32.restype = ctypes.c_int
+    lib.psrd_value_set_float32.argtypes = [ctypes.c_void_p, ctypes.c_float, ctypes.c_void_p]
+    lib.psrd_value_get_float64.restype = ctypes.c_int
+    lib.psrd_value_get_float64.argtypes = [ctypes.c_void_p, ctypes.POINTER(ctypes.c_double), ctypes.c_void_p]
+    lib.psrd_value_set_float64.restype = ctypes.c_int
+    lib.psrd_value_set_float64.argtypes = [ctypes.c_void_p, ctypes.c_double, ctypes.c_void_p]
+    lib.psrd_value_get_string.restype = ctypes.c_int
+    lib.psrd_value_get_string.argtypes = [ctypes.c_void_p, ctypes.c_char_p, ctypes.c_long, ctypes.c_void_p]
+    lib.psrd_value_set_string.restype = ctypes.c_int
+    lib.psrd_value_set_string.argtypes = [ctypes.c_void_p, ctypes.c_char_p, ctypes.c_long, ctypes.c_void_p]
+    lib.psrd_value_get_object.restype = ctypes.c_void_p
+    lib.psrd_value_get_object.argtypes = [ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_value_set_object.restype = ctypes.c_int
+    lib.psrd_value_set_object.argtypes = [ctypes.c_void_p, ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_value_get_list.restype = ctypes.c_void_p
+    lib.psrd_value_get_list.argtypes = [ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_value_set_list.restype = ctypes.c_int
+    lib.psrd_value_set_list.argtypes = [ctypes.c_void_p, ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_value_get_dict.restype = ctypes.c_void_p
+    lib.psrd_value_get_dict.argtypes = [ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_value_set_dict.restype = ctypes.c_int
+    lib.psrd_value_set_dict.argtypes = [ctypes.c_void_p, ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_value_set_null.restype = ctypes.c_int
+    lib.psrd_value_set_null.argtypes = [ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_value_is_null.restype = ctypes.c_int
+    lib.psrd_value_is_null.argtypes = [ctypes.c_void_p, ctypes.POINTER(ctypes.c_bool), ctypes.c_void_p]
+    lib.psrd_new_list.restype = ctypes.c_void_p
+    lib.psrd_new_list.argtypes = []
+    lib.psrd_free_list.restype = ctypes.c_int
+    lib.psrd_free_list.argtypes = [ctypes.c_void_p]
+    lib.psrd_list_count.restype = ctypes.c_int
+    lib.psrd_list_count.argtypes = [ctypes.c_void_p, ctypes.POINTER(ctypes.c_long), ctypes.c_void_p]
+    lib.psrd_list_clear.restype = ctypes.c_int
+    lib.psrd_list_clear.argtypes = [ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_list_get.restype = ctypes.c_int
+    lib.psrd_list_get.argtypes = [ctypes.c_void_p, ctypes.c_long, ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_list_set.restype = ctypes.c_int
+    lib.psrd_list_set.argtypes = [ctypes.c_void_p, ctypes.c_long, ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_list_append.restype = ctypes.c_int
+    lib.psrd_list_append.argtypes = [ctypes.c_void_p, ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_new_dict.restype = ctypes.c_void_p
+    lib.psrd_new_dict.argtypes = []
+    lib.psrd_free_dict.restype = ctypes.c_int
+    lib.psrd_free_dict.argtypes = [ctypes.c_void_p]
+    lib.psrd_dict_count.restype = ctypes.c_int
+    lib.psrd_dict_count.argtypes = [ctypes.c_void_p, ctypes.POINTER(ctypes.c_long), ctypes.c_void_p]
+    lib.psrd_dict_clear.restype = ctypes.c_int
+    lib.psrd_dict_clear.argtypes = [ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_dict_get_by_key.restype = ctypes.c_int
+    lib.psrd_dict_get_by_key.argtypes = [ctypes.c_void_p, ctypes.c_void_p, ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_dict_get_by_index.restype = ctypes.c_int
+    lib.psrd_dict_get_by_index.argtypes = [ctypes.c_void_p, ctypes.c_long, ctypes.c_void_p, ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_dict_get_key_by_index.restype = ctypes.c_int
+    lib.psrd_dict_get_key_by_index.argtypes = [ctypes.c_void_p, ctypes.c_long, ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_dict_get_value_by_index.restype = ctypes.c_int
+    lib.psrd_dict_get_value_by_index.argtypes = [ctypes.c_void_p, ctypes.c_long, ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_dict_set.restype = ctypes.c_int
+    lib.psrd_dict_set.argtypes = [ctypes.c_void_p, ctypes.c_void_p, ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_free_property_description.restype = ctypes.c_int
+    lib.psrd_free_property_description.argtypes = [ctypes.c_void_p]
+    lib.psrd_property_description_get_name.restype = ctypes.c_int
+    lib.psrd_property_description_get_name.argtypes = [ctypes.c_void_p, ctypes.c_char_p, ctypes.c_long, ctypes.c_void_p]
+    lib.psrd_property_description_get_alternative_name.restype = ctypes.c_int
+    lib.psrd_property_description_get_alternative_name.argtypes = [ctypes.c_void_p, ctypes.c_char_p, ctypes.c_long, ctypes.c_void_p]
+    lib.psrd_property_description_dimensions_count.restype = ctypes.c_int
+    lib.psrd_property_description_dimensions_count.argtypes = [ctypes.c_void_p, ctypes.POINTER(ctypes.c_long), ctypes.c_void_p]
+    lib.psrd_property_description_get_type.restype = ctypes.c_int
+    lib.psrd_property_description_get_type.argtypes = [ctypes.c_void_p, ctypes.POINTER(ctypes.c_long), ctypes.c_void_p]
+    lib.psrd_property_description_get_dimension_size.restype = ctypes.c_int
+    lib.psrd_property_description_get_dimension_size.argtypes = [ctypes.c_void_p, ctypes.c_long, ctypes.POINTER(ctypes.c_long), ctypes.c_void_p]
+    lib.psrd_property_description_get_dimension_name.restype = ctypes.c_int
+    lib.psrd_property_description_get_dimension_name.argtypes = [ctypes.c_void_p, ctypes.c_long, ctypes.c_char_p, ctypes.c_long, ctypes.c_void_p]
+    lib.psrd_property_description_is_reference.restype = ctypes.c_int
+    lib.psrd_property_description_is_reference.argtypes = [ctypes.c_void_p, ctypes.POINTER(ctypes.c_bool), ctypes.c_void_p]
+    lib.psrd_property_description_is_required.restype = ctypes.c_int
+    lib.psrd_property_description_is_required.argtypes = [ctypes.c_void_p, ctypes.POINTER(ctypes.c_bool), ctypes.c_void_p]
+    lib.psrd_property_description_is_dynamic.restype = ctypes.c_int
+    lib.psrd_property_description_is_dynamic.argtypes = [ctypes.c_void_p, ctypes.POINTER(ctypes.c_bool), ctypes.c_void_p]
+    lib.psrd_property_description_is_indexed.restype = ctypes.c_int
+    lib.psrd_property_description_is_indexed.argtypes = [ctypes.c_void_p, ctypes.POINTER(ctypes.c_bool), ctypes.c_void_p]
+    lib.psrd_property_description_is_grouped.restype = ctypes.c_int
+    lib.psrd_property_description_is_grouped.argtypes = [ctypes.c_void_p, ctypes.POINTER(ctypes.c_bool), ctypes.c_void_p]
+    lib.psrd_property_description_grouped_with.restype = ctypes.c_void_p
+    lib.psrd_property_description_grouped_with.argtypes = [ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_new_table.restype = ctypes.c_void_p
+    lib.psrd_new_table.argtypes = []
+    lib.psrd_free_table.restype = ctypes.c_int
+    lib.psrd_free_table.argtypes = [ctypes.c_void_p]
+    lib.psrd_table_load.restype = ctypes.c_int
+    lib.psrd_table_load.argtypes = [ctypes.c_void_p, ctypes.c_char_p, ctypes.c_long, ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_table_save.restype = ctypes.c_int
+    lib.psrd_table_save.argtypes = [ctypes.c_void_p, ctypes.c_char_p, ctypes.c_long, ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_table_set_property.restype = ctypes.c_int
+    lib.psrd_table_set_property.argtypes = [ctypes.c_void_p, ctypes.c_char_p, ctypes.c_long, ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_table_get_property.restype = ctypes.c_int
+    lib.psrd_table_get_property.argtypes = [ctypes.c_void_p, ctypes.c_char_p, ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_table_is_indexed.restype = ctypes.c_int
+    lib.psrd_table_is_indexed.argtypes = [ctypes.c_void_p, ctypes.POINTER(ctypes.c_bool), ctypes.c_void_p]
+    lib.psrd_table_resize.restype = ctypes.c_int
+    lib.psrd_table_resize.argtypes = [ctypes.c_void_p, ctypes.c_long, ctypes.c_void_p]
+    lib.psrd_table_get_as_dict.restype = ctypes.c_void_p
+    lib.psrd_table_get_as_dict.argtypes = [ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_table_set_from_dict.restype = ctypes.c_int
+    lib.psrd_table_set_from_dict.argtypes = [ctypes.c_void_p, ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_table_configure_index.restype = ctypes.c_int
+    lib.psrd_table_configure_index.argtypes = [ctypes.c_void_p, ctypes.c_long, ctypes.c_long, ctypes.c_void_p]
+    lib.psrd_table_configure_column.restype = ctypes.c_int
+    lib.psrd_table_configure_column.argtypes = [ctypes.c_void_p, ctypes.c_long, ctypes.c_long, ctypes.c_void_p]
+    lib.psrd_table_columns_count.restype = ctypes.c_int
+    lib.psrd_table_columns_count.argtypes = [ctypes.c_void_p, ctypes.POINTER(ctypes.c_long), ctypes.c_void_p]
+    lib.psrd_table_column_get_name.restype = ctypes.c_int
+    lib.psrd_table_column_get_name.argtypes = [ctypes.c_void_p, ctypes.c_long, ctypes.c_char_p, ctypes.c_long, ctypes.c_void_p]
+    lib.psrd_table_column_set_name.restype = ctypes.c_int
+    lib.psrd_table_column_set_name.argtypes = [ctypes.c_void_p, ctypes.c_long, ctypes.c_char_p, ctypes.c_long, ctypes.c_void_p]
+    lib.psrd_table_column_values_count.restype = ctypes.c_int
+    lib.psrd_table_column_values_count.argtypes = [ctypes.c_void_p, ctypes.c_long, ctypes.POINTER(ctypes.c_long), ctypes.c_void_p]
+    lib.psrd_table_column_get_value.restype = ctypes.c_int
+    lib.psrd_table_column_get_value.argtypes = [ctypes.c_void_p, ctypes.c_long, ctypes.c_long, ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_table_column_set_value.restype = ctypes.c_int
+    lib.psrd_table_column_set_value.argtypes = [ctypes.c_void_p, ctypes.c_long, ctypes.c_long, ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_table_rows_count.restype = ctypes.c_int
+    lib.psrd_table_rows_count.argtypes = [ctypes.c_void_p, ctypes.POINTER(ctypes.c_long), ctypes.c_void_p]
+    lib.psrd_table_index_count.restype = ctypes.c_int
+    lib.psrd_table_index_count.argtypes = [ctypes.c_void_p, ctypes.POINTER(ctypes.c_long), ctypes.c_void_p]
+    lib.psrd_table_index_get_name.restype = ctypes.c_int
+    lib.psrd_table_index_get_name.argtypes = [ctypes.c_void_p, ctypes.c_long, ctypes.c_char_p, ctypes.c_long, ctypes.c_void_p]
+    lib.psrd_table_index_set_name.restype = ctypes.c_int
+    lib.psrd_table_index_set_name.argtypes = [ctypes.c_void_p, ctypes.c_long, ctypes.c_char_p, ctypes.c_long, ctypes.c_void_p]
+    lib.psrd_table_index_get_value.restype = ctypes.c_int
+    lib.psrd_table_index_get_value.argtypes = [ctypes.c_void_p, ctypes.c_long, ctypes.c_long, ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_table_index_set_value.restype = ctypes.c_int
+    lib.psrd_table_index_set_value.argtypes = [ctypes.c_void_p, ctypes.c_long, ctypes.c_long, ctypes.c_void_p, ctypes.c_void_p]
+    lib.psrd_table_column_set_float32_values.restype = ctypes.c_int
+    lib.psrd_table_column_set_float32_values.argtypes = [ctypes.c_void_p, ctypes.c_long, ctypes.POINTER(ctypes.c_float), ctypes.c_void_p]
+    lib.psrd_table_column_set_float64_values.restype = ctypes.c_int
+    lib.psrd_table_column_set_float64_values.argtypes = [ctypes.c_void_p, ctypes.c_long, ctypes.POINTER(ctypes.c_double), ctypes.c_void_p]
+    lib.psrd_table_column_set_int32_values.restype = ctypes.c_int
+    lib.psrd_table_column_set_int32_values.argtypes = [ctypes.c_void_p, ctypes.c_long, ctypes.POINTER(ctypes.c_int), ctypes.c_void_p]
+    lib.psrd_table_column_set_date_values.restype = ctypes.c_int
+    lib.psrd_table_column_set_date_values.argtypes = [ctypes.c_void_p, ctypes.c_long, ctypes.POINTER(ctypes.c_longlong), ctypes.c_void_p]
+    lib.psrd_table_column_set_null_values.restype = ctypes.c_int
+    lib.psrd_table_column_set_null_values.argtypes = [ctypes.c_void_p, ctypes.c_long, ctypes.c_void_p]
+    lib.psrd_table_index_set_int32_values.restype = ctypes.c_int
+    lib.psrd_table_index_set_int32_values.argtypes = [ctypes.c_void_p, ctypes.c_long, ctypes.POINTER(ctypes.c_int), ctypes.c_void_p]
+    lib.psrd_table_index_set_int64_values.restype = ctypes.c_int
+    lib.psrd_table_index_set_int64_values.argtypes = [ctypes.c_void_p, ctypes.c_long, ctypes.POINTER(ctypes.c_longlong), ctypes.c_void_p]
+    lib.psrd_table_index_set_float32_values.restype = ctypes.c_int
+    lib.psrd_table_index_set_float32_values.argtypes = [ctypes.c_void_p, ctypes.c_long, ctypes.POINTER(ctypes.c_float), ctypes.c_void_p]
+    lib.psrd_table_index_set_float64_values.restype = ctypes.c_int
+    lib.psrd_table_index_set_float64_values.argtypes = [ctypes.c_void_p, ctypes.c_long, ctypes.POINTER(ctypes.c_double), ctypes.c_void_p]
+    lib.psrd_table_index_set_date_values.restype = ctypes.c_int
+    lib.psrd_table_index_set_date_values.argtypes = [ctypes.c_void_p, ctypes.c_long, ctypes.POINTER(ctypes.c_longlong), ctypes.c_void_p]
+    lib.psrd_table_column_get_float32_values.restype = ctypes.c_int
+    lib.psrd_table_column_get_float32_values.argtypes = [ctypes.c_void_p, ctypes.c_long, ctypes.POINTER(ctypes.c_float), ctypes.c_void_p]
+    lib.psrd_table_column_get_float64_values.restype = ctypes.c_int
+    lib.psrd_table_column_get_float64_values.argtypes = [ctypes.c_void_p, ctypes.c_long, ctypes.POINTER(ctypes.c_double), ctypes.c_void_p]
+    lib.psrd_table_column_get_int32_values.restype = ctypes.c_int
+    lib.psrd_table_column_get_int32_values.argtypes = [ctypes.c_void_p, ctypes.c_long, ctypes.POINTER(ctypes.c_int), ctypes.c_void_p]
+    lib.psrd_table_column_get_int64_values.restype = ctypes.c_int
+    lib.psrd_table_column_get_int64_values.argtypes = [ctypes.c_void_p, ctypes.c_long, ctypes.POINTER(ctypes.c_longlong), ctypes.c_void_p]
+    lib.psrd_table_column_get_date_values.restype = ctypes.c_int
+    lib.psrd_table_column_get_date_values.argtypes = [ctypes.c_void_p, ctypes.c_long, ctypes.POINTER(ctypes.c_longlong), ctypes.c_void_p]
+    lib.psrd_table_index_get_int32_values.restype = ctypes.c_int
+    lib.psrd_table_index_get_int32_values.argtypes = [ctypes.c_void_p, ctypes.c_long, ctypes.POINTER(ctypes.c_int), ctypes.c_void_p]
+    lib.psrd_table_index_get_int64_values.restype = ctypes.c_int
+    lib.psrd_table_index_get_int64_values.argtypes = [ctypes.c_void_p, ctypes.c_long, ctypes.POINTER(ctypes.c_longlong), ctypes.c_void_p]
+    lib.psrd_table_index_get_date_values.restype = ctypes.c_int
+    lib.psrd_table_index_get_date_values.argtypes = [ctypes.c_void_p, ctypes.c_long, ctypes.POINTER(ctypes.c_longlong), ctypes.c_void_p]
+    lib.psrd_new_date_iterator.restype = ctypes.c_void_p
+    lib.psrd_new_date_iterator.argtypes = []
+    lib.psrd_free_date_iterator.restype = ctypes.c_int
+    lib.psrd_free_date_iterator.argtypes = [ctypes.c_void_p]
+    lib.psrd_date_iterator_at_start.restype = ctypes.c_int
+    lib.psrd_date_iterator_at_start.argtypes = [ctypes.c_void_p, ctypes.POINTER(ctypes.c_bool), ctypes.c_void_p]
+    lib.psrd_date_iterator_at_end.restype = ctypes.c_int
+    lib.psrd_date_iterator_at_end.argtypes = [ctypes.c_void_p, ctypes.POINTER(ctypes.c_bool), ctypes.c_void_p]
+    lib.psrd_date_iterator_get_value.restype = ctypes.c_int
+    lib.psrd_date_iterator_get_value.argtypes = [ctypes.c_void_p, ctypes.c_char_p, ctypes.c_long, ctypes.c_void_p]
+    lib.psrd_convert_output.restype = ctypes.c_int
+    lib.psrd_convert_output.argtypes = [ctypes.c_char_p, ctypes.c_long, ctypes.c_char_p, ctypes.c_long, ctypes.c_void_p, ctypes.c_void_p]
+

psr/factory/samples/__init__.py

@@ -0,0 +1,2 @@
+from .sddp_case01 import create_case01
+from .sddp_case21 import create_case21

psr/factory/samples/sddp_case01.py

@@ -0,0 +1,166 @@
+"""Creates SDDP 1 stage Case01 example."""
+import copy
+import os
+
+import psr.factory
+
+
+def _get_case_path() -> str:
+    return os.path.join(os.path.splitext(os.path.basename(__file__))[0], "")
+
+
+def create_case01(legacy: bool = False) -> psr.factory.Study:
+    blocks = 1
+    model = "SDDP" if not legacy else "SDDP17"
+    # Create a study object and define its basic settings.
+    study = psr.factory.create_study({
+        "Models": [model, ], # Default model: SDDP
+        "Blocks": blocks, # Default number of blocks: 1
+        "StageType": 2,   # Weekly: 1 (default), Monthly: 2
+    })
+    study.from_dict({
+        "Description": "Caso ejemplo - DT - 1 etapa - 1 bloque",
+        "InitialYear": 2013,
+        "InitialStage": 1,
+        "NumberOfStages": 1,
+        "NumberOfSeries": 1,
+    })
+
+    # Study options
+    study.from_dict({
+        "PARModel": 2,
+        "InitialYearOfHydrology": 1996,
+        "NumberOfSystems": 1,
+        "AggregateInTheOperationPolicy": 0,
+        "UMON": "$",
+        "LoadSheddingInBuses": 0,
+        "MonitoringOfCircuitLimits": 0,
+        "HourlyRepresentation": 0,
+        "MaximumNumberOfIterations": 10,
+        "MinimumOutflowPenaltyHm3": 5000.0,
+        "DeficitSegment": [100.0, 0.0, 0.0, 0.0],
+        "DeficitCost": [500.0, 0.0, 0.0, 0.0],
+        "FutureCostStage": 4,
+        "FutureCostYear": 1998,
+    })
+
+    # Study duration
+    study.set("FixedDurationOfBlocks(1)", 100.0)
+
+    # By default, a study comes with one system.
+    system = study.get("System")[0]
+    system.code = 1
+    system.id = "s1"
+    system.name = "System 1"
+    # System's currency
+    system.set("SystemCurrency", "$")
+    # It's not required to add an existing object to the study.
+
+    # Set study to run with this unique system
+    study.set("CodesOfPowerSystems", [1, ])
+
+    # Create a demand segment - it's required to add at least
+    # an inelastic segment to a demand object.
+    segment = psr.factory.create("DemandSegment", study.context)
+    segment.code = 1
+    # Set demand and cost data.
+    segment.set_at("EnergyPerBlock(:)", "01/2013", 8.928)
+    # Add segment to the study.
+    study.add(segment)
+
+    # Create a system demand.
+    demand = psr.factory.create("Demand", study.context)
+    demand.code = 1
+    demand.name = "System 1"
+    # Associate it with the only system in the case.
+    demand.set("RefSystem", system)
+    # Associate the demand with its segments.
+    demand.set("RefSegments", [segment, ])
+    # Add demand to the study.
+    study.add(demand)
+
+    # Create all fuels - Thermal plants requires then.
+    fuel1 = psr.factory.create("Fuel", study.context)
+    fuel1.code = 1
+    fuel1.name = "Fuel 1"
+    fuel1.from_dict({
+        "Unit": "UC",
+        "UE": "MWh",
+        "Price": 0.8,
+        "EmissionFactor": 0.0,
+        "RefSystem": system,
+    })
+    study.add(fuel1)
+
+    fuel2 = psr.factory.create("Fuel", study.context)
+    fuel2.code = 2
+    fuel2.name = "Fuel 2"
+    fuel2.from_dict({
+        "Unit": "UC",
+        "UE": "MWh",
+        "Price": 1.2,
+        "EmissionFactor": 0.0,
+        "RefSystem": system,
+    })
+    study.add(fuel2)
+
+    # Create all thermal plants.
+    plant1 = study.create("ThermalPlant")
+    plant1.code = 1
+    plant1.name = "Thermal 1"
+    # Set plant's properties
+    t_params = {
+        "MaximumGenerationCapacity": 10.0,
+        "InstalledCapacity": 10.0,
+        "ThermalType": 0,
+        "Type": 0,
+        "NumberOfUnits": 1,
+        "NumberOfAlternativeFuels": 0,
+        "CodeOfAlternativeFuels(:)": 0,
+        "O&MCost": 0.0,
+        "FuelTransportationCost": 0.0,
+        "SpecificConsumptionSegment(1)": 100.0,
+        "SpecificConsumptionSegment(2:3)": 0.0,
+        "SpecificConsumption(1:3,1)": 10.0,
+        "RefFuels": [fuel1, ],
+        "RefSystem": system,
+    }
+    plant1.from_dict(t_params)
+    study.add(plant1)
+
+    # Use Python copy's module copy function to create
+    # a copy of an object.
+    plant2 = copy.copy(plant1)
+    plant2.code = 2
+    plant2.name = "Thermal 2"
+    plant2.set("MaximumGenerationCapacity", 5.0)
+    plant2.set("InstalledCapacity", 5.0)
+    plant2.set("SpecificConsumption(1:3,1)", 15.0)
+    plant2.set("RefFuels", [fuel1, ])
+    plant2.set("RefSystem", system)
+    study.add(plant2)
+
+    plant3 = plant2.clone()
+    plant3.code = 3
+    plant3.name = "Thermal 3"
+    plant3.from_dict({
+        "MaximumGenerationCapacity": 20.0,
+        "InstalledCapacity": 20.0,
+        "SpecificConsumption(1:3,1)": 12.5,
+        "RefFuels": [fuel2, ],
+        "RefSystem": system,
+    })
+    study.add(plant3)
+
+    return study
+
+
+if __name__ == "__main__":
+    case_path = _get_case_path()
+    os.makedirs(case_path, exist_ok=True)
+    print("Creating example case... ", end="")
+    study = create_case01(False)
+    print(" OK.")
+    print("Saving example case in \"{}\"... ".format(case_path), end="")
+    study.save(case_path)
+    print(" OK.")