diff --git a/2025R2/optiSLang-python-api/index.md b/2025R2/optiSLang-python-api/index.md index 0528025b86..5da89ee813 100644 --- a/2025R2/optiSLang-python-api/index.md +++ b/2025R2/optiSLang-python-api/index.md @@ -1,10 +1,4 @@ - # optiSLang Python API 2025 R2 dev (701) Welcome to the optiSLang Python API documentation. - - -# Available modules: - -* [Module Index](py-modindex.md) diff --git a/2025R2/optiSLang-python-api/modules/PyARSM.md b/2025R2/optiSLang-python-api/modules/PyARSM.md index 22b8331f65..85d420cdc9 100644 --- a/2025R2/optiSLang-python-api/modules/PyARSM.md +++ b/2025R2/optiSLang-python-api/modules/PyARSM.md @@ -1,78 +1,108 @@ + -### *class* PyARSM.Arsm +# PyARSM + -#### \_\_init_\_(arg2: [OptimizerSettingsARSM](#PyARSM.OptimizerSettingsARSM)) +## *class* PyARSM.Arsm + -#### get_iteration_number() → int +### \_\_init_\_(arg2: [OptimizerSettingsARSM](#PyARSM.OptimizerSettingsARSM)) + -#### set_responses(arg2: [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type)) +### get_iteration_number() → int + -#### set_terminated() +### set_responses(arg2: [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type)) + -### *class* PyARSM.OptimizerSettingsARSM +### set_terminated() + -#### \_\_init_\_() +## *class* PyARSM.OptimizerSettingsARSM + -#### get_doe_settings() → [DOESettings](py_doe_settings.md#py_doe_settings.DOESettings) +### \_\_init_\_() + -#### get_max_iteration() → int +### get_doe_settings() → [DOESettings](py_doe_settings.md#py_doe_settings.DOESettings) + -#### get_min_iteration() → int +### get_max_iteration() → int + -#### get_min_objective_diff() → float +### get_min_iteration() → int + -#### get_min_parameter_diff() → float +### get_min_objective_diff() → float + -#### get_min_range() → float +### get_min_parameter_diff() → float + -#### get_order() → int +### get_min_range() → float + -#### get_start_range() → float +### get_order() → int + -#### set_box_cox(arg2: bool) +### get_start_range() → float + -#### set_doe_settings(arg2: [DOESettings](py_doe_settings.md#py_doe_settings.DOESettings)) +### set_box_cox(arg2: bool) + -#### set_evaluate_criteria(arg2: bool) +### set_doe_settings(arg2: [DOESettings](py_doe_settings.md#py_doe_settings.DOESettings)) + -#### set_max_iteration(arg2: int) +### set_evaluate_criteria(arg2: bool) + -#### set_min_iteration(arg2: int) +### set_max_iteration(arg2: int) + -#### set_min_objective_diff(arg2: float) +### set_min_iteration(arg2: int) + -#### set_min_parameter_diff(arg2: float) +### set_min_objective_diff(arg2: float) + -#### set_min_range(arg2: float) +### set_min_parameter_diff(arg2: float) + -#### set_mixed_terms(arg2: bool) +### set_min_range(arg2: float) + -#### set_order(arg2: int) +### set_mixed_terms(arg2: bool) + -#### set_start_range(arg2: float) +### set_order(arg2: int) + + + +### set_start_range(arg2: float) diff --git a/2025R2/optiSLang-python-api/modules/PyMemetic.md b/2025R2/optiSLang-python-api/modules/PyMemetic.md index 10ad0ce0ec..07c95d6ae7 100644 --- a/2025R2/optiSLang-python-api/modules/PyMemetic.md +++ b/2025R2/optiSLang-python-api/modules/PyMemetic.md @@ -1,28 +1,40 @@ + -### *class* PyMemetic.Memetic +# PyMemetic + -#### \_\_init_\_() +## *class* PyMemetic.Memetic -#### \_\_init_\_(arg2: [MemeticSettings](#PyMemetic.MemeticSettings)) + +### \_\_init_\_() -### *class* PyMemetic.MemeticSettings +### \_\_init_\_(arg2: [MemeticSettings](#PyMemetic.MemeticSettings)) + -#### \_\_init_\_() +## *class* PyMemetic.MemeticSettings -#### \_\_init_\_() + +### \_\_init_\_() -#### set_inner_optimizer_settings(arg2: [PyOptimizerBase.SettingsBase](PyOptimizerBase.md#PyOptimizerBase.SettingsBase)) +### \_\_init_\_() + -#### set_outer_optimizer_settings(arg2: [PyOptimizerBase.SettingsBase](PyOptimizerBase.md#PyOptimizerBase.SettingsBase)) +### set_inner_optimizer_settings(arg2: [PyOptimizerBase.SettingsBase](PyOptimizerBase.md#PyOptimizerBase.SettingsBase)) + -#### set_parameter_types(arg2: [DeterministicTypeVec](dynardo_py_algorithms.md#dynardo_py_algorithms.DeterministicTypeVec)) +### set_outer_optimizer_settings(arg2: [PyOptimizerBase.SettingsBase](PyOptimizerBase.md#PyOptimizerBase.SettingsBase)) + -#### set_seed(arg2: int) +### set_parameter_types(arg2: [DeterministicTypeVec](dynardo_py_algorithms.md#dynardo_py_algorithms.DeterministicTypeVec)) + + + +### set_seed(arg2: int) diff --git a/2025R2/optiSLang-python-api/modules/PyNLPQLP.md b/2025R2/optiSLang-python-api/modules/PyNLPQLP.md index d5ca5b0bd2..c5f3ed47a4 100644 --- a/2025R2/optiSLang-python-api/modules/PyNLPQLP.md +++ b/2025R2/optiSLang-python-api/modules/PyNLPQLP.md @@ -1,113 +1,142 @@ + -### *class* PyNLPQLP.DiffType +# PyNLPQLP + + + +## *class* PyNLPQLP.DiffType **Enumeration** + -#### BACKWARD *= PyNLPQLP.DiffType.BACKWARD* +### BACKWARD *= PyNLPQLP.DiffType.BACKWARD* + -#### CENTRAL *= PyNLPQLP.DiffType.CENTRAL* +### CENTRAL *= PyNLPQLP.DiffType.CENTRAL* + -#### FORWARD *= PyNLPQLP.DiffType.FORWARD* +### FORWARD *= PyNLPQLP.DiffType.FORWARD* + -#### FOURTH_ORDER *= PyNLPQLP.DiffType.FOURTH_ORDER* +### FOURTH_ORDER *= PyNLPQLP.DiffType.FOURTH_ORDER* + -### *class* PyNLPQLP.NLPQLP +## *class* PyNLPQLP.NLPQLP + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [SettingsNLPQLP](#PyNLPQLP.SettingsNLPQLP)) +### \_\_init_\_(arg2: [SettingsNLPQLP](#PyNLPQLP.SettingsNLPQLP)) + -### *class* PyNLPQLP.SettingsNLPQLP +## *class* PyNLPQLP.SettingsNLPQLP + -#### \_\_init_\_() +### \_\_init_\_() + -#### get_accuracy() → float +### get_accuracy() → float Get tolerance by which optimality conditions are met. + -#### get_gradient_dx() → [vector_type](dynardo_py_algorithms.md#dynardo_py_algorithms.vector_type) +### get_gradient_dx() → [vector_type](dynardo_py_algorithms.md#dynardo_py_algorithms.vector_type) Get differentiation step size. + -#### get_line_search_stack_size() → int +### get_line_search_stack_size() → int Get value of nonmonotonous line search stack size. + -#### get_max_num_function_calls() → int +### get_max_num_function_calls() → int Get the maximum allowed number of function calls. + -#### get_max_step_size() → int +### get_max_step_size() → int + -#### get_number_of_parallel_line_searches() → int +### get_number_of_parallel_line_searches() → int Get number of line searches running parallel. + -#### get_numerical_differences() → [DiffType](#PyNLPQLP.DiffType) +### get_numerical_differences() → [DiffType](#PyNLPQLP.DiffType) Get value used for the differentiaion scheme. + -#### *property* min_line_search_stepsize +### *property* min_line_search_stepsize Default 0 means auto detection of step size. + -#### set_accuracy(arg2: float) +### set_accuracy(arg2: float) Set tolerance by which optimality conditions are met. + -#### set_gradient_dx(arg2: float) +### set_gradient_dx(arg2: float) -#### set_gradient_dx(arg2: [vector_type](dynardo_py_algorithms.md#dynardo_py_algorithms.vector_type)) +### set_gradient_dx(arg2: [vector_type](dynardo_py_algorithms.md#dynardo_py_algorithms.vector_type)) [0] Set differentiation step size. [1] Set differentiation step size. + -#### set_line_search_stack_size(arg2: int) +### set_line_search_stack_size(arg2: int) Set value of nonmonotonous line search stack size. + -#### set_max_num_function_calls(arg2: int) +### set_max_num_function_calls(arg2: int) Set the maximum allowed number of function calls. + -#### set_max_step_size(arg2: float) +### set_max_step_size(arg2: float) -#### set_max_step_size(arg2: [vector_type](dynardo_py_algorithms.md#dynardo_py_algorithms.vector_type)) +### set_max_step_size(arg2: [vector_type](dynardo_py_algorithms.md#dynardo_py_algorithms.vector_type)) + -#### set_number_of_parallel_line_searches(arg2: int) +### set_number_of_parallel_line_searches(arg2: int) Set number of line searches running parallel. + -#### set_numerical_differences(arg2: [DiffType](#PyNLPQLP.DiffType)) +### set_numerical_differences(arg2: [DiffType](#PyNLPQLP.DiffType)) Set value used for the differentiaion scheme. + -#### *property* use_initial_stepsize_limit +### *property* use_initial_stepsize_limit Initial stepsize limit. diff --git a/2025R2/optiSLang-python-api/modules/PyNOA.md b/2025R2/optiSLang-python-api/modules/PyNOA.md index 5ecde41fe0..808d9e0267 100644 --- a/2025R2/optiSLang-python-api/modules/PyNOA.md +++ b/2025R2/optiSLang-python-api/modules/PyNOA.md @@ -1,437 +1,544 @@ + -### *class* PyNOA.AdaptionMethods +# PyNOA + + + +## *class* PyNOA.AdaptionMethods **Enumeration** + -#### Arithmetic *= PyNOA.AdaptionMethods.Arithmetic* +### Arithmetic *= PyNOA.AdaptionMethods.Arithmetic* + -#### Copy *= PyNOA.AdaptionMethods.Copy* +### Copy *= PyNOA.AdaptionMethods.Copy* + -#### Multipoint *= PyNOA.AdaptionMethods.Multipoint* +### Multipoint *= PyNOA.AdaptionMethods.Multipoint* + -#### PSO *= PyNOA.AdaptionMethods.PSO* +### PSO *= PyNOA.AdaptionMethods.PSO* + -#### SBX *= PyNOA.AdaptionMethods.SBX* +### SBX *= PyNOA.AdaptionMethods.SBX* + -#### Singlepoint *= PyNOA.AdaptionMethods.Singlepoint* +### Singlepoint *= PyNOA.AdaptionMethods.Singlepoint* + -#### Uniform *= PyNOA.AdaptionMethods.Uniform* +### Uniform *= PyNOA.AdaptionMethods.Uniform* + -### *class* PyNOA.Design +## *class* PyNOA.Design + -#### \_\_init_\_() +### \_\_init_\_() + -#### get_actual_number() → int +### get_actual_number() → int + -#### get_objective() → [doubleVec](stdcpp_python_export.md#stdcpp_python_export.doubleVec) +### get_objective() → [doubleVec](stdcpp_python_export.md#stdcpp_python_export.doubleVec) + -#### get_parameters() → [doubleVec](stdcpp_python_export.md#stdcpp_python_export.doubleVec) +### get_parameters() → [doubleVec](stdcpp_python_export.md#stdcpp_python_export.doubleVec) + -### *class* PyNOA.MutationMethods +## *class* PyNOA.MutationMethods **Enumeration** + -#### ConstraintAdaptive *= PyNOA.MutationMethods.ConstraintAdaptive* +### ConstraintAdaptive *= PyNOA.MutationMethods.ConstraintAdaptive* + -#### ModulatedAdaptive *= PyNOA.MutationMethods.ModulatedAdaptive* +### ModulatedAdaptive *= PyNOA.MutationMethods.ModulatedAdaptive* + -#### NormalDistribution *= PyNOA.MutationMethods.NormalDistribution* +### NormalDistribution *= PyNOA.MutationMethods.NormalDistribution* + -#### SelfAdaptive *= PyNOA.MutationMethods.SelfAdaptive* +### SelfAdaptive *= PyNOA.MutationMethods.SelfAdaptive* + -### *class* PyNOA.NOA +## *class* PyNOA.NOA + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [PyOptimizerBase.SettingsBase](PyOptimizerBase.md#PyOptimizerBase.SettingsBase)) +### \_\_init_\_(arg2: [PyOptimizerBase.SettingsBase](PyOptimizerBase.md#PyOptimizerBase.SettingsBase)) + -### *class* PyNOA.NOASettings +## *class* PyNOA.NOASettings + -#### \_\_init_\_() +### \_\_init_\_() + -#### append_adaption_method(arg2: [AdaptionMethods](#PyNOA.AdaptionMethods)) +### append_adaption_method(arg2: [AdaptionMethods](#PyNOA.AdaptionMethods)) Append a new adaption method. Use set_adaption_method to reset. + -#### change_default_settings(population: int size, max: int. generations, lower: doubleVec bounds, upper: doubleVec bounds) +### change_default_settings(population: int size, max: int. generations, lower: doubleVec bounds, upper: doubleVec bounds) + -#### get_adaption_methods() → list +### get_adaption_methods() → list Get a list of all set adaption methods. + -#### get_arch_size() → int +### get_arch_size() → int Get maximum archive size. + -#### get_cliff_value() → float +### get_cliff_value() → float Get cliff for penalty term. + -#### get_contraint_scaling_factor() → float +### get_contraint_scaling_factor() → float Get scaling factor for constraints. + -#### get_crossover_probabilities() → list +### get_crossover_probabilities() → list Get a list of all crossover probabilities. + -#### get_distribution_parameters() → list +### get_distribution_parameters() → list Get a list of all distribution parameters. + -#### get_fitness_scaling() → bool +### get_fitness_scaling() → bool Get use automatic fitness scaling. + -#### get_hybrid() → bool +### get_hybrid() → bool Get use hybrid adaption. + -#### get_max_archive_size() → int +### get_max_archive_size() → int Return maximum archive size. + -#### get_max_gen() → int +### get_max_gen() → int Get maximum number of generations. + -#### get_min_gen() → int +### get_min_gen() → int Get minimum number of generations. + -#### get_mut_gnr() → float +### get_mut_gnr() → float Get number of mutating generations. + -#### get_mut_rate() → float +### get_mut_rate() → float Get probability of mutation. + -#### get_mutate() → bool +### get_mutate() → bool Get whether to mutate or not. + -#### get_mutation_method() → [MutationMethods](#PyNOA.MutationMethods) +### get_mutation_method() → [MutationMethods](#PyNOA.MutationMethods) Get mutation method. + -#### get_mutation_std_dev() → tuple +### get_mutation_std_dev() → tuple Get mutation standard deviation values. + -#### get_number_of_parents() → int +### get_number_of_parents() → int + -#### get_numbers_of_crosspoints() → list +### get_numbers_of_crosspoints() → list Get a list of all numbers of crosspoints. + -#### get_penalty_method() → [PenaltyMethods](#PyNOA.PenaltyMethods) +### get_penalty_method() → [PenaltyMethods](#PyNOA.PenaltyMethods) Get penalty method to evaluate constraint violations. + -#### get_ranking_method() → [RankingMethods](#PyNOA.RankingMethods) +### get_ranking_method() → [RankingMethods](#PyNOA.RankingMethods) Get ranking method. + -#### get_seed() → int +### get_seed() → int + -#### get_selection_method() → [SelectionMethods](#PyNOA.SelectionMethods) +### get_selection_method() → [SelectionMethods](#PyNOA.SelectionMethods) Get selection method. + -#### get_selection_pressure() → float +### get_selection_pressure() → float Get value for selection pressure. + -#### get_stagnation_generations() → int +### get_stagnation_generations() → int Get convergence parameter. + -#### get_stagnation_limit() → float +### get_stagnation_limit() → float Get convergence parameter. + -#### get_start_pop_size() → int +### get_start_pop_size() → int + -#### get_tournament_size() → int +### get_tournament_size() → int Get number of designs to compare in tournament. + -#### *property* parameter_free +### *property* parameter_free Whether to use parameter free constraint handling in penalty method. + -#### *property* roulette_with_replacement +### *property* roulette_with_replacement Roulette selection applied with replacement. + -#### set_adaption_method(arg2: [AdaptionMethods](#PyNOA.AdaptionMethods)) +### set_adaption_method(arg2: [AdaptionMethods](#PyNOA.AdaptionMethods)) Reset adaption methods and set first adaption method. + -#### set_arch_size(arg2: int) +### set_arch_size(arg2: int) Set maximum archive size. + -#### set_bounds(lower: doubleVec bounds, upper: doubleVec bounds) +### set_bounds(lower: doubleVec bounds, upper: doubleVec bounds) Set limiting bound for each dimension. + -#### set_cliff_value(arg2: float) +### set_cliff_value(arg2: float) Set cliff for penalty term. + -#### set_contraint_scaling_factor(arg2: float) +### set_contraint_scaling_factor(arg2: float) Set scaling factor for constraints. + -#### set_crossover_probability(arg2: float) +### set_crossover_probability(arg2: float) Set crossover rate. + -#### set_default(adaption: AdaptionMethods method, local: bool search) +### set_default(adaption: AdaptionMethods method, local: bool search) Apply default settings. + -#### set_distribution_parameter(arg2: float) +### set_distribution_parameter(arg2: float) Set distribution parameter for SBX. + -#### set_ea_balanced() +### set_ea_balanced() Set defaults for EA - balanced. + -#### set_ea_global() +### set_ea_global() Set defaults for EA - global. + -#### set_ea_local() +### set_ea_local() Set defaults for EA - local. + -#### set_fitness_scaling(arg2: bool) +### set_fitness_scaling(arg2: bool) Set use automatic fitness scaling. + -#### set_hybrid(arg2: bool) +### set_hybrid(arg2: bool) Set use hybrid adaption. + -#### set_max_gen(arg2: int) +### set_max_gen(arg2: int) Set maximum number of generations. + -#### set_min_gen(arg2: int) +### set_min_gen(arg2: int) Set minimum number of generations. + -#### set_mut_gnr(arg2: float) +### set_mut_gnr(arg2: float) Set number of mutating generations. + -#### set_mut_rate(arg2: float) +### set_mut_rate(arg2: float) Set probability of mutation. + -#### set_mutate(arg2: bool) +### set_mutate(arg2: bool) Set whether to mutate or not. + -#### set_mutation_method(arg2: [MutationMethods](#PyNOA.MutationMethods)) +### set_mutation_method(arg2: [MutationMethods](#PyNOA.MutationMethods)) Set mutation method. + -#### set_mutation_std_dev(lower: float bound continuous parameter, upper: float bound continuous parameter, lower: float bound discrete parameter, upper: float bound discrete parameter) +### set_mutation_std_dev(lower: float bound continuous parameter, upper: float bound continuous parameter, lower: float bound discrete parameter, upper: float bound discrete parameter) Set mutation standard deviation. + -#### set_number_of_crosspoints(arg2: int) +### set_number_of_crosspoints(arg2: int) Set number of crosspoints. + -#### set_number_of_parents(Set: int number of parents.) +### set_number_of_parents(Set: int number of parents.) + -#### set_penalty_method(arg2: [PenaltyMethods](#PyNOA.PenaltyMethods)) +### set_penalty_method(arg2: [PenaltyMethods](#PyNOA.PenaltyMethods)) Set penalty method to evaluate constraint violations. + -#### set_pso_coefficients(intertia: float weight at first generation, intertia: float weight at last generation, personal: float acceleration coefficient at first generation, personal: float acceleration coefficient at last generation, global: float acceleration coefficient at first generation, global: float acceleration coefficient at last generation) +### set_pso_coefficients(intertia: float weight at first generation, intertia: float weight at last generation, personal: float acceleration coefficient at first generation, personal: float acceleration coefficient at last generation, global: float acceleration coefficient at first generation, global: float acceleration coefficient at last generation) Set parameters relevant to PSO. + -#### set_pso_global() +### set_pso_global() Set defaults for PSO - global. + -#### set_pso_local() +### set_pso_local() Set defaults for PSO - local. + -#### set_ranking_method(arg2: [RankingMethods](#PyNOA.RankingMethods)) +### set_ranking_method(arg2: [RankingMethods](#PyNOA.RankingMethods)) Set ranking method. + -#### set_seed(arg2: int) +### set_seed(arg2: int) + -#### set_selection_method(arg2: [SelectionMethods](#PyNOA.SelectionMethods)) +### set_selection_method(arg2: [SelectionMethods](#PyNOA.SelectionMethods)) Set selection method. + -#### set_selection_pressure(arg2: float) +### set_selection_pressure(arg2: float) Set value for selection pressure. + -#### set_stagnation_generations(arg2: int) +### set_stagnation_generations(arg2: int) Set convergence parameter. + -#### set_stagnation_limit(arg2: float) +### set_stagnation_limit(arg2: float) Set convergence parameter. + -#### set_start_pop_size(Set: int start population size.) +### set_start_pop_size(Set: int start population size.) + -#### set_tournament_size(arg2: int) +### set_tournament_size(arg2: int) Set number of designs to compare in tournament. + -### *class* PyNOA.PenaltyMethods +## *class* PyNOA.PenaltyMethods **Enumeration** + -#### DISTANCE *= PyNOA.PenaltyMethods.DISTANCE* +### DISTANCE *= PyNOA.PenaltyMethods.DISTANCE* + -#### HYBRID *= PyNOA.PenaltyMethods.HYBRID* +### HYBRID *= PyNOA.PenaltyMethods.HYBRID* + -#### NUM_VIOLATIONS *= PyNOA.PenaltyMethods.NUM_VIOLATIONS* +### NUM_VIOLATIONS *= PyNOA.PenaltyMethods.NUM_VIOLATIONS* + -### *class* PyNOA.RankingMethods +## *class* PyNOA.RankingMethods **Enumeration** + -#### CrowdingDensity *= PyNOA.RankingMethods.CrowdingDensity* +### CrowdingDensity *= PyNOA.RankingMethods.CrowdingDensity* + -#### CumulatedDensity *= PyNOA.RankingMethods.CumulatedDensity* +### CumulatedDensity *= PyNOA.RankingMethods.CumulatedDensity* + -#### Exponential *= PyNOA.RankingMethods.Exponential* +### Exponential *= PyNOA.RankingMethods.Exponential* + -#### Linear *= PyNOA.RankingMethods.Linear* +### Linear *= PyNOA.RankingMethods.Linear* + -#### Pareto *= PyNOA.RankingMethods.Pareto* +### Pareto *= PyNOA.RankingMethods.Pareto* + -### *class* PyNOA.SelectionMethods +## *class* PyNOA.SelectionMethods **Enumeration** + -#### ArchiveBest *= PyNOA.SelectionMethods.ArchiveBest* +### ArchiveBest *= PyNOA.SelectionMethods.ArchiveBest* + -#### PopulationBest *= PyNOA.SelectionMethods.PopulationBest* +### PopulationBest *= PyNOA.SelectionMethods.PopulationBest* + -#### Roulette *= PyNOA.SelectionMethods.Roulette* +### Roulette *= PyNOA.SelectionMethods.Roulette* + -#### Stochastic *= PyNOA.SelectionMethods.Stochastic* +### Stochastic *= PyNOA.SelectionMethods.Stochastic* + -#### Tournament *= PyNOA.SelectionMethods.Tournament* +### Tournament *= PyNOA.SelectionMethods.Tournament* diff --git a/2025R2/optiSLang-python-api/modules/PyNOA2.md b/2025R2/optiSLang-python-api/modules/PyNOA2.md index f338290069..e7784e419d 100644 --- a/2025R2/optiSLang-python-api/modules/PyNOA2.md +++ b/2025R2/optiSLang-python-api/modules/PyNOA2.md @@ -1,374 +1,496 @@ + -### *class* PyNOA2.CMA +# PyNOA2 + -#### \_\_init_\_() +## *class* PyNOA2.CMA + -### *class* PyNOA2.ConstraintHandling +### \_\_init_\_() + + + +## *class* PyNOA2.ConstraintHandling **Enumeration** + -#### PENALTY_DISTANCE *= PyNOA2.ConstraintHandling.PENALTY_DISTANCE* +### PENALTY_DISTANCE *= PyNOA2.ConstraintHandling.PENALTY_DISTANCE* + -#### PENALTY_RANK *= PyNOA2.ConstraintHandling.PENALTY_RANK* +### PENALTY_RANK *= PyNOA2.ConstraintHandling.PENALTY_RANK* + -### *class* PyNOA2.EA +## *class* PyNOA2.EA + -#### \_\_init_\_() +### \_\_init_\_() + -### *class* PyNOA2.FitnessMethod +## *class* PyNOA2.FitnessMethod **Enumeration** + -#### PARETO_DOMINANCE *= PyNOA2.FitnessMethod.PARETO_DOMINANCE* +### PARETO_DOMINANCE *= PyNOA2.FitnessMethod.PARETO_DOMINANCE* + -#### WEIGHTED_SUM *= PyNOA2.FitnessMethod.WEIGHTED_SUM* +### WEIGHTED_SUM *= PyNOA2.FitnessMethod.WEIGHTED_SUM* + -### *class* PyNOA2.MutationMethod +## *class* PyNOA2.MutationMethod **Enumeration** + -#### NONE *= PyNOA2.MutationMethod.NONE* +### NONE *= PyNOA2.MutationMethod.NONE* + -#### NORMAL_DISTRIBUTED *= PyNOA2.MutationMethod.NORMAL_DISTRIBUTED* +### NORMAL_DISTRIBUTED *= PyNOA2.MutationMethod.NORMAL_DISTRIBUTED* + -#### SELF_ADAPTIVE *= PyNOA2.MutationMethod.SELF_ADAPTIVE* +### SELF_ADAPTIVE *= PyNOA2.MutationMethod.SELF_ADAPTIVE* + -### *class* PyNOA2.NOABase +## *class* PyNOA2.NOABase + -#### \_\_init_\_() +### \_\_init_\_() Raises an exception This class cannot be instantiated from Python + -### *class* PyNOA2.OptimizerSettingsCMA +## *class* PyNOA2.OptimizerSettingsCMA + -#### \_\_init_\_() +### \_\_init_\_() + -#### get_initial_sigma() → float +### get_initial_sigma() → float + -#### get_parent_size() → int +### get_parent_size() → int + -#### set_defaults(arg2: int, arg3: [SearchStrategy](#PyNOA2.SearchStrategy)) +### set_defaults(arg2: int, arg3: [SearchStrategy](#PyNOA2.SearchStrategy)) + -#### set_initial_sigma(arg2: float) +### set_initial_sigma(arg2: float) + -#### set_parent_size(arg2: int) +### set_parent_size(arg2: int) + -### *class* PyNOA2.OptimizerSettingsEA +## *class* PyNOA2.OptimizerSettingsEA + -#### \_\_init_\_() +### \_\_init_\_() + -#### get_archive_size() → int +### get_archive_size() → int + -#### get_crossover_probability(arg2: int) → float +### get_crossover_probability(arg2: int) → float + -#### get_distribution_parameter(arg2: int) → float +### get_distribution_parameter(arg2: int) → float + -#### get_mutation_method() → [MutationMethod](#PyNOA2.MutationMethod) +### get_mutation_method() → [MutationMethod](#PyNOA2.MutationMethod) + -#### get_mutation_rate() → float +### get_mutation_rate() → float + -#### get_mutation_stddev_begin() → float +### get_mutation_stddev_begin() → float + -#### get_mutation_stddev_end() → float +### get_mutation_stddev_end() → float + -#### get_num_crossover_points(arg2: int) → int +### get_num_crossover_points(arg2: int) → int + -#### get_num_recombination_methods() → int +### get_num_recombination_methods() → int + -#### get_parent_size() → int +### get_parent_size() → int + -#### get_ranking_method() → [RankingMethod](#PyNOA2.RankingMethod) +### get_ranking_method() → [RankingMethod](#PyNOA2.RankingMethod) + -#### get_recombination_method(arg2: int) → [RecombinationMethod](#PyNOA2.RecombinationMethod) +### get_recombination_method(arg2: int) → [RecombinationMethod](#PyNOA2.RecombinationMethod) + -#### get_selection_method() → [SelectionMethod](#PyNOA2.SelectionMethod) +### get_selection_method() → [SelectionMethod](#PyNOA2.SelectionMethod) + -#### get_tournament_size() → int +### get_tournament_size() → int + -#### set_archive_size(arg2: int) +### set_archive_size(arg2: int) + -#### set_crossover_probability(arg2: int, arg3: float) +### set_crossover_probability(arg2: int, arg3: float) + -#### set_defaults(arg2: int, arg3: [SearchStrategy](#PyNOA2.SearchStrategy)) +### set_defaults(arg2: int, arg3: [SearchStrategy](#PyNOA2.SearchStrategy)) + -#### set_distribution_parameter(arg2: int, arg3: float) +### set_distribution_parameter(arg2: int, arg3: float) + -#### set_mutation_method(arg2: [MutationMethod](#PyNOA2.MutationMethod)) +### set_mutation_method(arg2: [MutationMethod](#PyNOA2.MutationMethod)) + -#### set_mutation_rate(arg2: float) +### set_mutation_rate(arg2: float) + -#### set_mutation_stddev(arg2: float, arg3: float) +### set_mutation_stddev(arg2: float, arg3: float) + -#### set_num_crossover_points(arg2: int, arg3: int) +### set_num_crossover_points(arg2: int, arg3: int) + -#### set_num_recombination_methods(arg2: int) +### set_num_recombination_methods(arg2: int) + -#### set_parent_size(arg2: int) +### set_parent_size(arg2: int) + -#### set_ranking_method(arg2: [RankingMethod](#PyNOA2.RankingMethod)) +### set_ranking_method(arg2: [RankingMethod](#PyNOA2.RankingMethod)) + -#### set_recombination_method(arg2: int, arg3: [RecombinationMethod](#PyNOA2.RecombinationMethod)) +### set_recombination_method(arg2: int, arg3: [RecombinationMethod](#PyNOA2.RecombinationMethod)) + -#### set_selection_method(arg2: [SelectionMethod](#PyNOA2.SelectionMethod)) +### set_selection_method(arg2: [SelectionMethod](#PyNOA2.SelectionMethod)) + -#### set_tournament_size(arg2: int) +### set_tournament_size(arg2: int) + -### *class* PyNOA2.OptimizerSettingsNOABase +## *class* PyNOA2.OptimizerSettingsNOABase + -#### \_\_init_\_() +### \_\_init_\_() Raises an exception This class cannot be instantiated from Python + -#### get_constraint_handling() → [ConstraintHandling](#PyNOA2.ConstraintHandling) +### get_constraint_handling() → [ConstraintHandling](#PyNOA2.ConstraintHandling) + -#### get_fitness_method() → [FitnessMethod](#PyNOA2.FitnessMethod) +### get_fitness_method() → [FitnessMethod](#PyNOA2.FitnessMethod) + -#### get_max_evaluations() → int +### get_max_evaluations() → int + -#### get_max_generations() → int +### get_max_generations() → int + -#### get_population_size() → int +### get_population_size() → int + -#### get_search_strategy() → [SearchStrategy](#PyNOA2.SearchStrategy) +### get_search_strategy() → [SearchStrategy](#PyNOA2.SearchStrategy) + -#### get_seed() → int +### get_seed() → int + -#### get_stagnation_generations() → int +### get_stagnation_generations() → int + -#### get_start_population_size() → int +### get_start_population_size() → int + -#### set_constraint_handling(arg2: [ConstraintHandling](#PyNOA2.ConstraintHandling)) +### set_constraint_handling(arg2: [ConstraintHandling](#PyNOA2.ConstraintHandling)) + -#### set_fitness_method(arg2: [FitnessMethod](#PyNOA2.FitnessMethod)) +### set_fitness_method(arg2: [FitnessMethod](#PyNOA2.FitnessMethod)) + -#### set_max_generations(arg2: int) +### set_max_generations(arg2: int) + -#### set_population_size(arg2: int) +### set_population_size(arg2: int) + -#### set_seed(arg2: int) +### set_seed(arg2: int) + -#### set_stagnation_generations(arg2: int) +### set_stagnation_generations(arg2: int) + -#### set_start_population_size(arg2: int) +### set_start_population_size(arg2: int) + -### *class* PyNOA2.OptimizerSettingsPSO +## *class* PyNOA2.OptimizerSettingsPSO + -#### \_\_init_\_() +### \_\_init_\_() + -#### get_global_acccoeff_begin() → float +### get_global_acccoeff_begin() → float + -#### get_global_acccoeff_end() → float +### get_global_acccoeff_end() → float + -#### get_inertia_weight_begin() → float +### get_inertia_weight_begin() → float + -#### get_inertia_weight_end() → float +### get_inertia_weight_end() → float + -#### get_passive_congrcoeff_begin() → float +### get_passive_congrcoeff_begin() → float + -#### get_passive_congrcoeff_end() → float +### get_passive_congrcoeff_end() → float + -#### get_personal_acccoeff_begin() → float +### get_personal_acccoeff_begin() → float + -#### get_personal_acccoeff_end() → float +### get_personal_acccoeff_end() → float + -#### set_defaults(arg2: int, arg3: [SearchStrategy](#PyNOA2.SearchStrategy)) +### set_defaults(arg2: int, arg3: [SearchStrategy](#PyNOA2.SearchStrategy)) + -#### set_global_acccoeff_begin(arg2: float) +### set_global_acccoeff_begin(arg2: float) + -#### set_global_acccoeff_end(arg2: float) +### set_global_acccoeff_end(arg2: float) + -#### set_inertia_weight_begin(arg2: float) +### set_inertia_weight_begin(arg2: float) + -#### set_inertia_weight_end(arg2: float) +### set_inertia_weight_end(arg2: float) + -#### set_passive_congrcoeff_begin(arg2: float) +### set_passive_congrcoeff_begin(arg2: float) + -#### set_passive_congrcoeff_end(arg2: float) +### set_passive_congrcoeff_end(arg2: float) + -#### set_personal_acccoeff_begin(arg2: float) +### set_personal_acccoeff_begin(arg2: float) + -#### set_personal_acccoeff_end(arg2: float) +### set_personal_acccoeff_end(arg2: float) + -### *class* PyNOA2.OptimizerSettingsSDI +## *class* PyNOA2.OptimizerSettingsSDI + -#### \_\_init_\_() +### \_\_init_\_() + -#### get_sampling_bounds_width() → float +### get_sampling_bounds_width() → float + -#### set_defaults(arg2: int, arg3: [SearchStrategy](#PyNOA2.SearchStrategy)) +### set_defaults(arg2: int, arg3: [SearchStrategy](#PyNOA2.SearchStrategy)) + -#### set_sampling_bounds_width(arg2: float) +### set_sampling_bounds_width(arg2: float) + -### *class* PyNOA2.PSO +## *class* PyNOA2.PSO + -#### \_\_init_\_() +### \_\_init_\_() + -### *class* PyNOA2.RankingMethod +## *class* PyNOA2.RankingMethod **Enumeration** + -#### EXPONENTIAL *= PyNOA2.RankingMethod.EXPONENTIAL* +### EXPONENTIAL *= PyNOA2.RankingMethod.EXPONENTIAL* + -#### LINEAR *= PyNOA2.RankingMethod.LINEAR* +### LINEAR *= PyNOA2.RankingMethod.LINEAR* + -#### PARETO *= PyNOA2.RankingMethod.PARETO* +### PARETO *= PyNOA2.RankingMethod.PARETO* + -### *class* PyNOA2.RecombinationMethod +## *class* PyNOA2.RecombinationMethod **Enumeration** + -#### ARITHMETIC *= PyNOA2.RecombinationMethod.ARITHMETIC* +### ARITHMETIC *= PyNOA2.RecombinationMethod.ARITHMETIC* + -#### COPY *= PyNOA2.RecombinationMethod.COPY* +### COPY *= PyNOA2.RecombinationMethod.COPY* + -#### MULTIPOINT *= PyNOA2.RecombinationMethod.MULTIPOINT* +### MULTIPOINT *= PyNOA2.RecombinationMethod.MULTIPOINT* + -#### SIMULATED_BINARY *= PyNOA2.RecombinationMethod.SIMULATED_BINARY* +### SIMULATED_BINARY *= PyNOA2.RecombinationMethod.SIMULATED_BINARY* + -#### SINGLEPOINT *= PyNOA2.RecombinationMethod.SINGLEPOINT* +### SINGLEPOINT *= PyNOA2.RecombinationMethod.SINGLEPOINT* + -#### UNIFORM *= PyNOA2.RecombinationMethod.UNIFORM* +### UNIFORM *= PyNOA2.RecombinationMethod.UNIFORM* + -### *class* PyNOA2.SDI +## *class* PyNOA2.SDI + -#### \_\_init_\_() +### \_\_init_\_() + -### *class* PyNOA2.SearchStrategy +## *class* PyNOA2.SearchStrategy **Enumeration** + -#### BALANCED *= PyNOA2.SearchStrategy.BALANCED* +### BALANCED *= PyNOA2.SearchStrategy.BALANCED* + -#### GLOBAL *= PyNOA2.SearchStrategy.GLOBAL* +### GLOBAL *= PyNOA2.SearchStrategy.GLOBAL* + -#### LOCAL *= PyNOA2.SearchStrategy.LOCAL* +### LOCAL *= PyNOA2.SearchStrategy.LOCAL* + -### *class* PyNOA2.SelectionMethod +## *class* PyNOA2.SelectionMethod **Enumeration** + -#### ROULETTE *= PyNOA2.SelectionMethod.ROULETTE* +### ROULETTE *= PyNOA2.SelectionMethod.ROULETTE* + -#### STOCHASTIC *= PyNOA2.SelectionMethod.STOCHASTIC* +### STOCHASTIC *= PyNOA2.SelectionMethod.STOCHASTIC* + -#### TOURNAMENT *= PyNOA2.SelectionMethod.TOURNAMENT* +### TOURNAMENT *= PyNOA2.SelectionMethod.TOURNAMENT* diff --git a/2025R2/optiSLang-python-api/modules/PyOptimizerBase.md b/2025R2/optiSLang-python-api/modules/PyOptimizerBase.md index 9caf793941..761900b4f7 100644 --- a/2025R2/optiSLang-python-api/modules/PyOptimizerBase.md +++ b/2025R2/optiSLang-python-api/modules/PyOptimizerBase.md @@ -1,126 +1,170 @@ + -### *class* PyOptimizerBase.OptimizerBase +# PyOptimizerBase + -#### \_\_init_\_() +## *class* PyOptimizerBase.OptimizerBase + + + +### \_\_init_\_() Raises an exception This class cannot be instantiated from Python + -#### adapt() +### adapt() + -#### appraise() +### appraise() + -#### finalize() +### finalize() + -#### get_awaiting_designs() → [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type) +### get_awaiting_designs() → [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type) + -#### get_best_design_numbers() → object +### get_best_design_numbers() → object + -#### get_best_equalities() → [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type) +### get_best_equalities() → [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type) + -#### get_best_inequalities() → [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type) +### get_best_inequalities() → [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type) + -#### get_best_inputs() → [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type) +### get_best_inputs() → [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type) + -#### get_best_objectives() → [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type) +### get_best_objectives() → [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type) + -#### get_criteria_success_info() → [bitset_type](dynardo_py_algorithms.md#dynardo_py_algorithms.bitset_type) +### get_criteria_success_info() → [bitset_type](dynardo_py_algorithms.md#dynardo_py_algorithms.bitset_type) + -#### get_equalities() → [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type) +### get_equalities() → [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type) + -#### get_inequalities() → [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type) +### get_inequalities() → [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type) + -#### get_inputs() → [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type) +### get_inputs() → [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type) + -#### get_next_designs() → [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type) +### get_next_designs() → [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type) + -#### get_num_awaiting_designs() → int +### get_num_awaiting_designs() → int + -#### get_objectives() → [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type) +### get_objectives() → [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type) + -#### initialize(arg2: [SettingsBase](#PyOptimizerBase.SettingsBase)) +### initialize(arg2: [SettingsBase](#PyOptimizerBase.SettingsBase)) + -#### is_converged() → bool +### is_converged() → bool + -#### is_terminated() → bool +### is_terminated() → bool + -#### set_criteria_success_info(arg2: [bitset_type](dynardo_py_algorithms.md#dynardo_py_algorithms.bitset_type)) +### set_criteria_success_info(arg2: [bitset_type](dynardo_py_algorithms.md#dynardo_py_algorithms.bitset_type)) + -#### set_equalities(arg2: [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type)) +### set_equalities(arg2: [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type)) + -#### set_inequalities(arg2: [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type)) +### set_inequalities(arg2: [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type)) + -#### set_inputs(arg2: [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type)) +### set_inputs(arg2: [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type)) + -#### set_objectives(arg2: [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type)) +### set_objectives(arg2: [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type)) + -#### set_terminated() +### set_terminated() + -### *class* PyOptimizerBase.SettingsBase +## *class* PyOptimizerBase.SettingsBase + -#### \_\_init_\_() +### \_\_init_\_() Raises an exception This class cannot be instantiated from Python + -#### get_num_equalities() → int +### get_num_equalities() → int + -#### get_num_inequalities() → int +### get_num_inequalities() → int + -#### get_num_inputs() → int +### get_num_inputs() → int + -#### get_num_objectives() → int +### get_num_objectives() → int + -#### set_defaults() +### set_defaults() + -#### set_lower_bounds(arg2: [vector_type](dynardo_py_algorithms.md#dynardo_py_algorithms.vector_type)) +### set_lower_bounds(arg2: [vector_type](dynardo_py_algorithms.md#dynardo_py_algorithms.vector_type)) + -#### set_num_inequalities(arg2: int) +### set_num_inequalities(arg2: int) + -#### set_num_inputs(arg2: int) +### set_num_inputs(arg2: int) + -#### set_num_objectives(arg2: int) +### set_num_objectives(arg2: int) + -#### set_start_designs(arg2: [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type)) +### set_start_designs(arg2: [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type)) + -#### set_upper_bounds(arg2: [vector_type](dynardo_py_algorithms.md#dynardo_py_algorithms.vector_type)) +### set_upper_bounds(arg2: [vector_type](dynardo_py_algorithms.md#dynardo_py_algorithms.vector_type)) diff --git a/2025R2/optiSLang-python-api/modules/PyOptimizerGradientBase.md b/2025R2/optiSLang-python-api/modules/PyOptimizerGradientBase.md index 5a007b99bb..9745b50722 100644 --- a/2025R2/optiSLang-python-api/modules/PyOptimizerGradientBase.md +++ b/2025R2/optiSLang-python-api/modules/PyOptimizerGradientBase.md @@ -1,9 +1,16 @@ + -### *class* PyOptimizerGradientBase.SettingsBase +# PyOptimizerGradientBase + -#### SetMaxNumFunctionCalls(arg2: int) +## *class* PyOptimizerGradientBase.SettingsBase + -#### \_\_init_\_() +### SetMaxNumFunctionCalls(arg2: int) + + + +### \_\_init_\_() diff --git a/2025R2/optiSLang-python-api/modules/PySimplex.md b/2025R2/optiSLang-python-api/modules/PySimplex.md index dd6a66cdc9..73ebd105b3 100644 --- a/2025R2/optiSLang-python-api/modules/PySimplex.md +++ b/2025R2/optiSLang-python-api/modules/PySimplex.md @@ -1,71 +1,92 @@ + -### *class* PySimplex.OptimizerSettingsSimplex +# PySimplex + -#### \_\_init_\_() +## *class* PySimplex.OptimizerSettingsSimplex + -#### get_max_iteration() → int +### \_\_init_\_() + + + +### get_max_iteration() → int Get number of maximum iterations. + -#### get_min_iteration_test() → int +### get_min_iteration_test() → int Get number of minimum iterations before test. + -#### get_min_objective_diff() → float +### get_min_objective_diff() → float Get tolerance for objective test. + -#### get_min_parameter_diff() → float +### get_min_parameter_diff() → float Get tolerance for parameter test: convergence test. + -#### get_start_range() → float +### get_start_range() → float Get start range for Simplex. + -#### set_max_iteration(arg2: int) +### set_max_iteration(arg2: int) Set number of maximum iterations. + -#### set_min_iteration_test(arg2: int) +### set_min_iteration_test(arg2: int) Set number of minimum iterations before test. + -#### set_min_objective_diff(arg2: float) +### set_min_objective_diff(arg2: float) Set tolerance for objective test. + -#### set_min_parameter_diff(arg2: float) +### set_min_parameter_diff(arg2: float) Set tolerance for parameter test: convergence test. + -#### set_start_range(arg2: float) +### set_start_range(arg2: float) Set start range for Simplex. + -### *class* PySimplex.Simplex +## *class* PySimplex.Simplex + -#### \_\_init_\_(arg2: [PyOptimizerBase.SettingsBase](PyOptimizerBase.md#PyOptimizerBase.SettingsBase)) +### \_\_init_\_(arg2: [PyOptimizerBase.SettingsBase](PyOptimizerBase.md#PyOptimizerBase.SettingsBase)) + -#### get_best_design_history() → [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type) +### get_best_design_history() → [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type) + -#### get_iteration_history() → [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type) +### get_iteration_history() → [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type) + -#### get_iteration_number() → int +### get_iteration_number() → int diff --git a/2025R2/optiSLang-python-api/modules/_optiSLang_Actors.md b/2025R2/optiSLang-python-api/modules/_optiSLang_Actors.md index 63b051d612..4e4ef62839 100644 --- a/2025R2/optiSLang-python-api/modules/_optiSLang_Actors.md +++ b/2025R2/optiSLang-python-api/modules/_optiSLang_Actors.md @@ -1,717 +1,913 @@ + -### *class* \_optiSLang_Actors.AMOPActor +# \_optiSLang_Actors + -#### \_\_init_\_() +## *class* \_optiSLang_Actors.AMOPActor -#### \_\_init_\_(arg2: str) + +### \_\_init_\_() -#### *property* amop_settings +### \_\_init_\_(arg2: str) + -#### *property* mop_advanced_settings +### *property* amop_settings + -#### *property* mop_automatic_settings +### *property* mop_advanced_settings + -#### *property* parameter_importancy +### *property* mop_automatic_settings + -#### *property* settings_type +### *property* parameter_importancy + -### *class* \_optiSLang_Actors.ARSMActor +### *property* settings_type + -#### \_\_init_\_() +## *class* \_optiSLang_Actors.ARSMActor -#### \_\_init_\_(arg2: str) + +### \_\_init_\_() -#### *property* doe_settings +### \_\_init_\_(arg2: str) + -#### *property* nlpqlp_settings +### *property* doe_settings + -#### *property* optimizer_settings +### *property* nlpqlp_settings + -### *class* \_optiSLang_Actors.ARSMDSActor +### *property* optimizer_settings + + + +## *class* \_optiSLang_Actors.ARSMDSActor Reliability actor using ARSM with Directional Sampling. + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -#### *property* reliability_settings +### *property* reliability_settings + -### *class* \_optiSLang_Actors.AbaqusProcessActor +## *class* \_optiSLang_Actors.AbaqusProcessActor + -#### DBLBOTH *= \_optiSLang_Actors.DoubleMode.DBLBOTH* +### DBLBOTH *= \_optiSLang_Actors.DoubleMode.DBLBOTH* + -#### DBLCONSTRAINT *= \_optiSLang_Actors.DoubleMode.DBLCONSTRAINT* +### DBLCONSTRAINT *= \_optiSLang_Actors.DoubleMode.DBLCONSTRAINT* + -#### DBLEXPLICIT *= \_optiSLang_Actors.DoubleMode.DBLEXPLICIT* +### DBLEXPLICIT *= \_optiSLang_Actors.DoubleMode.DBLEXPLICIT* + -#### DBLOFF *= \_optiSLang_Actors.DoubleMode.DBLOFF* +### DBLOFF *= \_optiSLang_Actors.DoubleMode.DBLOFF* + -#### DBLUNSPECIFIED *= \_optiSLang_Actors.DoubleMode.DBLUNSPECIFIED* +### DBLUNSPECIFIED *= \_optiSLang_Actors.DoubleMode.DBLUNSPECIFIED* + -#### *class* DoubleMode +### *class* DoubleMode **Enumeration** + -#### DBLBOTH *= \_optiSLang_Actors.DoubleMode.DBLBOTH* +### DBLBOTH *= \_optiSLang_Actors.DoubleMode.DBLBOTH* + -#### DBLCONSTRAINT *= \_optiSLang_Actors.DoubleMode.DBLCONSTRAINT* +### DBLCONSTRAINT *= \_optiSLang_Actors.DoubleMode.DBLCONSTRAINT* + -#### DBLEXPLICIT *= \_optiSLang_Actors.DoubleMode.DBLEXPLICIT* +### DBLEXPLICIT *= \_optiSLang_Actors.DoubleMode.DBLEXPLICIT* + -#### DBLOFF *= \_optiSLang_Actors.DoubleMode.DBLOFF* +### DBLOFF *= \_optiSLang_Actors.DoubleMode.DBLOFF* + -#### DBLUNSPECIFIED *= \_optiSLang_Actors.DoubleMode.DBLUNSPECIFIED* +### DBLUNSPECIFIED *= \_optiSLang_Actors.DoubleMode.DBLUNSPECIFIED* + -#### NUM_TYPES_DBL *= \_optiSLang_Actors.DoubleMode.NUM_TYPES_DBL* +### NUM_TYPES_DBL *= \_optiSLang_Actors.DoubleMode.NUM_TYPES_DBL* + -#### EXECANALYSIS *= \_optiSLang_Actors.ExecType.EXECANALYSIS* +### EXECANALYSIS *= \_optiSLang_Actors.ExecType.EXECANALYSIS* + -#### EXECDATACHECK *= \_optiSLang_Actors.ExecType.EXECDATACHECK* +### EXECDATACHECK *= \_optiSLang_Actors.ExecType.EXECDATACHECK* + -#### EXECPARAMETERCHECK *= \_optiSLang_Actors.ExecType.EXECPARAMETERCHECK* +### EXECPARAMETERCHECK *= \_optiSLang_Actors.ExecType.EXECPARAMETERCHECK* + -#### EXECPREPOST *= \_optiSLang_Actors.ExecType.EXECPREPOST* +### EXECPREPOST *= \_optiSLang_Actors.ExecType.EXECPREPOST* + -#### EXECSYNTAXCHECK *= \_optiSLang_Actors.ExecType.EXECSYNTAXCHECK* +### EXECSYNTAXCHECK *= \_optiSLang_Actors.ExecType.EXECSYNTAXCHECK* + -#### *class* ExecType +### *class* ExecType **Enumeration** + -#### EXECANALYSIS *= \_optiSLang_Actors.ExecType.EXECANALYSIS* +### EXECANALYSIS *= \_optiSLang_Actors.ExecType.EXECANALYSIS* + -#### EXECDATACHECK *= \_optiSLang_Actors.ExecType.EXECDATACHECK* +### EXECDATACHECK *= \_optiSLang_Actors.ExecType.EXECDATACHECK* + -#### EXECPARAMETERCHECK *= \_optiSLang_Actors.ExecType.EXECPARAMETERCHECK* +### EXECPARAMETERCHECK *= \_optiSLang_Actors.ExecType.EXECPARAMETERCHECK* + -#### EXECPREPOST *= \_optiSLang_Actors.ExecType.EXECPREPOST* +### EXECPREPOST *= \_optiSLang_Actors.ExecType.EXECPREPOST* + -#### EXECSYNTAXCHECK *= \_optiSLang_Actors.ExecType.EXECSYNTAXCHECK* +### EXECSYNTAXCHECK *= \_optiSLang_Actors.ExecType.EXECSYNTAXCHECK* + -#### NUM_TYPES_EXEC *= \_optiSLang_Actors.ExecType.NUM_TYPES_EXEC* +### NUM_TYPES_EXEC *= \_optiSLang_Actors.ExecType.NUM_TYPES_EXEC* + -#### MPMPI *= \_optiSLang_Actors.MPMode.MPMPI* +### MPMPI *= \_optiSLang_Actors.MPMode.MPMPI* + -#### *class* MPMode +### *class* MPMode **Enumeration** + -#### MPMPI *= \_optiSLang_Actors.MPMode.MPMPI* +### MPMPI *= \_optiSLang_Actors.MPMode.MPMPI* + -#### MPTHREADS *= \_optiSLang_Actors.MPMode.MPTHREADS* +### MPTHREADS *= \_optiSLang_Actors.MPMode.MPTHREADS* + -#### MPUNSPECIFIED *= \_optiSLang_Actors.MPMode.MPUNSPECIFIED* +### MPUNSPECIFIED *= \_optiSLang_Actors.MPMode.MPUNSPECIFIED* + -#### NUM_TYPES_MP *= \_optiSLang_Actors.MPMode.NUM_TYPES_MP* +### NUM_TYPES_MP *= \_optiSLang_Actors.MPMode.NUM_TYPES_MP* + -#### MPTHREADS *= \_optiSLang_Actors.MPMode.MPTHREADS* +### MPTHREADS *= \_optiSLang_Actors.MPMode.MPTHREADS* + -#### MPUNSPECIFIED *= \_optiSLang_Actors.MPMode.MPUNSPECIFIED* +### MPUNSPECIFIED *= \_optiSLang_Actors.MPMode.MPUNSPECIFIED* + -#### NUM_TYPES_DBL *= \_optiSLang_Actors.DoubleMode.NUM_TYPES_DBL* +### NUM_TYPES_DBL *= \_optiSLang_Actors.DoubleMode.NUM_TYPES_DBL* + -#### NUM_TYPES_EXEC *= \_optiSLang_Actors.ExecType.NUM_TYPES_EXEC* +### NUM_TYPES_EXEC *= \_optiSLang_Actors.ExecType.NUM_TYPES_EXEC* + -#### NUM_TYPES_MP *= \_optiSLang_Actors.MPMode.NUM_TYPES_MP* +### NUM_TYPES_MP *= \_optiSLang_Actors.MPMode.NUM_TYPES_MP* + -#### NUM_TYPES_OP *= \_optiSLang_Actors.OutputPrecision.NUM_TYPES_OP* +### NUM_TYPES_OP *= \_optiSLang_Actors.OutputPrecision.NUM_TYPES_OP* + -#### NUM_TYPES_PAR *= \_optiSLang_Actors.ParallelType.NUM_TYPES_PAR* +### NUM_TYPES_PAR *= \_optiSLang_Actors.ParallelType.NUM_TYPES_PAR* + -#### NUM_TYPES_PP *= \_optiSLang_Actors.PrePost.NUM_TYPES_PP* +### NUM_TYPES_PP *= \_optiSLang_Actors.PrePost.NUM_TYPES_PP* + -#### NUM_TYPES_SP *= \_optiSLang_Actors.StdParallel.NUM_TYPES_SP* +### NUM_TYPES_SP *= \_optiSLang_Actors.StdParallel.NUM_TYPES_SP* + -#### OPFULL *= \_optiSLang_Actors.OutputPrecision.OPFULL* +### OPFULL *= \_optiSLang_Actors.OutputPrecision.OPFULL* + -#### OPSINGLE *= \_optiSLang_Actors.OutputPrecision.OPSINGLE* +### OPSINGLE *= \_optiSLang_Actors.OutputPrecision.OPSINGLE* + -#### OPUNSPECIFIED *= \_optiSLang_Actors.OutputPrecision.OPUNSPECIFIED* +### OPUNSPECIFIED *= \_optiSLang_Actors.OutputPrecision.OPUNSPECIFIED* + -#### *class* OutputPrecision +### *class* OutputPrecision **Enumeration** + -#### NUM_TYPES_OP *= \_optiSLang_Actors.OutputPrecision.NUM_TYPES_OP* +### NUM_TYPES_OP *= \_optiSLang_Actors.OutputPrecision.NUM_TYPES_OP* + -#### OPFULL *= \_optiSLang_Actors.OutputPrecision.OPFULL* +### OPFULL *= \_optiSLang_Actors.OutputPrecision.OPFULL* + -#### OPSINGLE *= \_optiSLang_Actors.OutputPrecision.OPSINGLE* +### OPSINGLE *= \_optiSLang_Actors.OutputPrecision.OPSINGLE* + -#### OPUNSPECIFIED *= \_optiSLang_Actors.OutputPrecision.OPUNSPECIFIED* +### OPUNSPECIFIED *= \_optiSLang_Actors.OutputPrecision.OPUNSPECIFIED* + -#### PARDOMAIN *= \_optiSLang_Actors.ParallelType.PARDOMAIN* +### PARDOMAIN *= \_optiSLang_Actors.ParallelType.PARDOMAIN* + -#### PARLOOP *= \_optiSLang_Actors.ParallelType.PARLOOP* +### PARLOOP *= \_optiSLang_Actors.ParallelType.PARLOOP* + -#### PARUNSPECIFIED *= \_optiSLang_Actors.ParallelType.PARUNSPECIFIED* +### PARUNSPECIFIED *= \_optiSLang_Actors.ParallelType.PARUNSPECIFIED* + -#### PPCAE *= \_optiSLang_Actors.PrePost.PPCAE* +### PPCAE *= \_optiSLang_Actors.PrePost.PPCAE* + -#### PPVIEWER *= \_optiSLang_Actors.PrePost.PPVIEWER* +### PPVIEWER *= \_optiSLang_Actors.PrePost.PPVIEWER* + -#### *class* ParallelType +### *class* ParallelType **Enumeration** + -#### NUM_TYPES_PAR *= \_optiSLang_Actors.ParallelType.NUM_TYPES_PAR* +### NUM_TYPES_PAR *= \_optiSLang_Actors.ParallelType.NUM_TYPES_PAR* + -#### PARDOMAIN *= \_optiSLang_Actors.ParallelType.PARDOMAIN* +### PARDOMAIN *= \_optiSLang_Actors.ParallelType.PARDOMAIN* + -#### PARLOOP *= \_optiSLang_Actors.ParallelType.PARLOOP* +### PARLOOP *= \_optiSLang_Actors.ParallelType.PARLOOP* + -#### PARUNSPECIFIED *= \_optiSLang_Actors.ParallelType.PARUNSPECIFIED* +### PARUNSPECIFIED *= \_optiSLang_Actors.ParallelType.PARUNSPECIFIED* + -#### *class* PrePost +### *class* PrePost **Enumeration** + -#### NUM_TYPES_PP *= \_optiSLang_Actors.PrePost.NUM_TYPES_PP* +### NUM_TYPES_PP *= \_optiSLang_Actors.PrePost.NUM_TYPES_PP* + -#### PPCAE *= \_optiSLang_Actors.PrePost.PPCAE* +### PPCAE *= \_optiSLang_Actors.PrePost.PPCAE* + -#### PPVIEWER *= \_optiSLang_Actors.PrePost.PPVIEWER* +### PPVIEWER *= \_optiSLang_Actors.PrePost.PPVIEWER* + -#### SPALL *= \_optiSLang_Actors.StdParallel.SPALL* +### SPALL *= \_optiSLang_Actors.StdParallel.SPALL* + -#### SPSOLVER *= \_optiSLang_Actors.StdParallel.SPSOLVER* +### SPSOLVER *= \_optiSLang_Actors.StdParallel.SPSOLVER* + -#### SPUNSPECIFIED *= \_optiSLang_Actors.StdParallel.SPUNSPECIFIED* +### SPUNSPECIFIED *= \_optiSLang_Actors.StdParallel.SPUNSPECIFIED* + -#### *class* StdParallel +### *class* StdParallel **Enumeration** + -#### NUM_TYPES_SP *= \_optiSLang_Actors.StdParallel.NUM_TYPES_SP* +### NUM_TYPES_SP *= \_optiSLang_Actors.StdParallel.NUM_TYPES_SP* + -#### SPALL *= \_optiSLang_Actors.StdParallel.SPALL* +### SPALL *= \_optiSLang_Actors.StdParallel.SPALL* + -#### SPSOLVER *= \_optiSLang_Actors.StdParallel.SPSOLVER* +### SPSOLVER *= \_optiSLang_Actors.StdParallel.SPSOLVER* + -#### SPUNSPECIFIED *= \_optiSLang_Actors.StdParallel.SPUNSPECIFIED* +### SPUNSPECIFIED *= \_optiSLang_Actors.StdParallel.SPUNSPECIFIED* + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -#### *property* abaqus_base +### *property* abaqus_base + -#### *property* additional_args +### *property* additional_args + -#### *property* cpus +### *property* cpus + -#### *property* domain_num +### *property* domain_num + -#### *property* double_mode +### *property* double_mode + -#### *property* dynamic_load_balance +### *property* dynamic_load_balance + -#### *property* execution_type +### *property* execution_type + -#### *property* input_file +### *property* input_file + -#### *property* interactive +### *property* interactive + -#### *property* job_name +### *property* job_name + -#### *property* madymo_input +### *property* madymo_input + -#### *property* memory_size +### *property* memory_size + -#### *property* mp_mode +### *property* mp_mode + -#### *property* output_database_file +### *property* output_database_file + -#### *property* output_precision +### *property* output_precision + -#### *property* parallel_type +### *property* parallel_type + -#### *property* pre_post_custom_script_file +### *property* pre_post_custom_script_file + -#### *property* pre_post_database_file +### *property* pre_post_database_file + -#### *property* pre_post_no_env_startup +### *property* pre_post_no_env_startup + -#### *property* pre_post_no_gui_file +### *property* pre_post_no_gui_file + -#### *property* pre_post_no_saved_options +### *property* pre_post_no_saved_options + -#### *property* pre_post_no_startup_dialog +### *property* pre_post_no_startup_dialog + -#### *property* pre_post_script_file +### *property* pre_post_script_file + -#### *property* pre_post_startup_script_file +### *property* pre_post_startup_script_file + -#### *property* pre_post_type +### *property* pre_post_type + -#### *property* scratch_dir +### *property* scratch_dir + -#### *property* standard_parallel +### *property* standard_parallel + -#### *property* user_function +### *property* user_function + -### *class* \_optiSLang_Actors.AdaptiveSamplingActor +## *class* \_optiSLang_Actors.AdaptiveSamplingActor Reliability actor using the Adaptive Sampling method. + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -#### *property* reliability_settings +### *property* reliability_settings + -### *class* \_optiSLang_Actors.AlgorithmPluginSystem +## *class* \_optiSLang_Actors.AlgorithmPluginSystem + -#### \_\_init_\_(plugin: str name) → object +### \_\_init_\_(plugin: str name) → object Create an algorithm plugin actor by name. The plugin must be loaded at runtime. + -#### get_internal_property_names() → list +### get_internal_property_names() → list Get names of properties defined by the plugin internally + -#### get_plugin_id() → str +### get_plugin_id() → str The plugin id. + -### *class* \_optiSLang_Actors.AlgorithmSystemActor +## *class* \_optiSLang_Actors.AlgorithmSystemActor + -#### \_\_init_\_() +### \_\_init_\_() Raises an exception This class cannot be instantiated from Python + -#### *property* start_designs +### *property* start_designs + -### *class* \_optiSLang_Actors.AnsysAPDLInputActor +## *class* \_optiSLang_Actors.AnsysAPDLInputActor + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -#### get_locations_from_file(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint)) → bool +### get_locations_from_file(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint)) → bool + -#### get_locations_from_string(arg2: str, arg3: [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint)) → bool +### get_locations_from_string(arg2: str, arg3: [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint)) → bool + -#### register_location_as_parameter(arg2: str) +### register_location_as_parameter(arg2: str) + -#### register_locations_as_parameter() +### register_locations_as_parameter() + -### *class* \_optiSLang_Actors.AppendDesignsToBinFileActor +## *class* \_optiSLang_Actors.AppendDesignsToBinFileActor + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -### *class* \_optiSLang_Actors.BashScriptActor +## *class* \_optiSLang_Actors.BashScriptActor + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -### *class* \_optiSLang_Actors.BatchScriptActor +## *class* \_optiSLang_Actors.BatchScriptActor + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -### *class* \_optiSLang_Actors.CalculatorSetActor +## *class* \_optiSLang_Actors.CalculatorSetActor + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -#### add_internal_variable(location: DerivedLocation) +### add_internal_variable(location: DerivedLocation) -#### add_internal_variable(derived_variable: DerivedLocation) +### add_internal_variable(derived_variable: DerivedLocation) [0] Assign location to an internal variable. [1] Create a derived variable. + -#### add_output(location: DerivedLocation) +### add_output(location: DerivedLocation) -#### add_output(derived_variable: DerivedLocation) +### add_output(derived_variable: DerivedLocation) -#### add_output(arg2: str, arg3: str) +### add_output(arg2: str, arg3: str) [0] Assign location to an output slot. [1] Create a derived variable and assign it to an output slot. + -#### add_response(location: DerivedLocation) +### add_response(location: DerivedLocation) -#### add_response(derived_variable: DerivedLocation) +### add_response(derived_variable: DerivedLocation) -#### add_response(arg2: str, arg3: str) +### add_response(arg2: str, arg3: str) [0] Assign location to a response. [1] Create a derived variable and assign it to a response. + -#### get_internal_variables() → list +### get_internal_variables() → list Get internal variables + -#### get_registered_outputs() → list +### get_registered_outputs() → list Get registered output slots + -#### get_registered_responses() → list +### get_registered_responses() → list Get registered responses + -#### unregister_from_internal_variables(arg2: str) +### unregister_from_internal_variables(arg2: str) + -### *class* \_optiSLang_Actors.CatiaInputActor +## *class* \_optiSLang_Actors.CatiaInputActor + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -#### get_locations_from_file(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint)) → bool +### get_locations_from_file(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint)) → bool + -#### get_locations_from_string(arg2: str, arg3: [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint)) → bool +### get_locations_from_string(arg2: str, arg3: [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint)) → bool + -### *class* \_optiSLang_Actors.Continuation +## *class* \_optiSLang_Actors.Continuation **Enumeration** Integration actor continuation mode in case of predecessor failure + -#### CONTINUE *= \_optiSLang_Actors.Continuation.CONTINUE* +### CONTINUE *= \_optiSLang_Actors.Continuation.CONTINUE* + -#### DEFAULT *= \_optiSLang_Actors.Continuation.DEFAULT* +### DEFAULT *= \_optiSLang_Actors.Continuation.DEFAULT* + -#### SKIP *= \_optiSLang_Actors.Continuation.SKIP* +### SKIP *= \_optiSLang_Actors.Continuation.SKIP* + -### \_optiSLang_Actors.CreateAlgorithmPluginActorTyped(arg1: str) → [Actor](_optiSLang_Kernel.md#optiSLang_Kernel.Actor) +## \_optiSLang_Actors.CreateAlgorithmPluginActorTyped(arg1: str) → [Actor](_optiSLang_Kernel.md#optiSLang_Kernel.Actor) Create instance of an algorithm plugin specified by plugin id. + -### \_optiSLang_Actors.CreateCustomIntegrationActorTyped(arg1: str) → [CustomIntegrationActor](#optiSLang_Actors.CustomIntegrationActor) +## \_optiSLang_Actors.CreateCustomIntegrationActorTyped(arg1: str) → [CustomIntegrationActor](#optiSLang_Actors.CustomIntegrationActor) Create a Custom Python Integration actor by ID. The script must be located in CI path. + -### \_optiSLang_Actors.CreateIntegrationPluginActorTyped(arg1: str) → [IntegrationPluginActor](#optiSLang_Actors.IntegrationPluginActor) +## \_optiSLang_Actors.CreateIntegrationPluginActorTyped(arg1: str) → [IntegrationPluginActor](#optiSLang_Actors.IntegrationPluginActor) Create instance of a plugin integration specified by plugin id. + -### *class* \_optiSLang_Actors.CustomActor +## *class* \_optiSLang_Actors.CustomActor + -#### \_\_init_\_(custom_node_id: str) → object +### \_\_init_\_(custom_node_id: str) → object Create a Custom Node by ID. + -#### get_api_version() → int +### get_api_version() → int The used API version. + -#### get_default_settings() → dict +### get_default_settings() → dict The custom node’s user-defined default settings. + -#### *property* id +### *property* id The custom node’s ID as specified in the wrapper script filename. + -#### *property* max_parallel +### *property* max_parallel + -#### *property* modifying_settings +### *property* modifying_settings Settings that will affect the node’s run status when changed. + -#### *property* multi_design_launch_num +### *property* multi_design_launch_num + -#### *property* non_modifying_settings +### *property* non_modifying_settings Settings that will not affect the node’s run status when changed. + -### *class* \_optiSLang_Actors.CustomAlgorithmActor +## *class* \_optiSLang_Actors.CustomAlgorithmActor + -#### \_\_init_\_(algorithm: str name) → object +### \_\_init_\_(algorithm: str name) → object Create a Custom Algorithm actor by name. The corresponding script must be located in CA path. + -#### get_default_settings() → [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint) +### get_default_settings() → [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint) + -#### *property* id +### *property* id The custom algorithm’s ID as specified in the wrapper script filename. + -#### *property* settings +### *property* settings + -### *class* \_optiSLang_Actors.CustomIntegrationActor +## *class* \_optiSLang_Actors.CustomIntegrationActor + -#### \_\_init_\_(integration: str name) → object +### \_\_init_\_(integration: str name) → object Create a Custom Python Integration actor by name. The script must be located in CI path. + -#### *property* error_code +### *property* error_code + -#### get_api_version() → int +### get_api_version() → int The used API version. + -#### get_default_settings(arg2: bool) → [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint) +### get_default_settings(arg2: bool) → [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint) + -#### *property* id +### *property* id The custom integration’s ID as specified in the wrapper script filename. + -#### *property* instant_variable_update +### *property* instant_variable_update + -#### *property* max_parallel +### *property* max_parallel + -#### *property* modifying_settings +### *property* modifying_settings Settings that will affect the node’s run status when changed. + -#### *property* multi_design_launch_num +### *property* multi_design_launch_num + -#### *property* non_modifying_settings +### *property* non_modifying_settings Settings that will not affect the node’s run status when changed. + -#### *property* path +### *property* path + -#### *property* settings +### *property* settings + -### *class* \_optiSLang_Actors.CustomMopActor +## *class* \_optiSLang_Actors.CustomMopActor + -#### \_\_init_\_(custom_mop_node_id: str) → object +### \_\_init_\_(custom_mop_node_id: str) → object Create a Custom MOP Node by ID. + -#### get_default_settings() → dict +### get_default_settings() → dict The custom MOP node’s user-defined default settings. + -#### *property* id +### *property* id The custom MOP node’s ID as specified in the wrapper script filename. + -### *class* \_optiSLang_Actors.CustomizedBaseActor +## *class* \_optiSLang_Actors.CustomizedBaseActor + -#### \_\_init_\_() +### \_\_init_\_() Raises an exception This class cannot be instantiated from Python + -#### add_input(location: CustomizedBaseInfo) +### add_input(location: CustomizedBaseInfo) -#### add_input(name: str and PyOSDesignEntry, location: [CustomizedBaseInfo](#optiSLang_Actors.CustomizedBaseInfo)) +### add_input(name: str and PyOSDesignEntry, location: [CustomizedBaseInfo](#optiSLang_Actors.CustomizedBaseInfo)) [0] Assign location to an input slot. [1] Assign location to input slot. + -#### add_internal_variable(location: CustomizedBaseInfo) +### add_internal_variable(location: CustomizedBaseInfo) -#### add_internal_variable(derived_variable: DerivedLocation) +### add_internal_variable(derived_variable: DerivedLocation) [0] Assign location to an internal variable. [1] Create a derived variable. + -#### add_output(location: CustomizedBaseInfo) +### add_output(location: CustomizedBaseInfo) -#### add_output(derived_variable: DerivedLocation) +### add_output(derived_variable: DerivedLocation) -#### add_output(name: str and PyOSDesignEntry, location: [CustomizedBaseInfo](#optiSLang_Actors.CustomizedBaseInfo)) +### add_output(name: str and PyOSDesignEntry, location: [CustomizedBaseInfo](#optiSLang_Actors.CustomizedBaseInfo)) [0] Assign location to an output slot. @@ -719,21 +915,23 @@ This class cannot be instantiated from Python [2] Assign location to output slot. + -#### add_parameter(location: CustomizedBaseInfo) +### add_parameter(location: CustomizedBaseInfo) -#### add_parameter(name: tuple and PyOSDesignEntry, location: [CustomizedBaseInfo](#optiSLang_Actors.CustomizedBaseInfo)) +### add_parameter(name: tuple and PyOSDesignEntry, location: [CustomizedBaseInfo](#optiSLang_Actors.CustomizedBaseInfo)) [0] Assign location to a parameter. [1] Assign location to parameter. + -#### add_response(location: CustomizedBaseInfo) +### add_response(location: CustomizedBaseInfo) -#### add_response(derived_variable: DerivedLocation) +### add_response(derived_variable: DerivedLocation) -#### add_response(name: tuple and PyOSDesignEntry, location: [CustomizedBaseInfo](#optiSLang_Actors.CustomizedBaseInfo)) +### add_response(name: tuple and PyOSDesignEntry, location: [CustomizedBaseInfo](#optiSLang_Actors.CustomizedBaseInfo)) [0] Assign location to a response. @@ -741,1169 +939,1444 @@ This class cannot be instantiated from Python [2] Assign location to response. + -#### *property* error_code +### *property* error_code + -#### get_internal_variables() → list +### get_internal_variables() → list Get internal variables + -#### get_registered_inputs() → list +### get_registered_inputs() → list Get registered input slots + -#### get_registered_outputs() → list +### get_registered_outputs() → list Get registered output slots + -#### get_registered_parameters() → list +### get_registered_parameters() → list Get registered parameters + -#### get_registered_responses() → list +### get_registered_responses() → list Get registered responses + -#### *property* instant_variable_update +### *property* instant_variable_update + -#### *property* path +### *property* path + -#### *property* use_as_input_integration +### *property* use_as_input_integration + -#### *property* use_as_output_integration +### *property* use_as_output_integration + -#### *property* use_as_solver +### *property* use_as_solver + -### *class* \_optiSLang_Actors.CustomizedBaseInfo +## *class* \_optiSLang_Actors.CustomizedBaseInfo + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(location: str id, direction: IntegrationDirection) +### \_\_init_\_(location: str id, direction: IntegrationDirection) -#### \_\_init_\_(complete: PyOSDesignPoint location info, direction: IntegrationDirection) +### \_\_init_\_(complete: PyOSDesignPoint location info, direction: IntegrationDirection) [1] Create a CustomizedBaseInfo instance. [2] Create a CustomizedBaseInfo instance. + -#### *property* direction +### *property* direction + -#### *property* name +### *property* name + -### *class* \_optiSLang_Actors.DCSActor +## *class* \_optiSLang_Actors.DCSActor + -#### \_\_init_\_() +### \_\_init_\_() + -#### add_input(location: DPSLocation) +### add_input(location: DPSLocation) Assign location to an input slot. + -#### add_internal_variable(location: DPSLocation) +### add_internal_variable(location: DPSLocation) -#### add_internal_variable(derived_variable: DerivedLocation) +### add_internal_variable(derived_variable: DerivedLocation) [0] Assign location to an internal variable. [1] Create a derived variable. + -#### add_output(location: DPSLocation) +### add_output(location: DPSLocation) -#### add_output(derived_variable: DerivedLocation) +### add_output(derived_variable: DerivedLocation) [0] Assign location to an output slot. [1] Create a derived variable and assign it to an output slot. + -#### add_parameter(location: DPSLocation) +### add_parameter(location: DPSLocation) -#### add_parameter(arg2: str) → str +### add_parameter(arg2: str) → str [0] Assign location to a parameter. + -#### add_response(location: DPSLocation) +### add_response(location: DPSLocation) -#### add_response(derived_variable: DerivedLocation) +### add_response(derived_variable: DerivedLocation) -#### add_response(arg2: str) → str +### add_response(arg2: str) → str [0] Assign location to a response. [1] Create a derived variable and assign it to a response. + -#### *property* configuration +### *property* configuration + -#### get_internal_variables() → list +### get_internal_variables() → list Get internal variables + -#### get_registered_inputs() → list +### get_registered_inputs() → list Get registered input slots + -#### get_registered_outputs() → list +### get_registered_outputs() → list Get registered output slots + -#### get_registered_parameters() → list +### get_registered_parameters() → list Get registered parameters + -#### get_registered_responses() → list +### get_registered_responses() → list Get registered responses + -#### login(arg2: str, arg3: str) +### login(arg2: str, arg3: str) + -#### *property* max_submission_batch_size +### *property* max_submission_batch_size + -#### *property* output_files_to_fetch +### *property* output_files_to_fetch + -#### *property* project +### *property* project + -#### *property* refresh_token +### *property* refresh_token + -#### *property* url +### *property* url + -### \_optiSLang_Actors.DPSActor +## \_optiSLang_Actors.DPSActor alias of [`DCSActor`](#optiSLang_Actors.DCSActor) + -### *class* \_optiSLang_Actors.DPSLocation +## *class* \_optiSLang_Actors.DPSLocation + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(location: str id, direction: IntegrationDirection) +### \_\_init_\_(location: str id, direction: IntegrationDirection) [1] Create a DPSLocation instance. + -#### *property* direction +### *property* direction + -#### *property* name +### *property* name + -### *class* \_optiSLang_Actors.DataExportActor +## *class* \_optiSLang_Actors.DataExportActor + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -#### *property* failure_treatment +### *property* failure_treatment + -#### *property* path +### *property* path + -### *class* \_optiSLang_Actors.DataImportActor +## *class* \_optiSLang_Actors.DataImportActor + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -#### *property* failure_treatment +### *property* failure_treatment + -#### *property* path +### *property* path + -### *class* \_optiSLang_Actors.DataMiningActor +## *class* \_optiSLang_Actors.DataMiningActor + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -#### init_append_best_designs() +### init_append_best_designs() Configure node with functionality to append best designs to an MDB file. + -### *class* \_optiSLang_Actors.DerivedLocation +## *class* \_optiSLang_Actors.DerivedLocation + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str, arg3: str) +### \_\_init_\_(arg2: str, arg3: str) + -#### *property* expression +### *property* expression + -#### *property* location_id +### *property* location_id + -### *class* \_optiSLang_Actors.DesignCounts +## *class* \_optiSLang_Actors.DesignCounts + -#### \_\_init_\_() +### \_\_init_\_() + -#### get_estimated() → object +### get_estimated() → object + -#### get_upper_bound() → object +### get_upper_bound() → object + -### *class* \_optiSLang_Actors.DesignExportActor +## *class* \_optiSLang_Actors.DesignExportActor + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -#### *property* csv_delimiter +### *property* csv_delimiter + -#### *property* design_exporter +### *property* design_exporter + -#### *property* export_format +### *property* export_format + -#### *property* json_legacy_mode +### *property* json_legacy_mode + -#### *property* json_prettified_mode +### *property* json_prettified_mode + -#### *property* json_signal_data +### *property* json_signal_data + -#### *property* mdb_path +### *property* mdb_path + -#### *property* out_path +### *property* out_path + -### *class* \_optiSLang_Actors.DesignImportActor +## *class* \_optiSLang_Actors.DesignImportActor + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -#### *property* csv_delimiter +### *property* csv_delimiter + -#### *property* design_importer +### *property* design_importer + -#### *property* dimension_settings +### *property* dimension_settings + -#### *property* import_format +### *property* import_format + -#### *property* in_path +### *property* in_path + -#### *property* settings_file_path +### *property* settings_file_path + -#### *property* sheet_name +### *property* sheet_name + -#### *property* use_import_settings +### *property* use_import_settings + -#### *property* use_import_settings_file +### *property* use_import_settings_file + -### *class* \_optiSLang_Actors.DesignImportDimensionEntry +## *class* \_optiSLang_Actors.DesignImportDimensionEntry + -#### \_\_init_\_() +### \_\_init_\_() + -#### *property* column +### *property* column Column in data set. + -#### *property* name +### *property* name Name ot the imported dimension. + -#### *property* type +### *property* type Type of the imported dimension. + -### *class* \_optiSLang_Actors.DesignImportDimensionsVector +## *class* \_optiSLang_Actors.DesignImportDimensionsVector + -#### \_\_init_\_() +### \_\_init_\_() + -#### \_\_iter_\_() → object +### \_\_iter_\_() → object + -#### entry_export_list() → object +### entry_export_list() → object + -#### push_back(arg2: [DesignImportDimensionEntry](#optiSLang_Actors.DesignImportDimensionEntry)) +### push_back(arg2: [DesignImportDimensionEntry](#optiSLang_Actors.DesignImportDimensionEntry)) + -#### size() → int +### size() → int + -### *class* \_optiSLang_Actors.DirectionalSamplingActor +## *class* \_optiSLang_Actors.DirectionalSamplingActor Reliability actor using Directional Sampling. + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -#### *property* reliability_settings +### *property* reliability_settings + -### *class* \_optiSLang_Actors.DistinctWorkingDirActor +## *class* \_optiSLang_Actors.DistinctWorkingDirActor + -#### \_\_init_\_() +### \_\_init_\_() Raises an exception This class cannot be instantiated from Python + -#### *property* distinct_working_directory +### *property* distinct_working_directory + -### *class* \_optiSLang_Actors.EAActor +## *class* \_optiSLang_Actors.EAActor + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -### *class* \_optiSLang_Actors.ETK +## *class* \_optiSLang_Actors.ETK + -#### *class* AMESimOutputVariable +### *class* AMESimOutputVariable + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str, arg4: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str, arg4: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg4: str, arg5: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg4: str, arg5: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) + -#### *class* AdamsOutputVariable +### *class* AdamsOutputVariable + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) + -#### *property* component +### *property* component + -#### *property* component_index +### *property* component_index + -#### *property* data +### *property* data + -#### *property* entity +### *property* entity + -#### *property* entity_type +### *property* entity_type + -#### *property* step +### *property* step + -#### *class* AnsysOutputVariable +### *class* AnsysOutputVariable + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) + -#### *property* extraction_type +### *property* extraction_type + -#### *property* kind +### *property* kind + -#### *property* node_channel +### *property* node_channel + -#### *property* node_number +### *property* node_number + -#### *property* number +### *property* number + -#### *property* range +### *property* range + -#### *property* type +### *property* type + -#### *class* AutoParamOutputVariable +### *class* AutoParamOutputVariable + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str, arg4: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str, arg4: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg4: str, arg5: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg4: str, arg5: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) + -#### *class* CFturboOutputVariable +### *class* CFturboOutputVariable + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str, arg4: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str, arg4: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg4: str, arg5: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg4: str, arg5: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) + -#### *class* CetolOutputVariable +### *class* CetolOutputVariable + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str, arg4: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str, arg4: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg4: str, arg5: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg4: str, arg5: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) + -#### *class* ColumnReader +### *class* ColumnReader + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: int) +### \_\_init_\_(arg2: int) -#### \_\_init_\_(arg2: int, arg3: int) +### \_\_init_\_(arg2: int, arg3: int) + -#### *property* initial_offset +### *property* initial_offset + -#### *property* width +### *property* width + -#### *class* CustomizedOutputVariable +### *class* CustomizedOutputVariable + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str, arg4: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str, arg4: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg4: str, arg5: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg4: str, arg5: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) + -#### set_custom_id(arg2: str) +### set_custom_id(arg2: str) + -#### *class* ETKAbaqusActor +### *class* ETKAbaqusActor + -#### *class* ODBFieldOutputVariable +### *class* ODBFieldOutputVariable + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg4: str) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg4: str) + -#### *property* component_name +### *property* component_name + -#### *property* element_types +### *property* element_types + -#### *property* field_output_name +### *property* field_output_name + -#### *property* frame +### *property* frame + -#### has_invariant() → bool +### has_invariant() → bool + -#### *property* invariant +### *property* invariant + -#### *property* position +### *property* position + -#### reset_invariant() +### reset_invariant() + -#### *property* section_point_name +### *property* section_point_name + -#### *property* section_points +### *property* section_points + -#### *property* set_infos +### *property* set_infos + -#### *property* set_type +### *property* set_type + -#### *property* step_name +### *property* step_name + -#### *property* use_last_frame +### *property* use_last_frame + -#### *class* ODBHistoryOutputVariable +### *class* ODBHistoryOutputVariable + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg4: str) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg4: str) + -#### *property* history_output_description +### *property* history_output_description + -#### *property* history_output_name +### *property* history_output_name + -#### *property* point_position +### *property* point_position + -#### *property* region_name +### *property* region_name + -#### *property* step_name +### *property* step_name + -#### *property* tip_set_info +### *property* tip_set_info + -#### *property* tipset_bound +### *property* tipset_bound + -#### *class* ODBSectionPointInfo +### *class* ODBSectionPointInfo + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: int) +### \_\_init_\_(arg2: int) -#### \_\_init_\_(arg2: int, arg3: str) +### \_\_init_\_(arg2: int, arg3: str) -#### \_\_init_\_(arg2: int, arg3: str, arg4: str) +### \_\_init_\_(arg2: int, arg3: str, arg4: str) + -#### *class* ODBSectionPointInfoSet +### *class* ODBSectionPointInfoSet A mutable set. + -#### \_\_and_\_(arg2: [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet)) → [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet) +### \_\_and_\_(arg2: [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet)) → [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet) Return the intersection of this set and other. + -#### \_\_contains_\_(arg2: [ODBSectionPointInfo](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfo)) → bool +### \_\_contains_\_(arg2: [ODBSectionPointInfo](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfo)) → bool + -#### \_\_delitem_\_(arg2: [ODBSectionPointInfo](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfo)) +### \_\_delitem_\_(arg2: [ODBSectionPointInfo](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfo)) + -#### \_\_hash_\_() +### \_\_hash_\_() + -#### \_\_init_\_() +### \_\_init_\_() + -#### \_\_iter_\_() → object +### \_\_iter_\_() → object + -#### \_\_len_\_() → int +### \_\_len_\_() → int + -#### \_\_or_\_(arg2: [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet)) → [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet) +### \_\_or_\_(arg2: [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet)) → [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet) Return the union of this set and other. + -#### \_\_sub_\_(arg2: [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet)) → [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet) +### \_\_sub_\_(arg2: [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet)) → [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet) Return elements of this set that are not in other. + -#### \_\_xor_\_(arg2: [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet)) → [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet) +### \_\_xor_\_(arg2: [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet)) → [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet) Return elements that are either in this set or in other but not in both. + -#### add(element: [ODBSectionPointInfo](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfo)) +### add(element: [ODBSectionPointInfo](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfo)) Add element. + -#### difference(other: [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet)) → [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet) +### difference(other: [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet)) → [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet) Return elements of this set that are not in other. + -#### intersection(other: [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet)) → [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet) +### intersection(other: [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet)) → [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet) Return the intersection of this set and other. + -#### remove(element: [ODBSectionPointInfo](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfo)) +### remove(element: [ODBSectionPointInfo](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfo)) Remove element. + -#### symmetric_difference(other: [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet)) → [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet) +### symmetric_difference(other: [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet)) → [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet) Return elements that are either in this set or in other but not in both. + -#### union(other: [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet)) → [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet) +### union(other: [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet)) → [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet) Return the union of this set and other. + -#### *class* ODBSetInfo +### *class* ODBSetInfo + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str, arg3: [SetLocation](#optiSLang_Actors.SetLocation), arg4: [SetType](#optiSLang_Actors.SetType)) +### \_\_init_\_(arg2: str, arg3: [SetLocation](#optiSLang_Actors.SetLocation), arg4: [SetType](#optiSLang_Actors.SetType)) -#### \_\_init_\_(arg2: str, arg3: [SetLocation](#optiSLang_Actors.SetLocation), arg4: [SetType](#optiSLang_Actors.SetType), arg5: [StrList](stdcpp_python_export.md#stdcpp_python_export.StrList)) +### \_\_init_\_(arg2: str, arg3: [SetLocation](#optiSLang_Actors.SetLocation), arg4: [SetType](#optiSLang_Actors.SetType), arg5: [StrList](stdcpp_python_export.md#stdcpp_python_export.StrList)) -#### \_\_init_\_(arg2: str, arg3: [SetLocation](#optiSLang_Actors.SetLocation), arg4: [SetType](#optiSLang_Actors.SetType), arg5: [StrList](stdcpp_python_export.md#stdcpp_python_export.StrList), arg6: str) +### \_\_init_\_(arg2: str, arg3: [SetLocation](#optiSLang_Actors.SetLocation), arg4: [SetType](#optiSLang_Actors.SetType), arg5: [StrList](stdcpp_python_export.md#stdcpp_python_export.StrList), arg6: str) + -#### *class* ODBSetInfoSet +### *class* ODBSetInfoSet A mutable set. + -#### \_\_and_\_(arg2: [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet)) → [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet) +### \_\_and_\_(arg2: [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet)) → [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet) Return the intersection of this set and other. + -#### \_\_contains_\_(arg2: [ODBSetInfo](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfo)) → bool +### \_\_contains_\_(arg2: [ODBSetInfo](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfo)) → bool + -#### \_\_delitem_\_(arg2: [ODBSetInfo](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfo)) +### \_\_delitem_\_(arg2: [ODBSetInfo](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfo)) + -#### \_\_hash_\_() +### \_\_hash_\_() + -#### \_\_init_\_() +### \_\_init_\_() + -#### \_\_iter_\_() → object +### \_\_iter_\_() → object + -#### \_\_len_\_() → int +### \_\_len_\_() → int + -#### \_\_or_\_(arg2: [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet)) → [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet) +### \_\_or_\_(arg2: [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet)) → [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet) Return the union of this set and other. + -#### \_\_sub_\_(arg2: [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet)) → [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet) +### \_\_sub_\_(arg2: [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet)) → [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet) Return elements of this set that are not in other. + -#### \_\_xor_\_(arg2: [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet)) → [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet) +### \_\_xor_\_(arg2: [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet)) → [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet) Return elements that are either in this set or in other but not in both. + -#### add(element: [ODBSetInfo](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfo)) +### add(element: [ODBSetInfo](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfo)) Add element. + -#### difference(other: [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet)) → [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet) +### difference(other: [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet)) → [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet) Return elements of this set that are not in other. + -#### intersection(other: [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet)) → [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet) +### intersection(other: [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet)) → [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet) Return the intersection of this set and other. + -#### remove(element: [ODBSetInfo](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfo)) +### remove(element: [ODBSetInfo](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfo)) Remove element. + -#### symmetric_difference(other: [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet)) → [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet) +### symmetric_difference(other: [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet)) → [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet) Return elements that are either in this set or in other but not in both. + -#### union(other: [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet)) → [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet) +### union(other: [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet)) → [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet) Return the union of this set and other. + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -#### free_cached_resources() +### free_cached_resources() + -#### *class* ETKActor +### *class* ETKActor + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -#### *property* imported_files +### *property* imported_files + -#### *property* max_parallel +### *property* max_parallel + -#### *class* ETKActorBase +### *class* ETKActorBase + -#### \_\_init_\_() +### \_\_init_\_() Raises an exception This class cannot be instantiated from Python + -#### add_internal_variable(location: ETKLocation) +### add_internal_variable(location: ETKLocation) -#### add_internal_variable(derived_variable: DerivedLocation) +### add_internal_variable(derived_variable: DerivedLocation) -#### add_internal_variable(arg2: [Variable](#optiSLang_Actors.ETK.Variable)) +### add_internal_variable(arg2: [Variable](#optiSLang_Actors.ETK.Variable)) [0] Assign location to an internal variable. [1] Create a derived variable. + -#### add_output(location: ETKLocation) +### add_output(location: ETKLocation) -#### add_output(derived_variable: DerivedLocation) +### add_output(derived_variable: DerivedLocation) -#### add_output(arg2: Variable) +### add_output(arg2: Variable) [0] Assign location to an output slot. [1] Create a derived variable and assign it to an output slot. + -#### add_response(location: ETKLocation) +### add_response(location: ETKLocation) -#### add_response(derived_variable: DerivedLocation) +### add_response(derived_variable: DerivedLocation) -#### add_response(arg2: Variable) +### add_response(arg2: Variable) -#### add_response(arg2: str, arg3: PyOSDesignEntry, arg4: DerivedLocation) → str +### add_response(arg2: str, arg3: PyOSDesignEntry, arg4: DerivedLocation) → str -#### add_response(arg2: str, arg3: PyOSDesignEntry, arg4: Variable) → str +### add_response(arg2: str, arg3: PyOSDesignEntry, arg4: Variable) → str [0] Assign location to a response. [1] Create a derived variable and assign it to a response. + -#### get_internal_variables() → list +### get_internal_variables() → list Get internal variables + -#### get_registered_outputs() → list +### get_registered_outputs() → list Get registered output slots + -#### get_registered_responses() → list +### get_registered_responses() → list Get registered responses + -#### register_as_internal_location(location: ETKLocation) +### register_as_internal_location(location: ETKLocation) -#### register_as_internal_location(derived_variable: DerivedLocation) +### register_as_internal_location(derived_variable: DerivedLocation) -#### register_as_internal_location(arg2: [Variable](#optiSLang_Actors.ETK.Variable)) +### register_as_internal_location(arg2: [Variable](#optiSLang_Actors.ETK.Variable)) [0] Assign location to an internal variable. [1] Create a derived variable. + -#### *class* ETKActorSingle +### *class* ETKActorSingle + -#### \_\_init_\_() +### \_\_init_\_() Raises an exception This class cannot be instantiated from Python + -#### *property* file +### *property* file + -#### *property* path +### *property* path + -#### *property* splitted_path +### *property* splitted_path + -#### *class* ETKFile +### *class* ETKFile + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [ProvidedPath](py_file_access.md#py_file_access.ProvidedPath), arg3: str) +### \_\_init_\_(arg2: [ProvidedPath](py_file_access.md#py_file_access.ProvidedPath), arg3: str) + -#### *property* path +### *property* path + -#### *property* type +### *property* type + -#### *class* ETKFileContainer +### *class* ETKFileContainer + -#### \_\_contains_\_(arg2: object) → bool +### \_\_contains_\_(arg2: object) → bool + -#### \_\_delitem_\_(arg2: object) +### \_\_delitem_\_(arg2: object) + -#### \_\_getitem_\_(arg2: object) → object +### \_\_getitem_\_(arg2: object) → object + -#### \_\_init_\_() +### \_\_init_\_() + -#### \_\_iter_\_() → object +### \_\_iter_\_() → object + -#### \_\_len_\_() → int +### \_\_len_\_() → int + -#### \_\_setitem_\_(arg2: object, arg3: object) +### \_\_setitem_\_(arg2: object, arg3: object) + -#### append(arg2: object) +### append(arg2: object) -#### append(arg2: [ETKFile](#optiSLang_Actors.ETK.ETKFile)) +### append(arg2: [ETKFile](#optiSLang_Actors.ETK.ETKFile)) + -#### extend(arg2: object) +### extend(arg2: object) + -#### size() → int +### size() → int + -#### *class* ETKFloEFDActor +### *class* ETKFloEFDActor + -#### *class* FloEFDOutputVariable +### *class* FloEFDOutputVariable + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str, arg4: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str, arg4: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg4: str, arg5: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg4: str, arg5: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) -#### \_\_init_\_(arg2: str, arg3: str, arg4: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) +### \_\_init_\_(arg2: str, arg3: str, arg4: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -#### *class* ETKLocation +### *class* ETKLocation + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [Variable](#optiSLang_Actors.ETK.Variable)) +### \_\_init_\_(arg2: [Variable](#optiSLang_Actors.ETK.Variable)) -#### \_\_init_\_(arg2: [Variable](#optiSLang_Actors.ETK.Variable), arg3: [ProvidedPath](py_file_access.md#py_file_access.ProvidedPath)) +### \_\_init_\_(arg2: [Variable](#optiSLang_Actors.ETK.Variable), arg3: [ProvidedPath](py_file_access.md#py_file_access.ProvidedPath)) + -#### *property* etk_variable +### *property* etk_variable + -#### *property* file_path +### *property* file_path + -#### *class* ETKSimPackActor +### *class* ETKSimPackActor + -#### *class* SimPackOutputVariable +### *class* SimPackOutputVariable + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str, arg4: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str, arg4: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg4: str, arg5: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg4: str, arg5: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) -#### \_\_init_\_(arg2: str, arg3: str, arg4: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) +### \_\_init_\_(arg2: str, arg3: str, arg4: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -#### *class* ETKTextOutputActor +### *class* ETKTextOutputActor + -#### *class* ColumnReader +### *class* ColumnReader + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: int) +### \_\_init_\_(arg2: int) -#### \_\_init_\_(arg2: int, arg3: int) +### \_\_init_\_(arg2: int, arg3: int) + -#### *property* initial_offset +### *property* initial_offset + -#### *property* width +### *property* width + -#### *class* IncrementRepeater +### *class* IncrementRepeater + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: int) +### \_\_init_\_(arg2: int) -#### \_\_init_\_(arg2: int, arg3: int) +### \_\_init_\_(arg2: int, arg3: int) -#### \_\_init_\_(arg2: int, arg3: int, arg4: int) +### \_\_init_\_(arg2: int, arg3: int, arg4: int) + -#### *property* increment +### *property* increment + -#### *property* max_increment +### *property* max_increment + -#### *property* offset +### *property* offset + -#### *class* LineReader +### *class* LineReader + -#### \_\_init_\_() +### \_\_init_\_() + -#### *class* MarkerRepeater +### *class* MarkerRepeater + -#### \_\_init_\_() +### \_\_init_\_() Raises an exception This class cannot be instantiated from Python + -#### *class* RegexSearcher +### *class* RegexSearcher + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -#### *property* end_search_string +### *property* end_search_string + -#### *property* end_search_string_is_regex +### *property* end_search_string_is_regex + -#### *property* search_string +### *property* search_string + -#### *property* search_string_is_regex +### *property* search_string_is_regex + -#### *class* RepeaterArgs +### *class* RepeaterArgs + -#### \_\_init_\_(arg2: int, arg3: int, arg4: int) +### \_\_init_\_(arg2: int, arg3: int, arg4: int) + -#### *class* TextMarker +### *class* TextMarker + -#### \_\_init_\_() +### \_\_init_\_() Raises an exception This class cannot be instantiated from Python + -#### append(arg2: [TextMarker](#optiSLang_Actors.ETKTextOutputActor.TextMarker)) +### append(arg2: [TextMarker](#optiSLang_Actors.ETKTextOutputActor.TextMarker)) + -#### get_child() → [TextMarker](#optiSLang_Actors.ETKTextOutputActor.TextMarker) +### get_child() → [TextMarker](#optiSLang_Actors.ETKTextOutputActor.TextMarker) + -#### get_row_reader() → bool +### get_row_reader() → bool + -#### has_child() → bool +### has_child() → bool + -#### has_repeater() → bool +### has_repeater() → bool + -#### is_row_reader() → bool +### is_row_reader() → bool + -#### *property* repeater +### *property* repeater + -#### *class* TextOutputVariable +### *class* TextOutputVariable + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg4: str) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg4: str) -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) -#### \_\_init_\_(arg2: str, arg3: str) +### \_\_init_\_(arg2: str, arg3: str) -#### \_\_init_\_(Output: Path file path, Variable: str name, Line: RepeaterArgs reapeater arguments, Token: RepeaterArgs repeater arguments) +### \_\_init_\_(Output: Path file path, Variable: str name, Line: RepeaterArgs reapeater arguments, Token: RepeaterArgs repeater arguments) -#### \_\_init_\_(Output: Path file path, Base: Path path, Variable: str name, Line: RepeaterArgs reapeater arguments, Token: RepeaterArgs repeater arguments) +### \_\_init_\_(Output: Path file path, Base: Path path, Variable: str name, Line: RepeaterArgs reapeater arguments, Token: RepeaterArgs repeater arguments) -#### \_\_init_\_(Output: Path file path, Variable: str name, Line: RepeaterArgs reapeater arguments, Column: RepeaterArgs repeater arguments, Column: int offset, Column: int width) +### \_\_init_\_(Output: Path file path, Variable: str name, Line: RepeaterArgs reapeater arguments, Column: RepeaterArgs repeater arguments, Column: int offset, Column: int width) -#### \_\_init_\_(Output: Path file path, Base: Path path, Variable: str name, Line: RepeaterArgs reapeater arguments, Column: RepeaterArgs repeater arguments, Column: int offset, Column: int width) +### \_\_init_\_(Output: Path file path, Base: Path path, Variable: str name, Line: RepeaterArgs reapeater arguments, Column: RepeaterArgs repeater arguments, Column: int offset, Column: int width) [7] Creates TextOutputVariable using token reader. @@ -1913,545 +2386,666 @@ This class cannot be instantiated from Python [10] Creates TextOutputVariable using column reader. + -#### *property* prefer_signal +### *property* prefer_signal Prefer as signal. + -#### *property* reader +### *property* reader Contains the variable’s reader. + -#### *class* TokenReader +### *class* TokenReader + -#### \_\_init_\_() +### \_\_init_\_() + -#### *property* separator +### *property* separator + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -#### *property* max_parallel +### *property* max_parallel + -#### *class* ETKTurboOptActor +### *class* ETKTurboOptActor + -#### *class* TurboOptOutputVariable +### *class* TurboOptOutputVariable + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str, arg4: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str, arg4: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg4: str, arg5: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg4: str, arg5: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) -#### \_\_init_\_(arg2: str, arg3: str, arg4: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) +### \_\_init_\_(arg2: str, arg3: str, arg4: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -#### *class* EdysonOutputVariable +### *class* EdysonOutputVariable + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) + -#### get_available_components() → [stringVec](stdcpp_python_export.md#stdcpp_python_export.stringVec) +### get_available_components() → [stringVec](stdcpp_python_export.md#stdcpp_python_export.stringVec) + -#### *property* selected_components +### *property* selected_components + -#### *class* ExtOutOutputVariable +### *class* ExtOutOutputVariable + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str, arg4: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str, arg4: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg4: str, arg5: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg4: str, arg5: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) + -#### *class* FileLocation +### *class* FileLocation + -#### \_\_init_\_() +### \_\_init_\_() Raises an exception This class cannot be instantiated from Python + -#### *class* FileVariable +### *class* FileVariable + -#### \_\_init_\_() +### \_\_init_\_() Raises an exception This class cannot be instantiated from Python + -#### *class* FloEFDOutputVariable +### *class* FloEFDOutputVariable + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str, arg4: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str, arg4: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg4: str, arg5: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg4: str, arg5: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) -#### \_\_init_\_(arg2: str, arg3: str, arg4: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) +### \_\_init_\_(arg2: str, arg3: str, arg4: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) + -#### *class* IncrementRepeater +### *class* IncrementRepeater + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: int) +### \_\_init_\_(arg2: int) -#### \_\_init_\_(arg2: int, arg3: int) +### \_\_init_\_(arg2: int, arg3: int) -#### \_\_init_\_(arg2: int, arg3: int, arg4: int) +### \_\_init_\_(arg2: int, arg3: int, arg4: int) + -#### *property* increment +### *property* increment + -#### *property* max_increment +### *property* max_increment + -#### *property* offset +### *property* offset + -#### *class* LSDYNAOutputVariable +### *class* LSDYNAOutputVariable + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str, arg4: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str, arg4: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg4: str, arg5: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg4: str, arg5: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) + -#### *class* LineReader +### *class* LineReader + -#### \_\_init_\_() +### \_\_init_\_() + -#### *class* MarkerRepeater +### *class* MarkerRepeater + -#### \_\_init_\_() +### \_\_init_\_() Raises an exception This class cannot be instantiated from Python + -#### *class* ODBFieldOutputVariable +### *class* ODBFieldOutputVariable + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg4: str) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg4: str) + -#### *property* component_name +### *property* component_name + -#### *property* element_types +### *property* element_types + -#### *property* field_output_name +### *property* field_output_name + -#### *property* frame +### *property* frame + -#### has_invariant() → bool +### has_invariant() → bool + -#### *property* invariant +### *property* invariant + -#### *property* position +### *property* position + -#### reset_invariant() +### reset_invariant() + -#### *property* section_point_name +### *property* section_point_name + -#### *property* section_points +### *property* section_points + -#### *property* set_infos +### *property* set_infos + -#### *property* set_type +### *property* set_type + -#### *property* step_name +### *property* step_name + -#### *property* use_last_frame +### *property* use_last_frame + -#### *class* ODBHistoryOutputVariable +### *class* ODBHistoryOutputVariable + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg4: str) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg4: str) + -#### *property* history_output_description +### *property* history_output_description + -#### *property* history_output_name +### *property* history_output_name + -#### *property* point_position +### *property* point_position + -#### *property* region_name +### *property* region_name + -#### *property* step_name +### *property* step_name + -#### *property* tip_set_info +### *property* tip_set_info + -#### *property* tipset_bound +### *property* tipset_bound + -#### *class* ODBSectionPointInfo +### *class* ODBSectionPointInfo + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: int) +### \_\_init_\_(arg2: int) -#### \_\_init_\_(arg2: int, arg3: str) +### \_\_init_\_(arg2: int, arg3: str) -#### \_\_init_\_(arg2: int, arg3: str, arg4: str) +### \_\_init_\_(arg2: int, arg3: str, arg4: str) + -#### *class* ODBSectionPointInfoSet +### *class* ODBSectionPointInfoSet A mutable set. + -#### \_\_and_\_(arg2: [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet)) → [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet) +### \_\_and_\_(arg2: [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet)) → [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet) Return the intersection of this set and other. + -#### \_\_contains_\_(arg2: [ODBSectionPointInfo](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfo)) → bool +### \_\_contains_\_(arg2: [ODBSectionPointInfo](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfo)) → bool + -#### \_\_delitem_\_(arg2: [ODBSectionPointInfo](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfo)) +### \_\_delitem_\_(arg2: [ODBSectionPointInfo](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfo)) + -#### \_\_hash_\_() +### \_\_hash_\_() + -#### \_\_init_\_() +### \_\_init_\_() + -#### \_\_iter_\_() → object +### \_\_iter_\_() → object + -#### \_\_len_\_() → int +### \_\_len_\_() → int + -#### \_\_or_\_(arg2: [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet)) → [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet) +### \_\_or_\_(arg2: [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet)) → [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet) Return the union of this set and other. + -#### \_\_sub_\_(arg2: [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet)) → [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet) +### \_\_sub_\_(arg2: [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet)) → [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet) Return elements of this set that are not in other. + -#### \_\_xor_\_(arg2: [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet)) → [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet) +### \_\_xor_\_(arg2: [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet)) → [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet) Return elements that are either in this set or in other but not in both. + -#### add(element: [ODBSectionPointInfo](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfo)) +### add(element: [ODBSectionPointInfo](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfo)) Add element. + -#### difference(other: [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet)) → [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet) +### difference(other: [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet)) → [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet) Return elements of this set that are not in other. + -#### intersection(other: [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet)) → [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet) +### intersection(other: [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet)) → [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet) Return the intersection of this set and other. + -#### remove(element: [ODBSectionPointInfo](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfo)) +### remove(element: [ODBSectionPointInfo](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfo)) Remove element. + -#### symmetric_difference(other: [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet)) → [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet) +### symmetric_difference(other: [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet)) → [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet) Return elements that are either in this set or in other but not in both. + -#### union(other: [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet)) → [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet) +### union(other: [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet)) → [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet) Return the union of this set and other. + -#### *class* ODBSetInfo +### *class* ODBSetInfo + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str, arg3: [SetLocation](#optiSLang_Actors.SetLocation), arg4: [SetType](#optiSLang_Actors.SetType)) +### \_\_init_\_(arg2: str, arg3: [SetLocation](#optiSLang_Actors.SetLocation), arg4: [SetType](#optiSLang_Actors.SetType)) -#### \_\_init_\_(arg2: str, arg3: [SetLocation](#optiSLang_Actors.SetLocation), arg4: [SetType](#optiSLang_Actors.SetType), arg5: [StrList](stdcpp_python_export.md#stdcpp_python_export.StrList)) +### \_\_init_\_(arg2: str, arg3: [SetLocation](#optiSLang_Actors.SetLocation), arg4: [SetType](#optiSLang_Actors.SetType), arg5: [StrList](stdcpp_python_export.md#stdcpp_python_export.StrList)) -#### \_\_init_\_(arg2: str, arg3: [SetLocation](#optiSLang_Actors.SetLocation), arg4: [SetType](#optiSLang_Actors.SetType), arg5: [StrList](stdcpp_python_export.md#stdcpp_python_export.StrList), arg6: str) +### \_\_init_\_(arg2: str, arg3: [SetLocation](#optiSLang_Actors.SetLocation), arg4: [SetType](#optiSLang_Actors.SetType), arg5: [StrList](stdcpp_python_export.md#stdcpp_python_export.StrList), arg6: str) + -#### *class* ODBSetInfoSet +### *class* ODBSetInfoSet A mutable set. + -#### \_\_and_\_(arg2: [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet)) → [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet) +### \_\_and_\_(arg2: [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet)) → [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet) Return the intersection of this set and other. + -#### \_\_contains_\_(arg2: [ODBSetInfo](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfo)) → bool +### \_\_contains_\_(arg2: [ODBSetInfo](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfo)) → bool + -#### \_\_delitem_\_(arg2: [ODBSetInfo](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfo)) +### \_\_delitem_\_(arg2: [ODBSetInfo](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfo)) + -#### \_\_hash_\_() +### \_\_hash_\_() + -#### \_\_init_\_() +### \_\_init_\_() + -#### \_\_iter_\_() → object +### \_\_iter_\_() → object + -#### \_\_len_\_() → int +### \_\_len_\_() → int + -#### \_\_or_\_(arg2: [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet)) → [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet) +### \_\_or_\_(arg2: [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet)) → [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet) Return the union of this set and other. + -#### \_\_sub_\_(arg2: [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet)) → [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet) +### \_\_sub_\_(arg2: [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet)) → [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet) Return elements of this set that are not in other. + -#### \_\_xor_\_(arg2: [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet)) → [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet) +### \_\_xor_\_(arg2: [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet)) → [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet) Return elements that are either in this set or in other but not in both. + -#### add(element: [ODBSetInfo](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfo)) +### add(element: [ODBSetInfo](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfo)) Add element. + -#### difference(other: [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet)) → [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet) +### difference(other: [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet)) → [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet) Return elements of this set that are not in other. + -#### intersection(other: [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet)) → [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet) +### intersection(other: [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet)) → [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet) Return the intersection of this set and other. + -#### remove(element: [ODBSetInfo](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfo)) +### remove(element: [ODBSetInfo](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfo)) Remove element. + -#### symmetric_difference(other: [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet)) → [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet) +### symmetric_difference(other: [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet)) → [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet) Return elements that are either in this set or in other but not in both. + -#### union(other: [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet)) → [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet) +### union(other: [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet)) → [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet) Return the union of this set and other. + -#### *class* PythonBasedOutputVariable +### *class* PythonBasedOutputVariable + -#### \_\_init_\_() +### \_\_init_\_() Raises an exception This class cannot be instantiated from Python + -#### *property* id_list +### *property* id_list + -#### *class* RegexSearcher +### *class* RegexSearcher + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -#### *property* end_search_string +### *property* end_search_string + -#### *property* end_search_string_is_regex +### *property* end_search_string_is_regex + -#### *property* search_string +### *property* search_string + -#### *property* search_string_is_regex +### *property* search_string_is_regex + -#### *class* RepeaterArgs +### *class* RepeaterArgs + -#### \_\_init_\_(arg2: int, arg3: int, arg4: int) +### \_\_init_\_(arg2: int, arg3: int, arg4: int) + -#### *class* SimPackOutputVariable +### *class* SimPackOutputVariable + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str, arg4: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str, arg4: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg4: str, arg5: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg4: str, arg5: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) -#### \_\_init_\_(arg2: str, arg3: str, arg4: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) +### \_\_init_\_(arg2: str, arg3: str, arg4: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) + -#### *class* TextMarker +### *class* TextMarker + -#### \_\_init_\_() +### \_\_init_\_() Raises an exception This class cannot be instantiated from Python + -#### append(arg2: [TextMarker](#optiSLang_Actors.ETKTextOutputActor.TextMarker)) +### append(arg2: [TextMarker](#optiSLang_Actors.ETKTextOutputActor.TextMarker)) + -#### get_child() → [TextMarker](#optiSLang_Actors.ETKTextOutputActor.TextMarker) +### get_child() → [TextMarker](#optiSLang_Actors.ETKTextOutputActor.TextMarker) + -#### get_row_reader() → bool +### get_row_reader() → bool + -#### has_child() → bool +### has_child() → bool + -#### has_repeater() → bool +### has_repeater() → bool + -#### is_row_reader() → bool +### is_row_reader() → bool + -#### *property* repeater +### *property* repeater + -#### *class* TextOutputVariable +### *class* TextOutputVariable + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg4: str) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg4: str) -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) -#### \_\_init_\_(arg2: str, arg3: str) +### \_\_init_\_(arg2: str, arg3: str) -#### \_\_init_\_(Output: Path file path, Variable: str name, Line: RepeaterArgs reapeater arguments, Token: RepeaterArgs repeater arguments) +### \_\_init_\_(Output: Path file path, Variable: str name, Line: RepeaterArgs reapeater arguments, Token: RepeaterArgs repeater arguments) -#### \_\_init_\_(Output: Path file path, Base: Path path, Variable: str name, Line: RepeaterArgs reapeater arguments, Token: RepeaterArgs repeater arguments) +### \_\_init_\_(Output: Path file path, Base: Path path, Variable: str name, Line: RepeaterArgs reapeater arguments, Token: RepeaterArgs repeater arguments) -#### \_\_init_\_(Output: Path file path, Variable: str name, Line: RepeaterArgs reapeater arguments, Column: RepeaterArgs repeater arguments, Column: int offset, Column: int width) +### \_\_init_\_(Output: Path file path, Variable: str name, Line: RepeaterArgs reapeater arguments, Column: RepeaterArgs repeater arguments, Column: int offset, Column: int width) -#### \_\_init_\_(Output: Path file path, Base: Path path, Variable: str name, Line: RepeaterArgs reapeater arguments, Column: RepeaterArgs repeater arguments, Column: int offset, Column: int width) +### \_\_init_\_(Output: Path file path, Base: Path path, Variable: str name, Line: RepeaterArgs reapeater arguments, Column: RepeaterArgs repeater arguments, Column: int offset, Column: int width) [7] Creates TextOutputVariable using token reader. @@ -2461,531 +3055,653 @@ This class cannot be instantiated from Python [10] Creates TextOutputVariable using column reader. + -#### *property* prefer_signal +### *property* prefer_signal Prefer as signal. + -#### *property* reader +### *property* reader Contains the variable’s reader. + -#### *class* TokenReader +### *class* TokenReader + -#### \_\_init_\_() +### \_\_init_\_() + -#### *property* separator +### *property* separator + -#### *class* TurboOptOutputVariable +### *class* TurboOptOutputVariable + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str, arg4: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str, arg4: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg4: str, arg5: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg4: str, arg5: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) -#### \_\_init_\_(arg2: str, arg3: str, arg4: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) +### \_\_init_\_(arg2: str, arg3: str, arg4: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) + -#### *class* Variable +### *class* Variable + -#### \_\_init_\_() +### \_\_init_\_() Raises an exception This class cannot be instantiated from Python + -#### *property* ident +### *property* ident + -#### \_\_init_\_() +### \_\_init_\_() Raises an exception This class cannot be instantiated from Python + -### *class* \_optiSLang_Actors.ETKAbaqusActor +## *class* \_optiSLang_Actors.ETKAbaqusActor + -#### *class* ODBFieldOutputVariable +### *class* ODBFieldOutputVariable + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg4: str) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg4: str) + -#### *property* component_name +### *property* component_name + -#### *property* element_types +### *property* element_types + -#### *property* field_output_name +### *property* field_output_name + -#### *property* frame +### *property* frame + -#### has_invariant() → bool +### has_invariant() → bool + -#### *property* invariant +### *property* invariant + -#### *property* position +### *property* position + -#### reset_invariant() +### reset_invariant() + -#### *property* section_point_name +### *property* section_point_name + -#### *property* section_points +### *property* section_points + -#### *property* set_infos +### *property* set_infos + -#### *property* set_type +### *property* set_type + -#### *property* step_name +### *property* step_name + -#### *property* use_last_frame +### *property* use_last_frame + -#### *class* ODBHistoryOutputVariable +### *class* ODBHistoryOutputVariable + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg4: str) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg4: str) + -#### *property* history_output_description +### *property* history_output_description + -#### *property* history_output_name +### *property* history_output_name + -#### *property* point_position +### *property* point_position + -#### *property* region_name +### *property* region_name + -#### *property* step_name +### *property* step_name + -#### *property* tip_set_info +### *property* tip_set_info + -#### *property* tipset_bound +### *property* tipset_bound + -#### *class* ODBSectionPointInfo +### *class* ODBSectionPointInfo + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: int) +### \_\_init_\_(arg2: int) -#### \_\_init_\_(arg2: int, arg3: str) +### \_\_init_\_(arg2: int, arg3: str) -#### \_\_init_\_(arg2: int, arg3: str, arg4: str) +### \_\_init_\_(arg2: int, arg3: str, arg4: str) + -#### *class* ODBSectionPointInfoSet +### *class* ODBSectionPointInfoSet A mutable set. + -#### \_\_and_\_(arg2: [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet)) → [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet) +### \_\_and_\_(arg2: [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet)) → [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet) Return the intersection of this set and other. + -#### \_\_contains_\_(arg2: [ODBSectionPointInfo](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfo)) → bool +### \_\_contains_\_(arg2: [ODBSectionPointInfo](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfo)) → bool + -#### \_\_delitem_\_(arg2: [ODBSectionPointInfo](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfo)) +### \_\_delitem_\_(arg2: [ODBSectionPointInfo](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfo)) + -#### \_\_hash_\_() +### \_\_hash_\_() + -#### \_\_init_\_() +### \_\_init_\_() + -#### \_\_iter_\_() → object +### \_\_iter_\_() → object + -#### \_\_len_\_() → int +### \_\_len_\_() → int + -#### \_\_or_\_(arg2: [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet)) → [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet) +### \_\_or_\_(arg2: [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet)) → [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet) Return the union of this set and other. + -#### \_\_sub_\_(arg2: [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet)) → [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet) +### \_\_sub_\_(arg2: [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet)) → [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet) Return elements of this set that are not in other. + -#### \_\_xor_\_(arg2: [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet)) → [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet) +### \_\_xor_\_(arg2: [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet)) → [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet) Return elements that are either in this set or in other but not in both. + -#### add(element: [ODBSectionPointInfo](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfo)) +### add(element: [ODBSectionPointInfo](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfo)) Add element. + -#### difference(other: [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet)) → [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet) +### difference(other: [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet)) → [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet) Return elements of this set that are not in other. + -#### intersection(other: [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet)) → [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet) +### intersection(other: [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet)) → [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet) Return the intersection of this set and other. + -#### remove(element: [ODBSectionPointInfo](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfo)) +### remove(element: [ODBSectionPointInfo](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfo)) Remove element. + -#### symmetric_difference(other: [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet)) → [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet) +### symmetric_difference(other: [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet)) → [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet) Return elements that are either in this set or in other but not in both. + -#### union(other: [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet)) → [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet) +### union(other: [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet)) → [ODBSectionPointInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSectionPointInfoSet) Return the union of this set and other. + -#### *class* ODBSetInfo +### *class* ODBSetInfo + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str, arg3: [SetLocation](#optiSLang_Actors.SetLocation), arg4: [SetType](#optiSLang_Actors.SetType)) +### \_\_init_\_(arg2: str, arg3: [SetLocation](#optiSLang_Actors.SetLocation), arg4: [SetType](#optiSLang_Actors.SetType)) -#### \_\_init_\_(arg2: str, arg3: [SetLocation](#optiSLang_Actors.SetLocation), arg4: [SetType](#optiSLang_Actors.SetType), arg5: [StrList](stdcpp_python_export.md#stdcpp_python_export.StrList)) +### \_\_init_\_(arg2: str, arg3: [SetLocation](#optiSLang_Actors.SetLocation), arg4: [SetType](#optiSLang_Actors.SetType), arg5: [StrList](stdcpp_python_export.md#stdcpp_python_export.StrList)) -#### \_\_init_\_(arg2: str, arg3: [SetLocation](#optiSLang_Actors.SetLocation), arg4: [SetType](#optiSLang_Actors.SetType), arg5: [StrList](stdcpp_python_export.md#stdcpp_python_export.StrList), arg6: str) +### \_\_init_\_(arg2: str, arg3: [SetLocation](#optiSLang_Actors.SetLocation), arg4: [SetType](#optiSLang_Actors.SetType), arg5: [StrList](stdcpp_python_export.md#stdcpp_python_export.StrList), arg6: str) + -#### *class* ODBSetInfoSet +### *class* ODBSetInfoSet A mutable set. + -#### \_\_and_\_(arg2: [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet)) → [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet) +### \_\_and_\_(arg2: [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet)) → [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet) Return the intersection of this set and other. + -#### \_\_contains_\_(arg2: [ODBSetInfo](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfo)) → bool +### \_\_contains_\_(arg2: [ODBSetInfo](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfo)) → bool + -#### \_\_delitem_\_(arg2: [ODBSetInfo](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfo)) +### \_\_delitem_\_(arg2: [ODBSetInfo](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfo)) + -#### \_\_hash_\_() +### \_\_hash_\_() + -#### \_\_init_\_() +### \_\_init_\_() + -#### \_\_iter_\_() → object +### \_\_iter_\_() → object + -#### \_\_len_\_() → int +### \_\_len_\_() → int + -#### \_\_or_\_(arg2: [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet)) → [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet) +### \_\_or_\_(arg2: [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet)) → [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet) Return the union of this set and other. + -#### \_\_sub_\_(arg2: [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet)) → [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet) +### \_\_sub_\_(arg2: [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet)) → [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet) Return elements of this set that are not in other. + -#### \_\_xor_\_(arg2: [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet)) → [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet) +### \_\_xor_\_(arg2: [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet)) → [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet) Return elements that are either in this set or in other but not in both. + -#### add(element: [ODBSetInfo](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfo)) +### add(element: [ODBSetInfo](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfo)) Add element. + -#### difference(other: [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet)) → [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet) +### difference(other: [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet)) → [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet) Return elements of this set that are not in other. + -#### intersection(other: [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet)) → [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet) +### intersection(other: [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet)) → [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet) Return the intersection of this set and other. + -#### remove(element: [ODBSetInfo](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfo)) +### remove(element: [ODBSetInfo](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfo)) Remove element. + -#### symmetric_difference(other: [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet)) → [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet) +### symmetric_difference(other: [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet)) → [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet) Return elements that are either in this set or in other but not in both. + -#### union(other: [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet)) → [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet) +### union(other: [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet)) → [ODBSetInfoSet](#optiSLang_Actors.ETKAbaqusActor.ODBSetInfoSet) Return the union of this set and other. + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -#### free_cached_resources() +### free_cached_resources() + -### *class* \_optiSLang_Actors.ETKActor +## *class* \_optiSLang_Actors.ETKActor + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -#### *property* imported_files +### *property* imported_files + -#### *property* max_parallel +### *property* max_parallel + -### *class* \_optiSLang_Actors.ETKFloEFDActor +## *class* \_optiSLang_Actors.ETKFloEFDActor + -#### *class* FloEFDOutputVariable +### *class* FloEFDOutputVariable + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str, arg4: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str, arg4: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg4: str, arg5: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg4: str, arg5: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) -#### \_\_init_\_(arg2: str, arg3: str, arg4: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) +### \_\_init_\_(arg2: str, arg3: str, arg4: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -### *class* \_optiSLang_Actors.ETKSimPackActor +## *class* \_optiSLang_Actors.ETKSimPackActor + -#### *class* SimPackOutputVariable +### *class* SimPackOutputVariable + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str, arg4: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str, arg4: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg4: str, arg5: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg4: str, arg5: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) -#### \_\_init_\_(arg2: str, arg3: str, arg4: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) +### \_\_init_\_(arg2: str, arg3: str, arg4: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -### *class* \_optiSLang_Actors.ETKTextOutputActor +## *class* \_optiSLang_Actors.ETKTextOutputActor + -#### *class* ColumnReader +### *class* ColumnReader + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: int) +### \_\_init_\_(arg2: int) -#### \_\_init_\_(arg2: int, arg3: int) +### \_\_init_\_(arg2: int, arg3: int) + -#### *property* initial_offset +### *property* initial_offset + -#### *property* width +### *property* width + -#### *class* IncrementRepeater +### *class* IncrementRepeater + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: int) +### \_\_init_\_(arg2: int) -#### \_\_init_\_(arg2: int, arg3: int) +### \_\_init_\_(arg2: int, arg3: int) -#### \_\_init_\_(arg2: int, arg3: int, arg4: int) +### \_\_init_\_(arg2: int, arg3: int, arg4: int) + -#### *property* increment +### *property* increment + -#### *property* max_increment +### *property* max_increment + -#### *property* offset +### *property* offset + -#### *class* LineReader +### *class* LineReader + -#### \_\_init_\_() +### \_\_init_\_() + -#### *class* MarkerRepeater +### *class* MarkerRepeater + -#### \_\_init_\_() +### \_\_init_\_() Raises an exception This class cannot be instantiated from Python + -#### *class* RegexSearcher +### *class* RegexSearcher + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -#### *property* end_search_string +### *property* end_search_string + -#### *property* end_search_string_is_regex +### *property* end_search_string_is_regex + -#### *property* search_string +### *property* search_string + -#### *property* search_string_is_regex +### *property* search_string_is_regex + -#### *class* RepeaterArgs +### *class* RepeaterArgs + -#### \_\_init_\_(arg2: int, arg3: int, arg4: int) +### \_\_init_\_(arg2: int, arg3: int, arg4: int) + -#### *class* TextMarker +### *class* TextMarker + -#### \_\_init_\_() +### \_\_init_\_() Raises an exception This class cannot be instantiated from Python + -#### append(arg2: [TextMarker](#optiSLang_Actors.ETKTextOutputActor.TextMarker)) +### append(arg2: [TextMarker](#optiSLang_Actors.ETKTextOutputActor.TextMarker)) + -#### get_child() → [TextMarker](#optiSLang_Actors.ETKTextOutputActor.TextMarker) +### get_child() → [TextMarker](#optiSLang_Actors.ETKTextOutputActor.TextMarker) + -#### get_row_reader() → bool +### get_row_reader() → bool + -#### has_child() → bool +### has_child() → bool + -#### has_repeater() → bool +### has_repeater() → bool + -#### is_row_reader() → bool +### is_row_reader() → bool + -#### *property* repeater +### *property* repeater + -#### *class* TextOutputVariable +### *class* TextOutputVariable + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg4: str) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg4: str) -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) -#### \_\_init_\_(arg2: str, arg3: str) +### \_\_init_\_(arg2: str, arg3: str) -#### \_\_init_\_(Output: Path file path, Variable: str name, Line: RepeaterArgs reapeater arguments, Token: RepeaterArgs repeater arguments) +### \_\_init_\_(Output: Path file path, Variable: str name, Line: RepeaterArgs reapeater arguments, Token: RepeaterArgs repeater arguments) -#### \_\_init_\_(Output: Path file path, Base: Path path, Variable: str name, Line: RepeaterArgs reapeater arguments, Token: RepeaterArgs repeater arguments) +### \_\_init_\_(Output: Path file path, Base: Path path, Variable: str name, Line: RepeaterArgs reapeater arguments, Token: RepeaterArgs repeater arguments) -#### \_\_init_\_(Output: Path file path, Variable: str name, Line: RepeaterArgs reapeater arguments, Column: RepeaterArgs repeater arguments, Column: int offset, Column: int width) +### \_\_init_\_(Output: Path file path, Variable: str name, Line: RepeaterArgs reapeater arguments, Column: RepeaterArgs repeater arguments, Column: int offset, Column: int width) -#### \_\_init_\_(Output: Path file path, Base: Path path, Variable: str name, Line: RepeaterArgs reapeater arguments, Column: RepeaterArgs repeater arguments, Column: int offset, Column: int width) +### \_\_init_\_(Output: Path file path, Base: Path path, Variable: str name, Line: RepeaterArgs reapeater arguments, Column: RepeaterArgs repeater arguments, Column: int offset, Column: int width) [7] Creates TextOutputVariable using token reader. @@ -2995,2422 +3711,3070 @@ This class cannot be instantiated from Python [10] Creates TextOutputVariable using column reader. + -#### *property* prefer_signal +### *property* prefer_signal Prefer as signal. + -#### *property* reader +### *property* reader Contains the variable’s reader. + -#### *class* TokenReader +### *class* TokenReader + -#### \_\_init_\_() +### \_\_init_\_() + -#### *property* separator +### *property* separator + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -#### *property* max_parallel +### *property* max_parallel + -### *class* \_optiSLang_Actors.ETKTurboOptActor +## *class* \_optiSLang_Actors.ETKTurboOptActor + -#### *class* TurboOptOutputVariable +### *class* TurboOptOutputVariable + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str, arg4: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str, arg4: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg4: str, arg5: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg4: str, arg5: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) -#### \_\_init_\_(arg2: str, arg3: str, arg4: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) +### \_\_init_\_(arg2: str, arg3: str, arg4: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -### *class* \_optiSLang_Actors.ExecutionPolicy +## *class* \_optiSLang_Actors.ExecutionPolicy + -#### \_\_init_\_(continuation_behaviour: Continuation=_optiSLang_Actors.Continuation.DEFAULT, expressions: WStrList) +### \_\_init_\_(continuation_behaviour: Continuation=_optiSLang_Actors.Continuation.DEFAULT, expressions: WStrList) -#### \_\_init_\_(, continuation_behaviour: Continuation=_optiSLang_Actors.Continuation.DEFAULT [, expressions_mode: Expressions=_optiSLang_Actors.Expressions.FULFILL_ALL]]) +### \_\_init_\_(, continuation_behaviour: Continuation=_optiSLang_Actors.Continuation.DEFAULT [, expressions_mode: Expressions=_optiSLang_Actors.Expressions.FULFILL_ALL]]) + -#### *property* continuation_behaviour +### *property* continuation_behaviour Continuation behaviour in case of predecessor failure + -#### *property* expressions +### *property* expressions Expression conditions + -#### *property* expressions_mode +### *property* expressions_mode Fulfillment mode for expression conditions + -### *class* \_optiSLang_Actors.ExportFailureTreatment +## *class* \_optiSLang_Actors.ExportFailureTreatment **Enumeration** + -#### ALWAYS_SUCCEED *= \_optiSLang_Actors.ExportFailureTreatment.ALWAYS_SUCCEED* +### ALWAYS_SUCCEED *= \_optiSLang_Actors.ExportFailureTreatment.ALWAYS_SUCCEED* + -#### FAIL_ON_WRITE_ERROR *= \_optiSLang_Actors.ExportFailureTreatment.FAIL_ON_WRITE_ERROR* +### FAIL_ON_WRITE_ERROR *= \_optiSLang_Actors.ExportFailureTreatment.FAIL_ON_WRITE_ERROR* + -### *class* \_optiSLang_Actors.ExportFormat +## *class* \_optiSLang_Actors.ExportFormat **Enumeration** + -#### CSV *= \_optiSLang_Actors.ExportFormat.CSV* +### CSV *= \_optiSLang_Actors.ExportFormat.CSV* + -#### EXCEL *= \_optiSLang_Actors.ExportFormat.EXCEL* +### EXCEL *= \_optiSLang_Actors.ExportFormat.EXCEL* + -#### GENERIC *= \_optiSLang_Actors.ExportFormat.GENERIC* +### GENERIC *= \_optiSLang_Actors.ExportFormat.GENERIC* + -#### JSON *= \_optiSLang_Actors.ExportFormat.JSON* +### JSON *= \_optiSLang_Actors.ExportFormat.JSON* + -### *class* \_optiSLang_Actors.Expressions +## *class* \_optiSLang_Actors.Expressions **Enumeration** Integration actor expression conditions fulfillment mode + -#### DISABLED *= \_optiSLang_Actors.Expressions.DISABLED* +### DISABLED *= \_optiSLang_Actors.Expressions.DISABLED* + -#### FULFILL_ALL *= \_optiSLang_Actors.Expressions.FULFILL_ALL* +### FULFILL_ALL *= \_optiSLang_Actors.Expressions.FULFILL_ALL* + -#### FULFILL_ANY *= \_optiSLang_Actors.Expressions.FULFILL_ANY* +### FULFILL_ANY *= \_optiSLang_Actors.Expressions.FULFILL_ANY* + -### *class* \_optiSLang_Actors.ExtrapolationType +## *class* \_optiSLang_Actors.ExtrapolationType **Enumeration** + -#### EXTRAPOLATE *= \_optiSLang_Actors.ExtrapolationType.EXTRAPOLATE* +### EXTRAPOLATE *= \_optiSLang_Actors.ExtrapolationType.EXTRAPOLATE* + -#### INITIAL_SAMPLING_BOUNDS *= \_optiSLang_Actors.ExtrapolationType.INITIAL_SAMPLING_BOUNDS* +### INITIAL_SAMPLING_BOUNDS *= \_optiSLang_Actors.ExtrapolationType.INITIAL_SAMPLING_BOUNDS* + -#### REDUCED_SAMPLING_BOUNDS *= \_optiSLang_Actors.ExtrapolationType.REDUCED_SAMPLING_BOUNDS* +### REDUCED_SAMPLING_BOUNDS *= \_optiSLang_Actors.ExtrapolationType.REDUCED_SAMPLING_BOUNDS* + -### *class* \_optiSLang_Actors.FORMActor +## *class* \_optiSLang_Actors.FORMActor Reliability actor using First Order Reliability Method. + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -#### *property* reliability_settings +### *property* reliability_settings + -### *class* \_optiSLang_Actors.FloEFDInputActor +## *class* \_optiSLang_Actors.FloEFDInputActor + -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -### \_optiSLang_Actors.GetLoadedCIPlugins() → [WStrSet](stdcpp_python_export.md#stdcpp_python_export.WStrSet) +## \_optiSLang_Actors.GetLoadedCIPlugins() → [WStrSet](stdcpp_python_export.md#stdcpp_python_export.WStrSet) + -### \_optiSLang_Actors.GetLoadedPlugins() → [WStrSet](stdcpp_python_export.md#stdcpp_python_export.WStrSet) +## \_optiSLang_Actors.GetLoadedPlugins() → [WStrSet](stdcpp_python_export.md#stdcpp_python_export.WStrSet) List customization plugins that are loaded at runtime. + -### *class* \_optiSLang_Actors.HPSActor +## *class* \_optiSLang_Actors.HPSActor + -#### \_\_init_\_() +### \_\_init_\_() + -#### add_input(location: HPSLocation) +### add_input(location: HPSLocation) Assign location to an input slot. + -#### add_internal_variable(location: HPSLocation) +### add_internal_variable(location: HPSLocation) -#### add_internal_variable(derived_variable: DerivedLocation) +### add_internal_variable(derived_variable: DerivedLocation) [0] Assign location to an internal variable. [1] Create a derived variable. + -#### add_output(location: HPSLocation) +### add_output(location: HPSLocation) -#### add_output(derived_variable: DerivedLocation) +### add_output(derived_variable: DerivedLocation) [0] Assign location to an output slot. [1] Create a derived variable and assign it to an output slot. + -#### add_parameter(location: HPSLocation) +### add_parameter(location: HPSLocation) -#### add_parameter(arg2: str) → str +### add_parameter(arg2: str) → str [0] Assign location to a parameter. + -#### add_response(location: HPSLocation) +### add_response(location: HPSLocation) -#### add_response(derived_variable: DerivedLocation) +### add_response(derived_variable: DerivedLocation) -#### add_response(arg2: str) → str +### add_response(arg2: str) → str [0] Assign location to a response. [1] Create a derived variable and assign it to a response. + -#### *property* designs_per_process +### *property* designs_per_process + -#### get_internal_variables() → list +### get_internal_variables() → list Get internal variables + -#### get_registered_inputs() → list +### get_registered_inputs() → list Get registered input slots + -#### get_registered_outputs() → list +### get_registered_outputs() → list Get registered output slots + -#### get_registered_parameters() → list +### get_registered_parameters() → list Get registered parameters + -#### get_registered_responses() → list +### get_registered_responses() → list Get registered responses + -#### *property* job_definition +### *property* job_definition + -#### login(arg2: str, arg3: str) +### login(arg2: str, arg3: str) + -#### *property* output_files_to_fetch +### *property* output_files_to_fetch + -#### *property* project +### *property* project + -#### *property* refresh_token +### *property* refresh_token + -#### *property* url +### *property* url + -### *class* \_optiSLang_Actors.HPSLocation +## *class* \_optiSLang_Actors.HPSLocation + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(location: str id, direction: IntegrationDirection) +### \_\_init_\_(location: str id, direction: IntegrationDirection) [1] Create a HPSLocation instance. + -#### *property* direction +### *property* direction + -#### *property* name +### *property* name + -### *class* \_optiSLang_Actors.ISPUDActor +## *class* \_optiSLang_Actors.ISPUDActor Reliability actor that utilizes Importance Sampling Using the Design Point. + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -#### *property* reliability_settings +### *property* reliability_settings + -### *class* \_optiSLang_Actors.ImportDimensionType +## *class* \_optiSLang_Actors.ImportDimensionType **Enumeration** + -#### DesignId *= \_optiSLang_Actors.ImportDimensionType.DesignId* +### DesignId *= \_optiSLang_Actors.ImportDimensionType.DesignId* + -#### DontImport *= \_optiSLang_Actors.ImportDimensionType.DontImport* +### DontImport *= \_optiSLang_Actors.ImportDimensionType.DontImport* + -#### Parameter *= \_optiSLang_Actors.ImportDimensionType.Parameter* +### Parameter *= \_optiSLang_Actors.ImportDimensionType.Parameter* + -#### Response *= \_optiSLang_Actors.ImportDimensionType.Response* +### Response *= \_optiSLang_Actors.ImportDimensionType.Response* + -### *class* \_optiSLang_Actors.ImportFailureTreatment +## *class* \_optiSLang_Actors.ImportFailureTreatment **Enumeration** + -#### ALWAYS_SUCCEED *= \_optiSLang_Actors.ImportFailureTreatment.ALWAYS_SUCCEED* +### ALWAYS_SUCCEED *= \_optiSLang_Actors.ImportFailureTreatment.ALWAYS_SUCCEED* + -#### FAIL_ON_MISSING_ENTRY *= \_optiSLang_Actors.ImportFailureTreatment.FAIL_ON_MISSING_ENTRY* +### FAIL_ON_MISSING_ENTRY *= \_optiSLang_Actors.ImportFailureTreatment.FAIL_ON_MISSING_ENTRY* + -#### FAIL_ON_READ_ERROR *= \_optiSLang_Actors.ImportFailureTreatment.FAIL_ON_READ_ERROR* +### FAIL_ON_READ_ERROR *= \_optiSLang_Actors.ImportFailureTreatment.FAIL_ON_READ_ERROR* + -#### FAIL_ON_TYPE_MISMATCH *= \_optiSLang_Actors.ImportFailureTreatment.FAIL_ON_TYPE_MISMATCH* +### FAIL_ON_TYPE_MISMATCH *= \_optiSLang_Actors.ImportFailureTreatment.FAIL_ON_TYPE_MISMATCH* + -### *class* \_optiSLang_Actors.ImportFormat +## *class* \_optiSLang_Actors.ImportFormat **Enumeration** + -#### CSV *= \_optiSLang_Actors.ImportFormat.CSV* +### CSV *= \_optiSLang_Actors.ImportFormat.CSV* + -#### EXCEL *= \_optiSLang_Actors.ImportFormat.EXCEL* +### EXCEL *= \_optiSLang_Actors.ImportFormat.EXCEL* + -#### GENERIC *= \_optiSLang_Actors.ImportFormat.GENERIC* +### GENERIC *= \_optiSLang_Actors.ImportFormat.GENERIC* + -#### JSON *= \_optiSLang_Actors.ImportFormat.JSON* +### JSON *= \_optiSLang_Actors.ImportFormat.JSON* + -### *class* \_optiSLang_Actors.IntegrationBaseActor +## *class* \_optiSLang_Actors.IntegrationBaseActor + -#### \_\_init_\_() +### \_\_init_\_() Raises an exception This class cannot be instantiated from Python + -#### add_input(location: str) +### add_input(location: str) Assign location to an input slot. + -#### add_internal_variable(location: str) +### add_internal_variable(location: str) -#### add_internal_variable(derived_variable: DerivedLocation) +### add_internal_variable(derived_variable: DerivedLocation) [0] Assign location to an internal variable. [1] Create a derived variable. + -#### add_output(location: str) +### add_output(location: str) -#### add_output(derived_variable: DerivedLocation) +### add_output(derived_variable: DerivedLocation) [0] Assign location to an output slot. [1] Create a derived variable and assign it to an output slot. + -#### add_parameter(location: str) +### add_parameter(location: str) Assign location to a parameter. + -#### add_response(location: str) +### add_response(location: str) -#### add_response(derived_variable: DerivedLocation) +### add_response(derived_variable: DerivedLocation) -#### add_response(arg2: tuple) → str +### add_response(arg2: tuple) → str -#### add_response(arg2: tuple) → str +### add_response(arg2: tuple) → str [0] Assign location to a response. [1] Create a derived variable and assign it to a response. + -#### *property* error_code +### *property* error_code + -#### *property* execution_policy +### *property* execution_policy + -#### get_internal_variables() → list +### get_internal_variables() → list Get internal variables + -#### get_registered_inputs() → list +### get_registered_inputs() → list Get registered input slots + -#### get_registered_outputs() → list +### get_registered_outputs() → list Get registered output slots + -#### get_registered_parameters() → list +### get_registered_parameters() → list Get registered parameters + -#### get_registered_responses() → list +### get_registered_responses() → list Get registered responses + -#### *property* instant_variable_update +### *property* instant_variable_update + -#### load() → bool +### load() → bool -#### load(json: str) → bool +### load(json: str) → bool [0] Initialize integration according to specified properties [1] Initialize integration according to specified json-string content + -#### remove_input(arg2: str) +### remove_input(arg2: str) + -#### remove_internal_variable(arg2: str) → bool +### remove_internal_variable(arg2: str) → bool + -#### remove_output(arg2: str) +### remove_output(arg2: str) + -#### remove_parameter(arg2: str) +### remove_parameter(arg2: str) + -#### remove_response(arg2: str) +### remove_response(arg2: str) + -#### reread_parameter_reference_values(, publish_reference_changes: bool=True [, invalidate_on_fail: bool=False]]) +### reread_parameter_reference_values(, publish_reference_changes: bool=True [, invalidate_on_fail: bool=False]]) Re-reads parameter reference values and optionally updates values held by the parent system + -#### reread_response_reference_values(, publish_reference_changes: bool=True [, invalidate_on_fail: bool=False]]) +### reread_response_reference_values(, publish_reference_changes: bool=True [, invalidate_on_fail: bool=False]]) Re-reads response reference values and optionally updates values held by the parent system + -#### set_locations(arg2: str) → bool +### set_locations(arg2: str) → bool + -### *class* \_optiSLang_Actors.IntegrationDirection +## *class* \_optiSLang_Actors.IntegrationDirection **Enumeration** + -#### DIRECTION_INPUT *= \_optiSLang_Actors.IntegrationDirection.DIRECTION_INPUT* +### DIRECTION_INPUT *= \_optiSLang_Actors.IntegrationDirection.DIRECTION_INPUT* + -#### DIRECTION_OUTPUT *= \_optiSLang_Actors.IntegrationDirection.DIRECTION_OUTPUT* +### DIRECTION_OUTPUT *= \_optiSLang_Actors.IntegrationDirection.DIRECTION_OUTPUT* + -### *class* \_optiSLang_Actors.IntegrationPluginActor +## *class* \_optiSLang_Actors.IntegrationPluginActor + -#### \_\_init_\_(plugin: str name) → object +### \_\_init_\_(plugin: str name) → object Create an integration plugin actor by name. The plugin must be loaded at runtime. + -#### add_input(arg2: str) +### add_input(arg2: str) + -#### add_internal_variable(arg2: str) +### add_internal_variable(arg2: str) -#### add_internal_variable(derived: DerivedLocation variable) +### add_internal_variable(derived: DerivedLocation variable) [1] Create a derived variable. + -#### add_output(arg2: str) +### add_output(arg2: str) -#### add_output(arg2: DerivedLocation) +### add_output(arg2: DerivedLocation) [1] Create a derived variable and assign it to an output slot. + -#### add_parameter(arg2: str) +### add_parameter(arg2: str) + -#### add_response(arg2: str) +### add_response(arg2: str) -#### add_response(arg2: DerivedLocation) +### add_response(arg2: DerivedLocation) [1] Create a derived variable and assign it to a response. + -#### *property* error_code +### *property* error_code + -#### get_internal_property_names() → list +### get_internal_property_names() → list Get names of properties defined by the plugin internally + -#### get_plugin_id() → str +### get_plugin_id() → str The plugin id. + -#### *property* max_parallel +### *property* max_parallel + -#### re_register_locations_as_parameter() +### re_register_locations_as_parameter() + -#### re_register_locations_as_response() +### re_register_locations_as_response() + -#### register_location_as_input(arg2: str) +### register_location_as_input(arg2: str) + -#### register_location_as_internal_variable(arg2: str) +### register_location_as_internal_variable(arg2: str) -#### register_location_as_internal_variable(derived: DerivedLocation variable) +### register_location_as_internal_variable(derived: DerivedLocation variable) [1] Create a derived variable. + -#### register_location_as_output(arg2: str) +### register_location_as_output(arg2: str) -#### register_location_as_output(arg2: DerivedLocation) +### register_location_as_output(arg2: DerivedLocation) [1] Create a derived variable and assign it to an output slot. + -#### register_location_as_parameter(arg2: str) +### register_location_as_parameter(arg2: str) + -#### register_location_as_response(arg2: str) +### register_location_as_response(arg2: str) -#### register_location_as_response(arg2: DerivedLocation) +### register_location_as_response(arg2: DerivedLocation) [1] Create a derived variable and assign it to a response. + -#### register_locations_as_input() +### register_locations_as_input() + -#### register_locations_as_internal_variable() +### register_locations_as_internal_variable() + -#### register_locations_as_output() +### register_locations_as_output() + -#### register_locations_as_parameter() +### register_locations_as_parameter() + -#### register_locations_as_response() +### register_locations_as_response() + -### *class* \_optiSLang_Actors.Invariant +## *class* \_optiSLang_Actors.Invariant **Enumeration** + -#### INVARIANT_INV3 *= \_optiSLang_Actors.Invariant.INVARIANT_INV3* +### INVARIANT_INV3 *= \_optiSLang_Actors.Invariant.INVARIANT_INV3* + -#### INVARIANT_MAGNITUDE *= \_optiSLang_Actors.Invariant.INVARIANT_MAGNITUDE* +### INVARIANT_MAGNITUDE *= \_optiSLang_Actors.Invariant.INVARIANT_MAGNITUDE* + -#### INVARIANT_MAX_INPLANE_PRINCIPAL *= \_optiSLang_Actors.Invariant.INVARIANT_MAX_INPLANE_PRINCIPAL* +### INVARIANT_MAX_INPLANE_PRINCIPAL *= \_optiSLang_Actors.Invariant.INVARIANT_MAX_INPLANE_PRINCIPAL* + -#### INVARIANT_MAX_PRINCIPAL *= \_optiSLang_Actors.Invariant.INVARIANT_MAX_PRINCIPAL* +### INVARIANT_MAX_PRINCIPAL *= \_optiSLang_Actors.Invariant.INVARIANT_MAX_PRINCIPAL* + -#### INVARIANT_MID_PRINCIPAL *= \_optiSLang_Actors.Invariant.INVARIANT_MID_PRINCIPAL* +### INVARIANT_MID_PRINCIPAL *= \_optiSLang_Actors.Invariant.INVARIANT_MID_PRINCIPAL* + -#### INVARIANT_MIN_INPLANE_PRINCIPAL *= \_optiSLang_Actors.Invariant.INVARIANT_MIN_INPLANE_PRINCIPAL* +### INVARIANT_MIN_INPLANE_PRINCIPAL *= \_optiSLang_Actors.Invariant.INVARIANT_MIN_INPLANE_PRINCIPAL* + -#### INVARIANT_MIN_PRINCIPAL *= \_optiSLang_Actors.Invariant.INVARIANT_MIN_PRINCIPAL* +### INVARIANT_MIN_PRINCIPAL *= \_optiSLang_Actors.Invariant.INVARIANT_MIN_PRINCIPAL* + -#### INVARIANT_MISES *= \_optiSLang_Actors.Invariant.INVARIANT_MISES* +### INVARIANT_MISES *= \_optiSLang_Actors.Invariant.INVARIANT_MISES* + -#### INVARIANT_OUTOFPLANE_PRINCIPAL *= \_optiSLang_Actors.Invariant.INVARIANT_OUTOFPLANE_PRINCIPAL* +### INVARIANT_OUTOFPLANE_PRINCIPAL *= \_optiSLang_Actors.Invariant.INVARIANT_OUTOFPLANE_PRINCIPAL* + -#### INVARIANT_PRESS *= \_optiSLang_Actors.Invariant.INVARIANT_PRESS* +### INVARIANT_PRESS *= \_optiSLang_Actors.Invariant.INVARIANT_PRESS* + -#### INVARIANT_TRESCA *= \_optiSLang_Actors.Invariant.INVARIANT_TRESCA* +### INVARIANT_TRESCA *= \_optiSLang_Actors.Invariant.INVARIANT_TRESCA* + -#### INVARIANT_UNDEFINED *= \_optiSLang_Actors.Invariant.INVARIANT_UNDEFINED* +### INVARIANT_UNDEFINED *= \_optiSLang_Actors.Invariant.INVARIANT_UNDEFINED* + -### *class* \_optiSLang_Actors.LSDYNAInputActor +## *class* \_optiSLang_Actors.LSDYNAInputActor + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -#### get_locations_from_file(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint)) → bool +### get_locations_from_file(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint)) → bool + -#### get_locations_from_string(arg2: str, arg3: [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint)) → bool +### get_locations_from_string(arg2: str, arg3: [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint)) → bool + -### *class* \_optiSLang_Actors.MOPActor +## *class* \_optiSLang_Actors.MOPActor + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -#### *property* advanced_settings +### *property* advanced_settings MOP advanced settings. Assigning to this property will activate advanced mode. + -#### *property* model_complexity +### *property* model_complexity + -#### *property* mop_data +### *property* mop_data MOP parameter and response handling. + -#### *property* num_responses_parallel +### *property* num_responses_parallel + -#### *property* pmop_settings +### *property* pmop_settings + -#### *property* settings_type +### *property* settings_type + -#### *property* variable_reduction +### *property* variable_reduction + -### *class* \_optiSLang_Actors.MOPAdvancedSettings +## *class* \_optiSLang_Actors.MOPAdvancedSettings + -#### \_\_init_\_() +### \_\_init_\_() + -#### *property* adapt_bounds +### *property* adapt_bounds + -#### *property* adapt_bounds_safety_factor +### *property* adapt_bounds_safety_factor + -#### *property* custom_surrogates +### *property* custom_surrogates + -#### *property* cv_values_suffix +### *property* cv_values_suffix + -#### *property* log_file_path +### *property* log_file_path + -#### *property* log_in_file +### *property* log_in_file + -#### *property* log_in_project_log +### *property* log_in_project_log + -#### *property* num_parallel +### *property* num_parallel + -#### *property* use_incomplete +### *property* use_incomplete + -#### *property* write_cv_values +### *property* write_cv_values + -#### *property* write_function_string +### *property* write_function_string + -### *class* \_optiSLang_Actors.MOPAlgoSettings +## *class* \_optiSLang_Actors.MOPAlgoSettings + -#### \_\_init_\_() +### \_\_init_\_() + -#### *property* coefficient_factor_ascmo +### *property* coefficient_factor_ascmo Factor for minimum number of support points. + -#### *property* coefficient_factor_kriging +### *property* coefficient_factor_kriging Factor for minimum number of support points. + -#### *property* coefficient_factor_mls +### *property* coefficient_factor_mls Factor for minimum number of support points. + -#### *property* coefficient_factor_polynomial +### *property* coefficient_factor_polynomial Factor for minimum number of support points. + -#### *property* correlation_input_check +### *property* correlation_input_check Minimum correlation value for check. + -#### get_custom_surrogate_usage() → dict +### get_custom_surrogate_usage() → dict Return a dictionary of available custom surrogates and their usage state. + -#### *property* limits +### *property* limits Set limits as tuple of two values. + -#### *property* max_cod +### *property* max_cod Maximum CoD step. + -#### *property* max_coi +### *property* max_coi Maximum CoI step. + -#### *property* max_input_correlation +### *property* max_input_correlation Maximum correlation (multi-dimensional) for inputs. + -#### *property* max_order_mls +### *property* max_order_mls Maximum basis order. + -#### *property* max_order_polynomial +### *property* max_order_polynomial Maximum basis order. + -#### *property* min_input_correlation +### *property* min_input_correlation Minimum correlation (threshold) for inputs. + -#### *property* min_significance +### *property* min_significance Limit for significance filter. + -#### *property* num_correlation_steps +### *property* num_correlation_steps Number of steps for correlation filter combinations + -#### set_custom_surrogate(name: str, use: bool) +### set_custom_surrogate(name: str, use: bool) Set use of custom surrogate by name. Add the surrogate if not yet present. + -#### set_defaults() +### set_defaults() Reset settings to default values. + -#### *property* step_cod +### *property* step_cod Step size for CoD filter. + -#### *property* step_coi +### *property* step_coi Step size for CoI filter. + -#### *property* step_significance +### *property* step_significance Steps for filter reduction. + -#### *property* testing_type +### *property* testing_type + -#### *property* tolerance_cop_model +### *property* tolerance_cop_model + -#### *property* tolerance_cop_variables +### *property* tolerance_cop_variables + -#### *property* use_adjusted_cod +### *property* use_adjusted_cod + -#### *property* use_adjusted_cop +### *property* use_adjusted_cop + -#### *property* use_anisotropic_kernel_kriging +### *property* use_anisotropic_kernel_kriging + -#### *property* use_anisotropic_kernel_mls +### *property* use_anisotropic_kernel_mls + -#### *property* use_ascmo +### *property* use_ascmo Use ASCMO. + -#### *property* use_boxcox +### *property* use_boxcox Use Box Cox. + -#### *property* use_cod_filter +### *property* use_cod_filter + -#### *property* use_coi_filter +### *property* use_coi_filter + -#### *property* use_correlation_filter +### *property* use_correlation_filter + -#### *property* use_input_correlation_filter +### *property* use_input_correlation_filter + -#### *property* use_interpolation +### *property* use_interpolation Use interpolation. + -#### *property* use_kriging +### *property* use_kriging Use Kriging. + -#### *property* use_limits +### *property* use_limits + -#### *property* use_mls +### *property* use_mls Use moving least squares. + -#### *property* use_polynomials +### *property* use_polynomials Use polynomials. + -#### *property* use_significance_filter +### *property* use_significance_filter + -#### *property* use_spearman +### *property* use_spearman Use Spearman. + -#### *property* use_uniform_resample +### *property* use_uniform_resample + -### *class* \_optiSLang_Actors.MOPAutomaticSettings +## *class* \_optiSLang_Actors.MOPAutomaticSettings + -#### \_\_init_\_() +### \_\_init_\_() + -#### *property* model_complexity +### *property* model_complexity + -#### *property* num_parallel +### *property* num_parallel + -#### *property* variables_reduction +### *property* variables_reduction + -### *class* \_optiSLang_Actors.MOPData +## *class* \_optiSLang_Actors.MOPData Manages parameter importance and response usage for MOP. + -#### \_\_init_\_() +### \_\_init_\_() + -#### *property* parameter_importance +### *property* parameter_importance Set importance per parameter. The provided map may be partial, i.e. contain only the parameters that should be changed. The integer values 0 to 2 correspond to “Unimportant”, “Selectable” and “Mandatory”. + -#### *property* response_usage +### *property* response_usage Set usage per response. Provided map may be partial. + -### *class* \_optiSLang_Actors.MOPSolverActor +## *class* \_optiSLang_Actors.MOPSolverActor + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -#### add_input(location: MOPSolverLocation) +### add_input(location: MOPSolverLocation) Assign location to an input slot. + -#### add_internal_variable(location: MOPSolverLocation) +### add_internal_variable(location: MOPSolverLocation) -#### add_internal_variable(derived_variable: DerivedLocation) +### add_internal_variable(derived_variable: DerivedLocation) [0] Assign location to an internal variable. [1] Create a derived variable. + -#### add_output(location: MOPSolverLocation) +### add_output(location: MOPSolverLocation) -#### add_output(derived_variable: DerivedLocation) +### add_output(derived_variable: DerivedLocation) [0] Assign location to an output slot. [1] Create a derived variable and assign it to an output slot. + -#### add_parameter(location: MOPSolverLocation) +### add_parameter(location: MOPSolverLocation) Assign location to a parameter. + -#### add_response(location: MOPSolverLocation) +### add_response(location: MOPSolverLocation) -#### add_response(derived_variable: DerivedLocation) +### add_response(derived_variable: DerivedLocation) [0] Assign location to a response. [1] Create a derived variable and assign it to a response. + -#### *property* boundary_handling +### *property* boundary_handling + -#### *property* enable_multi_designs +### *property* enable_multi_designs + -#### get_internal_variables() → list +### get_internal_variables() → list Get internal variables + -#### get_registered_inputs() → list +### get_registered_inputs() → list Get registered input slots + -#### get_registered_outputs() → list +### get_registered_outputs() → list Get registered output slots + -#### get_registered_parameters() → list +### get_registered_parameters() → list Get registered parameters + -#### get_registered_responses() → list +### get_registered_responses() → list Get registered responses + -#### initialize_solver(arg2: Path) → bool +### initialize_solver(arg2: Path) → bool -#### initialize_solver(arg2: ProvidedPath) → bool +### initialize_solver(arg2: ProvidedPath) → bool + -#### *property* mdb_path +### *property* mdb_path + -#### *property* multi_design_num +### *property* multi_design_num + -#### register_available_parameters() +### register_available_parameters() + -#### register_available_responses() +### register_available_responses() + -### *class* \_optiSLang_Actors.MOPSolverLocation +## *class* \_optiSLang_Actors.MOPSolverLocation + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(id_base: str, direction: [IntegrationDirection](#optiSLang_Actors.IntegrationDirection), value_type: [MOPSolverLocationValueType](#optiSLang_Actors.MOPSolverLocationValueType), id_suffix: str) +### \_\_init_\_(id_base: str, direction: [IntegrationDirection](#optiSLang_Actors.IntegrationDirection), value_type: [MOPSolverLocationValueType](#optiSLang_Actors.MOPSolverLocationValueType), id_suffix: str) -#### \_\_init_\_(id: str, direction: [IntegrationDirection](#optiSLang_Actors.IntegrationDirection), quality_usage_suffix_vector: object) +### \_\_init_\_(id: str, direction: [IntegrationDirection](#optiSLang_Actors.IntegrationDirection), quality_usage_suffix_vector: object) [1] Create a MOPSolverLocation instance. [2] Create a MOPSolverLocation instance. + -#### *property* direction +### *property* direction + -#### *property* id +### *property* id + -#### *property* id_base +### *property* id_base + -#### *property* id_suffix +### *property* id_suffix + -#### *property* value_type +### *property* value_type + -### *class* \_optiSLang_Actors.MOPSolverLocationValueType +## *class* \_optiSLang_Actors.MOPSolverLocationValueType **Enumeration** + -#### MOP_SOLVER_LOCATION_TYPE_ABSERROR *= \_optiSLang_Actors.MOPSolverLocationValueType.MOP_SOLVER_LOCATION_TYPE_ABSERROR* +### MOP_SOLVER_LOCATION_TYPE_ABSERROR *= \_optiSLang_Actors.MOPSolverLocationValueType.MOP_SOLVER_LOCATION_TYPE_ABSERROR* + -#### MOP_SOLVER_LOCATION_TYPE_COP *= \_optiSLang_Actors.MOPSolverLocationValueType.MOP_SOLVER_LOCATION_TYPE_COP* +### MOP_SOLVER_LOCATION_TYPE_COP *= \_optiSLang_Actors.MOPSolverLocationValueType.MOP_SOLVER_LOCATION_TYPE_COP* + -#### MOP_SOLVER_LOCATION_TYPE_DENSITY *= \_optiSLang_Actors.MOPSolverLocationValueType.MOP_SOLVER_LOCATION_TYPE_DENSITY* +### MOP_SOLVER_LOCATION_TYPE_DENSITY *= \_optiSLang_Actors.MOPSolverLocationValueType.MOP_SOLVER_LOCATION_TYPE_DENSITY* + -#### MOP_SOLVER_LOCATION_TYPE_ERROR *= \_optiSLang_Actors.MOPSolverLocationValueType.MOP_SOLVER_LOCATION_TYPE_ERROR* +### MOP_SOLVER_LOCATION_TYPE_ERROR *= \_optiSLang_Actors.MOPSolverLocationValueType.MOP_SOLVER_LOCATION_TYPE_ERROR* + -#### MOP_SOLVER_LOCATION_TYPE_RMSE *= \_optiSLang_Actors.MOPSolverLocationValueType.MOP_SOLVER_LOCATION_TYPE_RMSE* +### MOP_SOLVER_LOCATION_TYPE_RMSE *= \_optiSLang_Actors.MOPSolverLocationValueType.MOP_SOLVER_LOCATION_TYPE_RMSE* + -#### MOP_SOLVER_LOCATION_TYPE_VALUE *= \_optiSLang_Actors.MOPSolverLocationValueType.MOP_SOLVER_LOCATION_TYPE_VALUE* +### MOP_SOLVER_LOCATION_TYPE_VALUE *= \_optiSLang_Actors.MOPSolverLocationValueType.MOP_SOLVER_LOCATION_TYPE_VALUE* + -### *class* \_optiSLang_Actors.MatlabActor +## *class* \_optiSLang_Actors.MatlabActor + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -#### get_available_versions() → list +### get_available_versions() → list Return a list of tuples containing the displayed name and the value to set at the version property. + -#### *property* max_parallel +### *property* max_parallel + -#### *property* use_batch_mode +### *property* use_batch_mode + -### *class* \_optiSLang_Actors.MemeticActor +## *class* \_optiSLang_Actors.MemeticActor + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -#### *property* optimizer_settings +### *property* optimizer_settings + -### *class* \_optiSLang_Actors.MonitoringActor +## *class* \_optiSLang_Actors.MonitoringActor + -#### \_\_init_\_() +### \_\_init_\_() Raises an exception This class cannot be instantiated from Python + -### *class* \_optiSLang_Actors.MonitoringMode +## *class* \_optiSLang_Actors.MonitoringMode **Enumeration** + -#### APPROXIMATION *= \_optiSLang_Actors.MonitoringMode.APPROXIMATION* +### APPROXIMATION *= \_optiSLang_Actors.MonitoringMode.APPROXIMATION* + -#### AUTOMATIC *= \_optiSLang_Actors.MonitoringMode.AUTOMATIC* +### AUTOMATIC *= \_optiSLang_Actors.MonitoringMode.AUTOMATIC* + -#### OPTIMIZATION *= \_optiSLang_Actors.MonitoringMode.OPTIMIZATION* +### OPTIMIZATION *= \_optiSLang_Actors.MonitoringMode.OPTIMIZATION* + -#### RELIABILITY *= \_optiSLang_Actors.MonitoringMode.RELIABILITY* +### RELIABILITY *= \_optiSLang_Actors.MonitoringMode.RELIABILITY* + -#### STATISTICS *= \_optiSLang_Actors.MonitoringMode.STATISTICS* +### STATISTICS *= \_optiSLang_Actors.MonitoringMode.STATISTICS* + -### *class* \_optiSLang_Actors.MonteCarloActor +## *class* \_optiSLang_Actors.MonteCarloActor Reliability actor using Monte Carlo methods. + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -#### *property* reliability_settings +### *property* reliability_settings + -### *class* \_optiSLang_Actors.NLPQLPActor +## *class* \_optiSLang_Actors.NLPQLPActor + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -#### *property* optimizer_settings +### *property* optimizer_settings + -### *class* \_optiSLang_Actors.NOA2Actor +## *class* \_optiSLang_Actors.NOA2Actor + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -#### *property* algorithm_type +### *property* algorithm_type + -#### *property* optimizer_settings +### *property* optimizer_settings + -### *class* \_optiSLang_Actors.NOAActor +## *class* \_optiSLang_Actors.NOAActor + -#### \_\_init_\_() +### \_\_init_\_() Raises an exception This class cannot be instantiated from Python + -#### *property* optimizer_settings +### *property* optimizer_settings + -### *class* \_optiSLang_Actors.OctaveActor +## *class* \_optiSLang_Actors.OctaveActor + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -#### *property* max_parallel +### *property* max_parallel + -### *class* \_optiSLang_Actors.OptimizationBaseActor +## *class* \_optiSLang_Actors.OptimizationBaseActor + -#### \_\_init_\_() +### \_\_init_\_() Raises an exception This class cannot be instantiated from Python + -#### *property* optimizer_settings +### *property* optimizer_settings + -### *class* \_optiSLang_Actors.OutputFileType +## *class* \_optiSLang_Actors.OutputFileType **Enumeration** + -#### NUM_TYPES *= \_optiSLang_Actors.OutputFileType.NUM_TYPES* +### NUM_TYPES *= \_optiSLang_Actors.OutputFileType.NUM_TYPES* + -#### ROBUSTNESS_OUTPUTFILE *= \_optiSLang_Actors.OutputFileType.ROBUSTNESS_OUTPUTFILE* +### ROBUSTNESS_OUTPUTFILE *= \_optiSLang_Actors.OutputFileType.ROBUSTNESS_OUTPUTFILE* + -#### SENSITIVITY_OUTPUTFILE *= \_optiSLang_Actors.OutputFileType.SENSITIVITY_OUTPUTFILE* +### SENSITIVITY_OUTPUTFILE *= \_optiSLang_Actors.OutputFileType.SENSITIVITY_OUTPUTFILE* + -### *class* \_optiSLang_Actors.PDMActor +## *class* \_optiSLang_Actors.PDMActor + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -### *class* \_optiSLang_Actors.PDMReceiveActor +## *class* \_optiSLang_Actors.PDMReceiveActor + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -### *class* \_optiSLang_Actors.PDMSendActor +## *class* \_optiSLang_Actors.PDMSendActor + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -### *class* \_optiSLang_Actors.PSOActor +## *class* \_optiSLang_Actors.PSOActor + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -### *class* \_optiSLang_Actors.ParameterMergingMode +## *class* \_optiSLang_Actors.ParameterMergingMode **Enumeration** + -#### MERGE_FROM_SLOT *= \_optiSLang_Actors.ParameterMergingMode.MERGE_FROM_SLOT* +### MERGE_FROM_SLOT *= \_optiSLang_Actors.ParameterMergingMode.MERGE_FROM_SLOT* + -#### PREFER_PROPERTY *= \_optiSLang_Actors.ParameterMergingMode.PREFER_PROPERTY* +### PREFER_PROPERTY *= \_optiSLang_Actors.ParameterMergingMode.PREFER_PROPERTY* + -#### PREFER_SLOT *= \_optiSLang_Actors.ParameterMergingMode.PREFER_SLOT* +### PREFER_SLOT *= \_optiSLang_Actors.ParameterMergingMode.PREFER_SLOT* + -### *class* \_optiSLang_Actors.ParametricSystemActor +## *class* \_optiSLang_Actors.ParametricSystemActor + -#### CleanupResponses() +### CleanupResponses() + -#### CollectParameters() +### CollectParameters() + -#### GetDesignCounts() → [DesignCounts](#optiSLang_Actors.DesignCounts) +### GetDesignCounts() → [DesignCounts](#optiSLang_Actors.DesignCounts) + -#### GetDesigns() → [PyOSDesignContainer](py_os_design.md#py_os_design.PyOSDesignContainer) +### GetDesigns() → [PyOSDesignContainer](py_os_design.md#py_os_design.PyOSDesignContainer) + -#### RemoveAllResponses(, arg2: bool]) +### RemoveAllResponses(, arg2: bool]) + -#### RemoveResponse(arg2: str) +### RemoveResponse(arg2: str) + -#### SetDesigns(arg2: [PyOSDesignContainer](py_os_design.md#py_os_design.PyOSDesignContainer)) +### SetDesigns(arg2: [PyOSDesignContainer](py_os_design.md#py_os_design.PyOSDesignContainer)) + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -#### *property* criteria +### *property* criteria + -#### *property* design_point_tolerance +### *property* design_point_tolerance + -#### get_result_file_path(, hid: HID]) → [Path](stdcpp_python_export.md#stdcpp_python_export.Path) +### get_result_file_path(, hid: HID]) → [Path](stdcpp_python_export.md#stdcpp_python_export.Path) Path to the OMDB file by HId. The returned path is relative to the project working directory and is empty if the OMDB file does not exist. For top-level systems the argument may be omitted. + -#### *property* manual_seed_value +### *property* manual_seed_value + -#### *property* parameter_manager +### *property* parameter_manager + -#### *property* parameter_merging_mode +### *property* parameter_merging_mode + -#### *property* prefer_criteria_from_slot +### *property* prefer_criteria_from_slot + -#### *property* register_avz_files +### *property* register_avz_files + -#### *property* register_cax_files +### *property* register_cax_files + -#### *property* register_images +### *property* register_images + -#### *property* responses +### *property* responses + -#### *property* solve_duplicated +### *property* solve_duplicated + -#### *property* solve_reference +### *property* solve_reference + -#### *property* solve_start_designs_again +### *property* solve_start_designs_again + -#### *property* solve_violated +### *property* solve_violated + -#### *property* start_designs +### *property* start_designs + -#### *property* update_result_file +### *property* update_result_file + -#### *property* use_manual_seed +### *property* use_manual_seed + -#### *property* write_osl3_bin_file_default +### *property* write_osl3_bin_file_default + -### *class* \_optiSLang_Actors.PathActor +## *class* \_optiSLang_Actors.PathActor + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -#### *property* path +### *property* path + -### *class* \_optiSLang_Actors.PerlScriptActor +## *class* \_optiSLang_Actors.PerlScriptActor + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -### *class* \_optiSLang_Actors.Position +## *class* \_optiSLang_Actors.Position **Enumeration** + -#### POSITION_CENTROID *= \_optiSLang_Actors.Position.POSITION_CENTROID* +### POSITION_CENTROID *= \_optiSLang_Actors.Position.POSITION_CENTROID* + -#### POSITION_ELEMENT_FACE *= \_optiSLang_Actors.Position.POSITION_ELEMENT_FACE* +### POSITION_ELEMENT_FACE *= \_optiSLang_Actors.Position.POSITION_ELEMENT_FACE* + -#### POSITION_ELEMENT_FACE_INTEGRATION_POINT *= \_optiSLang_Actors.Position.POSITION_ELEMENT_FACE_INTEGRATION_POINT* +### POSITION_ELEMENT_FACE_INTEGRATION_POINT *= \_optiSLang_Actors.Position.POSITION_ELEMENT_FACE_INTEGRATION_POINT* + -#### POSITION_ELEMENT_NODAL *= \_optiSLang_Actors.Position.POSITION_ELEMENT_NODAL* +### POSITION_ELEMENT_NODAL *= \_optiSLang_Actors.Position.POSITION_ELEMENT_NODAL* + -#### POSITION_GENERAL_PARTICLE *= \_optiSLang_Actors.Position.POSITION_GENERAL_PARTICLE* +### POSITION_GENERAL_PARTICLE *= \_optiSLang_Actors.Position.POSITION_GENERAL_PARTICLE* + -#### POSITION_INTEGRATION_POINT *= \_optiSLang_Actors.Position.POSITION_INTEGRATION_POINT* +### POSITION_INTEGRATION_POINT *= \_optiSLang_Actors.Position.POSITION_INTEGRATION_POINT* + -#### POSITION_NODAL *= \_optiSLang_Actors.Position.POSITION_NODAL* +### POSITION_NODAL *= \_optiSLang_Actors.Position.POSITION_NODAL* + -#### POSITION_NUM_OUTPUT_POSITION *= \_optiSLang_Actors.Position.POSITION_NUM_OUTPUT_POSITION* +### POSITION_NUM_OUTPUT_POSITION *= \_optiSLang_Actors.Position.POSITION_NUM_OUTPUT_POSITION* + -#### POSITION_SURFACE_FACET *= \_optiSLang_Actors.Position.POSITION_SURFACE_FACET* +### POSITION_SURFACE_FACET *= \_optiSLang_Actors.Position.POSITION_SURFACE_FACET* + -#### POSITION_SURFACE_INTEGRATION_POINT *= \_optiSLang_Actors.Position.POSITION_SURFACE_INTEGRATION_POINT* +### POSITION_SURFACE_INTEGRATION_POINT *= \_optiSLang_Actors.Position.POSITION_SURFACE_INTEGRATION_POINT* + -#### POSITION_SURFACE_NODAL *= \_optiSLang_Actors.Position.POSITION_SURFACE_NODAL* +### POSITION_SURFACE_NODAL *= \_optiSLang_Actors.Position.POSITION_SURFACE_NODAL* + -#### POSITION_UNDEFINED *= \_optiSLang_Actors.Position.POSITION_UNDEFINED* +### POSITION_UNDEFINED *= \_optiSLang_Actors.Position.POSITION_UNDEFINED* + -#### POSITION_WHOLE_ELEMENT *= \_optiSLang_Actors.Position.POSITION_WHOLE_ELEMENT* +### POSITION_WHOLE_ELEMENT *= \_optiSLang_Actors.Position.POSITION_WHOLE_ELEMENT* + -#### POSITION_WHOLE_MODEL *= \_optiSLang_Actors.Position.POSITION_WHOLE_MODEL* +### POSITION_WHOLE_MODEL *= \_optiSLang_Actors.Position.POSITION_WHOLE_MODEL* + -#### POSITION_WHOLE_PART_INSTANCE *= \_optiSLang_Actors.Position.POSITION_WHOLE_PART_INSTANCE* +### POSITION_WHOLE_PART_INSTANCE *= \_optiSLang_Actors.Position.POSITION_WHOLE_PART_INSTANCE* + -#### POSITION_WHOLE_REGION *= \_optiSLang_Actors.Position.POSITION_WHOLE_REGION* +### POSITION_WHOLE_REGION *= \_optiSLang_Actors.Position.POSITION_WHOLE_REGION* + -### *class* \_optiSLang_Actors.PostprocessingActor +## *class* \_optiSLang_Actors.PostprocessingActor + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -#### *property* custom_script_path +### *property* custom_script_path + -#### *property* force_classic +### *property* force_classic + -#### *property* mdb_path +### *property* mdb_path + -#### *property* monitoring_mode +### *property* monitoring_mode + -#### *property* pp_mode +### *property* pp_mode + -#### *property* show_pp_during_run +### *property* show_pp_during_run + -#### *property* show_reduced_pp_when_avaiable +### *property* show_reduced_pp_when_avaiable + -#### *property* template_file +### *property* template_file + -#### *property* text_import_non_interactive +### *property* text_import_non_interactive + -#### *property* text_import_settings_file +### *property* text_import_settings_file + -#### *property* use_custom_script +### *property* use_custom_script + -#### *property* use_template +### *property* use_template + -#### *property* wait_for_pp_to_finish +### *property* wait_for_pp_to_finish + -### *class* \_optiSLang_Actors.PostprocessingModePP3 +## *class* \_optiSLang_Actors.PostprocessingModePP3 **Enumeration** + -#### PP3_APPROXIMATION *= \_optiSLang_Actors.PostprocessingModePP3.PP3_APPROXIMATION* +### PP3_APPROXIMATION *= \_optiSLang_Actors.PostprocessingModePP3.PP3_APPROXIMATION* + -#### PP3_AUTOMATIC *= \_optiSLang_Actors.PostprocessingModePP3.PP3_AUTOMATIC* +### PP3_AUTOMATIC *= \_optiSLang_Actors.PostprocessingModePP3.PP3_AUTOMATIC* + -#### PP3_OPTIMIZATION *= \_optiSLang_Actors.PostprocessingModePP3.PP3_OPTIMIZATION* +### PP3_OPTIMIZATION *= \_optiSLang_Actors.PostprocessingModePP3.PP3_OPTIMIZATION* + -#### PP3_STATISTICS *= \_optiSLang_Actors.PostprocessingModePP3.PP3_STATISTICS* +### PP3_STATISTICS *= \_optiSLang_Actors.PostprocessingModePP3.PP3_STATISTICS* + -### *class* \_optiSLang_Actors.Precision +## *class* \_optiSLang_Actors.Precision **Enumeration** + -#### PRECISION_DOUBLE *= \_optiSLang_Actors.Precision.PRECISION_DOUBLE* +### PRECISION_DOUBLE *= \_optiSLang_Actors.Precision.PRECISION_DOUBLE* + -#### PRECISION_SINGLE *= \_optiSLang_Actors.Precision.PRECISION_SINGLE* +### PRECISION_SINGLE *= \_optiSLang_Actors.Precision.PRECISION_SINGLE* + -### *class* \_optiSLang_Actors.ProEInputActor +## *class* \_optiSLang_Actors.ProEInputActor + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -#### get_locations_from_file(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint)) → bool +### get_locations_from_file(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint)) → bool + -#### get_locations_from_string(arg2: str, arg3: [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint)) → bool +### get_locations_from_string(arg2: str, arg3: [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint)) → bool + -### *class* \_optiSLang_Actors.ProcessActor +## *class* \_optiSLang_Actors.ProcessActor + -#### *class* ArchivalMode +### *class* ArchivalMode **Enumeration** + -#### archivalCompressed *= \_optiSLang_Actors.ArchivalMode.archivalCompressed* +### archivalCompressed *= \_optiSLang_Actors.ArchivalMode.archivalCompressed* + -#### archivalDefault *= \_optiSLang_Actors.ArchivalMode.archivalDefault* +### archivalDefault *= \_optiSLang_Actors.ArchivalMode.archivalDefault* + -#### archivalDelete *= \_optiSLang_Actors.ArchivalMode.archivalDelete* +### archivalDelete *= \_optiSLang_Actors.ArchivalMode.archivalDelete* + -#### *class* BaseFileMapping +### *class* BaseFileMapping + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str, arg4: [ArchivalMode](#optiSLang_Actors.ProcessActor.ArchivalMode)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str, arg4: [ArchivalMode](#optiSLang_Actors.ProcessActor.ArchivalMode)) + -#### *property* archival_mode +### *property* archival_mode + -#### *property* slot_name +### *property* slot_name + -#### *property* working_file_name +### *property* working_file_name + -#### *class* FileImportance +### *class* FileImportance **Enumeration** + -#### OPTIONAL *= \_optiSLang_Actors.FileImportance.OPTIONAL* +### OPTIONAL *= \_optiSLang_Actors.FileImportance.OPTIONAL* + -#### REQUIRED *= \_optiSLang_Actors.FileImportance.REQUIRED* +### REQUIRED *= \_optiSLang_Actors.FileImportance.REQUIRED* + -#### WAIT_FAIL *= \_optiSLang_Actors.FileImportance.WAIT_FAIL* +### WAIT_FAIL *= \_optiSLang_Actors.FileImportance.WAIT_FAIL* + -#### WAIT_SUCCESS *= \_optiSLang_Actors.FileImportance.WAIT_SUCCESS* +### WAIT_SUCCESS *= \_optiSLang_Actors.FileImportance.WAIT_SUCCESS* + -#### *class* FileMapping +### *class* FileMapping + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str, arg4: [ArchivalMode](#optiSLang_Actors.ProcessActor.ArchivalMode)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str, arg4: [ArchivalMode](#optiSLang_Actors.ProcessActor.ArchivalMode)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg4: [ArchivalMode](#optiSLang_Actors.ProcessActor.ArchivalMode)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg4: [ArchivalMode](#optiSLang_Actors.ProcessActor.ArchivalMode)) + -#### *property* archival_mode +### *property* archival_mode + -#### *property* input_file_name_ +### *property* input_file_name_ + -#### *property* slot_name +### *property* slot_name + -#### *property* working_file_name +### *property* working_file_name + -#### *class* InputFileMapping +### *class* InputFileMapping + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg4: [ArchivalMode](#optiSLang_Actors.ProcessActor.ArchivalMode)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg4: [ArchivalMode](#optiSLang_Actors.ProcessActor.ArchivalMode)) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str, arg4: [ArchivalMode](#optiSLang_Actors.ProcessActor.ArchivalMode)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str, arg4: [ArchivalMode](#optiSLang_Actors.ProcessActor.ArchivalMode)) + -#### *property* input_file_name +### *property* input_file_name + -#### *property* input_file_name_ +### *property* input_file_name_ + -#### *class* InputFilesList +### *class* InputFilesList + -#### \_\_contains_\_(arg2: object) → bool +### \_\_contains_\_(arg2: object) → bool + -#### \_\_delitem_\_(arg2: object) +### \_\_delitem_\_(arg2: object) + -#### \_\_getitem_\_(arg2: object) → object +### \_\_getitem_\_(arg2: object) → object + -#### \_\_init_\_() +### \_\_init_\_() + -#### \_\_iter_\_() → object +### \_\_iter_\_() → object + -#### \_\_len_\_() → int +### \_\_len_\_() → int + -#### \_\_setitem_\_(arg2: object, arg3: object) +### \_\_setitem_\_(arg2: object, arg3: object) + -#### append(arg2: object) +### append(arg2: object) + -#### extend(arg2: object) +### extend(arg2: object) + -#### push_back(arg2: [InputFileMapping](#optiSLang_Actors.ProcessActor.InputFileMapping)) +### push_back(arg2: [InputFileMapping](#optiSLang_Actors.ProcessActor.InputFileMapping)) + -#### size() → int +### size() → int + -#### *class* OutputFileMapping +### *class* OutputFileMapping + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str, arg4: [ArchivalMode](#optiSLang_Actors.ProcessActor.ArchivalMode)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: str, arg4: [ArchivalMode](#optiSLang_Actors.ProcessActor.ArchivalMode)) -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) -#### \_\_init_\_(arg2: str, arg3: [ArchivalMode](#optiSLang_Actors.ProcessActor.ArchivalMode)) +### \_\_init_\_(arg2: str, arg3: [ArchivalMode](#optiSLang_Actors.ProcessActor.ArchivalMode)) + -#### *property* importance +### *property* importance + -#### *property* remove_on_reset +### *property* remove_on_reset + -#### *property* working_file_regex +### *property* working_file_regex + -#### *class* OutputFilesList +### *class* OutputFilesList + -#### \_\_contains_\_(arg2: object) → bool +### \_\_contains_\_(arg2: object) → bool + -#### \_\_delitem_\_(arg2: object) +### \_\_delitem_\_(arg2: object) + -#### \_\_getitem_\_(arg2: object) → object +### \_\_getitem_\_(arg2: object) → object + -#### \_\_init_\_() +### \_\_init_\_() + -#### \_\_iter_\_() → object +### \_\_iter_\_() → object + -#### \_\_len_\_() → int +### \_\_len_\_() → int + -#### \_\_setitem_\_(arg2: object, arg3: object) +### \_\_setitem_\_(arg2: object, arg3: object) + -#### append(arg2: object) +### append(arg2: object) + -#### extend(arg2: object) +### extend(arg2: object) + -#### push_back(arg2: [OutputFileMapping](#optiSLang_Actors.ProcessActor.OutputFileMapping)) +### push_back(arg2: [OutputFileMapping](#optiSLang_Actors.ProcessActor.OutputFileMapping)) + -#### size() → int +### size() → int + -#### *class* SlotPathList +### *class* SlotPathList + -#### \_\_contains_\_(arg2: object) → bool +### \_\_contains_\_(arg2: object) → bool + -#### \_\_delitem_\_(arg2: object) +### \_\_delitem_\_(arg2: object) + -#### \_\_getitem_\_(arg2: object) → object +### \_\_getitem_\_(arg2: object) → object + -#### \_\_init_\_() +### \_\_init_\_() + -#### \_\_iter_\_() → object +### \_\_iter_\_() → object + -#### \_\_len_\_() → int +### \_\_len_\_() → int + -#### \_\_setitem_\_(arg2: object, arg3: object) +### \_\_setitem_\_(arg2: object, arg3: object) + -#### append(arg2: object) +### append(arg2: object) + -#### extend(arg2: object) +### extend(arg2: object) + -#### push_back(arg2: [FileMapping](#optiSLang_Actors.ProcessActor.FileMapping)) +### push_back(arg2: [FileMapping](#optiSLang_Actors.ProcessActor.FileMapping)) + -#### size() → int +### size() → int + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -#### *property* arguments +### *property* arguments + -#### *property* command +### *property* command + -#### *property* enable_multi_design_launch +### *property* enable_multi_design_launch + -#### *property* environment +### *property* environment + -#### *property* ignore_exit_code +### *property* ignore_exit_code + -#### *property* input_files +### *property* input_files + -#### *property* max_parallel +### *property* max_parallel + -#### *property* multi_design_launch_num +### *property* multi_design_launch_num + -#### *property* output_files +### *property* output_files + -#### *property* prepend_project_bin_to_path +### *property* prepend_project_bin_to_path + -#### *property* working_dir +### *property* working_dir + -### *class* \_optiSLang_Actors.PythonActor +## *class* \_optiSLang_Actors.PythonActor + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -#### *property* max_parallel +### *property* max_parallel + -#### *property* path +### *property* path + -#### *property* source +### *property* source + -### *class* \_optiSLang_Actors.PythonScriptActor +## *class* \_optiSLang_Actors.PythonScriptActor + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -### *class* \_optiSLang_Actors.ReevaluateActor +## *class* \_optiSLang_Actors.ReevaluateActor + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -#### *property* adapt_bounds +### *property* adapt_bounds + -#### *property* design_dir_format +### *property* design_dir_format + -#### *property* design_dir_path +### *property* design_dir_path + -#### *property* design_numbers +### *property* design_numbers + -#### *property* input_file_path +### *property* input_file_path + -#### *property* merge_input_data +### *property* merge_input_data + -#### *property* merge_output_data +### *property* merge_output_data + -#### *property* result_file_type +### *property* result_file_type + -#### *property* use_input_file +### *property* use_input_file + -### *class* \_optiSLang_Actors.ReliabilityBaseActor +## *class* \_optiSLang_Actors.ReliabilityBaseActor + -#### \_\_init_\_() +### \_\_init_\_() Raises an exception This class cannot be instantiated from Python + -#### *property* reliability_settings +### *property* reliability_settings + -### *class* \_optiSLang_Actors.RobustnessActor +## *class* \_optiSLang_Actors.RobustnessActor + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -#### *property* nominal_design_point +### *property* nominal_design_point + -#### *property* solve_nominal_design +### *property* solve_nominal_design + -### *class* \_optiSLang_Actors.RunnableSystem +## *class* \_optiSLang_Actors.RunnableSystem + -#### \_\_init_\_() +### \_\_init_\_() Raises an exception This class cannot be instantiated from Python + -#### get_working_directory() → [Path](stdcpp_python_export.md#stdcpp_python_export.Path) +### get_working_directory() → [Path](stdcpp_python_export.md#stdcpp_python_export.Path) + -### *class* \_optiSLang_Actors.SDIActor +## *class* \_optiSLang_Actors.SDIActor + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -### *class* \_optiSLang_Actors.SamplingActor +## *class* \_optiSLang_Actors.SamplingActor + -#### \_\_init_\_() +### \_\_init_\_() Raises an exception This class cannot be instantiated from Python + -#### *property* algorithm_settings +### *property* algorithm_settings + -#### *property* dynamic_sampling +### *property* dynamic_sampling + -#### *property* preserve_start_design_ids +### *property* preserve_start_design_ids + -### *class* \_optiSLang_Actors.ScriptFileActor +## *class* \_optiSLang_Actors.ScriptFileActor + -#### \_\_init_\_() +### \_\_init_\_() Raises an exception This class cannot be instantiated from Python + -#### add_input(location: Parameter) +### add_input(location: Parameter) Assign location to an input slot. + -#### add_internal_variable(location: Parameter) +### add_internal_variable(location: Parameter) -#### add_internal_variable(derived_variable: DerivedLocation) +### add_internal_variable(derived_variable: DerivedLocation) [0] Assign location to an internal variable. [1] Create a derived variable. + -#### add_output(location: Parameter) +### add_output(location: Parameter) -#### add_output(derived_variable: DerivedLocation) +### add_output(derived_variable: DerivedLocation) [0] Assign location to an output slot. [1] Create a derived variable and assign it to an output slot. + -#### add_parameter(location: Parameter) +### add_parameter(location: Parameter) Assign location to a parameter. + -#### add_response(location: Parameter) +### add_response(location: Parameter) -#### add_response(derived_variable: DerivedLocation) +### add_response(derived_variable: DerivedLocation) [0] Assign location to a response. [1] Create a derived variable and assign it to a response. + -#### *property* content +### *property* content + -#### get_internal_variables() → list +### get_internal_variables() → list Get internal variables + -#### get_locations_from_file(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint)) → bool +### get_locations_from_file(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint)) → bool + -#### get_locations_from_string(arg2: str, arg3: [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint)) → bool +### get_locations_from_string(arg2: str, arg3: [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint)) → bool + -#### get_registered_inputs() → list +### get_registered_inputs() → list Get registered input slots + -#### get_registered_outputs() → list +### get_registered_outputs() → list Get registered output slots + -#### get_registered_parameters() → list +### get_registered_parameters() → list Get registered parameters + -#### get_registered_responses() → list +### get_registered_responses() → list Get registered responses + -#### register_location_as_parameter(arg2: str) +### register_location_as_parameter(arg2: str) + -#### register_locations_as_parameter() +### register_locations_as_parameter() + -#### *property* script_path +### *property* script_path + -### *class* \_optiSLang_Actors.SensitivityActor +## *class* \_optiSLang_Actors.SensitivityActor + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -### *class* \_optiSLang_Actors.SetLocation +## *class* \_optiSLang_Actors.SetLocation **Enumeration** + -#### LOCATION_CUSTOM *= \_optiSLang_Actors.SetLocation.LOCATION_CUSTOM* +### LOCATION_CUSTOM *= \_optiSLang_Actors.SetLocation.LOCATION_CUSTOM* + -#### LOCATION_INSTANCE *= \_optiSLang_Actors.SetLocation.LOCATION_INSTANCE* +### LOCATION_INSTANCE *= \_optiSLang_Actors.SetLocation.LOCATION_INSTANCE* + -#### LOCATION_PART *= \_optiSLang_Actors.SetLocation.LOCATION_PART* +### LOCATION_PART *= \_optiSLang_Actors.SetLocation.LOCATION_PART* + -#### LOCATION_ROOT_ASSEMBLY *= \_optiSLang_Actors.SetLocation.LOCATION_ROOT_ASSEMBLY* +### LOCATION_ROOT_ASSEMBLY *= \_optiSLang_Actors.SetLocation.LOCATION_ROOT_ASSEMBLY* + -#### LOCATION_UNSUPPORTED_LOCATION *= \_optiSLang_Actors.SetLocation.LOCATION_UNSUPPORTED_LOCATION* +### LOCATION_UNSUPPORTED_LOCATION *= \_optiSLang_Actors.SetLocation.LOCATION_UNSUPPORTED_LOCATION* + -### *class* \_optiSLang_Actors.SetType +## *class* \_optiSLang_Actors.SetType **Enumeration** + -#### TYPE_ELEMENT_SET *= \_optiSLang_Actors.SetType.TYPE_ELEMENT_SET* +### TYPE_ELEMENT_SET *= \_optiSLang_Actors.SetType.TYPE_ELEMENT_SET* + -#### TYPE_NODE_SET *= \_optiSLang_Actors.SetType.TYPE_NODE_SET* +### TYPE_NODE_SET *= \_optiSLang_Actors.SetType.TYPE_NODE_SET* + -#### TYPE_SURFACE_SET *= \_optiSLang_Actors.SetType.TYPE_SURFACE_SET* +### TYPE_SURFACE_SET *= \_optiSLang_Actors.SetType.TYPE_SURFACE_SET* + -#### TYPE_UNSUPPORTED_SET_TYPE *= \_optiSLang_Actors.SetType.TYPE_UNSUPPORTED_SET_TYPE* +### TYPE_UNSUPPORTED_SET_TYPE *= \_optiSLang_Actors.SetType.TYPE_UNSUPPORTED_SET_TYPE* + -### *class* \_optiSLang_Actors.SimpackInputActor +## *class* \_optiSLang_Actors.SimpackInputActor + -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -### *class* \_optiSLang_Actors.SimplexActor +## *class* \_optiSLang_Actors.SimplexActor + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -#### *property* optimizer_settings +### *property* optimizer_settings + -### *class* \_optiSLang_Actors.SimtoolActor +## *class* \_optiSLang_Actors.SimtoolActor + -#### \_\_init_\_() +### \_\_init_\_() Raises an exception This class cannot be instantiated from Python + -#### *property* file_path +### *property* file_path + -#### get_available_versions(arg2: bool) → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) +### get_available_versions(arg2: bool) → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) + -#### *property* pre_command +### *property* pre_command + -#### *property* save +### *property* save + -#### *property* version +### *property* version + -### *class* \_optiSLang_Actors.SurrogateBaseActor +## *class* \_optiSLang_Actors.SurrogateBaseActor + -#### \_\_init_\_() +### \_\_init_\_() Raises an exception This class cannot be instantiated from Python + -#### get_parameter_from_actor(arg2: [HID](id.md#id.HID), arg3: object) → [PyParameterManager](py_os_parameter.md#py_os_parameter.PyParameterManager) +### get_parameter_from_actor(arg2: [HID](id.md#id.HID), arg3: object) → [PyParameterManager](py_os_parameter.md#py_os_parameter.PyParameterManager) + -#### get_responses_from_actor(arg2: [HID](id.md#id.HID), arg3: object) → [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint) +### get_responses_from_actor(arg2: [HID](id.md#id.HID), arg3: object) → [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint) + -#### get_resulting_parameters() → [PyParameterManager](py_os_parameter.md#py_os_parameter.PyParameterManager) +### get_resulting_parameters() → [PyParameterManager](py_os_parameter.md#py_os_parameter.PyParameterManager) + -#### *property* important_info +### *property* important_info + -#### is_valid() → bool +### is_valid() → bool + -#### *property* mdb_path +### *property* mdb_path + -#### *property* parameter_manager +### *property* parameter_manager + -#### *property* responses +### *property* responses + -#### *property* responses_to_be_used +### *property* responses_to_be_used + -#### *property* show_pp_when_avaiable +### *property* show_pp_when_avaiable + -#### *property* show_pp_when_available +### *property* show_pp_when_available + -#### *property* use_incomplete_designs +### *property* use_incomplete_designs + -### *class* \_optiSLang_Actors.TaggedParameter +## *class* \_optiSLang_Actors.TaggedParameter + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(name: str) +### \_\_init_\_(name: str) -#### \_\_init_\_(name: str, line: int, column: int, length: int, tagged_line: int, tagged_column: int, tagged_length: int) +### \_\_init_\_(name: str, line: int, column: int, length: int, tagged_line: int, tagged_column: int, tagged_length: int) + -#### get_tagged_range(content: str) → tuple +### get_tagged_range(content: str) → tuple + -#### get_tagged_start(content: str) → int +### get_tagged_start(content: str) → int + -#### intersects(parameter: [TaggedParameter](#optiSLang_Actors.TaggedParameter)) → bool +### intersects(parameter: [TaggedParameter](#optiSLang_Actors.TaggedParameter)) → bool + -#### *property* tagged_column +### *property* tagged_column + -#### *property* tagged_length +### *property* tagged_length + -#### *property* tagged_line +### *property* tagged_line + -### *class* \_optiSLang_Actors.TaggedParametersActor +## *class* \_optiSLang_Actors.TaggedParametersActor + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -#### get_locations_from_file(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint)) → bool +### get_locations_from_file(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint)) → bool + -#### get_locations_from_string(arg2: str, arg3: [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint)) → bool +### get_locations_from_string(arg2: str, arg3: [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint)) → bool + -#### register_location_as_parameter(arg2: str) +### register_location_as_parameter(arg2: str) + -#### register_locations_as_parameter() +### register_locations_as_parameter() + -### *class* \_optiSLang_Actors.TextInputActor +## *class* \_optiSLang_Actors.TextInputActor + -#### *class* Parameter +### *class* Parameter + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(name: str) +### \_\_init_\_(name: str) -#### \_\_init_\_(name: str, line: int, column: int, length: int) +### \_\_init_\_(name: str, line: int, column: int, length: int) -#### \_\_init_\_(name: str, line: int, column: int, length: int, format: str) +### \_\_init_\_(name: str, line: int, column: int, length: int, format: str) -#### \_\_init_\_(name: str, line: int, column: int, length: int, format: str, type: [EntryType](py_os_design.md#py_os_design.EntryType)) +### \_\_init_\_(name: str, line: int, column: int, length: int, format: str, type: [EntryType](py_os_design.md#py_os_design.EntryType)) -#### \_\_init_\_(name: str, line: int, column: int, length: int, format: str, type: [EntryType](py_os_design.md#py_os_design.EntryType), expandable: bool) +### \_\_init_\_(name: str, line: int, column: int, length: int, format: str, type: [EntryType](py_os_design.md#py_os_design.EntryType), expandable: bool) + -#### *property* column +### *property* column + -#### *property* end_in_line +### *property* end_in_line + -#### *property* expandable +### *property* expandable + -#### *property* format +### *property* format + -#### get_text(arg2: str, arg3: bool, arg4: int, arg5: int, arg6: int) → str +### get_text(arg2: str, arg3: bool, arg4: int, arg5: int, arg6: int) → str + -#### intersects(arg2: [Parameter](#optiSLang_Actors.TextInputActor.Parameter)) → bool +### intersects(arg2: [Parameter](#optiSLang_Actors.TextInputActor.Parameter)) → bool + -#### *property* length +### *property* length + -#### *property* line +### *property* line + -#### *property* marker +### *property* marker + -#### *property* name +### *property* name + -#### read(arg2: str, arg3: bool) → [PyOSDesignEntry](py_os_design.md#py_os_design.PyOSDesignEntry) +### read(arg2: str, arg3: bool) → [PyOSDesignEntry](py_os_design.md#py_os_design.PyOSDesignEntry) + -#### replace(arg2: [PyOSDesignEntry](py_os_design.md#py_os_design.PyOSDesignEntry), arg3: str, arg4: int) → [PyOSDesignEntry](py_os_design.md#py_os_design.PyOSDesignEntry) +### replace(arg2: [PyOSDesignEntry](py_os_design.md#py_os_design.PyOSDesignEntry), arg3: str, arg4: int) → [PyOSDesignEntry](py_os_design.md#py_os_design.PyOSDesignEntry) + -#### to_string(arg2: [PyOSDesignEntry](py_os_design.md#py_os_design.PyOSDesignEntry)) → str +### to_string(arg2: [PyOSDesignEntry](py_os_design.md#py_os_design.PyOSDesignEntry)) → str + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -#### add_input(location: Parameter) +### add_input(location: Parameter) Assign location to an input slot. + -#### add_parameter(location: Parameter) +### add_parameter(location: Parameter) -#### add_parameter(arg2: [Parameter](#optiSLang_Actors.TextInputActor.Parameter)) +### add_parameter(arg2: [Parameter](#optiSLang_Actors.TextInputActor.Parameter)) [0] Assign location to a parameter. + -#### *property* content +### *property* content + -#### *property* encoding +### *property* encoding + -#### *property* file_content +### *property* file_content + -#### *property* file_path +### *property* file_path + -#### get_locations_from_file(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: object, arg4: [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint)) → bool +### get_locations_from_file(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: object, arg4: [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint)) → bool + -#### get_locations_from_string(arg2: str, arg3: object, arg4: [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint)) → bool +### get_locations_from_string(arg2: str, arg3: object, arg4: [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint)) → bool + -#### get_registered_inputs() → list +### get_registered_inputs() → list Get registered input slots + -#### get_registered_parameters() → list +### get_registered_parameters() → list Get registered parameters + -#### has_parameter_location(arg2: int, arg3: int, arg4: int) → bool +### has_parameter_location(arg2: int, arg3: int, arg4: int) → bool + -#### *property* registered_parameters +### *property* registered_parameters List of parameters in the text. Note that these represent locations in the input file. So there can be multiple of them registered to the actual input parameters. + -#### remove_parameter(arg2: str) +### remove_parameter(arg2: str) + -#### rename_parameter(arg2: str, arg3: str) +### rename_parameter(arg2: str, arg3: str) + -#### replace_parameter(arg2: [Parameter](#optiSLang_Actors.TextInputActor.Parameter), arg3: [Parameter](#optiSLang_Actors.TextInputActor.Parameter)) +### replace_parameter(arg2: [Parameter](#optiSLang_Actors.TextInputActor.Parameter), arg3: [Parameter](#optiSLang_Actors.TextInputActor.Parameter)) + -#### set_content() +### set_content() + -#### *property* store_content +### *property* store_content + -### *class* \_optiSLang_Actors.TurboOptInputActor +## *class* \_optiSLang_Actors.TurboOptInputActor + -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -### *class* \_optiSLang_Actors.UpdateResultFileInterval +## *class* \_optiSLang_Actors.UpdateResultFileInterval **Enumeration** + -#### AT_THE_END *= \_optiSLang_Actors.UpdateResultFileInterval.AT_THE_END* +### AT_THE_END *= \_optiSLang_Actors.UpdateResultFileInterval.AT_THE_END* + -#### EVERY_DESIGN *= \_optiSLang_Actors.UpdateResultFileInterval.EVERY_DESIGN* +### EVERY_DESIGN *= \_optiSLang_Actors.UpdateResultFileInterval.EVERY_DESIGN* + -#### EVERY_ITERATION *= \_optiSLang_Actors.UpdateResultFileInterval.EVERY_ITERATION* +### EVERY_ITERATION *= \_optiSLang_Actors.UpdateResultFileInterval.EVERY_ITERATION* + -#### NEVER *= \_optiSLang_Actors.UpdateResultFileInterval.NEVER* +### NEVER *= \_optiSLang_Actors.UpdateResultFileInterval.NEVER* + -### *class* \_optiSLang_Actors.VariableActor +## *class* \_optiSLang_Actors.VariableActor + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -#### *property* variant +### *property* variant + -### *class* \_optiSLang_Actors.VariantMonitoringActor +## *class* \_optiSLang_Actors.VariantMonitoringActor + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -### *class* \_optiSLang_Actors.WhileActor +## *class* \_optiSLang_Actors.WhileActor + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -### \_optiSLang_Actors.create_custom_actor_typed(arg1: str) → [CustomActor](#optiSLang_Actors.CustomActor) +## \_optiSLang_Actors.create_custom_actor_typed(arg1: str) → [CustomActor](#optiSLang_Actors.CustomActor) Create a Custom Node by ID. + -### \_optiSLang_Actors.create_custom_integration_actor_typed(arg1: str) → [CustomIntegrationActor](#optiSLang_Actors.CustomIntegrationActor) +## \_optiSLang_Actors.create_custom_integration_actor_typed(arg1: str) → [CustomIntegrationActor](#optiSLang_Actors.CustomIntegrationActor) Create a Custom Python Integration actor by ID. The script must be located in CI path. + -### \_optiSLang_Actors.create_custom_mop_actor_typed(arg1: str) → [CustomMopActor](#optiSLang_Actors.CustomMopActor) +## \_optiSLang_Actors.create_custom_mop_actor_typed(arg1: str) → [CustomMopActor](#optiSLang_Actors.CustomMopActor) Create a Custom MOP Node by ID. + -### *class* \_optiSLang_Actors.eModelComplexityType +## *class* \_optiSLang_Actors.eModelComplexityType **Enumeration** + + +### eBALANCED_MODEL *= \_optiSLang_Actors.eModelComplexityType.eBALANCED_MODEL* + + + +### eCOMPLEX_MODEL *= \_optiSLang_Actors.eModelComplexityType.eCOMPLEX_MODEL* + + + +### eGARS *= \_optiSLang_Actors.eModelComplexityType.eGARS* + + -#### eBALANCED_MODEL *= \_optiSLang_Actors.eModelComplexityType.eBALANCED_MODEL* +### eISOKRIG *= \_optiSLang_Actors.eModelComplexityType.eISOKRIG* + -#### eCOMPLEX_MODEL *= \_optiSLang_Actors.eModelComplexityType.eCOMPLEX_MODEL* +### eMLS *= \_optiSLang_Actors.eModelComplexityType.eMLS* + -#### ePOLY_DLN *= \_optiSLang_Actors.eModelComplexityType.ePOLY_DLN* +### ePOLY_DLN *= \_optiSLang_Actors.eModelComplexityType.ePOLY_DLN* + -#### eSIMPLE_MODEL *= \_optiSLang_Actors.eModelComplexityType.eSIMPLE_MODEL* +### eSIMPLE_MODEL *= \_optiSLang_Actors.eModelComplexityType.eSIMPLE_MODEL* + -### *class* \_optiSLang_Actors.eSettingsType +## *class* \_optiSLang_Actors.eSettingsType **Enumeration** + -#### eADVANCED *= \_optiSLang_Actors.eSettingsType.eADVANCED* +### eADVANCED *= \_optiSLang_Actors.eSettingsType.eADVANCED* + -#### eAUTOMATIC *= \_optiSLang_Actors.eSettingsType.eAUTOMATIC* +### eAUTOMATIC *= \_optiSLang_Actors.eSettingsType.eAUTOMATIC* + -### *class* \_optiSLang_Actors.eVariableReductionType +## *class* \_optiSLang_Actors.eVariableReductionType **Enumeration** + -#### eFILTER_MINOR_IMPORTANT *= \_optiSLang_Actors.eVariableReductionType.eFILTER_MINOR_IMPORTANT* +### eFILTER_MINOR_IMPORTANT *= \_optiSLang_Actors.eVariableReductionType.eFILTER_MINOR_IMPORTANT* + -#### eFILTER_UNIMPORTANT *= \_optiSLang_Actors.eVariableReductionType.eFILTER_UNIMPORTANT* +### eFILTER_UNIMPORTANT *= \_optiSLang_Actors.eVariableReductionType.eFILTER_UNIMPORTANT* + -#### eNO_REDUCTION *= \_optiSLang_Actors.eVariableReductionType.eNO_REDUCTION* +### eNO_REDUCTION *= \_optiSLang_Actors.eVariableReductionType.eNO_REDUCTION* + -#### eUSER_DEFINED *= \_optiSLang_Actors.eVariableReductionType.eUSER_DEFINED* +### eUSER_DEFINED *= \_optiSLang_Actors.eVariableReductionType.eUSER_DEFINED* + -### \_optiSLang_Actors.get_loaded_ci_plugins() → list +## \_optiSLang_Actors.get_loaded_ci_plugins() → list List Python-based custom integrations loaded at runtime. + -### \_optiSLang_Actors.get_loaded_custom_integrations() → list +## \_optiSLang_Actors.get_loaded_custom_integrations() → list List Python-based custom integrations loaded at runtime. + -### \_optiSLang_Actors.get_loaded_custom_mop_nodes() → list +## \_optiSLang_Actors.get_loaded_custom_mop_nodes() → list List IDs of python-based custom MOP nodes loaded at runtime. + -### \_optiSLang_Actors.get_loaded_custom_nodes() → list +## \_optiSLang_Actors.get_loaded_custom_nodes() → list List IDs of python-based custom node loaded at runtime. + -### \_optiSLang_Actors.get_loaded_custom_surrogates() → list +## \_optiSLang_Actors.get_loaded_custom_surrogates() → list List all available custom surrogates. + -### \_optiSLang_Actors.get_loaded_plugins() → list +## \_optiSLang_Actors.get_loaded_plugins() → list List customization plugins that are loaded at runtime. diff --git a/2025R2/optiSLang-python-api/modules/_optiSLang_Kernel.md b/2025R2/optiSLang-python-api/modules/_optiSLang_Kernel.md index 0551130c00..d6b5c20e3b 100644 --- a/2025R2/optiSLang-python-api/modules/_optiSLang_Kernel.md +++ b/2025R2/optiSLang-python-api/modules/_optiSLang_Kernel.md @@ -1,168 +1,210 @@ + -### *class* \_optiSLang_Kernel.Actor +# \_optiSLang_Kernel + + + +## *class* \_optiSLang_Kernel.Actor Base class of all actor classes + -#### *class* SlotType +### *class* SlotType **Enumeration** + -#### BOOL *= \_optiSLang_Kernel.SlotType.BOOL* +### BOOL *= \_optiSLang_Kernel.SlotType.BOOL* + -#### BOOL_VEC *= \_optiSLang_Kernel.SlotType.BOOL_VEC* +### BOOL_VEC *= \_optiSLang_Kernel.SlotType.BOOL_VEC* + -#### CRITERION *= \_optiSLang_Kernel.SlotType.CRITERION* +### CRITERION *= \_optiSLang_Kernel.SlotType.CRITERION* + -#### CRITERION_SEQ *= \_optiSLang_Kernel.SlotType.CRITERION_SEQ* +### CRITERION_SEQ *= \_optiSLang_Kernel.SlotType.CRITERION_SEQ* + -#### DESIGN *= \_optiSLang_Kernel.SlotType.DESIGN* +### DESIGN *= \_optiSLang_Kernel.SlotType.DESIGN* + -#### DESIGNENTRY *= \_optiSLang_Kernel.SlotType.DESIGNENTRY* +### DESIGNENTRY *= \_optiSLang_Kernel.SlotType.DESIGNENTRY* + -#### DESIGNPOINT_CONTAINER *= \_optiSLang_Kernel.SlotType.DESIGNPOINT_CONTAINER* +### DESIGNPOINT_CONTAINER *= \_optiSLang_Kernel.SlotType.DESIGNPOINT_CONTAINER* + -#### FLOAT *= \_optiSLang_Kernel.SlotType.FLOAT* +### FLOAT *= \_optiSLang_Kernel.SlotType.FLOAT* + -#### INTEGER *= \_optiSLang_Kernel.SlotType.INTEGER* +### INTEGER *= \_optiSLang_Kernel.SlotType.INTEGER* + -#### PARAMETER *= \_optiSLang_Kernel.SlotType.PARAMETER* +### PARAMETER *= \_optiSLang_Kernel.SlotType.PARAMETER* + -#### PARAMETER_MANAGER *= \_optiSLang_Kernel.SlotType.PARAMETER_MANAGER* +### PARAMETER_MANAGER *= \_optiSLang_Kernel.SlotType.PARAMETER_MANAGER* + -#### PARAMETER_SET *= \_optiSLang_Kernel.SlotType.PARAMETER_SET* +### PARAMETER_SET *= \_optiSLang_Kernel.SlotType.PARAMETER_SET* + -#### PATH *= \_optiSLang_Kernel.SlotType.PATH* +### PATH *= \_optiSLang_Kernel.SlotType.PATH* + -#### RUNINFO *= \_optiSLang_Kernel.SlotType.RUNINFO* +### RUNINFO *= \_optiSLang_Kernel.SlotType.RUNINFO* + -#### RUNINFO_META *= \_optiSLang_Kernel.SlotType.RUNINFO_META* +### RUNINFO_META *= \_optiSLang_Kernel.SlotType.RUNINFO_META* + -#### SAMPLING_DESIGN *= \_optiSLang_Kernel.SlotType.SAMPLING_DESIGN* +### SAMPLING_DESIGN *= \_optiSLang_Kernel.SlotType.SAMPLING_DESIGN* + -#### STRING *= \_optiSLang_Kernel.SlotType.STRING* +### STRING *= \_optiSLang_Kernel.SlotType.STRING* + -#### STRING_LIST *= \_optiSLang_Kernel.SlotType.STRING_LIST* +### STRING_LIST *= \_optiSLang_Kernel.SlotType.STRING_LIST* + -#### UNDEFINED *= \_optiSLang_Kernel.SlotType.UNDEFINED* +### UNDEFINED *= \_optiSLang_Kernel.SlotType.UNDEFINED* + -#### UNSIGNED_INTEGER *= \_optiSLang_Kernel.SlotType.UNSIGNED_INTEGER* +### UNSIGNED_INTEGER *= \_optiSLang_Kernel.SlotType.UNSIGNED_INTEGER* + -#### UNSIGNED_INTEGER_VECTOR *= \_optiSLang_Kernel.SlotType.UNSIGNED_INTEGER_VECTOR* +### UNSIGNED_INTEGER_VECTOR *= \_optiSLang_Kernel.SlotType.UNSIGNED_INTEGER_VECTOR* + -#### VARIANT *= \_optiSLang_Kernel.SlotType.VARIANT* +### VARIANT *= \_optiSLang_Kernel.SlotType.VARIANT* + -#### VARIANTSEQ *= \_optiSLang_Kernel.SlotType.VARIANTSEQ* +### VARIANTSEQ *= \_optiSLang_Kernel.SlotType.VARIANTSEQ* + -#### \_\_init_\_() +### \_\_init_\_() Raises an exception This class cannot be instantiated from Python + -#### *property* active +### *property* active + -#### add_file_provider_item(id: [FileProviderId](py_file_access.md#py_file_access.FileProviderId)) → bool +### add_file_provider_item(id: [FileProviderId](py_file_access.md#py_file_access.FileProviderId)) → bool Add and use a file provider item. + -#### add_input_slot(slot_type: [SlotType](#optiSLang_Kernel.Actor.SlotType), id: str) +### add_input_slot(slot_type: [SlotType](#optiSLang_Kernel.Actor.SlotType), id: str) Add an input slot with slot_type and id. + -#### add_output_slot(slot_type: [SlotType](#optiSLang_Kernel.Actor.SlotType), id: str) +### add_output_slot(slot_type: [SlotType](#optiSLang_Kernel.Actor.SlotType), id: str) Add an output slot with slot_type and id. + -#### *property* auto_save_mode +### *property* auto_save_mode + -#### *property* auto_save_on_nth_design_collected +### *property* auto_save_on_nth_design_collected + -#### *property* connected_input_slots +### *property* connected_input_slots Dictionary with connected input slots as keys and the slot’s sources as values. Each source is a tuple of the source actor and the source slot name. + -#### *property* connected_output_slots +### *property* connected_output_slots Dictionary with connected output slots as keys and the slot’s destinations as values. Each destination is a tuple of the destination actor and the destination slot name. + -#### get_cleaning_mode() → int +### get_cleaning_mode() → int + -#### get_file_provider_items() → object +### get_file_provider_items() → object Get a list of file provider items used in this actor. + -#### get_processed_hids() → dict +### get_processed_hids() → dict Dictionary with HIDs categorized by their success states. + -#### get_property(property_id: str, default_value: [ProvidedPath](py_file_access.md#py_file_access.ProvidedPath)) → [ProvidedPath](py_file_access.md#py_file_access.ProvidedPath) +### get_property(property_id: str, default_value: [ProvidedPath](py_file_access.md#py_file_access.ProvidedPath)) → [ProvidedPath](py_file_access.md#py_file_access.ProvidedPath) -#### get_property(property_id: str, default_value: [RelativeSplittedPath](stdcpp_python_export.md#stdcpp_python_export.RelativeSplittedPath)) → [RelativeSplittedPath](stdcpp_python_export.md#stdcpp_python_export.RelativeSplittedPath) +### get_property(property_id: str, default_value: [RelativeSplittedPath](stdcpp_python_export.md#stdcpp_python_export.RelativeSplittedPath)) → [RelativeSplittedPath](stdcpp_python_export.md#stdcpp_python_export.RelativeSplittedPath) -#### get_property(property_id: str, default_value: [SplittedPath](stdcpp_python_export.md#stdcpp_python_export.SplittedPath)) → [SplittedPath](stdcpp_python_export.md#stdcpp_python_export.SplittedPath) +### get_property(property_id: str, default_value: [SplittedPath](stdcpp_python_export.md#stdcpp_python_export.SplittedPath)) → [SplittedPath](stdcpp_python_export.md#stdcpp_python_export.SplittedPath) -#### get_property(property_id: str, default_value: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) → [Path](stdcpp_python_export.md#stdcpp_python_export.Path) +### get_property(property_id: str, default_value: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) → [Path](stdcpp_python_export.md#stdcpp_python_export.Path) -#### get_property(property_id: str, default_value: str) → str +### get_property(property_id: str, default_value: str) → str -#### get_property(property_id: str, default_value: [uintVec](stdcpp_python_export.md#stdcpp_python_export.uintVec)) → [uintVec](stdcpp_python_export.md#stdcpp_python_export.uintVec) +### get_property(property_id: str, default_value: [uintVec](stdcpp_python_export.md#stdcpp_python_export.uintVec)) → [uintVec](stdcpp_python_export.md#stdcpp_python_export.uintVec) -#### get_property(property_id: str, default_value: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) +### get_property(property_id: str, default_value: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) -#### get_property(property_id: str, default_value: [PyParameterManager](py_os_parameter.md#py_os_parameter.PyParameterManager)) → [PyParameterManager](py_os_parameter.md#py_os_parameter.PyParameterManager) +### get_property(property_id: str, default_value: [PyParameterManager](py_os_parameter.md#py_os_parameter.PyParameterManager)) → [PyParameterManager](py_os_parameter.md#py_os_parameter.PyParameterManager) -#### get_property(property_id: str, default_value: [PyOSDesign](py_os_design.md#py_os_design.PyOSDesign)) → [PyOSDesign](py_os_design.md#py_os_design.PyOSDesign) +### get_property(property_id: str, default_value: [PyOSDesign](py_os_design.md#py_os_design.PyOSDesign)) → [PyOSDesign](py_os_design.md#py_os_design.PyOSDesign) -#### get_property(property_id: str, default_value: [PyOSDesignEntry](py_os_design.md#py_os_design.PyOSDesignEntry)) → [PyOSDesignEntry](py_os_design.md#py_os_design.PyOSDesignEntry) +### get_property(property_id: str, default_value: [PyOSDesignEntry](py_os_design.md#py_os_design.PyOSDesignEntry)) → [PyOSDesignEntry](py_os_design.md#py_os_design.PyOSDesignEntry) -#### get_property(property_id: str, default_value: [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint)) → [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint) +### get_property(property_id: str, default_value: [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint)) → [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint) -#### get_property(property_id: str, default_value: [PyOSDesignPointContainer](py_os_design.md#py_os_design.PyOSDesignPointContainer)) → [PyOSDesignPointContainer](py_os_design.md#py_os_design.PyOSDesignPointContainer) +### get_property(property_id: str, default_value: [PyOSDesignPointContainer](py_os_design.md#py_os_design.PyOSDesignPointContainer)) → [PyOSDesignPointContainer](py_os_design.md#py_os_design.PyOSDesignPointContainer) -#### get_property(property_id: str, default_value: [PyOSDesignContainer](py_os_design.md#py_os_design.PyOSDesignContainer)) → [PyOSDesignContainer](py_os_design.md#py_os_design.PyOSDesignContainer) +### get_property(property_id: str, default_value: [PyOSDesignContainer](py_os_design.md#py_os_design.PyOSDesignContainer)) → [PyOSDesignContainer](py_os_design.md#py_os_design.PyOSDesignContainer) -#### get_property(property_id: str, default_value: [boolVec](stdcpp_python_export.md#stdcpp_python_export.boolVec)) → [boolVec](stdcpp_python_export.md#stdcpp_python_export.boolVec) +### get_property(property_id: str, default_value: [boolVec](stdcpp_python_export.md#stdcpp_python_export.boolVec)) → [boolVec](stdcpp_python_export.md#stdcpp_python_export.boolVec) -#### get_property(property_id: str, default_value: [PyOSCriterion](py_os_criterion.md#py_os_criterion.PyOSCriterion)) → [PyOSCriterion](py_os_criterion.md#py_os_criterion.PyOSCriterion) +### get_property(property_id: str, default_value: [PyOSCriterion](py_os_criterion.md#py_os_criterion.PyOSCriterion)) → [PyOSCriterion](py_os_criterion.md#py_os_criterion.PyOSCriterion) -#### get_property(property_id: str, default_value: [PyOSCriterionContainer](py_os_criterion.md#py_os_criterion.PyOSCriterionContainer)) → [PyOSCriterionContainer](py_os_criterion.md#py_os_criterion.PyOSCriterionContainer) +### get_property(property_id: str, default_value: [PyOSCriterionContainer](py_os_criterion.md#py_os_criterion.PyOSCriterionContainer)) → [PyOSCriterionContainer](py_os_criterion.md#py_os_criterion.PyOSCriterionContainer) [0] Get the value of a property specified by property_id. If no such property or datatype doesn’t match, default_value is returned. @@ -196,124 +238,145 @@ Dictionary with HIDs categorized by their success states. [15] Get the value of a property specified by property_id. If no such property or datatype doesn’t match, default_value is returned. + -#### get_property_bool(property_id: str, default_value: bool) → bool +### get_property_bool(property_id: str, default_value: bool) → bool Get the value of a property specified by property_id. If no such property or datatype doesn’t match, default_value is returned. + -#### get_property_float(property_id: str, default_value: float) → float +### get_property_float(property_id: str, default_value: float) → float Get the value of a property specified by property_id. If no such property or datatype doesn’t match, default_value is returned. + -#### get_property_int(property_id: str, default_value: int) → int +### get_property_int(property_id: str, default_value: int) → int Get the value of a property specified by property_id. If no such property or datatype doesn’t match, default_value is returned. + -#### get_property_keys() → list +### get_property_keys() → list Get all accessible property keys + -#### get_property_raw(property_id: str) → str +### get_property_raw(property_id: str) → str Get the raw value of a property specified by property_id. + -#### get_property_uint(property_id: str, default_value: int) → int +### get_property_uint(property_id: str, default_value: int) → int Get the value of a property specified by property_id. If no such property or datatype doesn’t match, default_value is returned. + -#### get_slot_value(slot: str name, hid: HID) → object +### get_slot_value(slot: str name, hid: HID) → object Get the value of a slot specified by its name and HID. + -#### *property* goal +### *property* goal + -#### *property* input_slots +### *property* input_slots List of input slots. Items are dicts of name, type and standard. + -#### is_finished(, consider_inactive: bool=False]) → bool +### is_finished(, consider_inactive: bool=False]) → bool Whether an actor or a system including its children have finished their computation. If consider_inactive is set, an inactive actor will return whether it’s truly finished. Otherwise it will always pretend to be finished. + -#### is_succeeded(, consider_inactive: bool=False]) → bool +### is_succeeded(, consider_inactive: bool=False]) → bool Whether an actor or a system including its children have finished their computation successfully. + -#### *property* max_runtime +### *property* max_runtime + -#### *property* output_slots +### *property* output_slots List of output slots. Items are dicts of name, type and standard. + -#### *property* read_mode +### *property* read_mode + -#### remove_file_provider_item(id: [FileProviderId](py_file_access.md#py_file_access.FileProviderId)) → bool +### remove_file_provider_item(id: [FileProviderId](py_file_access.md#py_file_access.FileProviderId)) → bool Remove a file provider item. + -#### *property* result_recycling +### *property* result_recycling + -#### *property* retry_count +### *property* retry_count + -#### *property* retry_delay +### *property* retry_delay + -#### *property* retry_enable +### *property* retry_enable + -#### set_cleaning_mode(mode: int) +### set_cleaning_mode(mode: int) Set clean-up mode to enable particular cleanup behavior using bitwise linked combinations of CleanupFlags + -#### set_property(property_id: str, value: [ProvidedPath](py_file_access.md#py_file_access.ProvidedPath)) → bool +### set_property(property_id: str, value: [ProvidedPath](py_file_access.md#py_file_access.ProvidedPath)) → bool -#### set_property(property_id: str, value: [RelativeSplittedPath](stdcpp_python_export.md#stdcpp_python_export.RelativeSplittedPath)) → bool +### set_property(property_id: str, value: [RelativeSplittedPath](stdcpp_python_export.md#stdcpp_python_export.RelativeSplittedPath)) → bool -#### set_property(property_id: str, value: [SplittedPath](stdcpp_python_export.md#stdcpp_python_export.SplittedPath)) → bool +### set_property(property_id: str, value: [SplittedPath](stdcpp_python_export.md#stdcpp_python_export.SplittedPath)) → bool -#### set_property(property_id: str, value: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) → bool +### set_property(property_id: str, value: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) → bool -#### set_property(property_id: str, value: str) → bool +### set_property(property_id: str, value: str) → bool -#### set_property(property_id: str, value: [uintVec](stdcpp_python_export.md#stdcpp_python_export.uintVec)) → bool +### set_property(property_id: str, value: [uintVec](stdcpp_python_export.md#stdcpp_python_export.uintVec)) → bool -#### set_property(property_id: str, value: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) → bool +### set_property(property_id: str, value: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) → bool -#### set_property(property_id: str, value: [PyParameterManager](py_os_parameter.md#py_os_parameter.PyParameterManager)) → bool +### set_property(property_id: str, value: [PyParameterManager](py_os_parameter.md#py_os_parameter.PyParameterManager)) → bool -#### set_property(property_id: str, value: [PyOSDesign](py_os_design.md#py_os_design.PyOSDesign)) → bool +### set_property(property_id: str, value: [PyOSDesign](py_os_design.md#py_os_design.PyOSDesign)) → bool -#### set_property(property_id: str, value: [PyOSDesignEntry](py_os_design.md#py_os_design.PyOSDesignEntry)) → bool +### set_property(property_id: str, value: [PyOSDesignEntry](py_os_design.md#py_os_design.PyOSDesignEntry)) → bool -#### set_property(property_id: str, value: [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint)) → bool +### set_property(property_id: str, value: [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint)) → bool -#### set_property(property_id: str, value: [PyOSDesignPointContainer](py_os_design.md#py_os_design.PyOSDesignPointContainer)) → bool +### set_property(property_id: str, value: [PyOSDesignPointContainer](py_os_design.md#py_os_design.PyOSDesignPointContainer)) → bool -#### set_property(property_id: str, value: [PyOSDesignContainer](py_os_design.md#py_os_design.PyOSDesignContainer)) → bool +### set_property(property_id: str, value: [PyOSDesignContainer](py_os_design.md#py_os_design.PyOSDesignContainer)) → bool -#### set_property(property_id: str, value: [boolVec](stdcpp_python_export.md#stdcpp_python_export.boolVec)) → bool +### set_property(property_id: str, value: [boolVec](stdcpp_python_export.md#stdcpp_python_export.boolVec)) → bool -#### set_property(property_id: str, value: [PyOSCriterion](py_os_criterion.md#py_os_criterion.PyOSCriterion)) → bool +### set_property(property_id: str, value: [PyOSCriterion](py_os_criterion.md#py_os_criterion.PyOSCriterion)) → bool -#### set_property(property_id: str, value: [PyOSCriterionContainer](py_os_criterion.md#py_os_criterion.PyOSCriterionContainer)) → bool +### set_property(property_id: str, value: [PyOSCriterionContainer](py_os_criterion.md#py_os_criterion.PyOSCriterionContainer)) → bool [0] Set the value of a property specified by property_id. Returns true if set successful. @@ -347,106 +410,132 @@ Set clean-up mode to enable particular cleanup behavior using bitwise linked com [15] Set the value of a property specified by property_id. Returns true if set successful. + -#### set_property_bool(property_id: str, value: bool) → bool +### set_property_bool(property_id: str, value: bool) → bool Set the value of a property specified by property_id. Returns true if set successful. + -#### set_property_float(property_id: str, value: float) → bool +### set_property_float(property_id: str, value: float) → bool Set the value of a property specified by property_id. Returns true if set successful. + -#### set_property_int(property_id: str, value: int) → bool +### set_property_int(property_id: str, value: int) → bool Set the value of a property specified by property_id. Returns true if set successful. + -#### set_property_raw(property_tree_json: str) → bool +### set_property_raw(property_tree_json: str) → bool Set the value of a property. Argument has to be a json object, containing one or more properties. Returns true if set successful. + -#### set_property_uint(property_id: str, value: int) → bool +### set_property_uint(property_id: str, value: int) → bool Set the value of a property specified by property_id. Returns true if set successful. + -#### *property* starting_delay +### *property* starting_delay + -#### *property* starting_point +### *property* starting_point + -#### *property* stop_after_execution +### *property* stop_after_execution + -#### supports_read_mode() → bool +### supports_read_mode() → bool + -#### supports_recycling() → bool +### supports_recycling() → bool + -### *class* \_optiSLang_Kernel.AutoSaveMode +## *class* \_optiSLang_Kernel.AutoSaveMode **Enumeration** + -#### AS_ACTOR_FINISHED *= \_optiSLang_Kernel.AutoSaveMode.AS_ACTOR_FINISHED* +### AS_ACTOR_FINISHED *= \_optiSLang_Kernel.AutoSaveMode.AS_ACTOR_FINISHED* + -#### AS_ALGO_ITERATION_FINISHED *= \_optiSLang_Kernel.AutoSaveMode.AS_ALGO_ITERATION_FINISHED* +### AS_ALGO_ITERATION_FINISHED *= \_optiSLang_Kernel.AutoSaveMode.AS_ALGO_ITERATION_FINISHED* + -#### AS_PSS_NTH_DESIGN_COLLECTED *= \_optiSLang_Kernel.AutoSaveMode.AS_PSS_NTH_DESIGN_COLLECTED* +### AS_PSS_NTH_DESIGN_COLLECTED *= \_optiSLang_Kernel.AutoSaveMode.AS_PSS_NTH_DESIGN_COLLECTED* + -#### NO_AUTO_SAVE *= \_optiSLang_Kernel.AutoSaveMode.NO_AUTO_SAVE* +### NO_AUTO_SAVE *= \_optiSLang_Kernel.AutoSaveMode.NO_AUTO_SAVE* + -### *class* \_optiSLang_Kernel.CleanupFlags +## *class* \_optiSLang_Kernel.CleanupFlags **Enumeration** + -#### CLEANUP_INTERMEDIATE_SLOT_VALUES *= \_optiSLang_Kernel.CleanupFlags.CLEANUP_INTERMEDIATE_SLOT_VALUES* +### CLEANUP_INTERMEDIATE_SLOT_VALUES *= \_optiSLang_Kernel.CleanupFlags.CLEANUP_INTERMEDIATE_SLOT_VALUES* + -#### IDLE *= \_optiSLang_Kernel.CleanupFlags.IDLE* +### IDLE *= \_optiSLang_Kernel.CleanupFlags.IDLE* + -### *class* \_optiSLang_Kernel.ReadMode +## *class* \_optiSLang_Kernel.ReadMode **Enumeration** + -#### CLASSIC_REEVALUATE_MODE *= \_optiSLang_Kernel.ReadMode.CLASSIC_REEVALUATE_MODE* +### CLASSIC_REEVALUATE_MODE *= \_optiSLang_Kernel.ReadMode.CLASSIC_REEVALUATE_MODE* + -#### READ_AND_WRITE_MODE *= \_optiSLang_Kernel.ReadMode.READ_AND_WRITE_MODE* +### READ_AND_WRITE_MODE *= \_optiSLang_Kernel.ReadMode.READ_AND_WRITE_MODE* + -### *class* \_optiSLang_Kernel.SequencingSystem +## *class* \_optiSLang_Kernel.SequencingSystem + -#### \_\_init_\_() +### \_\_init_\_() Raises an exception This class cannot be instantiated from Python + -### *class* \_optiSLang_Kernel.System +## *class* \_optiSLang_Kernel.System + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_() → object +### \_\_init_\_() → object -#### \_\_init_\_(arg2: str) → object +### \_\_init_\_(arg2: str) → object + -#### add_actor(actor: [Actor](#optiSLang_Kernel.Actor)) +### add_actor(actor: [Actor](#optiSLang_Kernel.Actor)) Add actor as child to this system. @@ -455,17 +544,19 @@ param_system = actors.ParametricSystemActor("System") add_actor(param_system) ``` + -#### connect(from_actor: Actor, from_slot: str, to_actor: Actor, to_slot: str) → bool +### connect(from_actor: Actor, from_slot: str, to_actor: Actor, to_slot: str) → bool -#### connect(from_actor: str, from_slot: str, to_actor: Actor, to_slot: str) → bool +### connect(from_actor: str, from_slot: str, to_actor: Actor, to_slot: str) → bool -#### connect(from_actor: Actor, from_slot: str, to_actor: str, to_slot: str) → bool +### connect(from_actor: Actor, from_slot: str, to_actor: str, to_slot: str) → bool -#### connect(from_actor: str, from_slot: str, to_actor: str, to_slot: str) → bool +### connect(from_actor: str, from_slot: str, to_actor: str, to_slot: str) → bool [0] Connect slots. + # Parameters @@ -484,6 +575,7 @@ to_slot skip_rename_slot : Whether to skip automatic slot renaming for untyped slots. False by default. + # Returns @@ -492,6 +584,7 @@ bool [1] Connect slots. + # Parameters @@ -510,6 +603,7 @@ to_slot skip_rename_slot : Whether to skip automatic slot renaming for untyped slots. False by default. + # Returns @@ -518,6 +612,7 @@ bool [2] Connect slots. + # Parameters @@ -536,6 +631,7 @@ to_slot skip_rename_slot : Whether to skip automatic slot renaming for untyped slots. False by default. + # Returns @@ -544,6 +640,7 @@ bool [3] Connect slots. + # Parameters @@ -562,62 +659,75 @@ to_slot skip_rename_slot : Whether to skip automatic slot renaming for untyped slots. False by default. + # Returns bool : True if connection succeeded c. + -#### *property* connected_inner_input_slots +### *property* connected_inner_input_slots Dictionary with connected inner input slots as keys and the slot’s sources as values. Each source is a tuple of the source actor and the source slot name. + -#### *property* connected_inner_output_slots +### *property* connected_inner_output_slots Dictionary with connected inner output slots as keys and the slot’s destinations as values. Each destination is a tuple of the destination actor and the destination slot name. + -#### disconnect(from_actor: [Actor](#optiSLang_Kernel.Actor), from_slot: str, to_actor: [Actor](#optiSLang_Kernel.Actor), to_slot: str) → bool +### disconnect(from_actor: [Actor](#optiSLang_Kernel.Actor), from_slot: str, to_actor: [Actor](#optiSLang_Kernel.Actor), to_slot: str) → bool -#### disconnect(from_actor: str, from_slot: str, to_actor: [Actor](#optiSLang_Kernel.Actor), to_slot: str) → bool +### disconnect(from_actor: str, from_slot: str, to_actor: [Actor](#optiSLang_Kernel.Actor), to_slot: str) → bool -#### disconnect(from_actor: [Actor](#optiSLang_Kernel.Actor), from_slot: str, to_actor: str, to_slot: str) → bool +### disconnect(from_actor: [Actor](#optiSLang_Kernel.Actor), from_slot: str, to_actor: str, to_slot: str) → bool -#### disconnect(from_actor: str, from_slot: str, to_actor: str, to_slot: str) → bool +### disconnect(from_actor: str, from_slot: str, to_actor: str, to_slot: str) → bool + -#### *property* dot_graph +### *property* dot_graph + -#### find_actor(name: str) → object +### find_actor(name: str) → object + -#### get_children() → dict +### get_children() → dict Return all descending actors in a dictionary. + -#### get_dot_graph() → str +### get_dot_graph() → str + -#### get_working_directory(hid: [HID](id.md#id.HID)) → [Path](stdcpp_python_export.md#stdcpp_python_export.Path) +### get_working_directory(hid: [HID](id.md#id.HID)) → [Path](stdcpp_python_export.md#stdcpp_python_export.Path) + -#### *property* inner_input_slots +### *property* inner_input_slots List of inner input slots. Items are dicts of name, type and standard. + -#### *property* inner_output_slots +### *property* inner_output_slots List of inner output slots. Items are dicts of name, type and standard. + -#### remove_actor(arg2: [Actor](#optiSLang_Kernel.Actor)) +### remove_actor(arg2: [Actor](#optiSLang_Kernel.Actor)) + -#### reset_complete() +### reset_complete() Reset system’s status, working directory and runtime data. Attempts to shrink database. diff --git a/2025R2/optiSLang-python-api/modules/amop.md b/2025R2/optiSLang-python-api/modules/amop.md index c7f6f6d67c..ed9c430bbd 100644 --- a/2025R2/optiSLang-python-api/modules/amop.md +++ b/2025R2/optiSLang-python-api/modules/amop.md @@ -1,238 +1,318 @@ + -### *class* amop.AMop +# amop + -#### \_\_init_\_(arg2: [AMopSettings](#amop.AMopSettings)) +## *class* amop.AMop + -#### adapt() +### \_\_init_\_(arg2: [AMopSettings](#amop.AMopSettings)) + -#### appraise() +### adapt() + -#### finalize() +### appraise() + -#### get_criteria_success_info() → [bitset_type](dynardo_py_algorithms.md#dynardo_py_algorithms.bitset_type) +### finalize() + -#### get_equalities() → [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type) +### get_criteria_success_info() → [bitset_type](dynardo_py_algorithms.md#dynardo_py_algorithms.bitset_type) + -#### get_inequalities() → [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type) +### get_equalities() → [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type) + -#### get_inputs() → [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type) +### get_inequalities() → [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type) + -#### get_next_designs() → [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type) +### get_inputs() → [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type) + -#### get_num_awaiting_designs() → int +### get_next_designs() → [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type) + -#### get_objectives() → [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type) +### get_num_awaiting_designs() → int + -#### get_responses() → [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type) +### get_objectives() → [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type) + -#### initialize(arg2: [AMopSettings](#amop.AMopSettings)) +### get_responses() → [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type) + -#### is_converged() → bool +### initialize(arg2: [AMopSettings](#amop.AMopSettings)) + -#### is_terminated() → bool +### is_converged() → bool + -#### set_criteria_success_info(arg2: [bitset_type](dynardo_py_algorithms.md#dynardo_py_algorithms.bitset_type)) +### is_terminated() → bool + -#### set_equalities(arg2: [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type)) +### set_criteria_success_info(arg2: [bitset_type](dynardo_py_algorithms.md#dynardo_py_algorithms.bitset_type)) + -#### set_inequalities(arg2: [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type)) +### set_equalities(arg2: [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type)) + -#### set_inputs(arg2: [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type)) +### set_inequalities(arg2: [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type)) + -#### set_objectives(arg2: [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type)) +### set_inputs(arg2: [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type)) + -#### set_responses(arg2: [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type)) +### set_objectives(arg2: [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type)) + -#### set_start_designs(arg2: [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type)) +### set_responses(arg2: [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type)) + -#### set_terminated() +### set_start_designs(arg2: [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type)) + -### *class* amop.AMopSettings +### set_terminated() + -#### \_\_init_\_() +## *class* amop.AMopSettings + -#### get_consider_failed_designs() → bool +### \_\_init_\_() + -#### get_max_iteration() → int +### get_consider_failed_designs() → bool + -#### get_min_cop() → float +### get_max_iteration() → int + -#### get_num_designs() → int +### get_min_cop() → float + -#### get_num_designs_max() → int +### get_num_designs() → int + -#### get_num_discretization_adapt() → int +### get_num_designs_max() → int + + + +### get_num_discretization_adapt() → int Return AMOP discretization number for refinement settings + -#### get_num_discretization_init() → int +### get_num_discretization_init() → int Return AMOP discretization number for start iteration settings + -#### get_num_equalities() → int +### get_num_equalities() → int + -#### get_num_inequalities() → int +### get_num_inequalities() → int + -#### get_num_inputs() → int +### get_num_inputs() → int + -#### get_num_objectives() → int +### get_num_objectives() → int + -#### get_num_responses() → int +### get_num_responses() → int + -#### get_refinement_type() → [RefinementType](#amop.RefinementType) +### get_refinement_type() → [RefinementType](#amop.RefinementType) + -#### get_sampling_type_adapt() → [DOETYPES](dynardo_py_algorithms.md#dynardo_py_algorithms.DOETYPES) +### get_sampling_type_adapt() → [DOETYPES](dynardo_py_algorithms.md#dynardo_py_algorithms.DOETYPES) + -#### get_sampling_type_init() → [DOETYPES](dynardo_py_algorithms.md#dynardo_py_algorithms.DOETYPES) +### get_sampling_type_init() → [DOETYPES](dynardo_py_algorithms.md#dynardo_py_algorithms.DOETYPES) + -#### get_stagnation_iterations() → int +### get_stagnation_iterations() → int + -#### get_use_incomplete_designs() → bool +### get_use_incomplete_designs() → bool + -#### get_use_pareto_refinement() → bool +### get_use_pareto_refinement() → bool + -#### get_use_start_designs_only() → bool +### get_use_start_designs_only() → bool + -#### get_weight_criteria() → float +### get_weight_criteria() → float + -#### get_weight_density() → float +### get_weight_density() → float + -#### get_weight_localCoP() → float +### get_weight_localCoP() → float + -#### set_consider_failed_designs(arg2: bool) +### set_consider_failed_designs(arg2: bool) + -#### set_defaults() +### set_defaults() + -#### set_lower_bounds(arg2: [vector_type](dynardo_py_algorithms.md#dynardo_py_algorithms.vector_type)) +### set_lower_bounds(arg2: [vector_type](dynardo_py_algorithms.md#dynardo_py_algorithms.vector_type)) + -#### set_max_iteration(arg2: int) +### set_max_iteration(arg2: int) + -#### set_min_cop(arg2: float) +### set_min_cop(arg2: float) + -#### set_num_designs_max(arg2: int) +### set_num_designs_max(arg2: int) + -#### set_num_discretization_adapt(num_discretization: int) +### set_num_discretization_adapt(num_discretization: int) Set AMOP discretization number for refinement + -#### set_num_discretization_init(num_discretization: int) +### set_num_discretization_init(num_discretization: int) Set AMOP discretization number for start iteration + -#### set_num_equalities(arg2: int) +### set_num_equalities(arg2: int) + -#### set_num_inequalities(arg2: int) +### set_num_inequalities(arg2: int) + -#### set_num_inputs(arg2: int) +### set_num_inputs(arg2: int) + -#### set_num_objectives(arg2: int) +### set_num_objectives(arg2: int) + -#### set_num_responses(arg2: int) +### set_num_responses(arg2: int) + -#### set_refinement_type(arg2: [RefinementType](#amop.RefinementType)) +### set_refinement_type(arg2: [RefinementType](#amop.RefinementType)) + -#### set_sampling_type_adapt(arg2: [DOETYPES](dynardo_py_algorithms.md#dynardo_py_algorithms.DOETYPES)) +### set_sampling_type_adapt(arg2: [DOETYPES](dynardo_py_algorithms.md#dynardo_py_algorithms.DOETYPES)) + -#### set_sampling_type_init(arg2: [DOETYPES](dynardo_py_algorithms.md#dynardo_py_algorithms.DOETYPES)) +### set_sampling_type_init(arg2: [DOETYPES](dynardo_py_algorithms.md#dynardo_py_algorithms.DOETYPES)) + -#### set_stagnation_iterations(arg2: int) +### set_stagnation_iterations(arg2: int) + -#### set_upper_bounds(arg2: [vector_type](dynardo_py_algorithms.md#dynardo_py_algorithms.vector_type)) +### set_upper_bounds(arg2: [vector_type](dynardo_py_algorithms.md#dynardo_py_algorithms.vector_type)) + -#### set_use_incomplete_designs(arg2: bool) +### set_use_incomplete_designs(arg2: bool) + -#### set_use_pareto_refinement(arg2: bool) +### set_use_pareto_refinement(arg2: bool) + -#### set_use_start_designs_only(arg2: bool) +### set_use_start_designs_only(arg2: bool) + -#### set_weight_criteria(arg2: float) +### set_weight_criteria(arg2: float) + -#### set_weight_density(arg2: float) +### set_weight_density(arg2: float) + -#### set_weight_localCoP(arg2: float) +### set_weight_localCoP(arg2: float) + -### *class* amop.RefinementType +## *class* amop.RefinementType **Enumeration** + -#### CRITERIA_REFINEMENT *= amop.RefinementType.CRITERIA_REFINEMENT* +### CRITERIA_REFINEMENT *= amop.RefinementType.CRITERIA_REFINEMENT* + -#### GLOBAL_REFINEMENT *= amop.RefinementType.GLOBAL_REFINEMENT* +### GLOBAL_REFINEMENT *= amop.RefinementType.GLOBAL_REFINEMENT* + -#### LOCAL_REFINEMENT *= amop.RefinementType.LOCAL_REFINEMENT* +### LOCAL_REFINEMENT *= amop.RefinementType.LOCAL_REFINEMENT* diff --git a/2025R2/optiSLang-python-api/modules/custom_types.md b/2025R2/optiSLang-python-api/modules/custom_types.md index da0c086a25..4049251a69 100644 --- a/2025R2/optiSLang-python-api/modules/custom_types.md +++ b/2025R2/optiSLang-python-api/modules/custom_types.md @@ -1,135 +1,161 @@ + -### *class* custom_types.HidSpecificInputData +# custom_types + + + +## *class* custom_types.HidSpecificInputData An aggregate of input arguments per hid. + -#### \_\_init_\_() +### \_\_init_\_() + -#### *property* hid +### *property* hid Hierarchical ID of a design variation, for example, [0.99.4] + -#### *property* input_file +### *property* input_file Input file. + -#### *property* input_file_encoding +### *property* input_file_encoding Input file encoding. + -#### *property* input_slot_values +### *property* input_slot_values A dict where slot names are keys and items are the slot values. + -#### *property* osl_variables +### *property* osl_variables A dict where the keys are optiSLang application specific variables names and items their respective values. + -#### *property* reference_file +### *property* reference_file Reference file. + -#### *property* reference_file_encoding +### *property* reference_file_encoding Reference file encoding. + -#### *property* reference_file_is_relative_to_working_directory +### *property* reference_file_is_relative_to_working_directory Whether “reference_file” is specified relative to working directory. + -#### *property* working_dir_hierarchy +### *property* working_dir_hierarchy The nodes working directory hierarchy. + -#### *property* working_directory +### *property* working_directory String. The nodes working directory. + -### *class* custom_types.HidSpecificInputDataIntegrations +## *class* custom_types.HidSpecificInputDataIntegrations + -#### \_\_init_\_() +### \_\_init_\_() + -#### *property* parameter_values +### *property* parameter_values Parameter values of a specific HId. + -### *class* custom_types.HidSpecificOutputData +## *class* custom_types.HidSpecificOutputData An aggregate of output arguments per hid. + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [HID](id.md#id.HID)) +### \_\_init_\_(arg2: [HID](id.md#id.HID)) -#### \_\_init_\_(arg2: [HID](id.md#id.HID), arg3: [RunStatus](#custom_types.RunStatus)) +### \_\_init_\_(arg2: [HID](id.md#id.HID), arg3: [RunStatus](#custom_types.RunStatus)) -#### \_\_init_\_(arg2: [HidSpecificInputData](#custom_types.HidSpecificInputData)) +### \_\_init_\_(arg2: [HidSpecificInputData](#custom_types.HidSpecificInputData)) -#### \_\_init_\_(arg2: [HidSpecificInputData](#custom_types.HidSpecificInputData), arg3: [RunStatus](#custom_types.RunStatus)) +### \_\_init_\_(arg2: [HidSpecificInputData](#custom_types.HidSpecificInputData), arg3: [RunStatus](#custom_types.RunStatus)) -#### \_\_init_\_(hid: [HID](id.md#id.HID), run_status: [RunStatus](#custom_types.RunStatus), output_slot_values: dict) → object +### \_\_init_\_(hid: [HID](id.md#id.HID), run_status: [RunStatus](#custom_types.RunStatus), output_slot_values: dict) → object -#### \_\_init_\_(input_data: [HidSpecificInputData](#custom_types.HidSpecificInputData), run_status: [RunStatus](#custom_types.RunStatus), output_slot_values: dict) → object +### \_\_init_\_(input_data: [HidSpecificInputData](#custom_types.HidSpecificInputData), run_status: [RunStatus](#custom_types.RunStatus), output_slot_values: dict) → object [5] Create a HidSpecificOutputData instance. [6] Create a HidSpecificOutputData instance. + -#### *property* hid +### *property* hid Hierarchical ID of a design variation, for example, [0.99.4] + -#### *property* output_slot_values +### *property* output_slot_values A dict where keys are the output slot names and items are the output slot values. + -#### *property* status +### *property* status RunStatus object. + -### *class* custom_types.HidSpecificOutputDataIntegrations +## *class* custom_types.HidSpecificOutputDataIntegrations An aggregate of output arguments per hid. Specialization for integration node. + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(hid: [HID](id.md#id.HID)) +### \_\_init_\_(hid: [HID](id.md#id.HID)) -#### \_\_init_\_(hid: [HID](id.md#id.HID), run_status: [RunStatus](#custom_types.RunStatus)) +### \_\_init_\_(hid: [HID](id.md#id.HID), run_status: [RunStatus](#custom_types.RunStatus)) -#### \_\_init_\_(input_data: [HidSpecificInputData](#custom_types.HidSpecificInputData)) +### \_\_init_\_(input_data: [HidSpecificInputData](#custom_types.HidSpecificInputData)) -#### \_\_init_\_(input_data: [HidSpecificInputData](#custom_types.HidSpecificInputData), run_status: [RunStatus](#custom_types.RunStatus)) +### \_\_init_\_(input_data: [HidSpecificInputData](#custom_types.HidSpecificInputData), run_status: [RunStatus](#custom_types.RunStatus)) -#### \_\_init_\_(hid: [HID](id.md#id.HID), run_status: [RunStatus](#custom_types.RunStatus), output_slot_values: dict) → object +### \_\_init_\_(hid: [HID](id.md#id.HID), run_status: [RunStatus](#custom_types.RunStatus), output_slot_values: dict) → object -#### \_\_init_\_(hid: [HID](id.md#id.HID), run_status: [RunStatus](#custom_types.RunStatus), output_slot_values: dict, response_values: [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint)) → object +### \_\_init_\_(hid: [HID](id.md#id.HID), run_status: [RunStatus](#custom_types.RunStatus), output_slot_values: dict, response_values: [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint)) → object -#### \_\_init_\_(input_data: [HidSpecificInputData](#custom_types.HidSpecificInputData), run_status: [RunStatus](#custom_types.RunStatus), output_slot_values: dict) → object +### \_\_init_\_(input_data: [HidSpecificInputData](#custom_types.HidSpecificInputData), run_status: [RunStatus](#custom_types.RunStatus), output_slot_values: dict) → object -#### \_\_init_\_(input_data: [HidSpecificInputData](#custom_types.HidSpecificInputData), run_status: [RunStatus](#custom_types.RunStatus), output_slot_values: dict, response_values: [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint)) → object +### \_\_init_\_(input_data: [HidSpecificInputData](#custom_types.HidSpecificInputData), run_status: [RunStatus](#custom_types.RunStatus), output_slot_values: dict, response_values: [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint)) → object [1] Create a HidSpecificOutputDataIntegrations instance. @@ -147,39 +173,43 @@ An aggregate of output arguments per hid. Specialization for integration node. [8] Create a HidSpecificOutputDataIntegrations instance. + -#### *property* adapted_parameter_values +### *property* adapted_parameter_values Adapted parameter values of a specific HId. + -#### *property* responses +### *property* responses Response values of a specific HId. + -### *class* custom_types.HidSpecificOutputDataMop +## *class* custom_types.HidSpecificOutputDataMop An aggregate of output arguments per hid. Specialization for MOP node. + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(hid: [HID](id.md#id.HID)) +### \_\_init_\_(hid: [HID](id.md#id.HID)) -#### \_\_init_\_(hid: [HID](id.md#id.HID), run_status: [RunStatus](#custom_types.RunStatus)) +### \_\_init_\_(hid: [HID](id.md#id.HID), run_status: [RunStatus](#custom_types.RunStatus)) -#### \_\_init_\_(input_data: [HidSpecificInputData](#custom_types.HidSpecificInputData)) +### \_\_init_\_(input_data: [HidSpecificInputData](#custom_types.HidSpecificInputData)) -#### \_\_init_\_(input_data: [HidSpecificInputData](#custom_types.HidSpecificInputData), run_status: [RunStatus](#custom_types.RunStatus)) +### \_\_init_\_(input_data: [HidSpecificInputData](#custom_types.HidSpecificInputData), run_status: [RunStatus](#custom_types.RunStatus)) -#### \_\_init_\_(hid: [HID](id.md#id.HID), run_status: [RunStatus](#custom_types.RunStatus), output_slot_values: dict) → object +### \_\_init_\_(hid: [HID](id.md#id.HID), run_status: [RunStatus](#custom_types.RunStatus), output_slot_values: dict) → object -#### \_\_init_\_(hid: [HID](id.md#id.HID), run_status: [RunStatus](#custom_types.RunStatus), output_slot_values: dict, resulting_parameter_manager: [PyParameterManager](py_os_parameter.md#py_os_parameter.PyParameterManager)) → object +### \_\_init_\_(hid: [HID](id.md#id.HID), run_status: [RunStatus](#custom_types.RunStatus), output_slot_values: dict, resulting_parameter_manager: [PyParameterManager](py_os_parameter.md#py_os_parameter.PyParameterManager)) → object -#### \_\_init_\_(input_data: [HidSpecificInputData](#custom_types.HidSpecificInputData), run_status: [RunStatus](#custom_types.RunStatus), output_slot_values: dict) → object +### \_\_init_\_(input_data: [HidSpecificInputData](#custom_types.HidSpecificInputData), run_status: [RunStatus](#custom_types.RunStatus), output_slot_values: dict) → object -#### \_\_init_\_(input_data: [HidSpecificInputData](#custom_types.HidSpecificInputData), run_status: [RunStatus](#custom_types.RunStatus), output_slot_values: dict, resulting_parameter_manager: [PyParameterManager](py_os_parameter.md#py_os_parameter.PyParameterManager)) → object +### \_\_init_\_(input_data: [HidSpecificInputData](#custom_types.HidSpecificInputData), run_status: [RunStatus](#custom_types.RunStatus), output_slot_values: dict, resulting_parameter_manager: [PyParameterManager](py_os_parameter.md#py_os_parameter.PyParameterManager)) → object [1] Create a HidSpecificOutputDataMop instance. @@ -197,103 +227,123 @@ An aggregate of output arguments per hid. Specialization for MOP node. [8] Create a HidSpecificOutputDataMop instance. + -#### *property* resulting_parameter_manager +### *property* resulting_parameter_manager A class for managing parameters. + -### *class* custom_types.InputDefinition +## *class* custom_types.InputDefinition Defining the inputs. + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str, arg3: [PyOSDesignEntry](py_os_design.md#py_os_design.PyOSDesignEntry)) +### \_\_init_\_(arg2: str, arg3: [PyOSDesignEntry](py_os_design.md#py_os_design.PyOSDesignEntry)) + -#### *property* discrete_states +### *property* discrete_states None or a list of design entries. + -#### *property* lower_bound +### *property* lower_bound The lower bound or None. + -#### *property* mean +### *property* mean The value’s mean or None. + -#### *property* random_variable_type +### *property* random_variable_type The random variable’s type or None. + -#### *property* standard_deviation +### *property* standard_deviation The standard deviation or None. + -#### *property* upper_bound +### *property* upper_bound The upper bound or None. + -### *class* custom_types.OutputDefinition +## *class* custom_types.OutputDefinition Defining the outputs. + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) -#### \_\_init_\_(arg2: str, arg3: [PyOSDesignEntry](py_os_design.md#py_os_design.PyOSDesignEntry)) +### \_\_init_\_(arg2: str, arg3: [PyOSDesignEntry](py_os_design.md#py_os_design.PyOSDesignEntry)) + -### *class* custom_types.RunStatus +## *class* custom_types.RunStatus An object for documenting success and loggin purpose. + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: bool) +### \_\_init_\_(arg2: bool) -#### \_\_init_\_(arg2: bool, arg3: str) +### \_\_init_\_(arg2: bool, arg3: str) + -#### *property* message +### *property* message Message for logging purpose. + -#### *property* success +### *property* success Flag for documenting success. + -### *class* custom_types.ValueDefinition +## *class* custom_types.ValueDefinition Common base for InputValueDefintion and OutputDefinition + -#### \_\_init_\_() +### \_\_init_\_() Raises an exception This class cannot be instantiated from Python + -#### *property* additional_data +### *property* additional_data Extend the list view of detected inputs and outputs by additional columns where “key” is the column headers and “item” is the corresponding field value. A tree structure for grouping the data can be build here as well: Providing “”entry_n” : “ANodeLabel””, where n can be 1-9, the current ValueDefinition is assigned to the specified group. + -#### *property* name +### *property* name + -#### *property* value +### *property* value diff --git a/2025R2/optiSLang-python-api/modules/dynardo_py_algorithms.md b/2025R2/optiSLang-python-api/modules/dynardo_py_algorithms.md index ff1ec9a1d7..efed65ec07 100644 --- a/2025R2/optiSLang-python-api/modules/dynardo_py_algorithms.md +++ b/2025R2/optiSLang-python-api/modules/dynardo_py_algorithms.md @@ -1,519 +1,686 @@ + -### *class* dynardo_py_algorithms.DOETYPES +# dynardo_py_algorithms + + + +## *class* dynardo_py_algorithms.DOETYPES **Enumeration** + -#### ADVANCEDLATINHYPER *= dynardo_py_algorithms.DOETYPES.ADVANCEDLATINHYPER* +### ADVANCEDLATINHYPER *= dynardo_py_algorithms.DOETYPES.ADVANCEDLATINHYPER* + -#### AXIAL *= dynardo_py_algorithms.DOETYPES.AXIAL* +### AXIAL *= dynardo_py_algorithms.DOETYPES.AXIAL* + -#### BOXBEHNKEN *= dynardo_py_algorithms.DOETYPES.BOXBEHNKEN* +### BOXBEHNKEN *= dynardo_py_algorithms.DOETYPES.BOXBEHNKEN* + -#### CENTERPOINT *= dynardo_py_algorithms.DOETYPES.CENTERPOINT* +### CENTERPOINT *= dynardo_py_algorithms.DOETYPES.CENTERPOINT* + -#### CENTRALCOMPOSITE *= dynardo_py_algorithms.DOETYPES.CENTRALCOMPOSITE* +### CENTRALCOMPOSITE *= dynardo_py_algorithms.DOETYPES.CENTRALCOMPOSITE* + -#### DOPTIMAL *= dynardo_py_algorithms.DOETYPES.DOPTIMAL* +### DOPTIMAL *= dynardo_py_algorithms.DOETYPES.DOPTIMAL* + -#### DOPTIMALLINEAR *= dynardo_py_algorithms.DOETYPES.DOPTIMALLINEAR* +### DOPTIMALLINEAR *= dynardo_py_algorithms.DOETYPES.DOPTIMALLINEAR* + -#### DOPTIMALQUADRATIC *= dynardo_py_algorithms.DOETYPES.DOPTIMALQUADRATIC* +### DOPTIMALQUADRATIC *= dynardo_py_algorithms.DOETYPES.DOPTIMALQUADRATIC* + -#### FEKETE *= dynardo_py_algorithms.DOETYPES.FEKETE* +### FEKETE *= dynardo_py_algorithms.DOETYPES.FEKETE* + -#### FULLCOMBINATORIAL *= dynardo_py_algorithms.DOETYPES.FULLCOMBINATORIAL* +### FULLCOMBINATORIAL *= dynardo_py_algorithms.DOETYPES.FULLCOMBINATORIAL* + -#### FULLFACTORIAL *= dynardo_py_algorithms.DOETYPES.FULLFACTORIAL* +### FULLFACTORIAL *= dynardo_py_algorithms.DOETYPES.FULLFACTORIAL* + -#### KOSHAL *= dynardo_py_algorithms.DOETYPES.KOSHAL* +### KOSHAL *= dynardo_py_algorithms.DOETYPES.KOSHAL* + -#### KOSHALLINEAR *= dynardo_py_algorithms.DOETYPES.KOSHALLINEAR* +### KOSHALLINEAR *= dynardo_py_algorithms.DOETYPES.KOSHALLINEAR* + -#### KOSHALQUADRATIC *= dynardo_py_algorithms.DOETYPES.KOSHALQUADRATIC* +### KOSHALQUADRATIC *= dynardo_py_algorithms.DOETYPES.KOSHALQUADRATIC* + -#### LATINHYPER *= dynardo_py_algorithms.DOETYPES.LATINHYPER* +### LATINHYPER *= dynardo_py_algorithms.DOETYPES.LATINHYPER* + -#### LATINHYPERDETERMINISTIC *= dynardo_py_algorithms.DOETYPES.LATINHYPERDETERMINISTIC* +### LATINHYPERDETERMINISTIC *= dynardo_py_algorithms.DOETYPES.LATINHYPERDETERMINISTIC* + -#### MIXEDTERMS *= dynardo_py_algorithms.DOETYPES.MIXEDTERMS* +### MIXEDTERMS *= dynardo_py_algorithms.DOETYPES.MIXEDTERMS* + -#### ORTHOLATINHYPERDETERMINISTIC *= dynardo_py_algorithms.DOETYPES.ORTHOLATINHYPERDETERMINISTIC* +### ORTHOLATINHYPERDETERMINISTIC *= dynardo_py_algorithms.DOETYPES.ORTHOLATINHYPERDETERMINISTIC* + -#### PLAINMONTECARLO *= dynardo_py_algorithms.DOETYPES.PLAINMONTECARLO* +### PLAINMONTECARLO *= dynardo_py_algorithms.DOETYPES.PLAINMONTECARLO* + -#### SOBOL *= dynardo_py_algorithms.DOETYPES.SOBOL* +### SOBOL *= dynardo_py_algorithms.DOETYPES.SOBOL* + -#### SPACEFILLINGLATINHYPER *= dynardo_py_algorithms.DOETYPES.SPACEFILLINGLATINHYPER* +### SPACEFILLINGLATINHYPER *= dynardo_py_algorithms.DOETYPES.SPACEFILLINGLATINHYPER* + -#### STARPOINTS *= dynardo_py_algorithms.DOETYPES.STARPOINTS* +### STARPOINTS *= dynardo_py_algorithms.DOETYPES.STARPOINTS* + -### *class* dynardo_py_algorithms.DesignTypes +## *class* dynardo_py_algorithms.DesignTypes **Enumeration** + -#### eGRADIENT *= dynardo_py_algorithms.DesignTypes.eGRADIENT* +### eGRADIENT *= dynardo_py_algorithms.DesignTypes.eGRADIENT* + -#### eITERATION_BEST *= dynardo_py_algorithms.DesignTypes.eITERATION_BEST* +### eITERATION_BEST *= dynardo_py_algorithms.DesignTypes.eITERATION_BEST* + -#### eNEW_POP *= dynardo_py_algorithms.DesignTypes.eNEW_POP* +### eNEW_POP *= dynardo_py_algorithms.DesignTypes.eNEW_POP* + -#### eNONE *= dynardo_py_algorithms.DesignTypes.eNONE* +### eNONE *= dynardo_py_algorithms.DesignTypes.eNONE* + -#### eOBJECTIVE *= dynardo_py_algorithms.DesignTypes.eOBJECTIVE* +### eOBJECTIVE *= dynardo_py_algorithms.DesignTypes.eOBJECTIVE* + -#### eSUPPORT_POINT *= dynardo_py_algorithms.DesignTypes.eSUPPORT_POINT* +### eSUPPORT_POINT *= dynardo_py_algorithms.DesignTypes.eSUPPORT_POINT* + -### *class* dynardo_py_algorithms.DeterministicType +## *class* dynardo_py_algorithms.DeterministicType **Enumeration** + -#### CONTINUOUS *= dynardo_py_algorithms.DeterministicType.CONTINUOUS* +### CONTINUOUS *= dynardo_py_algorithms.DeterministicType.CONTINUOUS* + -#### NOMINALDISCRETE *= dynardo_py_algorithms.DeterministicType.NOMINALDISCRETE* +### NOMINALDISCRETE *= dynardo_py_algorithms.DeterministicType.NOMINALDISCRETE* + -#### ORDINALDISCRETE_INDEX *= dynardo_py_algorithms.DeterministicType.ORDINALDISCRETE_INDEX* +### ORDINALDISCRETE_INDEX *= dynardo_py_algorithms.DeterministicType.ORDINALDISCRETE_INDEX* + -#### ORDINALDISCRETE_VALUE *= dynardo_py_algorithms.DeterministicType.ORDINALDISCRETE_VALUE* +### ORDINALDISCRETE_VALUE *= dynardo_py_algorithms.DeterministicType.ORDINALDISCRETE_VALUE* + -### *class* dynardo_py_algorithms.DeterministicTypeVec +## *class* dynardo_py_algorithms.DeterministicTypeVec + -#### \_\_contains_\_(arg2: object) → bool +### \_\_contains_\_(arg2: object) → bool + -#### \_\_delitem_\_(arg2: object) +### \_\_delitem_\_(arg2: object) + -#### \_\_getitem_\_(arg2: object) → object +### \_\_getitem_\_(arg2: object) → object + -#### \_\_init_\_() +### \_\_init_\_() + -#### \_\_iter_\_() → object +### \_\_iter_\_() → object + -#### \_\_len_\_() → int +### \_\_len_\_() → int + -#### \_\_setitem_\_(arg2: object, arg3: object) +### \_\_setitem_\_(arg2: object, arg3: object) + -#### append(arg2: object) +### append(arg2: object) + -#### extend(arg2: object) +### extend(arg2: object) + -#### push_back(arg2: [DeterministicType](#dynardo_py_algorithms.DeterministicType)) +### push_back(arg2: [DeterministicType](#dynardo_py_algorithms.DeterministicType)) + -#### size() → int +### size() → int + -### dynardo_py_algorithms.DeterministicType_list_to_vec(arg1: list) → [DeterministicTypeVec](#dynardo_py_algorithms.DeterministicTypeVec) +## dynardo_py_algorithms.DeterministicType_list_to_vec(arg1: list) → [DeterministicTypeVec](#dynardo_py_algorithms.DeterministicTypeVec) -### dynardo_py_algorithms.DeterministicType_list_to_vec(arg1: list) → [DeterministicTypeVec](#dynardo_py_algorithms.DeterministicTypeVec) +## dynardo_py_algorithms.DeterministicType_list_to_vec(arg1: list) → [DeterministicTypeVec](#dynardo_py_algorithms.DeterministicTypeVec) + -### *class* dynardo_py_algorithms.ParameterType +## *class* dynardo_py_algorithms.ParameterType **Enumeration** + -#### DEPENDENT *= dynardo_py_algorithms.ParameterType.DEPENDENT* +### DEPENDENT *= dynardo_py_algorithms.ParameterType.DEPENDENT* + -#### DETERMINISTIC *= dynardo_py_algorithms.ParameterType.DETERMINISTIC* +### DETERMINISTIC *= dynardo_py_algorithms.ParameterType.DETERMINISTIC* + -#### MIXED *= dynardo_py_algorithms.ParameterType.MIXED* +### MIXED *= dynardo_py_algorithms.ParameterType.MIXED* + -#### STOCHASTIC *= dynardo_py_algorithms.ParameterType.STOCHASTIC* +### STOCHASTIC *= dynardo_py_algorithms.ParameterType.STOCHASTIC* + -### *class* dynardo_py_algorithms.RandomVariableKind +## *class* dynardo_py_algorithms.RandomVariableKind **Enumeration** + -#### DETERMINISTIC *= dynardo_py_algorithms.RandomVariableKind.DETERMINISTIC* +### DETERMINISTIC *= dynardo_py_algorithms.RandomVariableKind.DETERMINISTIC* + -#### EMPIRICAL_CONTINUOUS *= dynardo_py_algorithms.RandomVariableKind.EMPIRICAL_CONTINUOUS* +### EMPIRICAL_CONTINUOUS *= dynardo_py_algorithms.RandomVariableKind.EMPIRICAL_CONTINUOUS* + -#### EMPIRICAL_DISCRETE *= dynardo_py_algorithms.RandomVariableKind.EMPIRICAL_DISCRETE* +### EMPIRICAL_DISCRETE *= dynardo_py_algorithms.RandomVariableKind.EMPIRICAL_DISCRETE* + -#### MARGINALDISTRIBUTION *= dynardo_py_algorithms.RandomVariableKind.MARGINALDISTRIBUTION* +### MARGINALDISTRIBUTION *= dynardo_py_algorithms.RandomVariableKind.MARGINALDISTRIBUTION* + -### *class* dynardo_py_algorithms.RandomVariableType +## *class* dynardo_py_algorithms.RandomVariableType **Enumeration** + -#### BERNOULLI *= dynardo_py_algorithms.RandomVariableType.BERNOULLI* +### BERNOULLI *= dynardo_py_algorithms.RandomVariableType.BERNOULLI* + -#### BETA *= dynardo_py_algorithms.RandomVariableType.BETA* +### BETA *= dynardo_py_algorithms.RandomVariableType.BETA* + -#### CHI_SQUARE *= dynardo_py_algorithms.RandomVariableType.CHI_SQUARE* +### CHI_SQUARE *= dynardo_py_algorithms.RandomVariableType.CHI_SQUARE* + -#### ERLANG *= dynardo_py_algorithms.RandomVariableType.ERLANG* +### ERLANG *= dynardo_py_algorithms.RandomVariableType.ERLANG* + -#### EXPONENTIAL *= dynardo_py_algorithms.RandomVariableType.EXPONENTIAL* +### EXPONENTIAL *= dynardo_py_algorithms.RandomVariableType.EXPONENTIAL* + -#### EXTERNAL *= dynardo_py_algorithms.RandomVariableType.EXTERNAL* +### EXTERNAL *= dynardo_py_algorithms.RandomVariableType.EXTERNAL* + -#### EXTERNALCOHERENCE *= dynardo_py_algorithms.RandomVariableType.EXTERNALCOHERENCE* +### EXTERNALCOHERENCE *= dynardo_py_algorithms.RandomVariableType.EXTERNALCOHERENCE* + -#### EXTREME_VALUE *= dynardo_py_algorithms.RandomVariableType.EXTREME_VALUE* +### EXTREME_VALUE *= dynardo_py_algorithms.RandomVariableType.EXTREME_VALUE* + -#### FISHER_F *= dynardo_py_algorithms.RandomVariableType.FISHER_F* +### FISHER_F *= dynardo_py_algorithms.RandomVariableType.FISHER_F* + -#### FISHER_TIPPETT *= dynardo_py_algorithms.RandomVariableType.FISHER_TIPPETT* +### FISHER_TIPPETT *= dynardo_py_algorithms.RandomVariableType.FISHER_TIPPETT* + -#### FISHER_Z *= dynardo_py_algorithms.RandomVariableType.FISHER_Z* +### FISHER_Z *= dynardo_py_algorithms.RandomVariableType.FISHER_Z* + -#### FRECHET *= dynardo_py_algorithms.RandomVariableType.FRECHET* +### FRECHET *= dynardo_py_algorithms.RandomVariableType.FRECHET* + -#### GAMMA *= dynardo_py_algorithms.RandomVariableType.GAMMA* +### GAMMA *= dynardo_py_algorithms.RandomVariableType.GAMMA* + -#### GENERAL_DISCRETE *= dynardo_py_algorithms.RandomVariableType.GENERAL_DISCRETE* +### GENERAL_DISCRETE *= dynardo_py_algorithms.RandomVariableType.GENERAL_DISCRETE* + -#### GUMBEL *= dynardo_py_algorithms.RandomVariableType.GUMBEL* +### GUMBEL *= dynardo_py_algorithms.RandomVariableType.GUMBEL* + -#### INVERSE_NORMAL *= dynardo_py_algorithms.RandomVariableType.INVERSE_NORMAL* +### INVERSE_NORMAL *= dynardo_py_algorithms.RandomVariableType.INVERSE_NORMAL* + -#### KERNEL *= dynardo_py_algorithms.RandomVariableType.KERNEL* +### KERNEL *= dynardo_py_algorithms.RandomVariableType.KERNEL* + -#### LAMBDA *= dynardo_py_algorithms.RandomVariableType.LAMBDA* +### LAMBDA *= dynardo_py_algorithms.RandomVariableType.LAMBDA* + -#### LAPLACE *= dynardo_py_algorithms.RandomVariableType.LAPLACE* +### LAPLACE *= dynardo_py_algorithms.RandomVariableType.LAPLACE* + -#### LARGE_I *= dynardo_py_algorithms.RandomVariableType.LARGE_I* +### LARGE_I *= dynardo_py_algorithms.RandomVariableType.LARGE_I* + -#### LARGE_II *= dynardo_py_algorithms.RandomVariableType.LARGE_II* +### LARGE_II *= dynardo_py_algorithms.RandomVariableType.LARGE_II* + -#### LARGE_III *= dynardo_py_algorithms.RandomVariableType.LARGE_III* +### LARGE_III *= dynardo_py_algorithms.RandomVariableType.LARGE_III* + -#### LEVY *= dynardo_py_algorithms.RandomVariableType.LEVY* +### LEVY *= dynardo_py_algorithms.RandomVariableType.LEVY* + -#### LOGISTIC *= dynardo_py_algorithms.RandomVariableType.LOGISTIC* +### LOGISTIC *= dynardo_py_algorithms.RandomVariableType.LOGISTIC* + -#### LOGNORMAL *= dynardo_py_algorithms.RandomVariableType.LOGNORMAL* +### LOGNORMAL *= dynardo_py_algorithms.RandomVariableType.LOGNORMAL* + -#### LOGUNIFORM *= dynardo_py_algorithms.RandomVariableType.LOGUNIFORM* +### LOGUNIFORM *= dynardo_py_algorithms.RandomVariableType.LOGUNIFORM* + -#### LOG_GAMMA *= dynardo_py_algorithms.RandomVariableType.LOG_GAMMA* +### LOG_GAMMA *= dynardo_py_algorithms.RandomVariableType.LOG_GAMMA* + -#### LOG_NORMAL *= dynardo_py_algorithms.RandomVariableType.LOG_NORMAL* +### LOG_NORMAL *= dynardo_py_algorithms.RandomVariableType.LOG_NORMAL* + -#### LORENTZ *= dynardo_py_algorithms.RandomVariableType.LORENTZ* +### LORENTZ *= dynardo_py_algorithms.RandomVariableType.LORENTZ* + -#### MAX_TYPE *= dynardo_py_algorithms.RandomVariableType.MAX_TYPE* +### MAX_TYPE *= dynardo_py_algorithms.RandomVariableType.MAX_TYPE* + -#### MULTIUNIFORM *= dynardo_py_algorithms.RandomVariableType.MULTIUNIFORM* +### MULTIUNIFORM *= dynardo_py_algorithms.RandomVariableType.MULTIUNIFORM* + -#### NORMAL *= dynardo_py_algorithms.RandomVariableType.NORMAL* +### NORMAL *= dynardo_py_algorithms.RandomVariableType.NORMAL* + -#### PARETO *= dynardo_py_algorithms.RandomVariableType.PARETO* +### PARETO *= dynardo_py_algorithms.RandomVariableType.PARETO* + -#### POISSON *= dynardo_py_algorithms.RandomVariableType.POISSON* +### POISSON *= dynardo_py_algorithms.RandomVariableType.POISSON* + -#### POLYMAP *= dynardo_py_algorithms.RandomVariableType.POLYMAP* +### POLYMAP *= dynardo_py_algorithms.RandomVariableType.POLYMAP* + -#### RAYLEIGH *= dynardo_py_algorithms.RandomVariableType.RAYLEIGH* +### RAYLEIGH *= dynardo_py_algorithms.RandomVariableType.RAYLEIGH* + -#### ROSSI *= dynardo_py_algorithms.RandomVariableType.ROSSI* +### ROSSI *= dynardo_py_algorithms.RandomVariableType.ROSSI* + -#### SMALL_I *= dynardo_py_algorithms.RandomVariableType.SMALL_I* +### SMALL_I *= dynardo_py_algorithms.RandomVariableType.SMALL_I* + -#### SMALL_II *= dynardo_py_algorithms.RandomVariableType.SMALL_II* +### SMALL_II *= dynardo_py_algorithms.RandomVariableType.SMALL_II* + -#### SMALL_III *= dynardo_py_algorithms.RandomVariableType.SMALL_III* +### SMALL_III *= dynardo_py_algorithms.RandomVariableType.SMALL_III* + -#### STUDENTS_T *= dynardo_py_algorithms.RandomVariableType.STUDENTS_T* +### STUDENTS_T *= dynardo_py_algorithms.RandomVariableType.STUDENTS_T* + -#### TRIANGULAR *= dynardo_py_algorithms.RandomVariableType.TRIANGULAR* +### TRIANGULAR *= dynardo_py_algorithms.RandomVariableType.TRIANGULAR* + -#### TRUNCATEDNORMAL *= dynardo_py_algorithms.RandomVariableType.TRUNCATEDNORMAL* +### TRUNCATEDNORMAL *= dynardo_py_algorithms.RandomVariableType.TRUNCATEDNORMAL* + -#### UNIFORM *= dynardo_py_algorithms.RandomVariableType.UNIFORM* +### UNIFORM *= dynardo_py_algorithms.RandomVariableType.UNIFORM* + -#### UNTYPED *= dynardo_py_algorithms.RandomVariableType.UNTYPED* +### UNTYPED *= dynardo_py_algorithms.RandomVariableType.UNTYPED* + -#### WEIBULL *= dynardo_py_algorithms.RandomVariableType.WEIBULL* +### WEIBULL *= dynardo_py_algorithms.RandomVariableType.WEIBULL* + -### *class* dynardo_py_algorithms.RandomVariableTypeVec +## *class* dynardo_py_algorithms.RandomVariableTypeVec + -#### \_\_contains_\_(arg2: object) → bool +### \_\_contains_\_(arg2: object) → bool + -#### \_\_delitem_\_(arg2: object) +### \_\_delitem_\_(arg2: object) + -#### \_\_getitem_\_(arg2: object) → object +### \_\_getitem_\_(arg2: object) → object + -#### \_\_init_\_() +### \_\_init_\_() + -#### \_\_iter_\_() → object +### \_\_iter_\_() → object -#### \_\_iter_\_() → object +### \_\_iter_\_() → object + -#### \_\_len_\_() → int +### \_\_len_\_() → int + -#### \_\_setitem_\_(arg2: object, arg3: object) +### \_\_setitem_\_(arg2: object, arg3: object) + -#### append(arg2: object) +### append(arg2: object) + -#### extend(arg2: object) +### extend(arg2: object) + -#### push_back(arg2: [RandomVariableType](#dynardo_py_algorithms.RandomVariableType)) +### push_back(arg2: [RandomVariableType](#dynardo_py_algorithms.RandomVariableType)) + -#### size() → int +### size() → int + -### *class* dynardo_py_algorithms.SupportedAlgorithms +## *class* dynardo_py_algorithms.SupportedAlgorithms **Enumeration** + -#### APPROXIMATION *= dynardo_py_algorithms.SupportedAlgorithms.APPROXIMATION* +### APPROXIMATION *= dynardo_py_algorithms.SupportedAlgorithms.APPROXIMATION* + -#### ARSM *= dynardo_py_algorithms.SupportedAlgorithms.ARSM* +### ARSM *= dynardo_py_algorithms.SupportedAlgorithms.ARSM* + -#### CMA *= dynardo_py_algorithms.SupportedAlgorithms.CMA* +### CMA *= dynardo_py_algorithms.SupportedAlgorithms.CMA* + -#### CUSTOM_OPTIMIZATION *= dynardo_py_algorithms.SupportedAlgorithms.CUSTOM_OPTIMIZATION* +### CUSTOM_OPTIMIZATION *= dynardo_py_algorithms.SupportedAlgorithms.CUSTOM_OPTIMIZATION* + -#### CUSTOM_SAMPLING *= dynardo_py_algorithms.SupportedAlgorithms.CUSTOM_SAMPLING* +### CUSTOM_SAMPLING *= dynardo_py_algorithms.SupportedAlgorithms.CUSTOM_SAMPLING* + -#### CUSTOM_STOCHASTIC *= dynardo_py_algorithms.SupportedAlgorithms.CUSTOM_STOCHASTIC* +### CUSTOM_STOCHASTIC *= dynardo_py_algorithms.SupportedAlgorithms.CUSTOM_STOCHASTIC* + -#### EA *= dynardo_py_algorithms.SupportedAlgorithms.EA* +### EA *= dynardo_py_algorithms.SupportedAlgorithms.EA* + -#### IMPORTED *= dynardo_py_algorithms.SupportedAlgorithms.IMPORTED* +### IMPORTED *= dynardo_py_algorithms.SupportedAlgorithms.IMPORTED* + -#### MEMETIC *= dynardo_py_algorithms.SupportedAlgorithms.MEMETIC* +### MEMETIC *= dynardo_py_algorithms.SupportedAlgorithms.MEMETIC* + -#### MOP3 *= dynardo_py_algorithms.SupportedAlgorithms.MOP3* +### MOP3 *= dynardo_py_algorithms.SupportedAlgorithms.MOP3* + -#### NLPQL *= dynardo_py_algorithms.SupportedAlgorithms.NLPQL* +### NLPQL *= dynardo_py_algorithms.SupportedAlgorithms.NLPQL* + -#### PARAMETRIC_SERVICE *= dynardo_py_algorithms.SupportedAlgorithms.PARAMETRIC_SERVICE* +### PARAMETRIC_SERVICE *= dynardo_py_algorithms.SupportedAlgorithms.PARAMETRIC_SERVICE* + -#### PSO *= dynardo_py_algorithms.SupportedAlgorithms.PSO* +### PSO *= dynardo_py_algorithms.SupportedAlgorithms.PSO* + -#### RDO *= dynardo_py_algorithms.SupportedAlgorithms.RDO* +### RDO *= dynardo_py_algorithms.SupportedAlgorithms.RDO* + -#### RELIABILITY *= dynardo_py_algorithms.SupportedAlgorithms.RELIABILITY* +### RELIABILITY *= dynardo_py_algorithms.SupportedAlgorithms.RELIABILITY* + -#### RELI_AS *= dynardo_py_algorithms.SupportedAlgorithms.RELI_AS* +### RELI_AS *= dynardo_py_algorithms.SupportedAlgorithms.RELI_AS* + -#### RELI_DS *= dynardo_py_algorithms.SupportedAlgorithms.RELI_DS* +### RELI_DS *= dynardo_py_algorithms.SupportedAlgorithms.RELI_DS* + -#### RELI_DS_ARSM *= dynardo_py_algorithms.SupportedAlgorithms.RELI_DS_ARSM* +### RELI_DS_ARSM *= dynardo_py_algorithms.SupportedAlgorithms.RELI_DS_ARSM* + -#### RELI_FORM *= dynardo_py_algorithms.SupportedAlgorithms.RELI_FORM* +### RELI_FORM *= dynardo_py_algorithms.SupportedAlgorithms.RELI_FORM* + -#### RELI_ISPUD *= dynardo_py_algorithms.SupportedAlgorithms.RELI_ISPUD* +### RELI_ISPUD *= dynardo_py_algorithms.SupportedAlgorithms.RELI_ISPUD* + -#### RELI_MCS *= dynardo_py_algorithms.SupportedAlgorithms.RELI_MCS* +### RELI_MCS *= dynardo_py_algorithms.SupportedAlgorithms.RELI_MCS* + -#### ROBUSTNESS *= dynardo_py_algorithms.SupportedAlgorithms.ROBUSTNESS* +### ROBUSTNESS *= dynardo_py_algorithms.SupportedAlgorithms.ROBUSTNESS* + -#### SDI *= dynardo_py_algorithms.SupportedAlgorithms.SDI* +### SDI *= dynardo_py_algorithms.SupportedAlgorithms.SDI* + -#### SENSITIVITY *= dynardo_py_algorithms.SupportedAlgorithms.SENSITIVITY* +### SENSITIVITY *= dynardo_py_algorithms.SupportedAlgorithms.SENSITIVITY* + -#### SIMPLEX *= dynardo_py_algorithms.SupportedAlgorithms.SIMPLEX* +### SIMPLEX *= dynardo_py_algorithms.SupportedAlgorithms.SIMPLEX* + -#### UNKNOWN *= dynardo_py_algorithms.SupportedAlgorithms.UNKNOWN* +### UNKNOWN *= dynardo_py_algorithms.SupportedAlgorithms.UNKNOWN* + -### *class* dynardo_py_algorithms.bitset_type +## *class* dynardo_py_algorithms.bitset_type + -#### \_\_init_\_() +### \_\_init_\_() + -### dynardo_py_algorithms.bool_list_to_bitset(bit_data: list) → [bitset_type](#dynardo_py_algorithms.bitset_type) +## dynardo_py_algorithms.bool_list_to_bitset(bit_data: list) → [bitset_type](#dynardo_py_algorithms.bitset_type) + -### dynardo_py_algorithms.get_row(matrix: [matrix_type](#dynardo_py_algorithms.matrix_type), rownum: int) → [vector_type](#dynardo_py_algorithms.vector_type) +## dynardo_py_algorithms.get_row(matrix: [matrix_type](#dynardo_py_algorithms.matrix_type), rownum: int) → [vector_type](#dynardo_py_algorithms.vector_type) Fetch row of index rownum from matrix and return it as a vector. + -### dynardo_py_algorithms.list_list_to_dynardo_matrix(data: list) → [matrix_type](#dynardo_py_algorithms.matrix_type) +## dynardo_py_algorithms.list_list_to_dynardo_matrix(data: list) → [matrix_type](#dynardo_py_algorithms.matrix_type) Create a matrix from a list of lists. + -### dynardo_py_algorithms.list_to_dynardo_vector(data: list) → [vector_type](#dynardo_py_algorithms.vector_type) +## dynardo_py_algorithms.list_to_dynardo_vector(data: list) → [vector_type](#dynardo_py_algorithms.vector_type) Create a vector from a list. + -### dynardo_py_algorithms.list_to_vec(arg1: list) → [DeterministicTypeVec](#dynardo_py_algorithms.DeterministicTypeVec) +## dynardo_py_algorithms.list_to_vec(arg1: list) → [DeterministicTypeVec](#dynardo_py_algorithms.DeterministicTypeVec) -### dynardo_py_algorithms.list_to_vec(arg1: list) → [DeterministicTypeVec](#dynardo_py_algorithms.DeterministicTypeVec) +## dynardo_py_algorithms.list_to_vec(arg1: list) → [DeterministicTypeVec](#dynardo_py_algorithms.DeterministicTypeVec) + -### *class* dynardo_py_algorithms.matrix_type +## *class* dynardo_py_algorithms.matrix_type Exposes optiSLang’s internal matrix representation. + -#### \_\_call_\_(arg2: int, arg3: int) → float +### \_\_call_\_(arg2: int, arg3: int) → float + -#### \_\_init_\_(arg2: int, arg3: int) +### \_\_init_\_(arg2: int, arg3: int) + -#### cols() → int +### cols() → int + -#### rows() → int +### rows() → int + -#### size() → int +### size() → int + -### *class* dynardo_py_algorithms.vector_type +## *class* dynardo_py_algorithms.vector_type Exposes optiSLang’s internal vector representation. + -#### \_\_call_\_(arg2: int) → float +### \_\_call_\_(arg2: int) → float + -#### \_\_init_\_(arg2: int) +### \_\_init_\_(arg2: int) + -#### cols() → int +### cols() → int + -#### rows() → int +### rows() → int + -#### size() → int +### size() → int diff --git a/2025R2/optiSLang-python-api/modules/id.md b/2025R2/optiSLang-python-api/modules/id.md index 441bd6a003..11f6c61efc 100644 --- a/2025R2/optiSLang-python-api/modules/id.md +++ b/2025R2/optiSLang-python-api/modules/id.md @@ -1,176 +1,229 @@ + -### *class* id.HID +# id + -#### *static* FromString() → [HID](#id.HID) +## *class* id.HID + -#### GetChild() → [HID](#id.HID) +### *static* FromString() → [HID](#id.HID) + -#### GetDepth() → int +### GetChild() → [HID](#id.HID) + -#### GetLeaf() → [HID](#id.HID) +### GetDepth() → int + -#### GetNumber() → int +### GetLeaf() → [HID](#id.HID) + -#### HasChild() → bool +### GetNumber() → int + -#### RemoveUndermostChild() → [HID](#id.HID) +### HasChild() → bool + -#### ToString() → str +### RemoveUndermostChild() → [HID](#id.HID) + -#### \_\_div_\_(arg2: int) → [HID](#id.HID) +### ToString() → str + -#### \_\_iadd_\_(arg2: int) → int +### \_\_div_\_(arg2: int) → [HID](#id.HID) + -#### \_\_idiv_\_(arg2: int) → [HID](#id.HID) +### \_\_iadd_\_(arg2: int) → int + -#### \_\_init_\_() +### \_\_idiv_\_(arg2: int) → [HID](#id.HID) -#### \_\_init_\_(arg2: int) + -#### \_\_init_\_(arg2: str) → object +### \_\_init_\_() +### \_\_init_\_(arg2: int) -#### \_\_isub_\_(arg2: int) → int +### \_\_init_\_(arg2: str) → object + -#### \_\_str_\_() → str +### \_\_isub_\_(arg2: int) → int + -#### *static* from_string() → [HID](#id.HID) +### \_\_str_\_() → str + -#### get_child() → [HID](#id.HID) +### *static* from_string() → [HID](#id.HID) + -#### get_depth() → int +### get_child() → [HID](#id.HID) + -#### get_leaf() → [HID](#id.HID) +### get_depth() → int + -#### get_number() → int +### get_leaf() → [HID](#id.HID) + -#### has_child() → bool +### get_number() → int + -#### remove_undermost_child() → [HID](#id.HID) +### has_child() → bool + -#### to_string() → str +### remove_undermost_child() → [HID](#id.HID) + -### *class* id.HIDSet +### to_string() → str + + + +## *class* id.HIDSet A mutable set. + -#### \_\_and_\_(arg2: [HIDSet](#id.HIDSet)) → [HIDSet](#id.HIDSet) +### \_\_and_\_(arg2: [HIDSet](#id.HIDSet)) → [HIDSet](#id.HIDSet) Return the intersection of this set and other. + -#### \_\_contains_\_(arg2: [HID](#id.HID)) → bool +### \_\_contains_\_(arg2: [HID](#id.HID)) → bool + -#### \_\_delitem_\_(arg2: [HID](#id.HID)) +### \_\_delitem_\_(arg2: [HID](#id.HID)) + -#### \_\_hash_\_() +### \_\_hash_\_() + -#### \_\_init_\_() +### \_\_init_\_() + -#### \_\_iter_\_() → object +### \_\_iter_\_() → object + -#### \_\_len_\_() → int +### \_\_len_\_() → int + -#### \_\_or_\_(arg2: [HIDSet](#id.HIDSet)) → [HIDSet](#id.HIDSet) +### \_\_or_\_(arg2: [HIDSet](#id.HIDSet)) → [HIDSet](#id.HIDSet) Return the union of this set and other. + -#### \_\_sub_\_(arg2: [HIDSet](#id.HIDSet)) → [HIDSet](#id.HIDSet) +### \_\_sub_\_(arg2: [HIDSet](#id.HIDSet)) → [HIDSet](#id.HIDSet) Return elements of this set that are not in other. + -#### \_\_xor_\_(arg2: [HIDSet](#id.HIDSet)) → [HIDSet](#id.HIDSet) +### \_\_xor_\_(arg2: [HIDSet](#id.HIDSet)) → [HIDSet](#id.HIDSet) Return elements that are either in this set or in other but not in both. + -#### add(element: [HID](#id.HID)) +### add(element: [HID](#id.HID)) Add element. + -#### difference(other: [HIDSet](#id.HIDSet)) → [HIDSet](#id.HIDSet) +### difference(other: [HIDSet](#id.HIDSet)) → [HIDSet](#id.HIDSet) Return elements of this set that are not in other. + -#### intersection(other: [HIDSet](#id.HIDSet)) → [HIDSet](#id.HIDSet) +### intersection(other: [HIDSet](#id.HIDSet)) → [HIDSet](#id.HIDSet) Return the intersection of this set and other. + -#### remove(element: [HID](#id.HID)) +### remove(element: [HID](#id.HID)) Remove element. + -#### symmetric_difference(other: [HIDSet](#id.HIDSet)) → [HIDSet](#id.HIDSet) +### symmetric_difference(other: [HIDSet](#id.HIDSet)) → [HIDSet](#id.HIDSet) Return elements that are either in this set or in other but not in both. + -#### union(other: [HIDSet](#id.HIDSet)) → [HIDSet](#id.HIDSet) +### union(other: [HIDSet](#id.HIDSet)) → [HIDSet](#id.HIDSet) Return the union of this set and other. + -### *class* id.Id +## *class* id.Id + -#### \_\_init_\_() +### \_\_init_\_() + -#### *property* name +### *property* name + -### *class* id.Tag +## *class* id.Tag + -#### \_\_init_\_() +### \_\_init_\_() + -#### *property* uuid +### *property* uuid + -### *class* id.UUID +## *class* id.UUID + -#### \_\_init_\_() +### \_\_init_\_() Raises an exception This class cannot be instantiated from Python + -#### \_\_str_\_() → str +### \_\_str_\_() → str diff --git a/2025R2/optiSLang-python-api/modules/os_doe_py_export.md b/2025R2/optiSLang-python-api/modules/os_doe_py_export.md index 318ab89438..04a8192884 100644 --- a/2025R2/optiSLang-python-api/modules/os_doe_py_export.md +++ b/2025R2/optiSLang-python-api/modules/os_doe_py_export.md @@ -1,84 +1,114 @@ + -### *class* os_doe_py_export.DOE +# os_doe_py_export + -#### \_\_init_\_(arg2: int, arg3: int) +## *class* os_doe_py_export.DOE + -#### append(arg2: [DOE](#os_doe_py_export.DOE)) +### \_\_init_\_(arg2: int, arg3: int) + -#### build(arg2: [DOETYPES](dynardo_py_algorithms.md#dynardo_py_algorithms.DOETYPES), arg3: int, arg4: bool) +### append(arg2: [DOE](#os_doe_py_export.DOE)) + -#### get_center() → [doubleVec](stdcpp_python_export.md#stdcpp_python_export.doubleVec) +### build(arg2: [DOETYPES](dynardo_py_algorithms.md#dynardo_py_algorithms.DOETYPES), arg3: int, arg4: bool) + -#### get_designs() → [doubleVecVec](stdcpp_python_export.md#stdcpp_python_export.doubleVecVec) +### get_center() → [doubleVec](stdcpp_python_export.md#stdcpp_python_export.doubleVec) + -#### get_lower_bounds() → [doubleVec](stdcpp_python_export.md#stdcpp_python_export.doubleVec) +### get_designs() → [doubleVecVec](stdcpp_python_export.md#stdcpp_python_export.doubleVecVec) + -#### get_matrix() → [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type) +### get_lower_bounds() → [doubleVec](stdcpp_python_export.md#stdcpp_python_export.doubleVec) + -#### get_upper_bounds() → [doubleVec](stdcpp_python_export.md#stdcpp_python_export.doubleVec) +### get_matrix() → [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type) + -#### move(arg2: [doubleVec](stdcpp_python_export.md#stdcpp_python_export.doubleVec)) +### get_upper_bounds() → [doubleVec](stdcpp_python_export.md#stdcpp_python_export.doubleVec) + -#### scale(arg2: [doubleVec](stdcpp_python_export.md#stdcpp_python_export.doubleVec)) +### move(arg2: [doubleVec](stdcpp_python_export.md#stdcpp_python_export.doubleVec)) + -#### sort() +### scale(arg2: [doubleVec](stdcpp_python_export.md#stdcpp_python_export.doubleVec)) + -#### unique() +### sort() + -### *class* os_doe_py_export.OSDOE +### unique() + -#### \_\_init_\_() +## *class* os_doe_py_export.OSDOE -#### \_\_init_\_(arg2: int) + +### \_\_init_\_() -#### build_robustness(Parameters: PyParameterManager to be used, Reference: PyOSDesignPoint/Nominal design point, DOE: DOETYPES method, Number: int of discretization) +### \_\_init_\_(arg2: int) + + + +### build_robustness(Parameters: PyParameterManager to be used, Reference: PyOSDesignPoint/Nominal design point, DOE: DOETYPES method, Number: int of discretization) Builds designs on unit hypercube at the design point given and transforms them to desired domain space. + -#### build_sensitivity(Parameters: PyParameterManager to be used, DOE: DOETYPES method, Number: int of discretization) +### build_sensitivity(Parameters: PyParameterManager to be used, DOE: DOETYPES method, Number: int of discretization) Builds designs on unit hypercube and transforms them to the desired domain space. + -#### get_design(arg2: int) → [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint) +### get_design(arg2: int) → [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint) + -#### get_designs() → [PyOSDesignPointContainer](py_os_design.md#py_os_design.PyOSDesignPointContainer) +### get_designs() → [PyOSDesignPointContainer](py_os_design.md#py_os_design.PyOSDesignPointContainer) + -#### get_lower_bounds() → [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint) +### get_lower_bounds() → [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint) + -#### get_num_designs() → int +### get_num_designs() → int + -#### get_upper_bounds() → [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint) +### get_upper_bounds() → [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint) + -#### set_seed(arg2: int) → int +### set_seed(arg2: int) → int + -#### size() → int +### size() → int + -#### sort() → [PyOSDesignPointContainer](py_os_design.md#py_os_design.PyOSDesignPointContainer) +### sort() → [PyOSDesignPointContainer](py_os_design.md#py_os_design.PyOSDesignPointContainer) + -#### unique() → [PyOSDesignPointContainer](py_os_design.md#py_os_design.PyOSDesignPointContainer) +### unique() → [PyOSDesignPointContainer](py_os_design.md#py_os_design.PyOSDesignPointContainer) diff --git a/2025R2/optiSLang-python-api/modules/py_algorithm_info.md b/2025R2/optiSLang-python-api/modules/py_algorithm_info.md index 86c795b8b5..276602f2d4 100644 --- a/2025R2/optiSLang-python-api/modules/py_algorithm_info.md +++ b/2025R2/optiSLang-python-api/modules/py_algorithm_info.md @@ -1,180 +1,222 @@ + -### *class* py_algorithm_info.AlgorithmInfo +# py_algorithm_info + -#### \_\_init_\_(arg2: [SupportedAlgorithms](dynardo_py_algorithms.md#dynardo_py_algorithms.SupportedAlgorithms)) +## *class* py_algorithm_info.AlgorithmInfo + -#### add_signal_info(signal: str name, abscissa: list) +### \_\_init_\_(arg2: [SupportedAlgorithms](dynardo_py_algorithms.md#dynardo_py_algorithms.SupportedAlgorithms)) + + + +### add_signal_info(signal: str name, abscissa: list) Add new signal info by name and abscissa values. Skip if signal info is already present. + -#### add_signal_info_y_data(signal: str name, channel: str name, data: str name, data: str part name, channel: list values) +### add_signal_info_y_data(signal: str name, channel: str name, data: str name, data: str part name, channel: list values) Add new channel values to an existing signal info. + -#### clear_signal_info() +### clear_signal_info() Clear all existing signal information. + -#### get_mop3_info() → [MOP3Info](#py_algorithm_info.MOP3Info) +### get_mop3_info() → [MOP3Info](#py_algorithm_info.MOP3Info) Returns detailed MOP3 info if present. + -#### get_mop_info() → [MOPInfo](#py_algorithm_info.MOPInfo) +### get_mop_info() → [MOPInfo](#py_algorithm_info.MOPInfo) Returns detailed MOP info if present. + -#### get_seed_value() → int +### get_seed_value() → int Returns the given seed value for the processed algorithm. + -#### get_signal_info_channel_names(signal: str name) → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) +### get_signal_info_channel_names(signal: str name) → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) Get a list of channel names for given signal info name + -#### get_signal_info_data_names(signal: str name, channel: str name) → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) +### get_signal_info_data_names(signal: str name, channel: str name) → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) Get a list of data names for given signal info name and channel name + -#### get_signal_info_signal_names() → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) +### get_signal_info_signal_names() → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) Get a list of signal info names + -#### get_type() → [SupportedAlgorithms](dynardo_py_algorithms.md#dynardo_py_algorithms.SupportedAlgorithms) +### get_type() → [SupportedAlgorithms](dynardo_py_algorithms.md#dynardo_py_algorithms.SupportedAlgorithms) Returns the algorithm type. + -#### has_best_design_infos() → bool +### has_best_design_infos() → bool Returns whether the detailed info has iteration best design infos. + -#### is_adaptive_mop_info() → bool +### is_adaptive_mop_info() → bool Returns whether the detailed info is of type AdaptiveMOP info. + -#### is_deterministic_sampling() → bool +### is_deterministic_sampling() → bool Returns whether the deterministic parameters were varied in this algorithm. + -#### is_mop3_info() → bool +### is_mop3_info() → bool Returns whether the detailed info is of type MOP3 info. + -#### is_mop_info() → bool +### is_mop_info() → bool Returns whether the detailed info is of type MOP info. + -#### is_optimization_info() → bool +### is_optimization_info() → bool Returns whether the detailed info is of type Optimization info. + -#### is_reliability_info() → bool +### is_reliability_info() → bool Returns whether the detailed info is of type Reliability info. + -#### is_robustness_info() → bool +### is_robustness_info() → bool Returns whether the detailed info is of type Robustness info. + -#### is_sensitivity_info() → bool +### is_sensitivity_info() → bool Returns whether the detailed info is of type Sensitivity info. + -#### is_stochastic_sampling() → bool +### is_stochastic_sampling() → bool Returns whether the stochastic parameters were varied in this algorithm. + -### *class* py_algorithm_info.DetailedAlgorithmInfo +## *class* py_algorithm_info.DetailedAlgorithmInfo + -#### \_\_init_\_() +### \_\_init_\_() Raises an exception This class cannot be instantiated from Python + -### *class* py_algorithm_info.MOP3Info +## *class* py_algorithm_info.MOP3Info + -#### \_\_init_\_() +### \_\_init_\_() + -#### *property* mop3_configuration +### *property* mop3_configuration Configuration file (string) for MOP3. + -#### *property* mop3_design_ids +### *property* mop3_design_ids Design IDs (string list/id vector) for MOP3. + -#### *property* mop3_parameter_manager +### *property* mop3_parameter_manager Parameter Manager (parameter_manager) for MOP3. + -#### *property* mop3_responses +### *property* mop3_responses Response Matrix (tmath::Matrix/Eigen::Matrix) for MOP3. + -#### *property* mop3_sdb +### *property* mop3_sdb Sdb file (string) for MOP3. + -#### *property* mop3_support_points +### *property* mop3_support_points Support Point Matrix (tmath::Matrix/Eigen::Matrix) for MOP3. + -### *class* py_algorithm_info.MOPInfo +## *class* py_algorithm_info.MOPInfo + -#### \_\_init_\_() +### \_\_init_\_() Raises an exception This class cannot be instantiated from Python + -#### has_cv_values() → bool +### has_cv_values() → bool Returns whether cross validation values are present. + -### py_algorithm_info.PyAlgorithmInfo +## py_algorithm_info.PyAlgorithmInfo alias of [`AlgorithmInfo`](#py_algorithm_info.AlgorithmInfo) + -### py_algorithm_info.PyDetailedAlgorithmInfo +## py_algorithm_info.PyDetailedAlgorithmInfo alias of [`DetailedAlgorithmInfo`](#py_algorithm_info.DetailedAlgorithmInfo) + -### py_algorithm_info.PyMOPInfo +## py_algorithm_info.PyMOPInfo alias of [`MOPInfo`](#py_algorithm_info.MOPInfo) diff --git a/2025R2/optiSLang-python-api/modules/py_doe_settings.md b/2025R2/optiSLang-python-api/modules/py_doe_settings.md index 3f401c0bcc..034b292b2f 100644 --- a/2025R2/optiSLang-python-api/modules/py_doe_settings.md +++ b/2025R2/optiSLang-python-api/modules/py_doe_settings.md @@ -1,24 +1,36 @@ + -### *class* py_doe_settings.DOESettings +# py_doe_settings + -#### \_\_init_\_() +## *class* py_doe_settings.DOESettings + -#### *property* num_dimensions +### \_\_init_\_() + -#### *property* num_discretization +### *property* num_dimensions + -#### *property* num_points +### *property* num_discretization + -#### *property* sampling_method +### *property* num_points + -#### *property* seed +### *property* sampling_method + -#### set_default() +### *property* seed + + + +### set_default(arg2: [DOETYPES](dynardo_py_algorithms.md#dynardo_py_algorithms.DOETYPES)) diff --git a/2025R2/optiSLang-python-api/modules/py_file_access.md b/2025R2/optiSLang-python-api/modules/py_file_access.md index a2073b86f3..9f3f90212f 100644 --- a/2025R2/optiSLang-python-api/modules/py_file_access.md +++ b/2025R2/optiSLang-python-api/modules/py_file_access.md @@ -1,271 +1,339 @@ + -### *class* py_file_access.FileProvider +# py_file_access + -#### \_\_init_\_() +## *class* py_file_access.FileProvider + + + +### \_\_init_\_() Raises an exception This class cannot be instantiated from Python + -#### \_\_iter_\_() → object +### \_\_iter_\_() → object + -#### \_\_len_\_() → int +### \_\_len_\_() → int + -#### *property* file_access_types +### *property* file_access_types List available types of file access. + -#### get_item(arg2: [FileProviderId](#py_file_access.FileProviderId)) → [FileProviderItem](#py_file_access.FileProviderItem) +### get_item(arg2: [FileProviderId](#py_file_access.FileProviderId)) → [FileProviderItem](#py_file_access.FileProviderItem) Get item by ID. + -#### set_item(arg2: [FileProviderItem](#py_file_access.FileProviderItem)) → bool +### set_item(arg2: [FileProviderItem](#py_file_access.FileProviderItem)) → bool Set item. + -### *class* py_file_access.FileProviderId +## *class* py_file_access.FileProviderId + -#### \_\_init_\_() +### \_\_init_\_() + -#### \_\_str_\_() → str +### \_\_str_\_() → str + -#### *property* name +### *property* name Name + -### *class* py_file_access.FileProviderItem +## *class* py_file_access.FileProviderItem + -#### *class* Action +### *class* Action **Enumeration** Enumerates possible FileProviderItem action types. + -#### LOCAL_COMPRESS_GZ *= py_file_access.Action.LOCAL_COMPRESS_GZ* +### LOCAL_COMPRESS_GZ *= py_file_access.Action.LOCAL_COMPRESS_GZ* + -#### LOCAL_REMOVE *= py_file_access.Action.LOCAL_REMOVE* +### LOCAL_REMOVE *= py_file_access.Action.LOCAL_REMOVE* + -#### NONE *= py_file_access.Action.NONE* +### NONE *= py_file_access.Action.NONE* + -#### RECEIVE *= py_file_access.Action.RECEIVE* +### RECEIVE *= py_file_access.Action.RECEIVE* + -#### SEND *= py_file_access.Action.SEND* +### SEND *= py_file_access.Action.SEND* + -#### *class* ActionPoint +### *class* ActionPoint **Enumeration** Enumerates possible FileProviderItem action points. + -#### CLOSE *= py_file_access.ActionPoint.CLOSE* +### CLOSE *= py_file_access.ActionPoint.CLOSE* + -#### LOAD *= py_file_access.ActionPoint.LOAD* +### LOAD *= py_file_access.ActionPoint.LOAD* + -#### NODE_FAILED *= py_file_access.ActionPoint.NODE_FAILED* +### NODE_FAILED *= py_file_access.ActionPoint.NODE_FAILED* + -#### NODE_FINISHED *= py_file_access.ActionPoint.NODE_FINISHED* +### NODE_FINISHED *= py_file_access.ActionPoint.NODE_FINISHED* + -#### NODE_STARTED *= py_file_access.ActionPoint.NODE_STARTED* +### NODE_STARTED *= py_file_access.ActionPoint.NODE_STARTED* + -#### NODE_SUCCEEDED *= py_file_access.ActionPoint.NODE_SUCCEEDED* +### NODE_SUCCEEDED *= py_file_access.ActionPoint.NODE_SUCCEEDED* + -#### NONE *= py_file_access.ActionPoint.NONE* +### NONE *= py_file_access.ActionPoint.NONE* + -#### RUN_FINISHED *= py_file_access.ActionPoint.RUN_FINISHED* +### RUN_FINISHED *= py_file_access.ActionPoint.RUN_FINISHED* + -#### RUN_STARTED *= py_file_access.ActionPoint.RUN_STARTED* +### RUN_STARTED *= py_file_access.ActionPoint.RUN_STARTED* + -#### SAVE *= py_file_access.ActionPoint.SAVE* +### SAVE *= py_file_access.ActionPoint.SAVE* + -#### *class* Existence +### *class* Existence **Enumeration** Enumerates possible FileProviderItem file existence options. + -#### DONT_CARE *= py_file_access.Existence.DONT_CARE* +### DONT_CARE *= py_file_access.Existence.DONT_CARE* + -#### INDICATES_FAILURE *= py_file_access.Existence.INDICATES_FAILURE* +### INDICATES_FAILURE *= py_file_access.Existence.INDICATES_FAILURE* + -#### REQUIRED_FOR_SUCCESS *= py_file_access.Existence.REQUIRED_FOR_SUCCESS* +### REQUIRED_FOR_SUCCESS *= py_file_access.Existence.REQUIRED_FOR_SUCCESS* + -#### *class* Usage +### *class* Usage **Enumeration** Enumerates possible FileProviderItem usage types. + -#### INPUT_FILE *= py_file_access.Usage.INPUT_FILE* +### INPUT_FILE *= py_file_access.Usage.INPUT_FILE* + -#### INTERMEDIATE_RESULT *= py_file_access.Usage.INTERMEDIATE_RESULT* +### INTERMEDIATE_RESULT *= py_file_access.Usage.INTERMEDIATE_RESULT* + -#### OUTPUT_FILE *= py_file_access.Usage.OUTPUT_FILE* +### OUTPUT_FILE *= py_file_access.Usage.OUTPUT_FILE* + -#### UNDETERMINED *= py_file_access.Usage.UNDETERMINED* +### UNDETERMINED *= py_file_access.Usage.UNDETERMINED* + -#### \_\_init_\_() +### \_\_init_\_() + -#### *property* action +### *property* action Action to be performed + -#### *property* action_point +### *property* action_point Point in time for the action to be performed + -#### *property* auto_generated +### *property* auto_generated Whether file is auto-generated + -#### *property* comment +### *property* comment Free text for comments + -#### *property* existence +### *property* existence Option controlling whether the local file existence is required + -#### *property* filename_regex +### *property* filename_regex Option controlling the regular expression for filename matching + -#### *property* id +### *property* id ID + -#### *property* local_path +### *property* local_path RelativeSplittedPath on the local system + -#### *property* name +### *property* name Item name + -#### *property* remove_on_reset +### *property* remove_on_reset Whether file should be removed when associated node is reset + -#### *property* revision +### *property* revision Revision + -#### *property* save_location +### *property* save_location Save location + -#### *property* store_in_project +### *property* store_in_project Whether to store file in project + -#### *property* type +### *property* type Access type + -#### *property* usage +### *property* usage File usage + -#### *property* use_regex_for_filename +### *property* use_regex_for_filename Whether to match filenames against a regular expression when checking for local files existence + -#### *property* wait_for_file +### *property* wait_for_file Whether to wait for the file after the node finished execution + -### *class* py_file_access.ProvidedPath +## *class* py_file_access.ProvidedPath + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) -#### \_\_init_\_(arg2: [SplittedPath](stdcpp_python_export.md#stdcpp_python_export.SplittedPath)) +### \_\_init_\_(arg2: [SplittedPath](stdcpp_python_export.md#stdcpp_python_export.SplittedPath)) -#### \_\_init_\_(arg2: [RelativeSplittedPath](stdcpp_python_export.md#stdcpp_python_export.RelativeSplittedPath)) +### \_\_init_\_(arg2: [RelativeSplittedPath](stdcpp_python_export.md#stdcpp_python_export.RelativeSplittedPath)) -#### \_\_init_\_(arg2: [FileProviderId](#py_file_access.FileProviderId)) +### \_\_init_\_(arg2: [FileProviderId](#py_file_access.FileProviderId)) + -#### \_\_str_\_() → str +### \_\_str_\_() → str + -#### *property* actual_relative_split_path +### *property* actual_relative_split_path Actual RelativeSplittedPath. Takes central file registration into account. + -#### *property* empty +### *property* empty True if ProvidedPath is empty + -#### *property* file_provider_id +### *property* file_provider_id A FileProviderId in case a FileProviderId is contained, or None otherwise. + -#### get_actual_path(file_provider: FileProvider) → [Path](stdcpp_python_export.md#stdcpp_python_export.Path) +### get_actual_path(file_provider: FileProvider) → [Path](stdcpp_python_export.md#stdcpp_python_export.Path) Return the actual file path. Takes central file registration into account. + -#### *property* relative_split_path +### *property* relative_split_path A RelativeSplittedPath in case a RelativeSplittedPath is contained, or None otherwise. diff --git a/2025R2/optiSLang-python-api/modules/py_monitoring_gui.md b/2025R2/optiSLang-python-api/modules/py_monitoring_gui.md index b7e3992afe..2ccb41b437 100644 --- a/2025R2/optiSLang-python-api/modules/py_monitoring_gui.md +++ b/2025R2/optiSLang-python-api/modules/py_monitoring_gui.md @@ -1,231 +1,281 @@ + -### *class* py_monitoring_gui.ApproximatingCOPMatrixIndicesType +# py_monitoring_gui + + + +## *class* py_monitoring_gui.ApproximatingCOPMatrixIndicesType **Enumeration** + -#### Interactions *= py_monitoring_gui.ApproximatingCOPMatrixIndicesType.Interactions* +### Interactions *= py_monitoring_gui.ApproximatingCOPMatrixIndicesType.Interactions* + -#### MainEffects *= py_monitoring_gui.ApproximatingCOPMatrixIndicesType.MainEffects* +### MainEffects *= py_monitoring_gui.ApproximatingCOPMatrixIndicesType.MainEffects* + -#### TotalEffects *= py_monitoring_gui.ApproximatingCOPMatrixIndicesType.TotalEffects* +### TotalEffects *= py_monitoring_gui.ApproximatingCOPMatrixIndicesType.TotalEffects* + -### *class* py_monitoring_gui.ApproximationHistoryMode +## *class* py_monitoring_gui.ApproximationHistoryMode **Enumeration** + -#### Criteria *= py_monitoring_gui.ApproximationHistoryMode.Criteria* +### Criteria *= py_monitoring_gui.ApproximationHistoryMode.Criteria* + -#### Responses *= py_monitoring_gui.ApproximationHistoryMode.Responses* +### Responses *= py_monitoring_gui.ApproximationHistoryMode.Responses* + -### *class* py_monitoring_gui.CoIVisualPolynomBasisTypes +## *class* py_monitoring_gui.CoIVisualPolynomBasisTypes **Enumeration** + -#### Automatic *= py_monitoring_gui.CoIVisualPolynomBasisTypes.Automatic* +### Automatic *= py_monitoring_gui.CoIVisualPolynomBasisTypes.Automatic* + -#### Linear *= py_monitoring_gui.CoIVisualPolynomBasisTypes.Linear* +### Linear *= py_monitoring_gui.CoIVisualPolynomBasisTypes.Linear* + -#### LinearMixed *= py_monitoring_gui.CoIVisualPolynomBasisTypes.LinearMixed* +### LinearMixed *= py_monitoring_gui.CoIVisualPolynomBasisTypes.LinearMixed* + -#### Quadratic *= py_monitoring_gui.CoIVisualPolynomBasisTypes.Quadratic* +### Quadratic *= py_monitoring_gui.CoIVisualPolynomBasisTypes.Quadratic* + -#### QuadraticMixed *= py_monitoring_gui.CoIVisualPolynomBasisTypes.QuadraticMixed* +### QuadraticMixed *= py_monitoring_gui.CoIVisualPolynomBasisTypes.QuadraticMixed* + -### *class* py_monitoring_gui.CoPMatrixClassicIndicesType +## *class* py_monitoring_gui.CoPMatrixClassicIndicesType **Enumeration** + -#### Interactions *= py_monitoring_gui.CoPMatrixClassicIndicesType.Interactions* +### Interactions *= py_monitoring_gui.CoPMatrixClassicIndicesType.Interactions* + -#### MainEffects *= py_monitoring_gui.CoPMatrixClassicIndicesType.MainEffects* +### MainEffects *= py_monitoring_gui.CoPMatrixClassicIndicesType.MainEffects* + -#### TotalEffects *= py_monitoring_gui.CoPMatrixClassicIndicesType.TotalEffects* +### TotalEffects *= py_monitoring_gui.CoPMatrixClassicIndicesType.TotalEffects* + -### *class* py_monitoring_gui.CoPMatrixClassicObjectTextOrientation +## *class* py_monitoring_gui.CoPMatrixClassicObjectTextOrientation **Enumeration** + -#### Automatic *= py_monitoring_gui.CoPMatrixClassicObjectTextOrientation.Automatic* +### Automatic *= py_monitoring_gui.CoPMatrixClassicObjectTextOrientation.Automatic* + -#### Horizontal *= py_monitoring_gui.CoPMatrixClassicObjectTextOrientation.Horizontal* +### Horizontal *= py_monitoring_gui.CoPMatrixClassicObjectTextOrientation.Horizontal* + -#### Vertical *= py_monitoring_gui.CoPMatrixClassicObjectTextOrientation.Vertical* +### Vertical *= py_monitoring_gui.CoPMatrixClassicObjectTextOrientation.Vertical* + -### *class* py_monitoring_gui.CoPMatrixIndicesType +## *class* py_monitoring_gui.CoPMatrixIndicesType **Enumeration** + -#### Interactions *= py_monitoring_gui.CoPMatrixIndicesType.Interactions* +### Interactions *= py_monitoring_gui.CoPMatrixIndicesType.Interactions* + -#### MainEffects *= py_monitoring_gui.CoPMatrixIndicesType.MainEffects* +### MainEffects *= py_monitoring_gui.CoPMatrixIndicesType.MainEffects* + -#### TotalEffects *= py_monitoring_gui.CoPMatrixIndicesType.TotalEffects* +### TotalEffects *= py_monitoring_gui.CoPMatrixIndicesType.TotalEffects* + -### *class* py_monitoring_gui.CoPMatrixObjectTextOrientation +## *class* py_monitoring_gui.CoPMatrixObjectTextOrientation **Enumeration** + -#### Automatic *= py_monitoring_gui.CoPMatrixObjectTextOrientation.Automatic* +### Automatic *= py_monitoring_gui.CoPMatrixObjectTextOrientation.Automatic* + -#### Horizontal *= py_monitoring_gui.CoPMatrixObjectTextOrientation.Horizontal* +### Horizontal *= py_monitoring_gui.CoPMatrixObjectTextOrientation.Horizontal* + -#### Vertical *= py_monitoring_gui.CoPMatrixObjectTextOrientation.Vertical* +### Vertical *= py_monitoring_gui.CoPMatrixObjectTextOrientation.Vertical* + -### *class* py_monitoring_gui.ConvenienceGUI +## *class* py_monitoring_gui.ConvenienceGUI + -#### \_\_init_\_() +### \_\_init_\_() + -#### *static* create_anthill_visuals(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: str, arg4: str) +### *static* create_anthill_visuals(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: str, arg4: str) + -#### *static* create_response_surface_2d_visuals(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: str, arg4: str) +### *static* create_response_surface_2d_visuals(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: str, arg4: str) + -#### *static* create_response_surface_3d_visuals(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: str, arg4: str, arg5: str) +### *static* create_response_surface_3d_visuals(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: str, arg4: str, arg5: str) + -#### *static* create_response_surface_topview_visuals(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: str, arg4: str, arg5: str) +### *static* create_response_surface_topview_visuals(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: str, arg4: str, arg5: str) + -### *class* py_monitoring_gui.ExtendedCorrelationMatrixViewTypes +## *class* py_monitoring_gui.ExtendedCorrelationMatrixViewTypes **Enumeration** + -#### All_Anthills *= py_monitoring_gui.ExtendedCorrelationMatrixViewTypes.All_Anthills* +### All_Anthills *= py_monitoring_gui.ExtendedCorrelationMatrixViewTypes.All_Anthills* + -#### All_Correlations *= py_monitoring_gui.ExtendedCorrelationMatrixViewTypes.All_Correlations* +### All_Correlations *= py_monitoring_gui.ExtendedCorrelationMatrixViewTypes.All_Correlations* + -#### Anthills_vs_Correlations *= py_monitoring_gui.ExtendedCorrelationMatrixViewTypes.Anthills_vs_Correlations* +### Anthills_vs_Correlations *= py_monitoring_gui.ExtendedCorrelationMatrixViewTypes.Anthills_vs_Correlations* + -#### Correlations_vs_Anthills *= py_monitoring_gui.ExtendedCorrelationMatrixViewTypes.Correlations_vs_Anthills* +### Correlations_vs_Anthills *= py_monitoring_gui.ExtendedCorrelationMatrixViewTypes.Correlations_vs_Anthills* + -### *class* py_monitoring_gui.MainWindow +## *class* py_monitoring_gui.MainWindow The main window holding monitoring visuals. + -#### ShowParameterSettings(arg2: bool) +### ShowParameterSettings(arg2: bool) Show/Hide parameter settings widget. + -#### ShowPreferences(arg2: bool) - -Show/Hide preferences widget. - - -#### \_\_init_\_() +### \_\_init_\_() Raises an exception This class cannot be instantiated from Python + -#### build_mop() +### build_mop() Build an MOP with current settings + -#### build_mop_save_as(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### build_mop_save_as(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) -Build an MOP with current settings and write it to a new database +Build a MOP with current settings and write it to a new database + -#### close(, arg2: int]) +### close(, arg2: int]) + -#### flush() +### flush() Process any pending events and flush main window to screen. : Use this functionality when changing data or setting to make shure, the changes are actually on-screen. Particularily usefull when exporting pictures or animating visuals. + -#### init_from_text_import_settings(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [TextImportSettings](py_os_design.md#py_os_design.TextImportSettings)) +### init_from_text_import_settings(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [TextImportSettings](py_os_design.md#py_os_design.TextImportSettings)) Initialize monitoring from given text file and text import settings. + -#### init_from_text_import_settings_file(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### init_from_text_import_settings_file(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) Initialize monitoring from given text file and text import settings file. + -#### maximize() +### maximize() Maximize mainwindow. + -#### save(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: bool, arg4: bool, arg5: bool) → bool +### save(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: bool, arg4: bool, arg5: bool) → bool Create and Save an OMDB file with the current monitoring data + -#### show_parameter_settings(arg2: bool) +### show_parameter_settings(arg2: bool) Show/Hide parameter settings widget. + -#### show_preferences(arg2: bool) - -Show/Hide preferences widget. - - -#### tile_subwindows() +### tile_subwindows() Arrange subwindows in a tile pattern. + -### *class* py_monitoring_gui.OSLMVisual +## *class* py_monitoring_gui.OSLMVisual A visual displaying monitoring data in a certain way. + -#### \_\_init_\_() +### \_\_init_\_() Raises an exception This class cannot be instantiated from Python + -#### export(file_path: Path) +### export(file_path: Path) -#### export(file_path: Path, width: int, height: int) +### export(file_path: Path, width: int, height: int) [0] Export the visual as picture, with given relative scale to file position given as path. : If scale is left empty, 1.0 is used. @@ -236,2780 +286,3346 @@ This class cannot be instantiated from Python : Transparency produces plot with transparent background which is available when having picture types supporting this, like png. Quality is available for jpg, determining the quality of the output in percent [0:100]. Set Watermark to True to export picture with watermark. + -#### export_data(file_path: Path) +### export_data(file_path: Path) Export the visual as ascii with given format_string to file position given as path. : If format_string is left empty, “%g” is used. + -#### set_font_size(arg2: int) +### set_font_size(arg2: int) Set the font size at the visual. + -### *class* py_monitoring_gui.PathBasedVisualTypes +## *class* py_monitoring_gui.PathBasedVisualTypes **Enumeration** + -#### Files *= py_monitoring_gui.PathBasedVisualTypes.Files* +### Files *= py_monitoring_gui.PathBasedVisualTypes.Files* + -#### Processes *= py_monitoring_gui.PathBasedVisualTypes.Processes* +### Processes *= py_monitoring_gui.PathBasedVisualTypes.Processes* + -### *class* py_monitoring_gui.RegressionType +## *class* py_monitoring_gui.RegressionType **Enumeration** + -#### LinearRegression *= py_monitoring_gui.RegressionType.LinearRegression* +### LinearRegression *= py_monitoring_gui.RegressionType.LinearRegression* + -#### NoRegression *= py_monitoring_gui.RegressionType.NoRegression* +### NoRegression *= py_monitoring_gui.RegressionType.NoRegression* + -#### QuadraticRegression *= py_monitoring_gui.RegressionType.QuadraticRegression* +### QuadraticRegression *= py_monitoring_gui.RegressionType.QuadraticRegression* + -### *class* py_monitoring_gui.ResponseSurfacePaletteData +## *class* py_monitoring_gui.ResponseSurfacePaletteData **Enumeration** + -#### AbsError *= py_monitoring_gui.ResponseSurfacePaletteData.AbsError* +### AbsError *= py_monitoring_gui.ResponseSurfacePaletteData.AbsError* + -#### CoP *= py_monitoring_gui.ResponseSurfacePaletteData.CoP* +### CoP *= py_monitoring_gui.ResponseSurfacePaletteData.CoP* + -#### Error *= py_monitoring_gui.ResponseSurfacePaletteData.Error* +### Error *= py_monitoring_gui.ResponseSurfacePaletteData.Error* + -#### RMSE *= py_monitoring_gui.ResponseSurfacePaletteData.RMSE* +### RMSE *= py_monitoring_gui.ResponseSurfacePaletteData.RMSE* + -#### SPDensity *= py_monitoring_gui.ResponseSurfacePaletteData.SPDensity* +### SPDensity *= py_monitoring_gui.ResponseSurfacePaletteData.SPDensity* + -#### Values *= py_monitoring_gui.ResponseSurfacePaletteData.Values* +### Values *= py_monitoring_gui.ResponseSurfacePaletteData.Values* + -### *class* py_monitoring_gui.StatisticAnalysisBoxType +## *class* py_monitoring_gui.StatisticAnalysisBoxType **Enumeration** + -#### MeanStddev *= py_monitoring_gui.StatisticAnalysisBoxType.MeanStddev* +### MeanStddev *= py_monitoring_gui.StatisticAnalysisBoxType.MeanStddev* + -#### None *= py_monitoring_gui.StatisticAnalysisBoxType.None* +### None *= py_monitoring_gui.StatisticAnalysisBoxType.None* + -#### Probability *= py_monitoring_gui.StatisticAnalysisBoxType.Probability* +### Probability *= py_monitoring_gui.StatisticAnalysisBoxType.Probability* + -### *class* py_monitoring_gui.StatisticAnalysisLimitsType +## *class* py_monitoring_gui.StatisticAnalysisLimitsType **Enumeration** + -#### Lines *= py_monitoring_gui.StatisticAnalysisLimitsType.Lines* +### Lines *= py_monitoring_gui.StatisticAnalysisLimitsType.Lines* + -#### None *= py_monitoring_gui.StatisticAnalysisLimitsType.None* +### None *= py_monitoring_gui.StatisticAnalysisLimitsType.None* + -#### StackedBar *= py_monitoring_gui.StatisticAnalysisLimitsType.StackedBar* +### StackedBar *= py_monitoring_gui.StatisticAnalysisLimitsType.StackedBar* + -### *class* py_monitoring_gui.StatisticAnalysisScalingType +## *class* py_monitoring_gui.StatisticAnalysisScalingType **Enumeration** + -#### MeanStddev *= py_monitoring_gui.StatisticAnalysisScalingType.MeanStddev* +### MeanStddev *= py_monitoring_gui.StatisticAnalysisScalingType.MeanStddev* + -#### MinMax *= py_monitoring_gui.StatisticAnalysisScalingType.MinMax* +### MinMax *= py_monitoring_gui.StatisticAnalysisScalingType.MinMax* + -#### None *= py_monitoring_gui.StatisticAnalysisScalingType.None* +### None *= py_monitoring_gui.StatisticAnalysisScalingType.None* + -### *class* py_monitoring_gui.StatisticAnalysisWhiskerType +## *class* py_monitoring_gui.StatisticAnalysisWhiskerType **Enumeration** + -#### MeanStddev *= py_monitoring_gui.StatisticAnalysisWhiskerType.MeanStddev* +### MeanStddev *= py_monitoring_gui.StatisticAnalysisWhiskerType.MeanStddev* + -#### None *= py_monitoring_gui.StatisticAnalysisWhiskerType.None* +### None *= py_monitoring_gui.StatisticAnalysisWhiskerType.None* + -#### Probability *= py_monitoring_gui.StatisticAnalysisWhiskerType.Probability* +### Probability *= py_monitoring_gui.StatisticAnalysisWhiskerType.Probability* + -### *class* py_monitoring_gui.Visual +## *class* py_monitoring_gui.Visual + -#### \_\_init_\_() +### \_\_init_\_() Raises an exception This class cannot be instantiated from Python + -### *class* py_monitoring_gui.Visuals +## *class* py_monitoring_gui.Visuals + -#### *class* Anthill +### *class* Anthill + -#### SetAbscissa(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### SetAbscissa(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) deprecated - use set_dimension_at_index(0, … ) instead. + -#### SetDimensionForColor(color: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### SetDimensionForColor(color: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) Set the additional dimension to be shown as color. + -#### SetDimensionForSize(size: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### SetDimensionForSize(size: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) Set the additional dimension to be shown as symbol_size. + -#### SetDimensions(x_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension), y_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### SetDimensions(x_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension), y_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) Set the dimensions to be shown in visual. + -#### SetOrdinate(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### SetOrdinate(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) deprecated - use set_dimension_at_index(1, … ) instead. + -#### UnsetDimensionForColor() +### UnsetDimensionForColor() Unset the color dimension. + -#### UnsetDimensionForSize() +### UnsetDimensionForSize() Unset the color dimension. + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) + -#### get_actual_dimensions() → [DimensionVector](py_monitoring_kernel.md#py_monitoring_kernel.DimensionVector) +### get_actual_dimensions() → [DimensionVector](py_monitoring_kernel.md#py_monitoring_kernel.DimensionVector) Return the actual visible dimensions as vector. + -#### get_caption() → str +### get_caption() → str Get the caption. + -#### get_data(layer_name: str) → list +### get_data(layer_name: str) → list Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text. + -#### *static* get_display_name() → str +### *static* get_display_name() → str Get a descriptive title for this visual type. + -#### *static* get_group_name() → str +### *static* get_group_name() → str Get the name of the containing group. + -#### get_header_data(layer_name: str, horizontal: bool) → list +### get_header_data(layer_name: str, horizontal: bool) → list Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header. + -#### get_palette_preset_names() → list +### get_palette_preset_names() → list Get a list of available palette preset names. + -#### get_regression_coefficients() → list +### get_regression_coefficients() → list Return the coefficients of a chosen Regression as list. : Dependent to chosen Regression type linear or quadratic, the list is 2 or 3 entries long. For a + b\*x you get [a,b], for a + b\*x + c\*x\*x yout get [a,b,c]. In case of non valid regression you get an empty list. + -#### get_x_axis_label() → str +### get_x_axis_label() → str Get the x axis label. + -#### get_y_axis_label() → str +### get_y_axis_label() → str Get the y axis label. + -#### has_legend() → bool +### has_legend() → bool + -#### reset_palette_limits() +### reset_palette_limits() ReSet the minimum and maximum values of palette to default. + -#### reset_palette_maximum() +### reset_palette_maximum() Reset the maximum value of palette. + -#### reset_palette_minimum() +### reset_palette_minimum() Reset the minimum value of palette. + -#### set_abscissa(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### set_abscissa(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) deprecated - use set_dimension_at_index(0, … ) instead. + -#### set_axes_enabled(enabled: bool) +### set_axes_enabled(enabled: bool) Set axes enabled state to True or False. + -#### set_caption(caption: str) +### set_caption(caption: str) Set the caption. + -#### set_dimension_for_color(color: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### set_dimension_for_color(color: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) Set the additional dimension to be shown as color. + -#### set_dimension_for_size(size: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### set_dimension_for_size(size: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) Set the additional dimension to be shown as symbol_size. + -#### set_dimensions(x_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension), y_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### set_dimensions(x_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension), y_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) Set the dimensions to be shown in visual. + -#### set_legend_font_size(font_size: int) +### set_legend_font_size(font_size: int) Set the font_size used in legend. + -#### set_legend_position(x_position: float, y_position: float) +### set_legend_position(x_position: float, y_position: float) Set the position of the legend, using absolute or relative coordinates. : (Internally stored as relative.) + -#### set_legend_size(width: float, height: float) +### set_legend_size(width: float, height: float) Set the size of the legend, using absolute or relative coordinates. : (Internally stored as relative.) + -#### set_legend_visible(enabled: bool) +### set_legend_visible(enabled: bool) Set legend visibilty to True or False. + -#### set_line_width(line_width: float) +### set_line_width(line_width: float) Set the line width at the visual. + -#### set_log_x_axis(enabled: bool) +### set_log_x_axis(enabled: bool) Set the x-axis to show values logarithmic. Will be ignored if data range contains values <=0. + -#### set_log_y_axis(enabled: bool) +### set_log_y_axis(enabled: bool) Set the y-axis to show values logarithmic. Will be ignored if data range contains values <=0 + -#### set_ordinate(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### set_ordinate(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) deprecated - use set_dimension_at_index(1, … ) instead. + -#### set_palette_limits(minimum: float, maximum: float) +### set_palette_limits(minimum: float, maximum: float) Set the minimum and maximum values of palette. + -#### set_palette_maximum(maximum: float) +### set_palette_maximum(maximum: float) Set the maximum value of palette. + -#### set_palette_minimum(minimum: float) +### set_palette_minimum(minimum: float) Set the minimum value of palette. + -#### set_palette_preset(name: str) +### set_palette_preset(name: str) Set palette preset with given name. + -#### set_ranges_x(minimum: float, maximum: float) +### set_ranges_x(minimum: float, maximum: float) Set the ranges to x-axis, Two inputs : minimum and maximum. + -#### set_ranges_y(minimum: float, maximum: float) +### set_ranges_y(minimum: float, maximum: float) Set the ranges to y-axis, Two inputs : minimum and maximum. + -#### set_regression(arg2: [RegressionType](#py_monitoring_gui.RegressionType)) +### set_regression(arg2: [RegressionType](#py_monitoring_gui.RegressionType)) Set regression + -#### set_symbol_size(symbol_size: float) +### set_symbol_size(symbol_size: float) Set the symbol size at the visual. + -#### set_x_axis_format(x_axis_format: str) +### set_x_axis_format(x_axis_format: str) Set the axis format for x axis. Will be ignored if log axis is been chosen for x-axis. + -#### set_x_axis_label(label_x: str) +### set_x_axis_label(label_x: str) Set the x axis label. + -#### set_y_axis_format(y_axis_format: str) +### set_y_axis_format(y_axis_format: str) Set the axis format for y axis. Will be ignored if log axis is been chosen for y-axis. + -#### set_y_axis_label(label_y: str) +### set_y_axis_label(label_y: str) Set the y axis label. + -#### unset_dimension_for_color() +### unset_dimension_for_color() Unset the color dimension. + -#### unset_dimension_for_size() +### unset_dimension_for_size() Unset the color dimension. + -#### update_plot() +### update_plot() Trigger an additional update on visual. + -#### *class* ApproxDesignTable +### *class* ApproxDesignTable + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) + -#### *static* get_display_name() → str +### *static* get_display_name() → str Get a descriptive title for this visual type. + -#### *static* get_group_name() → str +### *static* get_group_name() → str Get the name of the containing group. + -#### *class* ApproxModelInfo +### *class* ApproxModelInfo + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) + -#### export(file_path: Path) +### export(file_path: Path) Export the visual as picture to file position given as path. : Transparency produces plot with transparent background which is available when having picture types supporting this, like png. Quality is available for jpg, determining the quality of the output in percent [0:100]. + -#### export_data(file_path: Path) +### export_data(file_path: Path) Export the visual as ascii with given format_string to file position given as path. : If format_string is left empty, “%g” is used. + -#### *static* get_display_name() → str +### *static* get_display_name() → str Get a descriptive title for this visual type. + -#### *static* get_group_name() → str +### *static* get_group_name() → str Get the name of the containing group. + -#### set_font_size(arg2: int) +### set_font_size(arg2: int) Set the font size at the visual. + -#### *class* ApproximationHistory +### *class* ApproximationHistory + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) + -#### get_caption() → str +### get_caption() → str Get the caption. + -#### get_data(layer_name: str) → list +### get_data(layer_name: str) → list Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text. + -#### *static* get_display_name() → str +### *static* get_display_name() → str Get a descriptive title for this visual type. + -#### *static* get_group_name() → str +### *static* get_group_name() → str Get the name of the containing group. + -#### get_header_data(layer_name: str, horizontal: bool) → list +### get_header_data(layer_name: str, horizontal: bool) → list Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header. + -#### get_x_axis_label() → str +### get_x_axis_label() → str Get the x axis label. + -#### get_y_axis_label() → str +### get_y_axis_label() → str Get the y axis label. + -#### has_legend() → bool +### has_legend() → bool + -#### set_axes_enabled(enabled: bool) +### set_axes_enabled(enabled: bool) Set axes enabled state to True or False. + -#### set_caption(caption: str) +### set_caption(caption: str) Set the caption. + -#### set_legend_font_size(font_size: int) +### set_legend_font_size(font_size: int) Set the font_size used in legend. + -#### set_legend_position(x_position: float, y_position: float) +### set_legend_position(x_position: float, y_position: float) Set the position of the legend, using absolute or relative coordinates. : (Internally stored as relative.) + -#### set_legend_size(width: float, height: float) +### set_legend_size(width: float, height: float) Set the size of the legend, using absolute or relative coordinates. : (Internally stored as relative.) + -#### set_legend_visible(enabled: bool) +### set_legend_visible(enabled: bool) Set legend visibilty to True or False. + -#### set_line_width(line_width: float) +### set_line_width(line_width: float) Set the line width at the visual. + -#### set_log_y_axis(enabled: bool) +### set_log_y_axis(enabled: bool) Set the y-axis to show values logarithmic. Will be ignored if data range contains values <=0 + -#### set_mode(arg2: [ApproximationHistoryMode](#py_monitoring_gui.ApproximationHistoryMode)) +### set_mode(arg2: [ApproximationHistoryMode](#py_monitoring_gui.ApproximationHistoryMode)) Toggle the view between responses and criteria + -#### set_ranges_x(minimum: float, maximum: float) +### set_ranges_x(minimum: float, maximum: float) Set the ranges to x-axis, Two inputs : minimum and maximum. + -#### set_ranges_y(minimum: float, maximum: float) +### set_ranges_y(minimum: float, maximum: float) Set the ranges to y-axis, Two inputs : minimum and maximum. + -#### set_show_all_results(arg2: bool) +### set_show_all_results(arg2: bool) Set true to show all results + -#### set_show_minimal_local_cop_values(arg2: bool) +### set_show_minimal_local_cop_values(arg2: bool) Set true to additionally show minimum local cop values + -#### set_symbol_size(symbol_size: float) +### set_symbol_size(symbol_size: float) Set the symbol size at the visual. + -#### set_x_axis_label(label_x: str) +### set_x_axis_label(label_x: str) Set the x axis label. + -#### set_y_axis_format(y_axis_format: str) +### set_y_axis_format(y_axis_format: str) Set the axis format for y axis. Will be ignored if log axis is been chosen for y-axis. + -#### set_y_axis_label(label_y: str) +### set_y_axis_label(label_y: str) Set the y axis label. + -#### update_plot() +### update_plot() Trigger an additional update on visual. + -#### Bars *= py_monitoring_gui.CustomData_Type.Bars* +### Bars *= py_monitoring_gui.CustomData_Type.Bars* + -#### Box *= py_monitoring_gui.CustomData_Type.Box* +### Box *= py_monitoring_gui.CustomData_Type.Box* + -#### *class* BoxWhisker +### *class* BoxWhisker + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) + -#### get_caption() → str +### get_caption() → str Get the caption. + -#### get_data(layer_name: str) → list +### get_data(layer_name: str) → list Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text. + -#### *static* get_display_name() → str +### *static* get_display_name() → str Get a descriptive title for this visual type. + -#### *static* get_group_name() → str +### *static* get_group_name() → str Get the name of the containing group. + -#### get_header_data(layer_name: str, horizontal: bool) → list +### get_header_data(layer_name: str, horizontal: bool) → list Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header. + -#### get_x_axis_label() → str +### get_x_axis_label() → str Get the x axis label. + -#### get_y_axis_label() → str +### get_y_axis_label() → str Get the y axis label. + -#### has_legend() → bool +### has_legend() → bool + -#### set_axes_enabled(enabled: bool) +### set_axes_enabled(enabled: bool) Set axes enabled state to True or False. + -#### set_box_probability_content(box_probability_content: float) +### set_box_probability_content(box_probability_content: float) Set the probability content for the box. Box goes from median-content\*0.5 to median+content\*0.5. + -#### set_caption(caption: str) +### set_caption(caption: str) Set the caption. + -#### set_group(group_name: str) +### set_group(group_name: str) Set the group to be shown + -#### set_legend_font_size(font_size: int) +### set_legend_font_size(font_size: int) Set the font_size used in legend. + -#### set_legend_position(x_position: float, y_position: float) +### set_legend_position(x_position: float, y_position: float) Set the position of the legend, using absolute or relative coordinates. : (Internally stored as relative.) + -#### set_legend_size(width: float, height: float) +### set_legend_size(width: float, height: float) Set the size of the legend, using absolute or relative coordinates. : (Internally stored as relative.) + -#### set_legend_visible(enabled: bool) +### set_legend_visible(enabled: bool) Set legend visibilty to True or False. + -#### set_line_width(line_width: float) +### set_line_width(line_width: float) Set the line width at the visual. + -#### set_ranges_x(minimum: float, maximum: float) +### set_ranges_x(minimum: float, maximum: float) Set the ranges to x-axis, Two inputs : minimum and maximum. + -#### set_ranges_y(minimum: float, maximum: float) +### set_ranges_y(minimum: float, maximum: float) Set the ranges to y-axis, Two inputs : minimum and maximum. + -#### set_scale(scale: bool) +### set_scale(scale: bool) Scale to min/max. + -#### set_show_box(show: bool) +### set_show_box(show: bool) Show box. + -#### set_show_limits(show: bool) +### set_show_limits(show: bool) Show limits. + -#### set_show_samples(show_samples: bool) +### set_show_samples(show_samples: bool) Show sample points. + -#### set_show_whisker(show: bool) +### set_show_whisker(show: bool) Show whisker. + -#### set_symbol_size(symbol_size: float) +### set_symbol_size(symbol_size: float) Set the symbol size at the visual. + -#### set_whisker_probability_content(whisker_probability_content: float) +### set_whisker_probability_content(whisker_probability_content: float) Set the probability content for the whisker. Whisker goes from median-content\*0.5 to median+content\*0.5. + -#### set_x_axis_label(label_x: str) +### set_x_axis_label(label_x: str) Set the x axis label. + -#### set_y_axis_format(y_axis_format: str) +### set_y_axis_format(y_axis_format: str) Set the axis format for y axis. Will be ignored if log axis is been chosen for y-axis. + -#### set_y_axis_label(label_y: str) +### set_y_axis_label(label_y: str) Set the y axis label. + -#### update_plot() +### update_plot() Trigger an additional update on visual. + -#### *class* Cloud +### *class* Cloud + -#### SetAbscissa(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### SetAbscissa(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) deprecated - use set_dimension_at_index(0, … ) instead. + -#### SetDimensionForColor(color: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### SetDimensionForColor(color: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) Set the additional dimension to be shown as color. + -#### SetDimensionForSize(size: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### SetDimensionForSize(size: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) Set the additional dimension to be shown as symbol_size. + -#### SetDimensions(x_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension), y_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension), z_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### SetDimensions(x_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension), y_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension), z_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) Set the dimensions to be shown in visual. + -#### SetOrdinate(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### SetOrdinate(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) deprecated - use set_dimension_at_index(1, … ) instead. + -#### SetZAxis(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### SetZAxis(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) deprecated - use set_dimension_at_index(2, … ) instead. + -#### UnsetDimensionForColor() +### UnsetDimensionForColor() Unset the color dimension. + -#### UnsetDimensionForSize() +### UnsetDimensionForSize() Unset the color dimension. + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) + -#### get_actual_dimensions() → [DimensionVector](py_monitoring_kernel.md#py_monitoring_kernel.DimensionVector) +### get_actual_dimensions() → [DimensionVector](py_monitoring_kernel.md#py_monitoring_kernel.DimensionVector) Return the actual visible dimensions as vector. + -#### get_caption() → str +### get_caption() → str Get the caption. + -#### get_data(layer_name: str) → list +### get_data(layer_name: str) → list Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text. + -#### *static* get_display_name() → str +### *static* get_display_name() → str Get a descriptive title for this visual type. + -#### *static* get_group_name() → str +### *static* get_group_name() → str Get the name of the containing group. + -#### get_header_data(layer_name: str, horizontal: bool) → list +### get_header_data(layer_name: str, horizontal: bool) → list Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header. + -#### get_palette_preset_names() → list +### get_palette_preset_names() → list Get a list of available palette preset names. + -#### get_x_axis_label() → str +### get_x_axis_label() → str Get the x axis label. + -#### get_y_axis_label() → str +### get_y_axis_label() → str Get the y axis label. + -#### get_z_axis_label() → str +### get_z_axis_label() → str Get the z axis label. + -#### has_legend() → bool +### has_legend() → bool + -#### reset_palette_limits() +### reset_palette_limits() ReSet the minimum and maximum values of palette to default. + -#### reset_palette_maximum() +### reset_palette_maximum() Reset the maximum value of palette. + -#### reset_palette_minimum() +### reset_palette_minimum() Reset the minimum value of palette. + -#### set_abscissa(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### set_abscissa(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) deprecated - use set_dimension_at_index(0, … ) instead. + -#### set_alpha(alpha_angle: float) +### set_alpha(alpha_angle: float) Set the first angle for an rotation based on Euler angles z-x’-z’’. + -#### set_axes_enabled(enabled: bool) +### set_axes_enabled(enabled: bool) Set axes enabled state to True or False. + -#### set_beta(beta_angle: float) +### set_beta(beta_angle: float) Set the second angle for an rotation based on Euler angles z-x’-z’’. + -#### set_caption(caption: str) +### set_caption(caption: str) Set the caption. + -#### set_dimension_for_color(color: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### set_dimension_for_color(color: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) Set the additional dimension to be shown as color. + -#### set_dimension_for_size(size: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### set_dimension_for_size(size: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) Set the additional dimension to be shown as symbol_size. + -#### set_dimensions(x_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension), y_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension), z_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### set_dimensions(x_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension), y_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension), z_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) Set the dimensions to be shown in visual. + -#### set_gamma(gamma_angle: float) +### set_gamma(gamma_angle: float) Set the third angle for an rotation based on Euler angles z-x’-z’’. + -#### set_legend_font_size(font_size: int) +### set_legend_font_size(font_size: int) Set the font_size used in legend. + -#### set_legend_position(x_position: float, y_position: float) +### set_legend_position(x_position: float, y_position: float) Set the position of the legend, using absolute or relative coordinates. : (Internally stored as relative.) + -#### set_legend_size(width: float, height: float) +### set_legend_size(width: float, height: float) Set the size of the legend, using absolute or relative coordinates. : (Internally stored as relative.) + -#### set_legend_visible(enabled: bool) +### set_legend_visible(enabled: bool) Set legend visibilty to True or False. + -#### set_lighting_enabled(enabled: bool) +### set_lighting_enabled(enabled: bool) Set lighting enabled state to True or False. + -#### set_line_width(line_width: float) +### set_line_width(line_width: float) Set the line width at the visual. + -#### set_lines_enabled(enabled: bool) +### set_lines_enabled(enabled: bool) Set lines enabled state to True or False. + -#### set_log_x_axis(enabled: bool) +### set_log_x_axis(enabled: bool) Set the x-axis to show values logarithmic. Will be ignored if data range contains values <=0. + -#### set_log_y_axis(enabled: bool) +### set_log_y_axis(enabled: bool) Set the y-axis to show values logarithmic. Will be ignored if data range contains values <=0 + -#### set_log_z_axis(enabled: bool) +### set_log_z_axis(enabled: bool) Set the z-axis to show values logarithmic. Will be ignored if data range contains values <=0 + -#### set_ordinate(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### set_ordinate(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) deprecated - use set_dimension_at_index(1, … ) instead. + -#### set_palette_limits(minimum: float, maximum: float) +### set_palette_limits(minimum: float, maximum: float) Set the minimum and maximum values of palette. + -#### set_palette_maximum(maximum: float) +### set_palette_maximum(maximum: float) Set the maximum value of palette. + -#### set_palette_minimum(minimum: float) +### set_palette_minimum(minimum: float) Set the minimum value of palette. + -#### set_palette_position(x_position: float, y_position: float) +### set_palette_position(x_position: float, y_position: float) Set the position of the palette, using absolute or relative[%] coordinates. : (Internally stored as relative[%].) + -#### set_palette_preset(name: str) +### set_palette_preset(name: str) Set palette preset with given name. + -#### set_palette_size(x_position: float, y_position: float) +### set_palette_size(x_position: float, y_position: float) Set the size of the palette, using absolute or relative[%] coordinates. : (Internally stored as relative[%].) + -#### set_palette_visible(enabled: bool) +### set_palette_visible(enabled: bool) Set palette visibility to True or False. + -#### set_regression(arg2: [RegressionType](#py_monitoring_gui.RegressionType)) +### set_regression(arg2: [RegressionType](#py_monitoring_gui.RegressionType)) Set regression + -#### set_surfaces_enabled(enabled: bool) +### set_surfaces_enabled(enabled: bool) Set surfaces enabled state to True or False. + -#### set_symbol_size(symbol_size: float) +### set_symbol_size(symbol_size: float) Set the symbol size at the visual. + -#### set_x_axis_format(x_axis_format: str) +### set_x_axis_format(x_axis_format: str) Set the axis format for x axis. Will be ignored if log axis is been chosen for x-axis. + -#### set_x_axis_label(label_x: str) +### set_x_axis_label(label_x: str) Set the x axis label. + -#### set_y_axis_format(y_axis_format: str) +### set_y_axis_format(y_axis_format: str) Set the axis format for y axis. Will be ignored if log axis is been chosen for y-axis. + -#### set_y_axis_label(label_y: str) +### set_y_axis_label(label_y: str) Set the y axis label. + -#### set_z_axis(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### set_z_axis(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) deprecated - use set_dimension_at_index(2, … ) instead. + -#### set_z_axis_format(z_axis_format: str) +### set_z_axis_format(z_axis_format: str) Set the axis format for z axis. Will be ignored if log axis is been chosen for z-axis. + -#### set_z_axis_label(label_z: str) +### set_z_axis_label(label_z: str) Set the z axis label. + -#### unset_dimension_for_color() +### unset_dimension_for_color() Unset the color dimension. + -#### unset_dimension_for_size() +### unset_dimension_for_size() Unset the color dimension. + -#### update_plot() +### update_plot() Trigger an additional update on visual. + -#### *class* CoI +### *class* CoI + -#### ListenToDimensionIndex(arg2: int) +### ListenToDimensionIndex(arg2: int) deprecated - use set_dimension_id_at_index(0, … ) instead. + -#### SetAdjusted(adjust: bool) +### SetAdjusted(adjust: bool) Toggle the view to show adjusted values. + -#### SetDimension(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### SetDimension(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) deprecated - use set_dimension_at_index(0, … ) instead. + -#### SetInverted(invert: bool) +### SetInverted(invert: bool) Toggle the view to show ( value ) or ( CoD - value ). + -#### SetType(coi_type: [CoIVisualPolynomBasisTypes](#py_monitoring_gui.CoIVisualPolynomBasisTypes)) +### SetType(coi_type: [CoIVisualPolynomBasisTypes](#py_monitoring_gui.CoIVisualPolynomBasisTypes)) Set the type of coi calculation, where CoIVisualPolynomBasisTypes. : Automatic means that the best found model is used for calculation. + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) + -#### get_actual_dimension() → [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension) +### get_actual_dimension() → [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension) Return the actual visible dimension. + -#### get_caption() → str +### get_caption() → str Get the caption. + -#### get_data(layer_name: str) → list +### get_data(layer_name: str) → list Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text. + -#### *static* get_display_name() → str +### *static* get_display_name() → str Get a descriptive title for this visual type. + -#### *static* get_group_name() → str +### *static* get_group_name() → str Get the name of the containing group. + -#### get_header_data(layer_name: str, horizontal: bool) → list +### get_header_data(layer_name: str, horizontal: bool) → list Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header. + -#### get_palette_preset_names() → list +### get_palette_preset_names() → list Get a list of available palette preset names. + -#### get_x_axis_label() → str +### get_x_axis_label() → str Get the x axis label. + -#### get_y_axis_label() → str +### get_y_axis_label() → str Get the y axis label. + -#### reset_palette_limits() +### reset_palette_limits() ReSet the minimum and maximum values of palette to default. + -#### reset_palette_maximum() +### reset_palette_maximum() Reset the maximum value of palette. + -#### reset_palette_minimum() +### reset_palette_minimum() Reset the minimum value of palette. + -#### set_adjusted(adjust: bool) +### set_adjusted(adjust: bool) Toggle the view to show adjusted values. + -#### set_axes_enabled(enabled: bool) +### set_axes_enabled(enabled: bool) Set axes enabled state to True or False. + -#### set_caption(caption: str) +### set_caption(caption: str) Set the caption. + -#### set_inverted(invert: bool) +### set_inverted(invert: bool) Toggle the view to show ( value ) or ( CoD - value ). + -#### set_line_width(line_width: float) +### set_line_width(line_width: float) Set the line width at the visual. + -#### set_palette_limits(minimum: float, maximum: float) +### set_palette_limits(minimum: float, maximum: float) Set the minimum and maximum values of palette. + -#### set_palette_maximum(maximum: float) +### set_palette_maximum(maximum: float) Set the maximum value of palette. + -#### set_palette_minimum(minimum: float) +### set_palette_minimum(minimum: float) Set the minimum value of palette. + -#### set_palette_position(x_position: float, y_position: float) +### set_palette_position(x_position: float, y_position: float) Set the position of the palette, using absolute or relative[%] coordinates. : (Internally stored as relative[%].) + -#### set_palette_preset(name: str) +### set_palette_preset(name: str) Set palette preset with given name. + -#### set_palette_size(x_position: float, y_position: float) +### set_palette_size(x_position: float, y_position: float) Set the size of the palette, using absolute or relative[%] coordinates. : (Internally stored as relative[%].) + -#### set_palette_visible(enabled: bool) +### set_palette_visible(enabled: bool) Set palette visibility to True or False. + -#### set_ranges_x(minimum: float, maximum: float) +### set_ranges_x(minimum: float, maximum: float) Set the ranges to x-axis, Two inputs : minimum and maximum. + -#### set_ranges_y(minimum: float, maximum: float) +### set_ranges_y(minimum: float, maximum: float) Set the ranges to y-axis, Two inputs : minimum and maximum. + -#### set_type(coi_type: [CoIVisualPolynomBasisTypes](#py_monitoring_gui.CoIVisualPolynomBasisTypes)) +### set_type(coi_type: [CoIVisualPolynomBasisTypes](#py_monitoring_gui.CoIVisualPolynomBasisTypes)) Set the type of coi calculation, where CoIVisualPolynomBasisTypes. : Automatic means that the best found model is used for calculation. + -#### set_x_axis_label(label_x: str) +### set_x_axis_label(label_x: str) Set the x axis label. + -#### set_y_axis_label(label_y: str) +### set_y_axis_label(label_y: str) Set the y axis label. + -#### update_plot() +### update_plot() Trigger an additional update on visual. + -#### *class* CoP +### *class* CoP + -#### ListenToDimensionIndex(arg2: int) +### ListenToDimensionIndex(arg2: int) deprecated - use set_dimension_id_at_index(0, … ) instead. + -#### SetDimension(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### SetDimension(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) deprecated - use set_dimension_at_index(0, … ) instead. + -#### SetFiltered(arg2: bool) +### SetFiltered(arg2: bool) + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) + -#### get_actual_dimension() → [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension) +### get_actual_dimension() → [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension) Return the actual visible dimension. + -#### get_caption() → str +### get_caption() → str Get the caption. + -#### get_data(layer_name: str) → list +### get_data(layer_name: str) → list Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text. + -#### *static* get_display_name() → str +### *static* get_display_name() → str Get a descriptive title for this visual type. + -#### *static* get_group_name() → str +### *static* get_group_name() → str Get the name of the containing group. + -#### get_header_data(layer_name: str, horizontal: bool) → list +### get_header_data(layer_name: str, horizontal: bool) → list Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header. + -#### get_palette_preset_names() → list +### get_palette_preset_names() → list Get a list of available palette preset names. + -#### get_x_axis_label() → str +### get_x_axis_label() → str Get the x axis label. + -#### get_y_axis_label() → str +### get_y_axis_label() → str Get the y axis label. + -#### reset_palette_limits() +### reset_palette_limits() ReSet the minimum and maximum values of palette to default. + -#### reset_palette_maximum() +### reset_palette_maximum() Reset the maximum value of palette. + -#### reset_palette_minimum() +### reset_palette_minimum() Reset the minimum value of palette. + -#### set_axes_enabled(enabled: bool) +### set_axes_enabled(enabled: bool) Set axes enabled state to True or False. + -#### set_caption(caption: str) +### set_caption(caption: str) Set the caption. + -#### set_filter_limit(filter_value: float[%]) +### set_filter_limit(filter_value: float[%]) Set the limit below which the single CoP values are filtered in percent. + -#### set_filtered(arg2: bool) +### set_filtered(arg2: bool) + -#### set_line_width(line_width: float) +### set_line_width(line_width: float) Set the line width at the visual. + -#### set_palette_limits(minimum: float, maximum: float) +### set_palette_limits(minimum: float, maximum: float) Set the minimum and maximum values of palette. + -#### set_palette_maximum(maximum: float) +### set_palette_maximum(maximum: float) Set the maximum value of palette. + -#### set_palette_minimum(minimum: float) +### set_palette_minimum(minimum: float) Set the minimum value of palette. + -#### set_palette_position(x_position: float, y_position: float) +### set_palette_position(x_position: float, y_position: float) Set the position of the palette, using absolute or relative[%] coordinates. : (Internally stored as relative[%].) + -#### set_palette_preset(name: str) +### set_palette_preset(name: str) Set palette preset with given name. + -#### set_palette_size(x_position: float, y_position: float) +### set_palette_size(x_position: float, y_position: float) Set the size of the palette, using absolute or relative[%] coordinates. : (Internally stored as relative[%].) + -#### set_palette_visible(enabled: bool) +### set_palette_visible(enabled: bool) Set palette visibility to True or False. + -#### set_ranges_x(minimum: float, maximum: float) +### set_ranges_x(minimum: float, maximum: float) Set the ranges to x-axis, Two inputs : minimum and maximum. + -#### set_ranges_y(minimum: float, maximum: float) +### set_ranges_y(minimum: float, maximum: float) Set the ranges to y-axis, Two inputs : minimum and maximum. + -#### set_show_interactions(show: bool) +### set_show_interactions(show: bool) Toggle view to see “Main effect” and “Interaction “ values additional to “Total effect” values. + -#### set_x_axis_label(label_x: str) +### set_x_axis_label(label_x: str) Set the x axis label. + -#### set_y_axis_label(label_y: str) +### set_y_axis_label(label_y: str) Set the y axis label. + -#### update_plot() +### update_plot() Trigger an additional update on visual. + -#### *class* CoPMatrix +### *class* CoPMatrix + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) + -#### get_data(layer_name: str) → list +### get_data(layer_name: str) → list Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text. + -#### *static* get_display_name() → str +### *static* get_display_name() → str Get a descriptive title for this visual type. + -#### *static* get_group_name() → str +### *static* get_group_name() → str Get the name of the containing group. + -#### get_header_data(layer_name: str, horizontal: bool) → list +### get_header_data(layer_name: str, horizontal: bool) → list Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header. + -#### get_palette_preset_names() → list +### get_palette_preset_names() → list Get a list of available palette preset names. + -#### reset_palette_limits() +### reset_palette_limits() ReSet the minimum and maximum values of palette to default. + -#### reset_palette_maximum() +### reset_palette_maximum() Reset the maximum value of palette. + -#### reset_palette_minimum() +### reset_palette_minimum() Reset the minimum value of palette. + -#### set_approximation_line_width_scale(line_width_scale: float) +### set_approximation_line_width_scale(line_width_scale: float) Set line width scale with which the approximation line is shown. + -#### set_axes_enabled(enabled: bool) +### set_axes_enabled(enabled: bool) Set axes enabled state to True or False. + -#### set_axes_rotation_enabled(enable: bool) +### set_axes_rotation_enabled(enable: bool) Set axes rotation enabled. + -#### set_axes_rotation_orthogonal(enable: bool) +### set_axes_rotation_orthogonal(enable: bool) Set rotation angles to 0 degree if enough space for text exist, else to 90. + -#### set_axes_rotation_x_angle(angle: float) +### set_axes_rotation_x_angle(angle: float) Set the rotation angle for x-axis. + -#### set_axes_rotation_y_angle(angle: float) +### set_axes_rotation_y_angle(angle: float) Set the rotation angle for x-axis. + -#### set_caption(caption: str) +### set_caption(caption: str) Set the caption. + -#### set_filter_limit(filter_limit: float[%]) +### set_filter_limit(filter_limit: float[%]) Set the limit below which the values are filtered in percent. + -#### set_filter_total_limit(total_filter_value: float[%]) +### set_filter_total_limit(total_filter_value: float[%]) Set the limit below which the total CoP values ( ModelCoP’s ) are filtered in percent. + -#### set_indices_type(indices_type: [CoPMatrixIndicesType](#py_monitoring_gui.CoPMatrixIndicesType)) +### set_indices_type(indices_type: [CoPMatrixIndicesType](#py_monitoring_gui.CoPMatrixIndicesType)) Toggle the view to see “Total effects”, “Main effects” or “Interactions” in matrix. + -#### set_line_width(line_width: float) +### set_line_width(line_width: float) Set the line width at the visual. + -#### set_object_text_orientation(orientation: [CoPMatrixObjectTextOrientation](#py_monitoring_gui.CoPMatrixObjectTextOrientation)) +### set_object_text_orientation(orientation: [CoPMatrixObjectTextOrientation](#py_monitoring_gui.CoPMatrixObjectTextOrientation)) Toggle to change orientation of object text on tiles Automatic : horizontal if enough space, else vertical is tested Horizontal : ever show text horizontal Vertical : ever show text vertical. + -#### set_palette_limits(minimum: float, maximum: float) +### set_palette_limits(minimum: float, maximum: float) -#### set_palette_limits(minimum: float, maximum: float) +### set_palette_limits(minimum: float, maximum: float) [0] Set the minimum and maximum values of palette. [1] Set the minimum and maximum values of palette. + -#### set_palette_maximum(maximum: float) +### set_palette_maximum(maximum: float) Set the maximum value of palette. + -#### set_palette_minimum(minimum: float) +### set_palette_minimum(minimum: float) Set the minimum value of palette. + -#### set_palette_position(x_position: float, y_position: float) +### set_palette_position(x_position: float, y_position: float) Set the position of the palette, using absolute or relative[%] coordinates. : (Internally stored as relative[%].) + -#### set_palette_preset(name: str) +### set_palette_preset(name: str) Set palette preset with given name. + -#### set_palette_size(x_position: float, y_position: float) +### set_palette_size(x_position: float, y_position: float) Set the size of the palette, using absolute or relative[%] coordinates. : (Internally stored as relative[%].) + -#### set_palette_visible(enabled: bool) +### set_palette_visible(enabled: bool) Set palette visibility to True or False. + -#### set_ranges_x(minimum: float, maximum: float) +### set_ranges_x(minimum: float, maximum: float) Set the ranges to x-axis, Two inputs : minimum and maximum. + -#### set_ranges_y(minimum: float, maximum: float) +### set_ranges_y(minimum: float, maximum: float) Set the ranges to y-axis, Two inputs : minimum and maximum. + -#### set_resolution(resolution: int) +### set_resolution(resolution: int) Set resolution of approximation line.. + -#### set_show_additional_points(show: bool) +### set_show_additional_points(show: bool) Show additional points in tiles. + -#### set_show_approximated_points(show: bool) +### set_show_approximated_points(show: bool) Show approximated points in tiles. + -#### set_show_approximation(show: bool) +### set_show_approximation(show: bool) Show approximation line in tiles. + -#### set_show_background_cop(show: bool) +### set_show_background_cop(show: bool) Show background color in tiles. + -#### set_show_calculated_response_value(show: bool) +### set_show_calculated_response_value(show: bool) Show calculated response value in last column. + -#### set_show_cop(show: bool) +### set_show_cop(show: bool) Show cop value in tiles. + -#### set_show_deactivated_support_points(show: bool) +### set_show_deactivated_support_points(show: bool) Show deactivated supports points in tiles. + -#### set_show_extended(show: bool) +### set_show_extended(show: bool) Show matrix in extended mode with response surface 2d plots in tiles. + -#### set_show_filtered(show: bool) +### set_show_filtered(show: bool) Show all cop values including these filtered by mop. + -#### set_show_grid(show: bool) +### set_show_grid(show: bool) Show grid in tiles. + -#### set_show_parameter_line(show: bool) +### set_show_parameter_line(show: bool) Show parameter line in tiles. + -#### set_show_round_corners(show: bool) +### set_show_round_corners(show: bool) Show tile with round corners or as squares. + -#### set_show_selection(show: bool) +### set_show_selection(show: bool) Show selection lines in grid plot. + -#### set_show_support_points(show: bool) +### set_show_support_points(show: bool) Show support points in tiles. + -#### set_symbol_size(symbol_size: float) +### set_symbol_size(symbol_size: float) Set the symbol size at the visual. + -#### set_x_axis_label(label_x: str) +### set_x_axis_label(label_x: str) Set the x axis label. + -#### set_y_axis_label(label_y: str) +### set_y_axis_label(label_y: str) Set the y axis label. + -#### update_plot() +### update_plot() Trigger an additional update on visual. + -#### *class* CoPMatrixClassic +### *class* CoPMatrixClassic + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) + -#### get_caption() → str +### get_caption() → str Get the caption. + -#### get_data(layer_name: str) → list +### get_data(layer_name: str) → list Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text. + -#### *static* get_display_name() → str +### *static* get_display_name() → str Get a descriptive title for this visual type. + -#### *static* get_group_name() → str +### *static* get_group_name() → str Get the name of the containing group. + -#### get_header_data(layer_name: str, horizontal: bool) → list +### get_header_data(layer_name: str, horizontal: bool) → list Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header. + -#### get_palette_preset_names() → list +### get_palette_preset_names() → list Get a list of available palette preset names. + -#### get_x_axis_label() → str +### get_x_axis_label() → str Get the x axis label. + -#### get_y_axis_label() → str +### get_y_axis_label() → str Get the y axis label. + -#### reset_palette_limits() +### reset_palette_limits() ReSet the minimum and maximum values of palette to default. + -#### reset_palette_maximum() +### reset_palette_maximum() Reset the maximum value of palette. + -#### reset_palette_minimum() +### reset_palette_minimum() Reset the minimum value of palette. + -#### set_axes_enabled(enabled: bool) +### set_axes_enabled(enabled: bool) Set axes enabled state to True or False. + -#### set_axes_rotation_enabled(enable: bool) +### set_axes_rotation_enabled(enable: bool) Set axes rotation enabled. + -#### set_axes_rotation_orthogonal(enable: bool) +### set_axes_rotation_orthogonal(enable: bool) Set rotation angles to 0 degree if enough space for text exist, else to 90. + -#### set_axes_rotation_x_angle(angle: float) +### set_axes_rotation_x_angle(angle: float) Set the rotation angle for x-axis. + -#### set_axes_rotation_y_angle(angle: float) +### set_axes_rotation_y_angle(angle: float) Set the rotation angle for x-axis. + -#### set_caption(caption: str) +### set_caption(caption: str) Set the caption. + -#### set_filter_limit(filter_limit: float[%]) +### set_filter_limit(filter_limit: float[%]) Set the limit below which the values are filtered in percent. + -#### set_filter_total_limit(total_filter_value: float[%]) +### set_filter_total_limit(total_filter_value: float[%]) Set the limit below which the total CoP values ( ModelCoP’s ) are filtered in percent. + -#### set_indices_type(indices_type: [CoPMatrixClassicIndicesType](#py_monitoring_gui.CoPMatrixClassicIndicesType)) +### set_indices_type(indices_type: [CoPMatrixClassicIndicesType](#py_monitoring_gui.CoPMatrixClassicIndicesType)) Toggle the view to see “Total effects”, “Main effects” or “Interactions” in matrix. + -#### set_line_width(line_width: float) +### set_line_width(line_width: float) Set the line width at the visual. + -#### set_object_text_orientation(orientation: [CoPMatrixClassicObjectTextOrientation](#py_monitoring_gui.CoPMatrixClassicObjectTextOrientation)) +### set_object_text_orientation(orientation: [CoPMatrixClassicObjectTextOrientation](#py_monitoring_gui.CoPMatrixClassicObjectTextOrientation)) Toggle to change orientation of object text on tiles Automatic : horizontal if enough space, else vertical is tested Horizontal : ever show text horizontal Vertical : ever show text vertical. + -#### set_palette_limits(minimum: float, maximum: float) +### set_palette_limits(minimum: float, maximum: float) Set the minimum and maximum values of palette. + -#### set_palette_maximum(maximum: float) +### set_palette_maximum(maximum: float) Set the maximum value of palette. + -#### set_palette_minimum(minimum: float) +### set_palette_minimum(minimum: float) Set the minimum value of palette. + -#### set_palette_position(x_position: float, y_position: float) +### set_palette_position(x_position: float, y_position: float) Set the position of the palette, using absolute or relative[%] coordinates. : (Internally stored as relative[%].) + -#### set_palette_preset(name: str) +### set_palette_preset(name: str) Set palette preset with given name. + -#### set_palette_size(x_position: float, y_position: float) +### set_palette_size(x_position: float, y_position: float) Set the size of the palette, using absolute or relative[%] coordinates. : (Internally stored as relative[%].) + -#### set_palette_visible(enabled: bool) +### set_palette_visible(enabled: bool) Set palette visibility to True or False. + -#### set_ranges_x(minimum: float, maximum: float) +### set_ranges_x(minimum: float, maximum: float) Set the ranges to x-axis, Two inputs : minimum and maximum. + -#### set_ranges_y(minimum: float, maximum: float) +### set_ranges_y(minimum: float, maximum: float) Set the ranges to y-axis, Two inputs : minimum and maximum. + -#### set_x_axis_label(label_x: str) +### set_x_axis_label(label_x: str) Set the x axis label. + -#### set_y_axis_label(label_y: str) +### set_y_axis_label(label_y: str) Set the y axis label. + -#### update_plot() +### update_plot() Trigger an additional update on visual. + -#### *class* CorrelationCoefficient +### *class* CorrelationCoefficient + -#### ListenToDimensionIndex(arg2: int) +### ListenToDimensionIndex(arg2: int) deprecated - use set_dimension_id_at_index(0, … ) instead. + -#### SetDimension(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### SetDimension(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) deprecated - use set_dimension_at_index(0, … ) instead. + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) + -#### get_caption() → str +### get_caption() → str Get the caption. + -#### get_data(layer_name: str) → list +### get_data(layer_name: str) → list Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text. + -#### *static* get_display_name() → str +### *static* get_display_name() → str Get a descriptive title for this visual type. + -#### *static* get_group_name() → str +### *static* get_group_name() → str Get the name of the containing group. + -#### get_header_data(layer_name: str, horizontal: bool) → list +### get_header_data(layer_name: str, horizontal: bool) → list Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header. + -#### get_palette_preset_names() → list +### get_palette_preset_names() → list Get a list of available palette preset names. + -#### get_x_axis_label() → str +### get_x_axis_label() → str Get the x axis label. + -#### get_y_axis_label() → str +### get_y_axis_label() → str Get the y axis label. + -#### reset_palette_limits() +### reset_palette_limits() ReSet the minimum and maximum values of palette to default. + -#### reset_palette_maximum() +### reset_palette_maximum() Reset the maximum value of palette. + -#### reset_palette_minimum() +### reset_palette_minimum() Reset the minimum value of palette. + -#### set_axes_enabled(enabled: bool) +### set_axes_enabled(enabled: bool) Set axes enabled state to True or False. + -#### set_caption(caption: str) +### set_caption(caption: str) Set the caption. + -#### set_line_width(line_width: float) +### set_line_width(line_width: float) Set the line width at the visual. + -#### set_palette_limits(minimum: float, maximum: float) +### set_palette_limits(minimum: float, maximum: float) Set the minimum and maximum values of palette. + -#### set_palette_maximum(maximum: float) +### set_palette_maximum(maximum: float) Set the maximum value of palette. + -#### set_palette_minimum(minimum: float) +### set_palette_minimum(minimum: float) Set the minimum value of palette. + -#### set_palette_position(x_position: float, y_position: float) +### set_palette_position(x_position: float, y_position: float) Set the position of the palette, using absolute or relative[%] coordinates. : (Internally stored as relative[%].) + -#### set_palette_preset(name: str) +### set_palette_preset(name: str) Set palette preset with given name. + -#### set_palette_size(x_position: float, y_position: float) +### set_palette_size(x_position: float, y_position: float) Set the size of the palette, using absolute or relative[%] coordinates. : (Internally stored as relative[%].) + -#### set_palette_visible(enabled: bool) +### set_palette_visible(enabled: bool) Set palette visibility to True or False. + -#### set_ranges_x(minimum: float, maximum: float) +### set_ranges_x(minimum: float, maximum: float) Set the ranges to x-axis, Two inputs : minimum and maximum. + -#### set_ranges_y(minimum: float, maximum: float) +### set_ranges_y(minimum: float, maximum: float) Set the ranges to y-axis, Two inputs : minimum and maximum. + -#### set_x_axis_label(label_x: str) +### set_x_axis_label(label_x: str) Set the x axis label. + -#### set_y_axis_label(label_y: str) +### set_y_axis_label(label_y: str) Set the y axis label. + -#### update_plot() +### update_plot() Trigger an additional update on visual. + -#### *class* CriteriaValues +### *class* CriteriaValues + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) + -#### get_caption() → str +### get_caption() → str Get the caption. + -#### get_data(layer_name: str) → list +### get_data(layer_name: str) → list Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text. + -#### *static* get_display_name() → str +### *static* get_display_name() → str Get a descriptive title for this visual type. + -#### *static* get_group_name() → str +### *static* get_group_name() → str Get the name of the containing group. + -#### get_header_data(layer_name: str, horizontal: bool) → list +### get_header_data(layer_name: str, horizontal: bool) → list Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header. + -#### get_x_axis_label() → str +### get_x_axis_label() → str Get the x axis label. + -#### get_y_axis_label() → str +### get_y_axis_label() → str Get the y axis label. + -#### set_axes_enabled(enabled: bool) +### set_axes_enabled(enabled: bool) Set axes enabled state to True or False. + -#### set_caption(caption: str) +### set_caption(caption: str) Set the caption. + -#### set_line_width(line_width: float) +### set_line_width(line_width: float) Set the line width at the visual. + -#### set_ranges_x(minimum: float, maximum: float) +### set_ranges_x(minimum: float, maximum: float) Set the ranges to x-axis, Two inputs : minimum and maximum. + -#### set_ranges_y(minimum: float, maximum: float) +### set_ranges_y(minimum: float, maximum: float) Set the ranges to y-axis, Two inputs : minimum and maximum. + -#### set_x_axis_label(label_x: str) +### set_x_axis_label(label_x: str) Set the x axis label. + -#### set_y_axis_label(label_y: str) +### set_y_axis_label(label_y: str) Set the y axis label. + -#### update_plot() +### update_plot() Trigger an additional update on visual. + -#### Custom *= py_monitoring_gui.CustomData_Type.Custom* +### Custom *= py_monitoring_gui.CustomData_Type.Custom* + -#### *class* CustomData +### *class* CustomData + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) + -#### add_data(layer_name: str, data: PyOSDesignEntry, style_vector: StyleList, channel_names: WStrList, Vizualisation_type: CustomData_Type) → bool +### add_data(layer_name: str, data: PyOSDesignEntry, style_vector: StyleList, channel_names: WStrList, Vizualisation_type: CustomData_Type) → bool Add data as new layer to the Visual. + -#### add_eval_mesh(layer_name: str, x: doubleVec vector, y: doubleVec vector, color: doubleVec values) → bool +### add_eval_mesh(layer_name: str, x: doubleVec vector, y: doubleVec vector, color: doubleVec values) → bool Add data as new eval mesh layer to the Visual. + -#### add_grid(layer_name: str, data: PyOSDesignEntry) → bool +### add_grid(layer_name: str, data: PyOSDesignEntry) → bool Add data as new grid layer to the Visual. + -#### add_mesh(layer_name: str, x: doubleVec vector, y: doubleVec vector, style_vector: StyleList) → bool +### add_mesh(layer_name: str, x: doubleVec vector, y: doubleVec vector, style_vector: StyleList) → bool Add data as new mesh layer to the Visual. : If single_triangles=True, length of vectors has to be multiple size of 3 and equal. Produces single triangles. If single_triangles=False, then a colored stripe is been produced. Sizes has to be equal or greater equal than 3. + -#### clear_data() +### clear_data() Remove all layers. + -#### get_caption() → str +### get_caption() → str Get the caption. + -#### get_data(layer_name: str) → list +### get_data(layer_name: str) → list Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text. + -#### *static* get_display_name() → str +### *static* get_display_name() → str Get a descriptive title for this visual type. + -#### *static* get_group_name() → str +### *static* get_group_name() → str Get the name of the containing group. + -#### get_header_data(layer_name: str, horizontal: bool) → list +### get_header_data(layer_name: str, horizontal: bool) → list Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header. + -#### get_palette_preset_names() → list +### get_palette_preset_names() → list Get a list of available palette preset names. + -#### get_x_axis_label() → str +### get_x_axis_label() → str Get the x axis label. + -#### get_y_axis_label() → str +### get_y_axis_label() → str Get the y axis label. + -#### has_legend() → bool +### has_legend() → bool + -#### reset_palette_limits() +### reset_palette_limits() ReSet the minimum and maximum values of palette to default. + -#### reset_palette_maximum() +### reset_palette_maximum() Reset the maximum value of palette. + -#### reset_palette_minimum() +### reset_palette_minimum() Reset the minimum value of palette. + -#### set_alt_axis(axis: int, \_labels: WStrList, ticks: doubleVec) +### set_alt_axis(axis: int, \_labels: WStrList, ticks: doubleVec) Set an alternate axis to index (0 == x, 1== y, 2==z). : With labels as string_list, axes_ticks as vector, and an optional rotation_angle + -#### set_axes_enabled(arg2: bool) +### set_axes_enabled(arg2: bool) + -#### set_background_color(arg2: float, arg3: float, arg4: float, arg5: float) +### set_background_color(arg2: float, arg3: float, arg4: float, arg5: float) Change the background color. + -#### set_bar_width(layer_name: str, bar_width: float) +### set_bar_width(layer_name: str, bar_width: float) Set the width for StackedBar and Box (others will be ignored). : Senseful ranges between 1.0 (no space between bars) and 0.0 (bar is only a thin line). When the value is greater than 1.0 bars overlap. + -#### set_box_show_mean_and_median(layer_name: str, show_mean: bool) +### set_box_show_mean_and_median(layer_name: str, show_mean: bool) Toggle visibility of ‘Mean’ point additional to ‘Median’ line, if enough data_points are given. + -#### set_box_show_whisker(layer_name: str, show_whisker: bool) +### set_box_show_whisker(layer_name: str, show_whisker: bool) Toggle visibility of BoxPlot’s outer lines (whisker). + -#### set_caption(caption: str) +### set_caption(caption: str) Set the caption. + -#### set_iso_line_heights(layer_name: str, iso_lines_string: str) +### set_iso_line_heights(layer_name: str, iso_lines_string: str) -#### set_iso_line_heights(layer_name: str, iso_lines: [doubleVec](stdcpp_python_export.md#stdcpp_python_export.doubleVec)) +### set_iso_line_heights(layer_name: str, iso_lines: [doubleVec](stdcpp_python_export.md#stdcpp_python_export.doubleVec)) [0] Set the iso_lines given as string with delimiters space and ‘,’ and ‘;’ . Does only have effect when showing eval_mesh in this layer. [1] Set the iso lines as vector for given layer. Does only have effect when showing eval_mesh in this layer. + -#### set_legend_font_size(font_size: int) +### set_legend_font_size(font_size: int) Set the font_size used in legend. + -#### set_legend_position(x_position: float, y_position: float) +### set_legend_position(x_position: float, y_position: float) Set the position of the legend, using absolute or relative coordinates. : (Internally stored as relative.) + -#### set_legend_size(width: float, height: float) +### set_legend_size(width: float, height: float) Set the size of the legend, using absolute or relative coordinates. : (Internally stored as relative.) + -#### set_legend_visible(enabled: bool) +### set_legend_visible(enabled: bool) Set legend visibilty to True or False. + -#### set_line_width(arg2: float) +### set_line_width(arg2: float) + -#### set_lines_enabled(arg2: bool) +### set_lines_enabled(arg2: bool) + -#### set_log_x_axis(arg2: bool) +### set_log_x_axis(arg2: bool) + -#### set_log_y_axis(arg2: bool) +### set_log_y_axis(arg2: bool) + -#### set_object_text(arg2: str, arg3: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList), arg4: int, arg5: int) +### set_object_text(arg2: str, arg3: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList), arg4: int, arg5: int) Set the object text (e.g. on bars), from given list, spread to matrix when column is greater than 1 (e.g. multibar). + -#### set_palette_caption(layer_name: str, caption: str) +### set_palette_caption(layer_name: str, caption: str) Set the caption to the palette for given layer. + -#### set_palette_limits(minimum: float, maximum: float) +### set_palette_limits(minimum: float, maximum: float) Set the minimum and maximum values of palette. + -#### set_palette_maximum(maximum: float) +### set_palette_maximum(maximum: float) Set the maximum value of palette. + -#### set_palette_minimum(minimum: float) +### set_palette_minimum(minimum: float) Set the minimum value of palette. + -#### set_palette_position(x_position: float, y_position: float) +### set_palette_position(x_position: float, y_position: float) Set the position of the palette, using absolute or relative[%] coordinates. : (Internally stored as relative[%].) + -#### set_palette_preset(name: str) +### set_palette_preset(name: str) Set palette preset with given name. + -#### set_palette_size(x_position: float, y_position: float) +### set_palette_size(x_position: float, y_position: float) Set the size of the palette, using absolute or relative[%] coordinates. : (Internally stored as relative[%].) + -#### set_palette_visible(arg2: bool) +### set_palette_visible(arg2: bool) + -#### set_ranges_x(arg2: float, arg3: float) +### set_ranges_x(arg2: float, arg3: float) + -#### set_ranges_y(arg2: float, arg3: float) +### set_ranges_y(arg2: float, arg3: float) + -#### set_selection_color(arg2: str, arg3: int, arg4: int, arg5: int, arg6: int) +### set_selection_color(arg2: str, arg3: int, arg4: int, arg5: int, arg6: int) Set the selection color. + -#### set_selection_text(arg2: str, arg3: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) +### set_selection_text(arg2: str, arg3: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)) Set the selection text (e.g. on points, shown when selected), from given list. + -#### set_surfaces_enabled(arg2: bool) +### set_surfaces_enabled(arg2: bool) + -#### set_symbol_size(arg2: float) +### set_symbol_size(arg2: float) + -#### set_x_axis_format(arg2: str) +### set_x_axis_format(arg2: str) + -#### set_x_axis_label(label_x: str) +### set_x_axis_label(label_x: str) Set the x axis label. + -#### set_y_axis_format(arg2: str) +### set_y_axis_format(arg2: str) + -#### set_y_axis_label(label_y: str) +### set_y_axis_label(label_y: str) Set the y axis label. + -#### unset_alt_axis(arg2: int) +### unset_alt_axis(arg2: int) Unset the alternate axis at index (0 == x, 1== y, 2==z) to default float axis + -#### unset_background_color() +### unset_background_color() Reset background color to default [0.9,0.9,0.9,1.0]. + -#### unset_object_text(arg2: str) +### unset_object_text(arg2: str) Unset the object text. + -#### update_plot() +### update_plot() Trigger an additional update on visual. + -#### *class* CustomData_Type +### *class* CustomData_Type **Enumeration** + -#### Bars *= py_monitoring_gui.CustomData_Type.Bars* +### Bars *= py_monitoring_gui.CustomData_Type.Bars* + -#### Box *= py_monitoring_gui.CustomData_Type.Box* +### Box *= py_monitoring_gui.CustomData_Type.Box* + -#### Custom *= py_monitoring_gui.CustomData_Type.Custom* +### Custom *= py_monitoring_gui.CustomData_Type.Custom* + -#### Grid *= py_monitoring_gui.CustomData_Type.Grid* +### Grid *= py_monitoring_gui.CustomData_Type.Grid* + -#### HorizontalBars *= py_monitoring_gui.CustomData_Type.HorizontalBars* +### HorizontalBars *= py_monitoring_gui.CustomData_Type.HorizontalBars* + -#### HorizontalBox *= py_monitoring_gui.CustomData_Type.HorizontalBox* +### HorizontalBox *= py_monitoring_gui.CustomData_Type.HorizontalBox* + -#### Lines *= py_monitoring_gui.CustomData_Type.Lines* +### Lines *= py_monitoring_gui.CustomData_Type.Lines* + -#### Points *= py_monitoring_gui.CustomData_Type.Points* +### Points *= py_monitoring_gui.CustomData_Type.Points* + -#### StackedBars *= py_monitoring_gui.CustomData_Type.StackedBars* +### StackedBars *= py_monitoring_gui.CustomData_Type.StackedBars* + -#### StackedHorizontalBars *= py_monitoring_gui.CustomData_Type.StackedHorizontalBars* +### StackedHorizontalBars *= py_monitoring_gui.CustomData_Type.StackedHorizontalBars* + -#### *class* DesignTable +### *class* DesignTable + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) + -#### *static* get_display_name() → str +### *static* get_display_name() → str Get a descriptive title for this visual type. + -#### *static* get_group_name() → str +### *static* get_group_name() → str Get the name of the containing group. + -#### *class* DimensionId +### *class* DimensionId + -#### \_\_init_\_() +### \_\_init_\_() + -#### get_dimension_from_index(ax_index: int) → [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension) +### get_dimension_from_index(ax_index: int) → [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension) Return the dimension set at ax_index, if exist, else return dimension(). + -#### get_dimension_id_from_index(ax_index: int) → int +### get_dimension_id_from_index(ax_index: int) → int Return the dimension_id set at ax_index, if exist, else return -1. + -#### has_dimension_at_index(ax_index: int) → bool +### has_dimension_at_index(ax_index: int) → bool Return True when a dimension is set at ax-index of plot. + -#### has_dimension_id_at_index(ax_index: int) → bool +### has_dimension_id_at_index(ax_index: int) → bool Return True when the plot has a dimension_combo_box id set at ax_index. + -#### has_dimension_set_at_index(ax_index: int) → bool +### has_dimension_set_at_index(ax_index: int) → bool Return True when a dimension is set at ax-index of plot. + -#### listen_to_dimension_index(arg2: int) +### listen_to_dimension_index(arg2: int) deprecated - use set_dimension_id_at_index(0, … ) instead. + -#### reset_user_defined_variable_selection() +### reset_user_defined_variable_selection() Reset the previously made changes on dimension id to the predefined values, been saved at the visual on creation. + -#### set_dimension(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### set_dimension(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) deprecated - use set_dimension_at_index(0, … ) instead. + -#### set_dimension_at_index(ax_index: int, dimension_at_x_i: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### set_dimension_at_index(ax_index: int, dimension_at_x_i: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) Set a dimension at given ax_index to plot. + -#### set_dimension_id_at_index(ax_index: int, combo_box_id: int) +### set_dimension_id_at_index(ax_index: int, combo_box_id: int) Set a combo_box_id at ax_index. : Plot now shows content of belonging combo_box at ax_index. e.g. SetDimensionToId(1,2) means that the plot now shows the chosen dimension from 3rd combo_box at y-axis. + -#### unset_dimension_at_index(ax_index: int) +### unset_dimension_at_index(ax_index: int) Unset the dimension at given ax_index. : Plot now shows the predefined behavior. + -#### unset_dimension_id_at_index(ax_index: int) +### unset_dimension_id_at_index(ax_index: int) Unset the dimension_id at given ax_index. : Plot now shows the predefined behavior. + -#### *class* ExtendedCoPMatrix +### *class* ExtendedCoPMatrix + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) + -#### export(file_path: Path) +### export(file_path: Path) -#### export(file_path: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), width: int, height: int) +### export(file_path: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), width: int, height: int) [0] Export the visual as picture, with given relative scale to file position given as path. : If scale is left empty, 1.0 is used. [1] Export the visual as picture, with given absolute sizes to file position given as path. + -#### *static* get_display_name() → str +### *static* get_display_name() → str Get a descriptive title for this visual type. + -#### *static* get_group_name() → str +### *static* get_group_name() → str Get the name of the containing group. + -#### set_auto_rotate_axis_labels_enabled(enable: bool) +### set_auto_rotate_axis_labels_enabled(enable: bool) Enable/disable axis label auto rotation. + -#### set_fix_projection_to_design(show: bool) +### set_fix_projection_to_design(show: bool) Enables/disables fix projection to designs. + -#### set_indices_type(indices_type: [ApproximatingCOPMatrixIndicesType](#py_monitoring_gui.ApproximatingCOPMatrixIndicesType)) +### set_indices_type(indices_type: [ApproximatingCOPMatrixIndicesType](#py_monitoring_gui.ApproximatingCOPMatrixIndicesType)) Toggle the view to see “Total effects”, “Main effects” or “Interactions” in matrix. + -#### set_limit_axis_label_size(enable: bool) +### set_limit_axis_label_size(enable: bool) Limit axis label size. + -#### set_line_width(line_width: float) +### set_line_width(line_width: float) Set the line width at the visual. + -#### set_show_approximation(show: bool) +### set_show_approximation(show: bool) Show/hide approximation line. + -#### set_show_background_cop(show: bool) +### set_show_background_cop(show: bool) Show/hide background COP. + -#### set_show_cop(show: bool) +### set_show_cop(show: bool) Show/hide COP. + -#### set_show_filtered(show: bool) +### set_show_filtered(show: bool) Show/hide filtered parameters/responses. + -#### set_show_grid(show: bool) +### set_show_grid(show: bool) Show/hide grid. + -#### set_show_parameter_line(show: bool) +### set_show_parameter_line(show: bool) Show/hide parameter line. + -#### set_show_support_points(show: bool) +### set_show_support_points(show: bool) Show/hide support points. + -#### set_symbol_size(symbol_size: float) +### set_symbol_size(symbol_size: float) Set the symbol size at the visual. + -#### set_use_rectangular_view(show: bool) +### set_use_rectangular_view(show: bool) Enables/disables rectangular view. + -#### *class* ExtendedCorrelationMatrix +### *class* ExtendedCorrelationMatrix + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) + -#### export_with_given_tile_sizes(arg2: Path, arg3: int, file_path: int) +### export_with_given_tile_sizes(arg2: Path, arg3: int, file_path: int) Export the visual as picture, with given absolute tile sizes to file position given as path. + -#### get_caption() → str +### get_caption() → str Get the caption. + -#### get_data(layer_name: str) → list +### get_data(layer_name: str) → list Get data from DataTable of layer layer_name as list of lists. : Be aware that much memory can be allocated, in case of many dimensions. + -#### *static* get_display_name() → str +### *static* get_display_name() → str Get a descriptive title for this visual type. + -#### *static* get_group_name() → str +### *static* get_group_name() → str Get the name of the containing group. + -#### get_header_data(layer_name: str, horizontal: bool) → list +### get_header_data(layer_name: str, horizontal: bool) → list Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header. + -#### get_palette_preset_names() → list +### get_palette_preset_names() → list Get a list of available palette preset names. + -#### get_sizes_with_given_tile_sizes(tile_width: float, tile_height: float) → list +### get_sizes_with_given_tile_sizes(tile_width: float, tile_height: float) → list Return list with size of plot when tiles have to be sized with x_tile_size and y_tile_size. Index 0 : width. index 1 : height. + -#### get_x_axis_label() → str +### get_x_axis_label() → str Get the x axis label. + -#### get_y_axis_label() → str +### get_y_axis_label() → str Get the y axis label. + -#### reset_palette_limits() +### reset_palette_limits() ReSet the minimum and maximum values of palette to default. + -#### reset_palette_maximum() +### reset_palette_maximum() Reset the maximum value of palette. + -#### reset_palette_minimum() +### reset_palette_minimum() Reset the minimum value of palette. + -#### set_axes_rotation_enabled(enable: bool) +### set_axes_rotation_enabled(enable: bool) Set axes rotation enabled. + -#### set_axes_rotation_orthogonal(enable: bool) +### set_axes_rotation_orthogonal(enable: bool) Set rotation angles to 0 degree if possible, else to 90. + -#### set_axes_rotation_x_angle(angle: float) +### set_axes_rotation_x_angle(angle: float) Set the rotation angle for x-axis. + -#### set_axes_rotation_y_angle(angle: float) +### set_axes_rotation_y_angle(angle: float) Set the rotation angle for y-axis. + -#### set_caption(caption: str) +### set_caption(caption: str) Set the caption. + -#### set_histogram_classes(classes: int) +### set_histogram_classes(classes: int) Set the number of histogram classes. + -#### set_palette_limits(minimum: float, maximum: float) +### set_palette_limits(minimum: float, maximum: float) Set the minimum and maximum values of palette. + -#### set_palette_maximum(maximum: float) +### set_palette_maximum(maximum: float) Set the maximum value of palette. + -#### set_palette_minimum(minimum: float) +### set_palette_minimum(minimum: float) Set the minimum value of palette. + -#### set_palette_position(x_position: float, y_position: float) +### set_palette_position(x_position: float, y_position: float) Set the position of the palette, using absolute or relative[%] coordinates. : (Internally stored as relative[%].) + -#### set_palette_preset(name: str) +### set_palette_preset(name: str) Set palette preset with given name. + -#### set_palette_size(x_position: float, y_position: float) +### set_palette_size(x_position: float, y_position: float) Set the size of the palette, using absolute or relative[%] coordinates. : (Internally stored as relative[%].) + -#### set_palette_visible(enabled: bool) +### set_palette_visible(enabled: bool) Set palette visibility to True or False. + -#### set_symbol_size(symbol_size: float) +### set_symbol_size(symbol_size: float) Set the symbol size at the visual. + -#### set_view_type(view_type: [ExtendedCorrelationMatrixViewTypes](#py_monitoring_gui.ExtendedCorrelationMatrixViewTypes)) +### set_view_type(view_type: [ExtendedCorrelationMatrixViewTypes](#py_monitoring_gui.ExtendedCorrelationMatrixViewTypes)) Change the view of the visual to show the entils as : ExtendedCorrelationMatrixViewTypes.All_Correlations - correlation values in all entils @@ -3017,422 +3633,507 @@ Change the view of the visual to show the entils as ExtendedCorrelationMatrixViewTypes.Anthills_vs_Correlations - anthills in upper left part, histograms on main diagonal and correlation values in lower right part. ExtendedCorrelationMatrixViewTypes.All_Anthills - histograms on main diagonal, elsewhere anthills. + -#### set_x_axis_label(label_x: str) +### set_x_axis_label(label_x: str) Set the x axis label. + -#### set_y_axis_label(label_y: str) +### set_y_axis_label(label_y: str) Set the y axis label. + -#### update_plot() +### update_plot() Trigger an additional update on visual. + -#### Grid *= py_monitoring_gui.CustomData_Type.Grid* +### Grid *= py_monitoring_gui.CustomData_Type.Grid* + -#### *class* Histogram +### *class* Histogram + -#### ListenToDimensionIndex(arg2: int) +### ListenToDimensionIndex(arg2: int) deprecated - use set_dimension_id_at_index(0, … ) instead. + -#### SetAlpha(alpha_value: float) +### SetAlpha(alpha_value: float) Adjust the result wenn automatic fit is been chosen (actual when rv_types size is greater 1). + -#### SetChi2(chi_flag: bool) +### SetChi2(chi_flag: bool) Adjust the result wenn automatic fit is been chosen (actual when rv_types size is greater 1). + -#### SetDimension(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### SetDimension(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) deprecated - use set_dimension_at_index(0, … ) instead. + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) + -#### get_actual_dimension() → [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension) +### get_actual_dimension() → [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension) Return the actual visible dimension. + -#### get_caption() → str +### get_caption() → str Get the caption. + -#### get_data(layer_name: str) → list +### get_data(layer_name: str) → list Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text. + -#### *static* get_display_name() → str +### *static* get_display_name() → str Get a descriptive title for this visual type. + -#### *static* get_group_name() → str +### *static* get_group_name() → str Get the name of the containing group. + -#### get_header_data(layer_name: str, horizontal: bool) → list +### get_header_data(layer_name: str, horizontal: bool) → list Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header. + -#### get_statistical_data() → list +### get_statistical_data() → list Get statistical data as list of lists. + -#### get_x_axis_label() → str +### get_x_axis_label() → str Get the x axis label. + -#### get_y_axis_label() → str +### get_y_axis_label() → str Get the y axis label. + -#### has_legend() → bool +### has_legend() → bool + -#### set_alpha(alpha_value: float) +### set_alpha(alpha_value: float) Adjust the result wenn automatic fit is been chosen (actual when rv_types size is greater 1). + -#### set_axes_enabled(enabled: bool) +### set_axes_enabled(enabled: bool) Set axes enabled state to True or False. + -#### set_caption(caption: str) +### set_caption(caption: str) Set the caption. + -#### set_chi_2(chi_flag: bool) +### set_chi_2(chi_flag: bool) Adjust the result wenn automatic fit is been chosen (actual when rv_types size is greater 1). + -#### set_fit_type(fit_type: [RandomVariableType](dynardo_py_algorithms.md#dynardo_py_algorithms.RandomVariableType)) +### set_fit_type(fit_type: [RandomVariableType](dynardo_py_algorithms.md#dynardo_py_algorithms.RandomVariableType)) Set a random variable type for the fit. + -#### set_fit_type_to_automatic() +### set_fit_type_to_automatic() Set fit to automatic. + -#### set_fit_type_to_none() +### set_fit_type_to_none() Set fit to none. + -#### set_fit_types_for_automatic(rv_type: [RandomVariableTypeVec](dynardo_py_algorithms.md#dynardo_py_algorithms.RandomVariableTypeVec)) +### set_fit_types_for_automatic(rv_type: [RandomVariableTypeVec](dynardo_py_algorithms.md#dynardo_py_algorithms.RandomVariableTypeVec)) Set a vector of random variable types to be used for automatic fit. + -#### set_histogram_classes(classes: int) +### set_histogram_classes(classes: int) Set the number of histogram classes. + -#### set_legend_font_size(font_size: int) +### set_legend_font_size(font_size: int) Set the font_size used in legend. + -#### set_legend_position(x_position: float, y_position: float) +### set_legend_position(x_position: float, y_position: float) Set the position of the legend, using absolute or relative coordinates. : (Internally stored as relative.) + -#### set_legend_size(width: float, height: float) +### set_legend_size(width: float, height: float) Set the size of the legend, using absolute or relative coordinates. : (Internally stored as relative.) + -#### set_legend_visible(enabled: bool) +### set_legend_visible(enabled: bool) Set legend visibilty to True or False. + -#### set_line_width(line_width: float) +### set_line_width(line_width: float) Set the line width at the visual. + -#### set_lines_enabled(enabled: bool) +### set_lines_enabled(enabled: bool) Set lines enabled state to True or False. + -#### set_probability_value(probability_value: float) +### set_probability_value(probability_value: float) Set probability value. + -#### set_ranges_x(minimum: float, maximum: float) +### set_ranges_x(minimum: float, maximum: float) Set the ranges to x-axis, Two inputs : minimum and maximum. + -#### set_ranges_y(minimum: float, maximum: float) +### set_ranges_y(minimum: float, maximum: float) Set the ranges to y-axis, Two inputs : minimum and maximum. + -#### set_sigma_level(sigma_level: float) +### set_sigma_level(sigma_level: float) Set sigma level for pdf. + -#### set_surfaces_enabled(enabled: bool) +### set_surfaces_enabled(enabled: bool) Set surfaces enabled state to True or False. + -#### set_x_axis_format(x_axis_format: str) +### set_x_axis_format(x_axis_format: str) Set the axis format for x axis. Will be ignored if log axis is been chosen for x-axis. + -#### set_x_axis_label(label_x: str) +### set_x_axis_label(label_x: str) Set the x axis label. + -#### set_y_axis_format(y_axis_format: str) +### set_y_axis_format(y_axis_format: str) Set the axis format for y axis. Will be ignored if log axis is been chosen for y-axis. + -#### set_y_axis_label(label_y: str) +### set_y_axis_label(label_y: str) Set the y axis label. + -#### show_as_cdf(show_as_cdf: bool) +### show_as_cdf(show_as_cdf: bool) Show histogram bars, defined pdf and fitted pdf as cdf. + -#### show_defined_pdf(show_defined_pdf: bool) +### show_defined_pdf(show_defined_pdf: bool) Show defined pdf. + -#### show_limits(sigma_level: bool) +### show_limits(sigma_level: bool) Show limits. + -#### show_probability(show_probability: bool) +### show_probability(show_probability: bool) Show probability. + -#### show_process_capability(show_process_capability: bool) +### show_process_capability(show_process_capability: bool) Show process capability. + -#### unset_fit_types_for_automatic() +### unset_fit_types_for_automatic() Unset the vector of random variable types to standard. + -#### update_plot() +### update_plot() Trigger an additional update on visual. + -#### *class* History +### *class* History + -#### SetAbscissa(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### SetAbscissa(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) deprecated - use set_dimension_at_index(0, … ) instead. + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) + -#### get_actual_dimension() → [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension) +### get_actual_dimension() → [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension) Return the actual visible dimension. + -#### get_caption() → str +### get_caption() → str Get the caption. + -#### get_data(layer_name: str) → list +### get_data(layer_name: str) → list Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text. + -#### *static* get_display_name() → str +### *static* get_display_name() → str Get a descriptive title for this visual type. + -#### *static* get_group_name() → str +### *static* get_group_name() → str Get the name of the containing group. + -#### get_header_data(layer_name: str, horizontal: bool) → list +### get_header_data(layer_name: str, horizontal: bool) → list Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header. + -#### get_x_axis_label() → str +### get_x_axis_label() → str Get the x axis label. + -#### get_y_axis_label() → str +### get_y_axis_label() → str Get the y axis label. + -#### has_legend() → bool +### has_legend() → bool + -#### set_abscissa(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### set_abscissa(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) deprecated - use set_dimension_at_index(0, … ) instead. + -#### set_axes_enabled(enabled: bool) +### set_axes_enabled(enabled: bool) Set axes enabled state to True or False. + -#### set_caption(caption: str) +### set_caption(caption: str) Set the caption. + -#### set_legend_font_size(font_size: int) +### set_legend_font_size(font_size: int) Set the font_size used in legend. + -#### set_legend_position(x_position: float, y_position: float) +### set_legend_position(x_position: float, y_position: float) Set the position of the legend, using absolute or relative coordinates. : (Internally stored as relative.) + -#### set_legend_size(width: float, height: float) +### set_legend_size(width: float, height: float) Set the size of the legend, using absolute or relative coordinates. : (Internally stored as relative.) + -#### set_legend_visible(enabled: bool) +### set_legend_visible(enabled: bool) Set legend visibilty to True or False. + -#### set_line_width(line_width: float) +### set_line_width(line_width: float) Set the line width at the visual. + -#### set_log_y_axis(enabled: bool) +### set_log_y_axis(enabled: bool) Set the y-axis to show values logarithmic. Will be ignored if data range contains values <=0 + -#### set_ranges_x(minimum: float, maximum: float) +### set_ranges_x(minimum: float, maximum: float) Set the ranges to x-axis, Two inputs : minimum and maximum. + -#### set_ranges_y(minimum: float, maximum: float) +### set_ranges_y(minimum: float, maximum: float) Set the ranges to y-axis, Two inputs : minimum and maximum. + -#### set_symbol_size(symbol_size: float) +### set_symbol_size(symbol_size: float) Set the symbol size at the visual. + -#### set_x_axis_label(label_x: str) +### set_x_axis_label(label_x: str) Set the x axis label. + -#### set_y_axis_format(y_axis_format: str) +### set_y_axis_format(y_axis_format: str) Set the axis format for y axis. Will be ignored if log axis is been chosen for y-axis. + -#### set_y_axis_label(label_y: str) +### set_y_axis_label(label_y: str) Set the y axis label. + -#### update_plot() +### update_plot() Trigger an additional update on visual. + -#### HorizontalBars *= py_monitoring_gui.CustomData_Type.HorizontalBars* +### HorizontalBars *= py_monitoring_gui.CustomData_Type.HorizontalBars* + -#### HorizontalBox *= py_monitoring_gui.CustomData_Type.HorizontalBox* +### HorizontalBox *= py_monitoring_gui.CustomData_Type.HorizontalBox* + -#### Lines *= py_monitoring_gui.CustomData_Type.Lines* +### Lines *= py_monitoring_gui.CustomData_Type.Lines* + -#### *class* New_ParallelCoordinatesPlot +### *class* New_ParallelCoordinatesPlot + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) + -#### export(file_path: Path) +### export(file_path: Path) -#### export(file_path: Path, width: int, height: int) +### export(file_path: Path, width: int, height: int) [0] Export the visual as picture, with given relative scale to file position given as path. : If scale is left empty, 1.0 is used. @@ -3443,342 +4144,409 @@ Trigger an additional update on visual. : Transparency produces plot with transparent background which is available when having picture types supporting this, like png. Quality is available for jpg, determining the quality of the output in percent [0:100]. + -#### get_caption() → str +### get_caption() → str Get the caption. + -#### *static* get_display_name() → str +### *static* get_display_name() → str Get a descriptive title for this visual type. + -#### *static* get_group_name() → str +### *static* get_group_name() → str Get the name of the containing group. + -#### set_caption(caption: str) +### set_caption(caption: str) Set the caption. + -#### set_font_size(arg2: int) +### set_font_size(arg2: int) Set the font size at the visual. + -#### set_line_width(line_width: float) +### set_line_width(line_width: float) Set the line width at the visual. + -#### set_symbol_size(symbol_size: float) +### set_symbol_size(symbol_size: float) Set the symbol size at the visual. + -#### *class* OptimizationHistory +### *class* OptimizationHistory + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) + -#### get_active_layer_names() → list +### get_active_layer_names() → list Get actual active layer names. + -#### get_available_layer_names() → list +### get_available_layer_names() → list Get all possible layer names. + -#### get_caption() → str +### get_caption() → str Get the caption. + -#### get_data(layer_name: str) → list +### get_data(layer_name: str) → list Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text. + -#### *static* get_display_name() → str +### *static* get_display_name() → str Get a descriptive title for this visual type. + -#### *static* get_group_name() → str +### *static* get_group_name() → str Get the name of the containing group. + -#### get_header_data(layer_name: str, horizontal: bool) → list +### get_header_data(layer_name: str, horizontal: bool) → list Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header. + -#### get_x_axis_label() → str +### get_x_axis_label() → str Get the x axis label. + -#### get_y_axis_label() → str +### get_y_axis_label() → str Get the y axis label. + -#### has_legend() → bool +### has_legend() → bool + -#### set_all_layers_active_state(arg2: bool) +### set_all_layers_active_state(arg2: bool) Set active state of all layers. + -#### set_axes_enabled(enabled: bool) +### set_axes_enabled(enabled: bool) Set axes enabled state to True or False. + -#### set_caption(caption: str) +### set_caption(caption: str) Set the caption. + -#### set_layer_active_state(arg2: str, arg3: bool) +### set_layer_active_state(arg2: str, arg3: bool) Set active state of layer with given layer name. + -#### set_layers_active_state(arg2: list, arg3: bool) +### set_layers_active_state(arg2: list, arg3: bool) Set active state of layers with given layer names. + -#### set_legend_font_size(font_size: int) +### set_legend_font_size(font_size: int) Set the font_size used in legend. + -#### set_legend_position(x_position: float, y_position: float) +### set_legend_position(x_position: float, y_position: float) Set the position of the legend, using absolute or relative coordinates. : (Internally stored as relative.) + -#### set_legend_size(width: float, height: float) +### set_legend_size(width: float, height: float) Set the size of the legend, using absolute or relative coordinates. : (Internally stored as relative.) + -#### set_legend_visible(enabled: bool) +### set_legend_visible(enabled: bool) Set legend visibilty to True or False. + -#### set_line_width(line_width: float) +### set_line_width(line_width: float) Set the line width at the visual. + -#### set_log_y_axis(enabled: bool) +### set_log_y_axis(enabled: bool) Set the y-axis to show values logarithmic. Will be ignored if data range contains values <=0 + -#### set_ranges_x(minimum: float, maximum: float) +### set_ranges_x(minimum: float, maximum: float) Set the ranges to x-axis, Two inputs : minimum and maximum. + -#### set_ranges_y(minimum: float, maximum: float) +### set_ranges_y(minimum: float, maximum: float) Set the ranges to y-axis, Two inputs : minimum and maximum. + -#### set_x_axis_label(label_x: str) +### set_x_axis_label(label_x: str) Set the x axis label. + -#### set_y_axis_format(y_axis_format: str) +### set_y_axis_format(y_axis_format: str) Set the axis format for y axis. Will be ignored if log axis is been chosen for y-axis. + -#### set_y_axis_label(label_y: str) +### set_y_axis_label(label_y: str) Set the y axis label. + -#### update_plot() +### update_plot() Trigger an additional update on visual. + -#### *class* PCAData +### *class* PCAData + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) + -#### get_caption() → str +### get_caption() → str Get the caption. + -#### get_data(layer_name: str) → list +### get_data(layer_name: str) → list Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text. + -#### *static* get_display_name() → str +### *static* get_display_name() → str Get a descriptive title for this visual type. + -#### *static* get_group_name() → str +### *static* get_group_name() → str Get the name of the containing group. + -#### get_header_data(layer_name: str, horizontal: bool) → list +### get_header_data(layer_name: str, horizontal: bool) → list Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header. + -#### get_palette_preset_names() → list +### get_palette_preset_names() → list Get a list of available palette preset names. + -#### get_x_axis_label() → str +### get_x_axis_label() → str Get the x axis label. + -#### get_y_axis_label() → str +### get_y_axis_label() → str Get the y axis label. + -#### reset_palette_limits() +### reset_palette_limits() ReSet the minimum and maximum values of palette to default. + -#### reset_palette_maximum() +### reset_palette_maximum() Reset the maximum value of palette. + -#### reset_palette_minimum() +### reset_palette_minimum() Reset the minimum value of palette. + -#### set_axes_enabled(enabled: bool) +### set_axes_enabled(enabled: bool) Set axes enabled state to True or False. + -#### set_caption(caption: str) +### set_caption(caption: str) Set the caption. + -#### set_line_width(line_width: float) +### set_line_width(line_width: float) Set the line width at the visual. + -#### set_palette_limits(minimum: float, maximum: float) +### set_palette_limits(minimum: float, maximum: float) Set the minimum and maximum values of palette. + -#### set_palette_maximum(maximum: float) +### set_palette_maximum(maximum: float) Set the maximum value of palette. + -#### set_palette_minimum(minimum: float) +### set_palette_minimum(minimum: float) Set the minimum value of palette. + -#### set_palette_position(x_position: float, y_position: float) +### set_palette_position(x_position: float, y_position: float) Set the position of the palette, using absolute or relative[%] coordinates. : (Internally stored as relative[%].) + -#### set_palette_preset(name: str) +### set_palette_preset(name: str) Set palette preset with given name. + -#### set_palette_size(x_position: float, y_position: float) +### set_palette_size(x_position: float, y_position: float) Set the size of the palette, using absolute or relative[%] coordinates. : (Internally stored as relative[%].) + -#### set_palette_visible(enabled: bool) +### set_palette_visible(enabled: bool) Set palette visibility to True or False. + -#### set_ranges_x(minimum: float, maximum: float) +### set_ranges_x(minimum: float, maximum: float) Set the ranges to x-axis, Two inputs : minimum and maximum. + -#### set_ranges_y(minimum: float, maximum: float) +### set_ranges_y(minimum: float, maximum: float) Set the ranges to y-axis, Two inputs : minimum and maximum. + -#### set_x_axis_label(label_x: str) +### set_x_axis_label(label_x: str) Set the x axis label. + -#### set_y_axis_label(label_y: str) +### set_y_axis_label(label_y: str) Set the y axis label. + -#### update_plot() +### update_plot() Trigger an additional update on visual. + -#### *class* ParallelCoordinatesPlot +### *class* ParallelCoordinatesPlot + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) + -#### export(file_path: Path) +### export(file_path: Path) -#### export(file_path: Path, width: int, height: int) +### export(file_path: Path, width: int, height: int) [0] Export the visual as picture, with given relative scale to file position given as path. : If scale is left empty, 1.0 is used. @@ -3789,2872 +4557,3443 @@ Trigger an additional update on visual. : Transparency produces plot with transparent background which is available when having picture types supporting this, like png. Quality is available for jpg, determining the quality of the output in percent [0:100]. + -#### get_caption() → str +### get_caption() → str Get the caption. + -#### *static* get_display_name() → str +### *static* get_display_name() → str Get a descriptive title for this visual type. + -#### *static* get_group_name() → str +### *static* get_group_name() → str Get the name of the containing group. + -#### set_caption(caption: str) +### set_caption(caption: str) Set the caption. + -#### set_font_size(arg2: int) +### set_font_size(arg2: int) Set the font size at the visual. + -#### set_line_width(line_width: float) +### set_line_width(line_width: float) Set the line width at the visual. + -#### set_symbol_size(symbol_size: float) +### set_symbol_size(symbol_size: float) Set the symbol size at the visual. + -#### *class* ParameterValues +### *class* ParameterValues + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) + -#### get_caption() → str +### get_caption() → str Get the caption. + -#### get_data(layer_name: str) → list +### get_data(layer_name: str) → list Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text. + -#### *static* get_display_name() → str +### *static* get_display_name() → str Get a descriptive title for this visual type. + -#### *static* get_group_name() → str +### *static* get_group_name() → str Get the name of the containing group. + -#### get_header_data(layer_name: str, horizontal: bool) → list +### get_header_data(layer_name: str, horizontal: bool) → list Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header. + -#### get_x_axis_label() → str +### get_x_axis_label() → str Get the x axis label. + -#### get_y_axis_label() → str +### get_y_axis_label() → str Get the y axis label. + -#### set_axes_enabled(enabled: bool) +### set_axes_enabled(enabled: bool) Set axes enabled state to True or False. + -#### set_caption(caption: str) +### set_caption(caption: str) Set the caption. + -#### set_line_width(line_width: float) +### set_line_width(line_width: float) Set the line width at the visual. + -#### set_ranges_x(minimum: float, maximum: float) +### set_ranges_x(minimum: float, maximum: float) Set the ranges to x-axis, Two inputs : minimum and maximum. + -#### set_ranges_y(minimum: float, maximum: float) +### set_ranges_y(minimum: float, maximum: float) Set the ranges to y-axis, Two inputs : minimum and maximum. + -#### set_x_axis_label(label_x: str) +### set_x_axis_label(label_x: str) Set the x axis label. + -#### set_y_axis_label(label_y: str) +### set_y_axis_label(label_y: str) Set the y axis label. + -#### update_plot() +### update_plot() Trigger an additional update on visual. + -#### *class* Parametrization +### *class* Parametrization + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) + -#### *static* get_display_name() → str +### *static* get_display_name() → str Get a descriptive title for this visual type. + -#### *static* get_group_name() → str +### *static* get_group_name() → str Get the name of the containing group. + -#### *class* Pareto2D +### *class* Pareto2D + -#### SetAbscissa(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### SetAbscissa(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) deprecated - use set_dimension_at_index(0, … ) instead. + -#### SetDimensions(x_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension), y_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### SetDimensions(x_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension), y_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) Set the dimensions to be shown in visual. + -#### SetOrdinate(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### SetOrdinate(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) deprecated - use set_dimension_at_index(1, … ) instead. + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) + -#### get_actual_dimensions() → [DimensionVector](py_monitoring_kernel.md#py_monitoring_kernel.DimensionVector) +### get_actual_dimensions() → [DimensionVector](py_monitoring_kernel.md#py_monitoring_kernel.DimensionVector) Return the actual visible dimensions as vector. + -#### get_caption() → str +### get_caption() → str Get the caption. + -#### get_data(layer_name: str) → list +### get_data(layer_name: str) → list Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text. + -#### *static* get_display_name() → str +### *static* get_display_name() → str Get a descriptive title for this visual type. + -#### *static* get_group_name() → str +### *static* get_group_name() → str Get the name of the containing group. + -#### get_header_data(layer_name: str, horizontal: bool) → list +### get_header_data(layer_name: str, horizontal: bool) → list Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header. + -#### get_x_axis_label() → str +### get_x_axis_label() → str Get the x axis label. + -#### get_y_axis_label() → str +### get_y_axis_label() → str Get the y axis label. + -#### has_legend() → bool +### has_legend() → bool + -#### set_abscissa(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### set_abscissa(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) deprecated - use set_dimension_at_index(0, … ) instead. + -#### set_axes_enabled(enabled: bool) +### set_axes_enabled(enabled: bool) Set axes enabled state to True or False. + -#### set_caption(caption: str) +### set_caption(caption: str) Set the caption. + -#### set_dimensions(x_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension), y_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### set_dimensions(x_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension), y_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) Set the dimensions to be shown in visual. + -#### set_legend_font_size(font_size: int) +### set_legend_font_size(font_size: int) Set the font_size used in legend. + -#### set_legend_position(x_position: float, y_position: float) +### set_legend_position(x_position: float, y_position: float) Set the position of the legend, using absolute or relative coordinates. : (Internally stored as relative.) + -#### set_legend_size(width: float, height: float) +### set_legend_size(width: float, height: float) Set the size of the legend, using absolute or relative coordinates. : (Internally stored as relative.) + -#### set_legend_visible(enabled: bool) +### set_legend_visible(enabled: bool) Set legend visibilty to True or False. + -#### set_line_width(line_width: float) +### set_line_width(line_width: float) Set the line width at the visual. + -#### set_log_x_axis(enabled: bool) +### set_log_x_axis(enabled: bool) Set the x-axis to show values logarithmic. Will be ignored if data range contains values <=0. + -#### set_log_y_axis(enabled: bool) +### set_log_y_axis(enabled: bool) Set the y-axis to show values logarithmic. Will be ignored if data range contains values <=0 + -#### set_ordinate(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### set_ordinate(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) deprecated - use set_dimension_at_index(1, … ) instead. + -#### set_ranges_x(minimum: float, maximum: float) +### set_ranges_x(minimum: float, maximum: float) Set the ranges to x-axis, Two inputs : minimum and maximum. + -#### set_ranges_y(minimum: float, maximum: float) +### set_ranges_y(minimum: float, maximum: float) Set the ranges to y-axis, Two inputs : minimum and maximum. + -#### set_symbol_size(symbol_size: float) +### set_symbol_size(symbol_size: float) Set the symbol size at the visual. + -#### set_x_axis_format(x_axis_format: str) +### set_x_axis_format(x_axis_format: str) Set the axis format for x axis. Will be ignored if log axis is been chosen for x-axis. + -#### set_x_axis_label(label_x: str) +### set_x_axis_label(label_x: str) Set the x axis label. + -#### set_y_axis_format(y_axis_format: str) +### set_y_axis_format(y_axis_format: str) Set the axis format for y axis. Will be ignored if log axis is been chosen for y-axis. + -#### set_y_axis_label(label_y: str) +### set_y_axis_label(label_y: str) Set the y axis label. + -#### update_plot() +### update_plot() Trigger an additional update on visual. + -#### *class* Pareto3D +### *class* Pareto3D + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) + -#### get_actual_dimensions() → [DimensionVector](py_monitoring_kernel.md#py_monitoring_kernel.DimensionVector) +### get_actual_dimensions() → [DimensionVector](py_monitoring_kernel.md#py_monitoring_kernel.DimensionVector) Return the actual visible dimensions as vector. + -#### get_caption() → str +### get_caption() → str Get the caption. + -#### get_data(layer_name: str) → list +### get_data(layer_name: str) → list Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text. + -#### *static* get_display_name() → str +### *static* get_display_name() → str Get a descriptive title for this visual type. + -#### *static* get_group_name() → str +### *static* get_group_name() → str Get the name of the containing group. + -#### get_header_data(layer_name: str, horizontal: bool) → list +### get_header_data(layer_name: str, horizontal: bool) → list Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header. + -#### get_x_axis_label() → str +### get_x_axis_label() → str Get the x axis label. + -#### get_y_axis_label() → str +### get_y_axis_label() → str Get the y axis label. + -#### get_z_axis_label() → str +### get_z_axis_label() → str Get the z axis label. + -#### has_legend() → bool +### has_legend() → bool + -#### set_abscissa(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### set_abscissa(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) deprecated - use set_dimension_at_index(0, … ) instead. + -#### set_alpha(alpha_angle: float) +### set_alpha(alpha_angle: float) Set the first angle for an rotation based on Euler angles z-x’-z’’. + -#### set_axes_enabled(enabled: bool) +### set_axes_enabled(enabled: bool) Set axes enabled state to True or False. + -#### set_beta(beta_angle: float) +### set_beta(beta_angle: float) Set the second angle for an rotation based on Euler angles z-x’-z’’. + -#### set_caption(caption: str) +### set_caption(caption: str) Set the caption. + -#### set_dimensions(x_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension), y_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension), z_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### set_dimensions(x_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension), y_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension), z_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) Set the dimensions to be shown in visual. + -#### set_gamma(gamma_angle: float) +### set_gamma(gamma_angle: float) Set the third angle for an rotation based on Euler angles z-x’-z’’. + -#### set_legend_font_size(font_size: int) +### set_legend_font_size(font_size: int) Set the font_size used in legend. + -#### set_legend_position(x_position: float, y_position: float) +### set_legend_position(x_position: float, y_position: float) Set the position of the legend, using absolute or relative coordinates. : (Internally stored as relative.) + -#### set_legend_size(width: float, height: float) +### set_legend_size(width: float, height: float) Set the size of the legend, using absolute or relative coordinates. : (Internally stored as relative.) + -#### set_legend_visible(enabled: bool) +### set_legend_visible(enabled: bool) Set legend visibilty to True or False. + -#### set_lighting_enabled(enabled: bool) +### set_lighting_enabled(enabled: bool) Set lighting enabled state to True or False. + -#### set_line_width(line_width: float) +### set_line_width(line_width: float) Set the line width at the visual. + -#### set_lines_enabled(enabled: bool) +### set_lines_enabled(enabled: bool) Set lines enabled state to True or False. + -#### set_log_x_axis(enabled: bool) +### set_log_x_axis(enabled: bool) Set the x-axis to show values logarithmic. Will be ignored if data range contains values <=0. + -#### set_log_y_axis(enabled: bool) +### set_log_y_axis(enabled: bool) Set the y-axis to show values logarithmic. Will be ignored if data range contains values <=0 + -#### set_log_z_axis(enabled: bool) +### set_log_z_axis(enabled: bool) Set the z-axis to show values logarithmic. Will be ignored if data range contains values <=0 + -#### set_ordinate(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### set_ordinate(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) deprecated - use set_dimension_at_index(1, … ) instead. + -#### set_surfaces_enabled(enabled: bool) +### set_surfaces_enabled(enabled: bool) Set surfaces enabled state to True or False. + -#### set_symbol_size(symbol_size: float) +### set_symbol_size(symbol_size: float) Set the symbol size at the visual. + -#### set_x_axis_format(x_axis_format: str) +### set_x_axis_format(x_axis_format: str) Set the axis format for x axis. Will be ignored if log axis is been chosen for x-axis. + -#### set_x_axis_label(label_x: str) +### set_x_axis_label(label_x: str) Set the x axis label. + -#### set_y_axis_format(y_axis_format: str) +### set_y_axis_format(y_axis_format: str) Set the axis format for y axis. Will be ignored if log axis is been chosen for y-axis. + -#### set_y_axis_label(label_y: str) +### set_y_axis_label(label_y: str) Set the y axis label. + -#### set_z_axis(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### set_z_axis(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) deprecated - use set_dimension_at_index(2, … ) instead. + -#### set_z_axis_format(z_axis_format: str) +### set_z_axis_format(z_axis_format: str) Set the axis format for z axis. Will be ignored if log axis is been chosen for z-axis. + -#### set_z_axis_label(label_z: str) +### set_z_axis_label(label_z: str) Set the z axis label. + -#### update_plot() +### update_plot() Trigger an additional update on visual. + -#### *class* PathBase +### *class* PathBase + -#### SetPath(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### SetPath(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) Set the path to the image/process executable. + -#### SetPathFixed(arg2: bool) +### SetPathFixed(arg2: bool) Set the path to the image/process executable. Contained placeholders will not be resolved. + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [PathBasedVisualTypes](#py_monitoring_gui.PathBasedVisualTypes), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [PathBasedVisualTypes](#py_monitoring_gui.PathBasedVisualTypes), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) -#### \_\_init_\_(arg2: [PathBasedVisualTypes](#py_monitoring_gui.PathBasedVisualTypes), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg4: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [PathBasedVisualTypes](#py_monitoring_gui.PathBasedVisualTypes), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg4: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) + -#### *static* get_display_name() → str +### *static* get_display_name() → str Get a descriptive title for this visual type. + -#### *static* get_group_name() → str +### *static* get_group_name() → str Get the name of the containing group. + -#### set_arguments(arg2: str) +### set_arguments(arg2: str) Set the argument string, used by a process. + -#### set_auto_insert_placeholders(arg2: bool) +### set_auto_insert_placeholders(arg2: bool) If placeholders (e.g. $DESIGN_DIR) should be inserted automatically. + -#### set_path(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### set_path(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) Set the path to the image/process executable. + -#### set_path_fixed(arg2: bool) +### set_path_fixed(arg2: bool) Set the path to the image/process executable. Contained placeholders will not be resolved. + -#### Points *= py_monitoring_gui.CustomData_Type.Points* +### Points *= py_monitoring_gui.CustomData_Type.Points* + -#### *class* Probability +### *class* Probability + -#### ListenToDimensionIndex(arg2: int) +### ListenToDimensionIndex(arg2: int) deprecated - use set_dimension_id_at_index(0, … ) instead. + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) + -#### get_caption() → str +### get_caption() → str Get the caption. + -#### get_data(layer_name: str) → list +### get_data(layer_name: str) → list Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text. + -#### *static* get_display_name() → str +### *static* get_display_name() → str Get a descriptive title for this visual type. + -#### *static* get_group_name() → str +### *static* get_group_name() → str Get the name of the containing group. + -#### get_header_data(layer_name: str, horizontal: bool) → list +### get_header_data(layer_name: str, horizontal: bool) → list Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header. + -#### get_x_axis_label() → str +### get_x_axis_label() → str Get the x axis label. + -#### get_y_axis_label() → str +### get_y_axis_label() → str Get the y axis label. + -#### set_axes_enabled(enabled: bool) +### set_axes_enabled(enabled: bool) Set axes enabled state to True or False. + -#### set_caption(caption: str) +### set_caption(caption: str) Set the caption. + -#### set_line_width(line_width: float) +### set_line_width(line_width: float) Set the line width at the visual. + -#### set_ranges_x(minimum: float, maximum: float) +### set_ranges_x(minimum: float, maximum: float) Set the ranges to x-axis, Two inputs : minimum and maximum. + -#### set_ranges_y(minimum: float, maximum: float) +### set_ranges_y(minimum: float, maximum: float) Set the ranges to y-axis, Two inputs : minimum and maximum. + -#### set_symbol_size(symbol_size: float) +### set_symbol_size(symbol_size: float) Set the symbol size at the visual. + -#### set_x_axis_format(x_axis_format: str) +### set_x_axis_format(x_axis_format: str) Set the axis format for x axis. Will be ignored if log axis is been chosen for x-axis. + -#### set_x_axis_label(label_x: str) +### set_x_axis_label(label_x: str) Set the x axis label. + -#### set_y_axis_format(y_axis_format: str) +### set_y_axis_format(y_axis_format: str) Set the axis format for y axis. Will be ignored if log axis is been chosen for y-axis. + -#### set_y_axis_label(label_y: str) +### set_y_axis_label(label_y: str) Set the y axis label. + -#### update_plot() +### update_plot() Trigger an additional update on visual. + -#### *class* ReliAlgoInfo +### *class* ReliAlgoInfo + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) + -#### export(file_path: Path) +### export(file_path: Path) Export the visual as picture to file position given as path. : Transparency produces plot with transparent background which is available when having picture types supporting this, like png. Quality is available for jpg, determining the quality of the output in percent [0:100]. + -#### export_data(file_path: Path) +### export_data(file_path: Path) Export the visual as ascii with given format_string to file position given as path. : If format_string is left empty, “%g” is used. + -#### *static* get_display_name() → str +### *static* get_display_name() → str Get a descriptive title for this visual type. + -#### *static* get_group_name() → str +### *static* get_group_name() → str Get the name of the containing group. + -#### set_font_size(arg2: int) +### set_font_size(arg2: int) Set the font size at the visual. + -#### *class* ReliAnthill +### *class* ReliAnthill + -#### SetAbscissa(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### SetAbscissa(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) deprecated - use set_dimension_at_index(0, … ) instead. + -#### SetDimensions(x_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension), y_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### SetDimensions(x_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension), y_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) Set the dimensions to be shown in visual. + -#### SetOrdinate(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### SetOrdinate(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) deprecated - use set_dimension_at_index(1, … ) instead. + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) + -#### get_actual_dimensions() → [DimensionVector](py_monitoring_kernel.md#py_monitoring_kernel.DimensionVector) +### get_actual_dimensions() → [DimensionVector](py_monitoring_kernel.md#py_monitoring_kernel.DimensionVector) Return the actual visible dimensions as vector. + -#### get_caption() → str +### get_caption() → str Get the caption. + -#### get_data(layer_name: str) → list +### get_data(layer_name: str) → list Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text. + -#### *static* get_display_name() → str +### *static* get_display_name() → str Get a descriptive title for this visual type. + -#### *static* get_group_name() → str +### *static* get_group_name() → str Get the name of the containing group. + -#### get_header_data(layer_name: str, horizontal: bool) → list +### get_header_data(layer_name: str, horizontal: bool) → list Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header. + -#### get_x_axis_label() → str +### get_x_axis_label() → str Get the x axis label. + -#### get_y_axis_label() → str +### get_y_axis_label() → str Get the y axis label. + -#### has_legend() → bool +### has_legend() → bool + -#### set_abscissa(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### set_abscissa(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) deprecated - use set_dimension_at_index(0, … ) instead. + -#### set_axes_enabled(enabled: bool) +### set_axes_enabled(enabled: bool) Set axes enabled state to True or False. + -#### set_caption(caption: str) +### set_caption(caption: str) Set the caption. + -#### set_dimensions(x_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension), y_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### set_dimensions(x_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension), y_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) Set the dimensions to be shown in visual. + -#### set_legend_font_size(font_size: int) +### set_legend_font_size(font_size: int) Set the font_size used in legend. + -#### set_legend_position(x_position: float, y_position: float) +### set_legend_position(x_position: float, y_position: float) Set the position of the legend, using absolute or relative coordinates. : (Internally stored as relative.) + -#### set_legend_size(width: float, height: float) +### set_legend_size(width: float, height: float) Set the size of the legend, using absolute or relative coordinates. : (Internally stored as relative.) + -#### set_legend_visible(enabled: bool) +### set_legend_visible(enabled: bool) Set legend visibilty to True or False. + -#### set_log_x_axis(enabled: bool) +### set_log_x_axis(enabled: bool) Set the x-axis to show values logarithmic. Will be ignored if data range contains values <=0. + -#### set_log_y_axis(enabled: bool) +### set_log_y_axis(enabled: bool) Set the y-axis to show values logarithmic. Will be ignored if data range contains values <=0 + -#### set_ordinate(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### set_ordinate(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) deprecated - use set_dimension_at_index(1, … ) instead. + -#### set_ranges_x(minimum: float, maximum: float) +### set_ranges_x(minimum: float, maximum: float) Set the ranges to x-axis, Two inputs : minimum and maximum. + -#### set_ranges_y(minimum: float, maximum: float) +### set_ranges_y(minimum: float, maximum: float) Set the ranges to y-axis, Two inputs : minimum and maximum. + -#### set_symbol_size(symbol_size: float) +### set_symbol_size(symbol_size: float) Set the symbol size at the visual. + -#### set_x_axis_format(x_axis_format: str) +### set_x_axis_format(x_axis_format: str) Set the axis format for x axis. Will be ignored if log axis is been chosen for x-axis. + -#### set_x_axis_label(label_x: str) +### set_x_axis_label(label_x: str) Set the x axis label. + -#### set_y_axis_format(y_axis_format: str) +### set_y_axis_format(y_axis_format: str) Set the axis format for y axis. Will be ignored if log axis is been chosen for y-axis. + -#### set_y_axis_label(label_y: str) +### set_y_axis_label(label_y: str) Set the y axis label. + -#### show_designs_in_standard_gauss(arg2: bool) +### show_designs_in_standard_gauss(arg2: bool) Toggle view of designs to standard gauss. : Does not have an effect when original distribution is already standard gauss. + -#### update_plot() +### update_plot() Trigger an additional update on visual. + -#### *class* ReliCloud +### *class* ReliCloud + -#### SetAbscissa(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### SetAbscissa(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) deprecated - use set_dimension_at_index(0, … ) instead. + -#### SetDimensions(x_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension), y_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension), z_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### SetDimensions(x_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension), y_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension), z_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) Set the dimensions to be shown in visual. + -#### SetOrdinate(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### SetOrdinate(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) deprecated - use set_dimension_at_index(1, … ) instead. + -#### SetZAxis(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### SetZAxis(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) deprecated - use set_dimension_at_index(2, … ) instead. + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) + -#### get_actual_dimensions() → [DimensionVector](py_monitoring_kernel.md#py_monitoring_kernel.DimensionVector) +### get_actual_dimensions() → [DimensionVector](py_monitoring_kernel.md#py_monitoring_kernel.DimensionVector) Return the actual visible dimensions as vector. + -#### get_caption() → str +### get_caption() → str Get the caption. + -#### get_data(layer_name: str) → list +### get_data(layer_name: str) → list Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text. + -#### *static* get_display_name() → str +### *static* get_display_name() → str Get a descriptive title for this visual type. + -#### *static* get_group_name() → str +### *static* get_group_name() → str Get the name of the containing group. + -#### get_header_data(layer_name: str, horizontal: bool) → list +### get_header_data(layer_name: str, horizontal: bool) → list Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header. + -#### get_x_axis_label() → str +### get_x_axis_label() → str Get the x axis label. + -#### get_y_axis_label() → str +### get_y_axis_label() → str Get the y axis label. + -#### get_z_axis_label() → str +### get_z_axis_label() → str Get the z axis label. + -#### has_legend() → bool +### has_legend() → bool + -#### set_abscissa(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### set_abscissa(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) deprecated - use set_dimension_at_index(0, … ) instead. + -#### set_alpha(alpha_angle: float) +### set_alpha(alpha_angle: float) Set the first angle for an rotation based on Euler angles z-x’-z’’. + -#### set_axes_enabled(enabled: bool) +### set_axes_enabled(enabled: bool) Set axes enabled state to True or False. + -#### set_beta(beta_angle: float) +### set_beta(beta_angle: float) Set the second angle for an rotation based on Euler angles z-x’-z’’. + -#### set_caption(caption: str) +### set_caption(caption: str) Set the caption. + -#### set_dimensions(x_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension), y_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension), z_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### set_dimensions(x_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension), y_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension), z_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) Set the dimensions to be shown in visual. + -#### set_gamma(gamma_angle: float) +### set_gamma(gamma_angle: float) Set the third angle for an rotation based on Euler angles z-x’-z’’. + -#### set_legend_font_size(font_size: int) +### set_legend_font_size(font_size: int) Set the font_size used in legend. + -#### set_legend_position(x_position: float, y_position: float) +### set_legend_position(x_position: float, y_position: float) Set the position of the legend, using absolute or relative coordinates. : (Internally stored as relative.) + -#### set_legend_size(width: float, height: float) +### set_legend_size(width: float, height: float) Set the size of the legend, using absolute or relative coordinates. : (Internally stored as relative.) + -#### set_legend_visible(enabled: bool) +### set_legend_visible(enabled: bool) Set legend visibilty to True or False. + -#### set_lighting_enabled(enabled: bool) +### set_lighting_enabled(enabled: bool) Set lighting enabled state to True or False. + -#### set_log_x_axis(enabled: bool) +### set_log_x_axis(enabled: bool) Set the x-axis to show values logarithmic. Will be ignored if data range contains values <=0. + -#### set_log_y_axis(enabled: bool) +### set_log_y_axis(enabled: bool) Set the y-axis to show values logarithmic. Will be ignored if data range contains values <=0 + -#### set_log_z_axis(enabled: bool) +### set_log_z_axis(enabled: bool) Set the z-axis to show values logarithmic. Will be ignored if data range contains values <=0 + -#### set_ordinate(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### set_ordinate(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) deprecated - use set_dimension_at_index(1, … ) instead. + -#### set_symbol_size(symbol_size: float) +### set_symbol_size(symbol_size: float) Set the symbol size at the visual. + -#### set_x_axis_format(x_axis_format: str) +### set_x_axis_format(x_axis_format: str) Set the axis format for x axis. Will be ignored if log axis is been chosen for x-axis. + -#### set_x_axis_label(label_x: str) +### set_x_axis_label(label_x: str) Set the x axis label. + -#### set_y_axis_format(y_axis_format: str) +### set_y_axis_format(y_axis_format: str) Set the axis format for y axis. Will be ignored if log axis is been chosen for y-axis. + -#### set_y_axis_label(label_y: str) +### set_y_axis_label(label_y: str) Set the y axis label. + -#### set_z_axis(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### set_z_axis(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) deprecated - use set_dimension_at_index(2, … ) instead. + -#### set_z_axis_format(z_axis_format: str) +### set_z_axis_format(z_axis_format: str) Set the axis format for z axis. Will be ignored if log axis is been chosen for z-axis. + -#### set_z_axis_label(label_z: str) +### set_z_axis_label(label_z: str) Set the z axis label. + -#### show_designs_in_standard_gauss(arg2: bool) +### show_designs_in_standard_gauss(arg2: bool) Toggle view of designs to standard gauss. : Does not have an effect when original distribution is already standard gauss. + -#### update_plot() +### update_plot() Trigger an additional update on visual. + -#### *class* ReliFailureHistory +### *class* ReliFailureHistory + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) + -#### get_active_layer_names() → list +### get_active_layer_names() → list Get actual active layer names. + -#### get_available_layer_names() → list +### get_available_layer_names() → list Get all possible layer names. + -#### get_caption() → str +### get_caption() → str Get the caption. + -#### get_data(layer_name: str) → list +### get_data(layer_name: str) → list Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text. + -#### *static* get_display_name() → str +### *static* get_display_name() → str Get a descriptive title for this visual type. + -#### *static* get_group_name() → str +### *static* get_group_name() → str Get the name of the containing group. + -#### get_header_data(layer_name: str, horizontal: bool) → list +### get_header_data(layer_name: str, horizontal: bool) → list Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header. + -#### get_x_axis_label() → str +### get_x_axis_label() → str Get the x axis label. + -#### get_y_axis_label() → str +### get_y_axis_label() → str Get the y axis label. + -#### has_legend() → bool +### has_legend() → bool + -#### set_all_layers_active_state(arg2: bool) +### set_all_layers_active_state(arg2: bool) Set active state of all layers. + -#### set_axes_enabled(enabled: bool) +### set_axes_enabled(enabled: bool) Set axes enabled state to True or False. + -#### set_caption(caption: str) +### set_caption(caption: str) Set the caption. + -#### set_layer_active_state(arg2: str, arg3: bool) +### set_layer_active_state(arg2: str, arg3: bool) Set active state of layer with given layer name. + -#### set_layers_active_state(arg2: list, arg3: bool) +### set_layers_active_state(arg2: list, arg3: bool) Set active state of layers with given layer names. + -#### set_legend_font_size(font_size: int) +### set_legend_font_size(font_size: int) Set the font_size used in legend. + -#### set_legend_position(x_position: float, y_position: float) +### set_legend_position(x_position: float, y_position: float) Set the position of the legend, using absolute or relative coordinates. : (Internally stored as relative.) + -#### set_legend_size(width: float, height: float) +### set_legend_size(width: float, height: float) Set the size of the legend, using absolute or relative coordinates. : (Internally stored as relative.) + -#### set_legend_visible(enabled: bool) +### set_legend_visible(enabled: bool) Set legend visibilty to True or False. + -#### set_line_width(line_width: float) +### set_line_width(line_width: float) Set the line width at the visual. + -#### set_log_y_axis(enabled: bool) +### set_log_y_axis(enabled: bool) Set the y-axis to show values logarithmic. Will be ignored if data range contains values <=0 + -#### set_ranges_x(minimum: float, maximum: float) +### set_ranges_x(minimum: float, maximum: float) Set the ranges to x-axis, Two inputs : minimum and maximum. + -#### set_ranges_y(minimum: float, maximum: float) +### set_ranges_y(minimum: float, maximum: float) Set the ranges to y-axis, Two inputs : minimum and maximum. + -#### set_x_axis_label(label_x: str) +### set_x_axis_label(label_x: str) Set the x axis label. + -#### set_y_axis_format(y_axis_format: str) +### set_y_axis_format(y_axis_format: str) Set the axis format for y axis. Will be ignored if log axis is been chosen for y-axis. + -#### set_y_axis_label(label_y: str) +### set_y_axis_label(label_y: str) Set the y axis label. + -#### update_plot() +### update_plot() Trigger an additional update on visual. + -#### *class* ReliInputImportance +### *class* ReliInputImportance + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) + -#### get_caption() → str +### get_caption() → str Get the caption. + -#### get_data(layer_name: str) → list +### get_data(layer_name: str) → list Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text. + -#### *static* get_display_name() → str +### *static* get_display_name() → str Get a descriptive title for this visual type. + -#### *static* get_group_name() → str +### *static* get_group_name() → str Get the name of the containing group. + -#### get_header_data(layer_name: str, horizontal: bool) → list +### get_header_data(layer_name: str, horizontal: bool) → list Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header. + -#### get_palette_preset_names() → list +### get_palette_preset_names() → list Get a list of available palette preset names. + -#### get_x_axis_label() → str +### get_x_axis_label() → str Get the x axis label. + -#### get_y_axis_label() → str +### get_y_axis_label() → str Get the y axis label. + -#### reset_palette_limits() +### reset_palette_limits() ReSet the minimum and maximum values of palette to default. + -#### reset_palette_maximum() +### reset_palette_maximum() Reset the maximum value of palette. + -#### reset_palette_minimum() +### reset_palette_minimum() Reset the minimum value of palette. + -#### set_axes_enabled(enabled: bool) +### set_axes_enabled(enabled: bool) Set axes enabled state to True or False. + -#### set_caption(caption: str) +### set_caption(caption: str) Set the caption. + -#### set_line_width(line_width: float) +### set_line_width(line_width: float) Set the line width at the visual. + -#### set_palette_limits(minimum: float, maximum: float) +### set_palette_limits(minimum: float, maximum: float) Set the minimum and maximum values of palette. + -#### set_palette_maximum(maximum: float) +### set_palette_maximum(maximum: float) Set the maximum value of palette. + -#### set_palette_minimum(minimum: float) +### set_palette_minimum(minimum: float) Set the minimum value of palette. + -#### set_palette_position(x_position: float, y_position: float) +### set_palette_position(x_position: float, y_position: float) Set the position of the palette, using absolute or relative[%] coordinates. : (Internally stored as relative[%].) + -#### set_palette_preset(name: str) +### set_palette_preset(name: str) Set palette preset with given name. + -#### set_palette_size(x_position: float, y_position: float) +### set_palette_size(x_position: float, y_position: float) Set the size of the palette, using absolute or relative[%] coordinates. : (Internally stored as relative[%].) + -#### set_palette_visible(enabled: bool) +### set_palette_visible(enabled: bool) Set palette visibility to True or False. + -#### set_ranges_x(minimum: float, maximum: float) +### set_ranges_x(minimum: float, maximum: float) Set the ranges to x-axis, Two inputs : minimum and maximum. + -#### set_ranges_y(minimum: float, maximum: float) +### set_ranges_y(minimum: float, maximum: float) Set the ranges to y-axis, Two inputs : minimum and maximum. + -#### set_x_axis_label(label_x: str) +### set_x_axis_label(label_x: str) Set the x axis label. + -#### set_y_axis_label(label_y: str) +### set_y_axis_label(label_y: str) Set the y axis label. + -#### update_plot() +### update_plot() Trigger an additional update on visual. + -#### *class* Residual +### *class* Residual + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) + -#### get_actual_dimension() → [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension) +### get_actual_dimension() → [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension) Return the actual visible dimension. + -#### get_caption() → str +### get_caption() → str Get the caption. + -#### get_data(layer_name: str) → list +### get_data(layer_name: str) → list Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text. + -#### *static* get_display_name() → str +### *static* get_display_name() → str Get a descriptive title for this visual type. + -#### *static* get_group_name() → str +### *static* get_group_name() → str Get the name of the containing group. + -#### get_header_data(layer_name: str, horizontal: bool) → list +### get_header_data(layer_name: str, horizontal: bool) → list Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header. + -#### get_statistical_data() → list +### get_statistical_data() → list Get statistical data as list of lists. + -#### get_x_axis_label() → str +### get_x_axis_label() → str Get the x axis label. + -#### get_y_axis_label() → str +### get_y_axis_label() → str Get the y axis label. + -#### has_legend() → bool +### has_legend() → bool + -#### set_axes_enabled(enabled: bool) +### set_axes_enabled(enabled: bool) Set axes enabled state to True or False. + -#### set_caption(caption: str) +### set_caption(caption: str) Set the caption. + -#### set_error_relative(error_relative: bool) +### set_error_relative(error_relative: bool) When show_errors or show_absolute_errors is set, toggle view to show errors relative to range. + -#### set_legend_font_size(font_size: int) +### set_legend_font_size(font_size: int) Set the font_size used in legend. + -#### set_legend_position(x_position: float, y_position: float) +### set_legend_position(x_position: float, y_position: float) Set the position of the legend, using absolute or relative coordinates. : (Internally stored as relative.) + -#### set_legend_size(width: float, height: float) +### set_legend_size(width: float, height: float) Set the size of the legend, using absolute or relative coordinates. : (Internally stored as relative.) + -#### set_legend_visible(enabled: bool) +### set_legend_visible(enabled: bool) Set legend visibilty to True or False. + -#### set_line_width(line_width: float) +### set_line_width(line_width: float) Set the line width at the visual. + -#### set_log_x_axis(enabled: bool) +### set_log_x_axis(enabled: bool) Set the x-axis to show values logarithmic. Will be ignored if data range contains values <=0. + -#### set_log_y_axis(enabled: bool) +### set_log_y_axis(enabled: bool) Set the y-axis to show values logarithmic. Will be ignored if data range contains values <=0 + -#### set_ranges_x(minimum: float, maximum: float) +### set_ranges_x(minimum: float, maximum: float) Set the ranges to x-axis, Two inputs : minimum and maximum. + -#### set_ranges_y(minimum: float, maximum: float) +### set_ranges_y(minimum: float, maximum: float) Set the ranges to y-axis, Two inputs : minimum and maximum. + -#### set_sigma_level(sigma: float) +### set_sigma_level(sigma: float) Set the sigma level, which determines the distance the red sigma_lines have, to the black diagonal. : Distance is equal sigma_value times sigma_level. + -#### set_symbol_size(symbol_size: float) +### set_symbol_size(symbol_size: float) Set the symbol size at the visual. + -#### set_x_axis_format(x_axis_format: str) +### set_x_axis_format(x_axis_format: str) Set the axis format for x axis. Will be ignored if log axis is been chosen for x-axis. + -#### set_x_axis_label(label_x: str) +### set_x_axis_label(label_x: str) Set the x axis label. + -#### set_y_axis_format(y_axis_format: str) +### set_y_axis_format(y_axis_format: str) Set the axis format for y axis. Will be ignored if log axis is been chosen for y-axis. + -#### set_y_axis_label(label_y: str) +### set_y_axis_label(label_y: str) Set the y axis label. + -#### show_absolute_errors() +### show_absolute_errors() Show values in visual as absolute error of dimension_cv_value vs dimension_value over dimension_value. + -#### show_errors() +### show_errors() Show values in visual as error of dimension_cv vs dimension_value over dimension_value. + -#### show_maximum_error(arg2: bool) +### show_maximum_error(arg2: bool) Show an arrow pointing to the maximum error. : Only visible when show_errors or show_absolute_errors is set. + -#### show_sample_cops() +### show_sample_cops() Show values in visual as SampleCoPs over dimension_value. + -#### show_values() +### show_values() Show values in visual as dimension_cv_value over dimension_value. + -#### update_plot() +### update_plot() Trigger an additional update on visual. + -#### *class* ResponseSurface2D +### *class* ResponseSurface2D + -#### SetAbscissa(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### SetAbscissa(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) deprecated - use set_dimension_at_index(0, … ) instead. + -#### SetDimensions(x_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension), y_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### SetDimensions(x_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension), y_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) Set the dimensions to be shown in visual. + -#### SetOrdinate(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### SetOrdinate(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) deprecated - use set_dimension_at_index(1, … ) instead. + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) + -#### get_actual_dimensions() → [DimensionVector](py_monitoring_kernel.md#py_monitoring_kernel.DimensionVector) +### get_actual_dimensions() → [DimensionVector](py_monitoring_kernel.md#py_monitoring_kernel.DimensionVector) Return the actual visible dimensions as vector. + -#### get_caption() → str +### get_caption() → str Get the caption. + -#### get_data(layer_name: str) → list +### get_data(layer_name: str) → list Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text. + -#### *static* get_display_name() → str +### *static* get_display_name() → str Get a descriptive title for this visual type. + -#### *static* get_group_name() → str +### *static* get_group_name() → str Get the name of the containing group. + -#### get_header_data(layer_name: str, horizontal: bool) → list +### get_header_data(layer_name: str, horizontal: bool) → list Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header. + -#### get_x_axis_label() → str +### get_x_axis_label() → str Get the x axis label. + -#### get_y_axis_label() → str +### get_y_axis_label() → str Get the y axis label. + -#### has_legend() → bool +### has_legend() → bool + -#### set_abscissa(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### set_abscissa(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) deprecated - use set_dimension_at_index(0, … ) instead. + -#### set_axes_enabled(enabled: bool) +### set_axes_enabled(enabled: bool) Set axes enabled state to True or False. + -#### set_caption(caption: str) +### set_caption(caption: str) Set the caption. + -#### set_dimensions(x_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension), y_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### set_dimensions(x_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension), y_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) Set the dimensions to be shown in visual. + -#### set_legend_font_size(font_size: int) +### set_legend_font_size(font_size: int) Set the font_size used in legend. + -#### set_legend_position(x_position: float, y_position: float) +### set_legend_position(x_position: float, y_position: float) Set the position of the legend, using absolute or relative coordinates. : (Internally stored as relative.) + -#### set_legend_size(width: float, height: float) +### set_legend_size(width: float, height: float) Set the size of the legend, using absolute or relative coordinates. : (Internally stored as relative.) + -#### set_legend_visible(enabled: bool) +### set_legend_visible(enabled: bool) Set legend visibilty to True or False. + -#### set_line_width(line_width: float) +### set_line_width(line_width: float) Set the line width at the visual. + -#### set_log_x_axis(enabled: bool) +### set_log_x_axis(enabled: bool) Set the x-axis to show values logarithmic. Will be ignored if data range contains values <=0. + -#### set_log_y_axis(enabled: bool) +### set_log_y_axis(enabled: bool) Set the y-axis to show values logarithmic. Will be ignored if data range contains values <=0 + -#### set_ordinate(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### set_ordinate(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) deprecated - use set_dimension_at_index(1, … ) instead. + -#### set_ranges_x(minimum: float, maximum: float) +### set_ranges_x(minimum: float, maximum: float) Set the ranges to x-axis, Two inputs : minimum and maximum. + -#### set_ranges_y(minimum: float, maximum: float) +### set_ranges_y(minimum: float, maximum: float) Set the ranges to y-axis, Two inputs : minimum and maximum. + -#### set_resolution(resolution: int) +### set_resolution(resolution: int) Sets the resolution with which the response surface line is been plotted. + -#### set_show_additional_points(show_additional_data: bool) +### set_show_additional_points(show_additional_data: bool) Show additional data points or not. + -#### set_symbol_size(symbol_size: float) +### set_symbol_size(symbol_size: float) Set the symbol size at the visual. + -#### set_x_axis_format(x_axis_format: str) +### set_x_axis_format(x_axis_format: str) Set the axis format for x axis. Will be ignored if log axis is been chosen for x-axis. + -#### set_x_axis_label(label_x: str) +### set_x_axis_label(label_x: str) Set the x axis label. + -#### set_y_axis_format(y_axis_format: str) +### set_y_axis_format(y_axis_format: str) Set the axis format for y axis. Will be ignored if log axis is been chosen for y-axis. + -#### set_y_axis_label(label_y: str) +### set_y_axis_label(label_y: str) Set the y axis label. + -#### update_plot() +### update_plot() Trigger an additional update on visual. + -#### *class* ResponseSurface3D +### *class* ResponseSurface3D + -#### SetAbscissa(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### SetAbscissa(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) deprecated - use set_dimension_at_index(0, … ) instead. + -#### SetDimensions(x_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension), y_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension), z_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### SetDimensions(x_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension), y_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension), z_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) Set the dimensions to be shown in visual. + -#### SetOrdinate(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### SetOrdinate(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) deprecated - use set_dimension_at_index(1, … ) instead. + -#### SetZAxis(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### SetZAxis(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) deprecated - use set_dimension_at_index(2, … ) instead. + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) + -#### get_actual_dimensions() → [DimensionVector](py_monitoring_kernel.md#py_monitoring_kernel.DimensionVector) +### get_actual_dimensions() → [DimensionVector](py_monitoring_kernel.md#py_monitoring_kernel.DimensionVector) Return the actual visible dimensions as vector. + -#### get_caption() → str +### get_caption() → str Get the caption. + -#### get_data(layer_name: str) → list +### get_data(layer_name: str) → list Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text. + -#### *static* get_display_name() → str +### *static* get_display_name() → str Get a descriptive title for this visual type. + -#### *static* get_group_name() → str +### *static* get_group_name() → str Get the name of the containing group. + -#### get_header_data(layer_name: str, horizontal: bool) → list +### get_header_data(layer_name: str, horizontal: bool) → list Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header. + -#### get_palette_preset_names() → list +### get_palette_preset_names() → list Get a list of available palette preset names. + -#### get_x_axis_label() → str +### get_x_axis_label() → str Get the x axis label. + -#### get_y_axis_label() → str +### get_y_axis_label() → str Get the y axis label. + -#### get_z_axis_label() → str +### get_z_axis_label() → str Get the z axis label. + -#### has_legend() → bool +### has_legend() → bool + -#### reset_palette_limits() +### reset_palette_limits() ReSet the minimum and maximum values of palette to default. + -#### reset_palette_maximum() +### reset_palette_maximum() Reset the maximum value of palette. + -#### reset_palette_minimum() +### reset_palette_minimum() Reset the minimum value of palette. + -#### set_abscissa(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### set_abscissa(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) deprecated - use set_dimension_at_index(0, … ) instead. + -#### set_alpha(alpha_angle: float) +### set_alpha(alpha_angle: float) Set the first angle for an rotation based on Euler angles z-x’-z’’. + -#### set_axes_enabled(enabled: bool) +### set_axes_enabled(enabled: bool) Set axes enabled state to True or False. + -#### set_beta(beta_angle: float) +### set_beta(beta_angle: float) Set the second angle for an rotation based on Euler angles z-x’-z’’. + -#### set_caption(caption: str) +### set_caption(caption: str) Set the caption. + -#### set_dimensions(x_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension), y_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension), z_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### set_dimensions(x_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension), y_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension), z_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) Set the dimensions to be shown in visual. + -#### set_gamma(gamma_angle: float) +### set_gamma(gamma_angle: float) Set the third angle for an rotation based on Euler angles z-x’-z’’. + -#### set_iso_line_heights(iso_lines_string: str) +### set_iso_line_heights(iso_lines_string: str) -#### set_iso_line_heights(iso_lines: list) +### set_iso_line_heights(iso_lines: list) [0] Set the iso_lines given as string with delimiters space and ‘,’ and ‘;’ . [1] Set the iso_lines given as python list. + -#### set_legend_font_size(font_size: int) +### set_legend_font_size(font_size: int) Set the font_size used in legend. + -#### set_legend_position(x_position: float, y_position: float) +### set_legend_position(x_position: float, y_position: float) Set the position of the legend, using absolute or relative coordinates. : (Internally stored as relative.) + -#### set_legend_size(width: float, height: float) +### set_legend_size(width: float, height: float) Set the size of the legend, using absolute or relative coordinates. : (Internally stored as relative.) + -#### set_legend_visible(enabled: bool) +### set_legend_visible(enabled: bool) Set legend visibilty to True or False. + -#### set_lighting_enabled(enabled: bool) +### set_lighting_enabled(enabled: bool) Set lighting enabled state to True or False. + -#### set_line_width(line_width: float) +### set_line_width(line_width: float) Set the line width at the visual. + -#### set_lines_enabled(enabled: bool) +### set_lines_enabled(enabled: bool) Set lines enabled state to True or False. + -#### set_log_x_axis(enabled: bool) +### set_log_x_axis(enabled: bool) Set the x-axis to show values logarithmic. Will be ignored if data range contains values <=0. + -#### set_log_y_axis(enabled: bool) +### set_log_y_axis(enabled: bool) Set the y-axis to show values logarithmic. Will be ignored if data range contains values <=0 + -#### set_log_z_axis(enabled: bool) +### set_log_z_axis(enabled: bool) Set the z-axis to show values logarithmic. Will be ignored if data range contains values <=0 + -#### set_ordinate(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### set_ordinate(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) deprecated - use set_dimension_at_index(1, … ) instead. + -#### set_palette_data(palette_data: [ResponseSurfacePaletteData](#py_monitoring_gui.ResponseSurfacePaletteData)) +### set_palette_data(palette_data: [ResponseSurfacePaletteData](#py_monitoring_gui.ResponseSurfacePaletteData)) Set the palette_data so that response surface show certain specific values. + -#### set_palette_limits(minimum: float, maximum: float) +### set_palette_limits(minimum: float, maximum: float) Set the minimum and maximum values of palette. + -#### set_palette_maximum(maximum: float) +### set_palette_maximum(maximum: float) Set the maximum value of palette. + -#### set_palette_minimum(minimum: float) +### set_palette_minimum(minimum: float) Set the minimum value of palette. + -#### set_palette_position(x_position: float, y_position: float) +### set_palette_position(x_position: float, y_position: float) Set the position of the palette, using absolute or relative[%] coordinates. : (Internally stored as relative[%].) + -#### set_palette_preset(name: str) +### set_palette_preset(name: str) Set palette preset with given name. + -#### set_palette_size(x_position: float, y_position: float) +### set_palette_size(x_position: float, y_position: float) Set the size of the palette, using absolute or relative[%] coordinates. : (Internally stored as relative[%].) + -#### set_palette_visible(enabled: bool) +### set_palette_visible(enabled: bool) Set palette visibility to True or False. + -#### set_resolution(resolution: int) +### set_resolution(resolution: int) Set the resolution with which the response surface is been plotted. + -#### set_show_additional_points(show_additional_data: bool) +### set_show_additional_points(show_additional_data: bool) Show additional data points or not. + -#### set_surfaces_enabled(enabled: bool) +### set_surfaces_enabled(enabled: bool) Set surfaces enabled state to True or False. + -#### set_symbol_size(symbol_size: float) +### set_symbol_size(symbol_size: float) Set the symbol size at the visual. + -#### set_x_axis_format(x_axis_format: str) +### set_x_axis_format(x_axis_format: str) Set the axis format for x axis. Will be ignored if log axis is been chosen for x-axis. + -#### set_x_axis_label(label_x: str) +### set_x_axis_label(label_x: str) Set the x axis label. + -#### set_y_axis_format(y_axis_format: str) +### set_y_axis_format(y_axis_format: str) Set the axis format for y axis. Will be ignored if log axis is been chosen for y-axis. + -#### set_y_axis_label(label_y: str) +### set_y_axis_label(label_y: str) Set the y axis label. + -#### set_z_axis(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### set_z_axis(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) deprecated - use set_dimension_at_index(2, … ) instead. + -#### set_z_axis_format(z_axis_format: str) +### set_z_axis_format(z_axis_format: str) Set the axis format for z axis. Will be ignored if log axis is been chosen for z-axis. + -#### set_z_axis_label(label_z: str) +### set_z_axis_label(label_z: str) Set the z axis label. + -#### update_plot() +### update_plot() Trigger an additional update on visual. + -#### *class* ResponseSurfaceTV +### *class* ResponseSurfaceTV + -#### SetAbscissa(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### SetAbscissa(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) deprecated - use set_dimension_at_index(0, … ) instead. + -#### SetDimensions(x_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension), y_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension), z_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### SetDimensions(x_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension), y_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension), z_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) Set the dimensions to be shown in visual. + -#### SetOrdinate(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### SetOrdinate(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) deprecated - use set_dimension_at_index(1, … ) instead. + -#### SetZAxis(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### SetZAxis(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) deprecated - use set_dimension_at_index(2, … ) instead. + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) + -#### get_actual_dimensions() → [DimensionVector](py_monitoring_kernel.md#py_monitoring_kernel.DimensionVector) +### get_actual_dimensions() → [DimensionVector](py_monitoring_kernel.md#py_monitoring_kernel.DimensionVector) Return the actual visible dimensions as vector. + -#### get_caption() → str +### get_caption() → str Get the caption. + -#### get_data(layer_name: str) → list +### get_data(layer_name: str) → list Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text. + -#### *static* get_display_name() → str +### *static* get_display_name() → str Get a descriptive title for this visual type. + -#### *static* get_group_name() → str +### *static* get_group_name() → str Get the name of the containing group. + -#### get_header_data(layer_name: str, horizontal: bool) → list +### get_header_data(layer_name: str, horizontal: bool) → list Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header. + -#### get_palette_preset_names() → list +### get_palette_preset_names() → list Get a list of available palette preset names. + -#### get_x_axis_label() → str +### get_x_axis_label() → str Get the x axis label. + -#### get_y_axis_label() → str +### get_y_axis_label() → str Get the y axis label. + -#### has_legend() → bool +### has_legend() → bool + -#### reset_palette_limits() +### reset_palette_limits() ReSet the minimum and maximum values of palette to default. + -#### reset_palette_maximum() +### reset_palette_maximum() Reset the maximum value of palette. + -#### reset_palette_minimum() +### reset_palette_minimum() Reset the minimum value of palette. + -#### set_abscissa(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### set_abscissa(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) deprecated - use set_dimension_at_index(0, … ) instead. + -#### set_axes_enabled(enabled: bool) +### set_axes_enabled(enabled: bool) Set axes enabled state to True or False. + -#### set_caption(caption: str) +### set_caption(caption: str) Set the caption. + -#### set_dimensions(x_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension), y_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension), z_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### set_dimensions(x_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension), y_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension), z_axis_dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) Set the dimensions to be shown in visual. + -#### set_iso_line_heights(iso_lines_string: str) +### set_iso_line_heights(iso_lines_string: str) -#### set_iso_line_heights(iso_lines: list) +### set_iso_line_heights(iso_lines: list) [0] Set the iso_lines given as string with delimiters space and ‘,’ and ‘;’ . [1] Set the iso_lines given as python list. + -#### set_legend_font_size(font_size: int) +### set_legend_font_size(font_size: int) Set the font_size used in legend. + -#### set_legend_position(x_position: float, y_position: float) +### set_legend_position(x_position: float, y_position: float) Set the position of the legend, using absolute or relative coordinates. : (Internally stored as relative.) + -#### set_legend_size(width: float, height: float) +### set_legend_size(width: float, height: float) Set the size of the legend, using absolute or relative coordinates. : (Internally stored as relative.) + -#### set_legend_visible(enabled: bool) +### set_legend_visible(enabled: bool) Set legend visibilty to True or False. + -#### set_line_width(line_width: float) +### set_line_width(line_width: float) Set the line width at the visual. + -#### set_lines_enabled(enabled: bool) +### set_lines_enabled(enabled: bool) Set lines enabled state to True or False. + -#### set_log_x_axis(enabled: bool) +### set_log_x_axis(enabled: bool) Set the x-axis to show values logarithmic. Will be ignored if data range contains values <=0. + -#### set_log_y_axis(enabled: bool) +### set_log_y_axis(enabled: bool) Set the y-axis to show values logarithmic. Will be ignored if data range contains values <=0 + -#### set_ordinate(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### set_ordinate(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) deprecated - use set_dimension_at_index(1, … ) instead. + -#### set_palette_data(palette_data: [ResponseSurfacePaletteData](#py_monitoring_gui.ResponseSurfacePaletteData)) +### set_palette_data(palette_data: [ResponseSurfacePaletteData](#py_monitoring_gui.ResponseSurfacePaletteData)) Set the palette_data so that response surface show certain specific values. + -#### set_palette_limits(minimum: float, maximum: float) +### set_palette_limits(minimum: float, maximum: float) Set the minimum and maximum values of palette. + -#### set_palette_maximum(maximum: float) +### set_palette_maximum(maximum: float) Set the maximum value of palette. + -#### set_palette_minimum(minimum: float) +### set_palette_minimum(minimum: float) Set the minimum value of palette. + -#### set_palette_position(x_position: float, y_position: float) +### set_palette_position(x_position: float, y_position: float) Set the position of the palette, using absolute or relative[%] coordinates. : (Internally stored as relative[%].) + -#### set_palette_preset(name: str) +### set_palette_preset(name: str) Set palette preset with given name. + -#### set_palette_size(x_position: float, y_position: float) +### set_palette_size(x_position: float, y_position: float) Set the size of the palette, using absolute or relative[%] coordinates. : (Internally stored as relative[%].) + -#### set_palette_visible(enabled: bool) +### set_palette_visible(enabled: bool) Set palette visibility to True or False. + -#### set_ranges_x(minimum: float, maximum: float) +### set_ranges_x(minimum: float, maximum: float) Set the ranges to x-axis, Two inputs : minimum and maximum. + -#### set_ranges_y(minimum: float, maximum: float) +### set_ranges_y(minimum: float, maximum: float) Set the ranges to y-axis, Two inputs : minimum and maximum. + -#### set_resolution(resolution: int) +### set_resolution(resolution: int) Set the resolution with which the response surface is been plotted. + -#### set_show_additional_points(show_additional_data: bool) +### set_show_additional_points(show_additional_data: bool) Show additional data points or not. + -#### set_surfaces_enabled(enabled: bool) +### set_surfaces_enabled(enabled: bool) Set surfaces enabled state to True or False. + -#### set_symbol_size(symbol_size: float) +### set_symbol_size(symbol_size: float) Set the symbol size at the visual. + -#### set_x_axis_format(x_axis_format: str) +### set_x_axis_format(x_axis_format: str) Set the axis format for x axis. Will be ignored if log axis is been chosen for x-axis. + -#### set_x_axis_label(label_x: str) +### set_x_axis_label(label_x: str) Set the x axis label. + -#### set_y_axis_format(y_axis_format: str) +### set_y_axis_format(y_axis_format: str) Set the axis format for y axis. Will be ignored if log axis is been chosen for y-axis. + -#### set_y_axis_label(label_y: str) +### set_y_axis_label(label_y: str) Set the y axis label. + -#### set_z_axis(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### set_z_axis(arg2: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) deprecated - use set_dimension_at_index(2, … ) instead. + -#### update_plot() +### update_plot() Trigger an additional update on visual. + -#### *class* ResponseValues +### *class* ResponseValues + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) + -#### get_caption() → str +### get_caption() → str Get the caption. + -#### get_data(layer_name: str) → list +### get_data(layer_name: str) → list Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text. + -#### *static* get_display_name() → str +### *static* get_display_name() → str Get a descriptive title for this visual type. + -#### *static* get_group_name() → str +### *static* get_group_name() → str Get the name of the containing group. + -#### get_header_data(layer_name: str, horizontal: bool) → list +### get_header_data(layer_name: str, horizontal: bool) → list Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header. + -#### get_x_axis_label() → str +### get_x_axis_label() → str Get the x axis label. + -#### get_y_axis_label() → str +### get_y_axis_label() → str Get the y axis label. + -#### set_axes_enabled(enabled: bool) +### set_axes_enabled(enabled: bool) Set axes enabled state to True or False. + -#### set_caption(caption: str) +### set_caption(caption: str) Set the caption. + -#### set_line_width(line_width: float) +### set_line_width(line_width: float) Set the line width at the visual. + -#### set_ranges_x(minimum: float, maximum: float) +### set_ranges_x(minimum: float, maximum: float) Set the ranges to x-axis, Two inputs : minimum and maximum. + -#### set_ranges_y(minimum: float, maximum: float) +### set_ranges_y(minimum: float, maximum: float) Set the ranges to y-axis, Two inputs : minimum and maximum. + -#### set_x_axis_label(label_x: str) +### set_x_axis_label(label_x: str) Set the x axis label. + -#### set_y_axis_label(label_y: str) +### set_y_axis_label(label_y: str) Set the y axis label. + -#### update_plot() +### update_plot() Trigger an additional update on visual. + -#### *class* SignalDesignList +### *class* SignalDesignList + -#### IdExportList() → [SignalDesignList](#py_monitoring_gui.Visuals.SignalDesignList) +### IdExportList() → [SignalDesignList](#py_monitoring_gui.Visuals.SignalDesignList) + -#### \_\_init_\_() +### \_\_init_\_() + -#### \_\_iter_\_() → object +### \_\_iter_\_() → object + -#### id_export_list() → [SignalDesignList](#py_monitoring_gui.Visuals.SignalDesignList) +### id_export_list() → [SignalDesignList](#py_monitoring_gui.Visuals.SignalDesignList) + -#### push_back(arg2: [HID](id.md#id.HID)) +### push_back(arg2: [HID](id.md#id.HID)) + -#### size() → int +### size() → int + -#### *class* SignalLayer +### *class* SignalLayer + -#### SetChannel(channel: int) +### SetChannel(channel: int) Set the channel index. + -#### SetIds(ids: [SignalDesignList](#py_monitoring_gui.Visuals.SignalDesignList)) +### SetIds(ids: [SignalDesignList](#py_monitoring_gui.Visuals.SignalDesignList)) Set the ids. + -#### SetLayer(layer_name: str) +### SetLayer(layer_name: str) Set the layer name. + -#### SetSignal(signal: str) +### SetSignal(signal: str) Set the signal dimension. + -#### SetStyle(style: [Style](py_monitoring_kernel.md#py_monitoring_kernel.Style)) +### SetStyle(style: [Style](py_monitoring_kernel.md#py_monitoring_kernel.Style)) Set the style. + -#### \_\_init_\_() +### \_\_init_\_() + -#### set_channel(channel: int) +### set_channel(channel: int) Set the channel index. + -#### set_channel_name(channel_name: str) +### set_channel_name(channel_name: str) Set the channel name (sig_info). + -#### set_data_name(data_name: str) +### set_data_name(data_name: str) Set the data name (sig_info). + -#### set_ids(ids: [SignalDesignList](#py_monitoring_gui.Visuals.SignalDesignList)) +### set_ids(ids: [SignalDesignList](#py_monitoring_gui.Visuals.SignalDesignList)) Set the ids. + -#### set_layer(layer_name: str) +### set_layer(layer_name: str) Set the layer name. + -#### set_number_of_data(number_of_data: int) +### set_number_of_data(number_of_data: int) Set the number of lines to be shown (sig_info). + -#### set_signal(signal: str) +### set_signal(signal: str) Set the signal dimension. + -#### set_style(style: [Style](py_monitoring_kernel.md#py_monitoring_kernel.Style)) +### set_style(style: [Style](py_monitoring_kernel.md#py_monitoring_kernel.Style)) Set the style. + -#### set_take_all_ids(take_all_ids: bool) +### set_take_all_ids(take_all_ids: bool) Take all possible design ids when True. Overrides set_ids. + -#### *class* SignalPlot +### *class* SignalPlot + -#### AddLayer(signal_layer: [SignalLayer](#py_monitoring_gui.Visuals.SignalLayer)) +### AddLayer(signal_layer: [SignalLayer](#py_monitoring_gui.Visuals.SignalLayer)) Add a layer of type SignalLayer. : In this layer one can set the signal-channel combination he wants, showing the designs wished with a certain style. Style is been applied to all designs, if wished otherwise more than one layer has to be added. Design style set in e.g. DesignTable is NOT applied to this layer. + -#### RemoveAllLayers() +### RemoveAllLayers() Remove all layers, now showing “no valid data”. Every previous signal/reference setting is been resetted, to make a clean start possible. + -#### SetChannel(channel_index: int) +### SetChannel(channel_index: int) Set the channel index for signal. + -#### SetReference(reference: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### SetReference(reference: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) Set the reference signal. + -#### SetReferenceChannel(reference_channel_index: int) +### SetReferenceChannel(reference_channel_index: int) Set the reference channel index for signal. + -#### SetReferenceDesign(reference_design_id: [HID](id.md#id.HID)) +### SetReferenceDesign(reference_design_id: [HID](id.md#id.HID)) Set the reference design id. For reference signal only one design is shown. + -#### SetSignal(signal: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### SetSignal(signal: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) Set the signal. + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) + -#### add_layer(signal_layer: [SignalLayer](#py_monitoring_gui.Visuals.SignalLayer)) +### add_layer(signal_layer: [SignalLayer](#py_monitoring_gui.Visuals.SignalLayer)) Add a layer of type SignalLayer. : In this layer one can set the signal-channel combination he wants, showing the designs wished with a certain style. Style is been applied to all designs, if wished otherwise more than one layer has to be added. Design style set in e.g. DesignTable is NOT applied to this layer. + -#### adjust_resolution(arg2: bool) +### adjust_resolution(arg2: bool) Modify signals to be shown with given resolution. + -#### get_caption() → str +### get_caption() → str Get the caption. + -#### get_data(layer_name: str) → list +### get_data(layer_name: str) → list Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text. + -#### *static* get_display_name() → str +### *static* get_display_name() → str Get a descriptive title for this visual type. + -#### *static* get_group_name() → str +### *static* get_group_name() → str Get the name of the containing group. + -#### get_header_data(layer_name: str, horizontal: bool) → list +### get_header_data(layer_name: str, horizontal: bool) → list Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header. + -#### get_palette_preset_names() → list +### get_palette_preset_names() → list Get a list of available palette preset names. + -#### get_x_axis_label() → str +### get_x_axis_label() → str Get the x axis label. + -#### get_y_axis_label() → str +### get_y_axis_label() → str Get the y axis label. + -#### has_legend() → bool +### has_legend() → bool + -#### is_reference_of_type_signal_info() → bool +### is_reference_of_type_signal_info() → bool Get info about reference be signal info type. + -#### is_signal_of_type_signal_info() → bool +### is_signal_of_type_signal_info() → bool Get info about signal be signal info type. + -#### remove_all_layers() +### remove_all_layers() Remove all layers, now showing “no valid data”. Every previous signal/reference setting is been resetted, to make a clean start possible. + -#### reset_palette_limits() +### reset_palette_limits() ReSet the minimum and maximum values of palette to default. + -#### reset_palette_maximum() +### reset_palette_maximum() Reset the maximum value of palette. + -#### reset_palette_minimum() +### reset_palette_minimum() Reset the minimum value of palette. + -#### set_axes_enabled(enabled: bool) +### set_axes_enabled(enabled: bool) Set axes enabled state to True or False. + -#### set_caption(caption: str) +### set_caption(caption: str) Set the caption. + -#### set_channel(channel_index: int) +### set_channel(channel_index: int) Set the channel index for signal. + -#### set_channel_name(channel_name: str) +### set_channel_name(channel_name: str) Set the channel name for signal. + -#### set_data_name(data_name: str) +### set_data_name(data_name: str) Set the data name for signal. + -#### set_interpolation_type(arg2: int) +### set_interpolation_type(arg2: int) Set the interpolation type, for changed resolution to 1 = LINEAR, 2 = QUADRATIC, other values will be ignored. + -#### set_legend_font_size(font_size: int) +### set_legend_font_size(font_size: int) Set the font_size used in legend. + -#### set_legend_position(x_position: float, y_position: float) +### set_legend_position(x_position: float, y_position: float) Set the position of the legend, using absolute or relative coordinates. : (Internally stored as relative.) + -#### set_legend_size(width: float, height: float) +### set_legend_size(width: float, height: float) Set the size of the legend, using absolute or relative coordinates. : (Internally stored as relative.) + -#### set_legend_visible(enabled: bool) +### set_legend_visible(enabled: bool) Set legend visibilty to True or False. + -#### set_line_width(line_width: float) +### set_line_width(line_width: float) Set the line width at the visual. + -#### set_lines_enabled(enabled: bool) +### set_lines_enabled(enabled: bool) Set lines enabled state to True or False. + -#### set_log_x_axis(enabled: bool) +### set_log_x_axis(enabled: bool) Set the x-axis to show values logarithmic. Will be ignored if data range contains values <=0. + -#### set_log_y_axis(enabled: bool) +### set_log_y_axis(enabled: bool) Set the y-axis to show values logarithmic. Will be ignored if data range contains values <=0 + -#### set_number_of_classes(arg2: int) +### set_number_of_classes(arg2: int) Set the number of classes (parts in y direction) with which the contour plot is been shown. + -#### set_number_of_data(number_of_data: int) +### set_number_of_data(number_of_data: int) Set the maximum number of lines for signal_info view. + -#### set_palette_limits(minimum: float, maximum: float) +### set_palette_limits(minimum: float, maximum: float) Set the minimum and maximum values of palette. + -#### set_palette_maximum(maximum: float) +### set_palette_maximum(maximum: float) Set the maximum value of palette. + -#### set_palette_minimum(minimum: float) +### set_palette_minimum(minimum: float) Set the minimum value of palette. + -#### set_palette_position(x_position: float, y_position: float) +### set_palette_position(x_position: float, y_position: float) Set the position of the palette, using absolute or relative[%] coordinates. : (Internally stored as relative[%].) + -#### set_palette_preset(name: str) +### set_palette_preset(name: str) Set palette preset with given name. + -#### set_palette_size(x_position: float, y_position: float) +### set_palette_size(x_position: float, y_position: float) Set the size of the palette, using absolute or relative[%] coordinates. : (Internally stored as relative[%].) + -#### set_palette_visible(enabled: bool) +### set_palette_visible(enabled: bool) Set palette visibility to True or False. + -#### set_ranges_x(minimum: float, maximum: float) +### set_ranges_x(minimum: float, maximum: float) Set the ranges to x-axis, Two inputs : minimum and maximum. + -#### set_ranges_y(minimum: float, maximum: float) +### set_ranges_y(minimum: float, maximum: float) Set the ranges to y-axis, Two inputs : minimum and maximum. + -#### set_reference(reference: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### set_reference(reference: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) Set the reference signal. + -#### set_reference_channel(reference_channel_index: int) +### set_reference_channel(reference_channel_index: int) Set the reference channel index for signal. + -#### set_reference_channel_name(channel_name: str) +### set_reference_channel_name(channel_name: str) Set the channel name for reference. + -#### set_reference_data_name(data_name: str) +### set_reference_data_name(data_name: str) Set the data name for reference. + -#### set_reference_design(reference_design_id: [HID](id.md#id.HID)) +### set_reference_design(reference_design_id: [HID](id.md#id.HID)) Set the reference design id. For reference signal only one design is shown. + -#### set_reference_number_of_data(number_of_data: int) +### set_reference_number_of_data(number_of_data: int) Set the maximum number of lines for reference signal_info view. + -#### set_resolution(arg2: int) +### set_resolution(arg2: int) Set the resolution with which the signals are shown, when adjust_resolution is set to True. Minimum 2. + -#### set_sigma_factor(arg2: float) +### set_sigma_factor(arg2: float) Set the factor with which standard deviation is shown. Change plot only when statistical data is shown. + -#### set_signal(signal: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) +### set_signal(signal: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension)) Set the signal. + -#### set_surfaces_enabled(enabled: bool) +### set_surfaces_enabled(enabled: bool) Set surfaces enabled state to True or False. + -#### set_symbol_size(symbol_size: float) +### set_symbol_size(symbol_size: float) Set the symbol size at the visual. + -#### set_x_axis_format(x_axis_format: str) +### set_x_axis_format(x_axis_format: str) Set the axis format for x axis. Will be ignored if log axis is been chosen for x-axis. + -#### set_x_axis_label(label_x: str) +### set_x_axis_label(label_x: str) Set the x axis label. + -#### set_y_axis_format(y_axis_format: str) +### set_y_axis_format(y_axis_format: str) Set the axis format for y axis. Will be ignored if log axis is been chosen for y-axis. + -#### set_y_axis_label(label_y: str) +### set_y_axis_label(label_y: str) Set the y axis label. + -#### show_as_contour_plot(arg2: bool) +### show_as_contour_plot(arg2: bool) Show signal data as contour plot with given number of classes. + -#### show_statistical_values(arg2: bool) +### show_statistical_values(arg2: bool) Show additional to signal, mean and standard deviation for signals with more than one line. + -#### update_plot() +### update_plot() Trigger an additional update on visual. + -#### use_textures(toggle_texture_usage: bool) +### use_textures(toggle_texture_usage: bool) Modify the plot to show textures or not. : Does only afllict plots with many points. Setting is to be meant as possibility to deactivate texture usage on certain (graphic) systems, where showing as texture leads to graphical problems. Not showing as texture means in most cases a reduce in performance. + -#### *class* SpiderPlot +### *class* SpiderPlot + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) + -#### export(file_path: Path) +### export(file_path: Path) -#### export(file_path: Path, width: int, height: int) +### export(file_path: Path, width: int, height: int) [0] Export the visual as picture, with given relative scale to file position given as path. : If scale is left empty, 1.0 is used. @@ -6665,707 +8004,848 @@ Modify the plot to show textures or not. : Transparency produces plot with transparent background which is available when having picture types supporting this, like png. Quality is available for jpg, determining the quality of the output in percent [0:100]. + -#### get_caption() → str +### get_caption() → str Get the caption. + -#### *static* get_display_name() → str +### *static* get_display_name() → str Get a descriptive title for this visual type. + -#### *static* get_group_name() → str +### *static* get_group_name() → str Get the name of the containing group. + -#### set_caption(caption: str) +### set_caption(caption: str) Set the caption. + -#### set_font_size(arg2: int) +### set_font_size(arg2: int) Set the font size at the visual. + -#### set_line_width(line_width: float) +### set_line_width(line_width: float) Set the line width at the visual. + -#### set_symbol_size(symbol_size: float) +### set_symbol_size(symbol_size: float) Set the symbol size at the visual. + -#### StackedBars *= py_monitoring_gui.CustomData_Type.StackedBars* +### StackedBars *= py_monitoring_gui.CustomData_Type.StackedBars* + -#### StackedHorizontalBars *= py_monitoring_gui.CustomData_Type.StackedHorizontalBars* +### StackedHorizontalBars *= py_monitoring_gui.CustomData_Type.StackedHorizontalBars* + -#### *class* StatisticAnalysis +### *class* StatisticAnalysis + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) + -#### get_caption() → str +### get_caption() → str Get the caption. + -#### get_data(layer_name: str) → list +### get_data(layer_name: str) → list Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text. + -#### *static* get_display_name() → str +### *static* get_display_name() → str Get a descriptive title for this visual type. + -#### *static* get_group_name() → str +### *static* get_group_name() → str Get the name of the containing group. + -#### get_header_data(layer_name: str, horizontal: bool) → list +### get_header_data(layer_name: str, horizontal: bool) → list Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header. + -#### get_x_axis_label() → str +### get_x_axis_label() → str Get the x axis label. + -#### get_y_axis_label() → str +### get_y_axis_label() → str Get the y axis label. + -#### set_axes_enabled(enabled: bool) +### set_axes_enabled(enabled: bool) Set axes enabled state to True or False. + -#### set_box_probability_content(box_probability_content: float) +### set_box_probability_content(box_probability_content: float) Set the probability content for the box. Box goes from median-content\*0.5 to median+content\*0.5. + -#### set_box_sigma_factor(box_sigma_factor: float) +### set_box_sigma_factor(box_sigma_factor: float) Set the sigma factor for the box. Box goes from mean-factor to mean+factor. + -#### set_box_type(box_type: [StatisticAnalysisBoxType](#py_monitoring_gui.StatisticAnalysisBoxType)) +### set_box_type(box_type: [StatisticAnalysisBoxType](#py_monitoring_gui.StatisticAnalysisBoxType)) Set the box type. + -#### set_caption(caption: str) +### set_caption(caption: str) Set the caption. + -#### set_group(group_name: str) +### set_group(group_name: str) Set the group to be shown + -#### set_limit_type(limit_type: [StatisticAnalysisLimitsType](#py_monitoring_gui.StatisticAnalysisLimitsType)) +### set_limit_type(limit_type: [StatisticAnalysisLimitsType](#py_monitoring_gui.StatisticAnalysisLimitsType)) Set the limit type. + -#### set_line_width(line_width: float) +### set_line_width(line_width: float) Set the line width at the visual. + -#### set_ranges_x(minimum: float, maximum: float) +### set_ranges_x(minimum: float, maximum: float) Set the ranges to x-axis, Two inputs : minimum and maximum. + -#### set_ranges_y(minimum: float, maximum: float) +### set_ranges_y(minimum: float, maximum: float) Set the ranges to y-axis, Two inputs : minimum and maximum. + -#### set_scaling_type(scaling_type: [StatisticAnalysisScalingType](#py_monitoring_gui.StatisticAnalysisScalingType)) +### set_scaling_type(scaling_type: [StatisticAnalysisScalingType](#py_monitoring_gui.StatisticAnalysisScalingType)) Set the scaling type. + -#### set_separate_box_and_whisker(separate: bool) +### set_separate_box_and_whisker(separate: bool) Show Box and Whisker on two layers. + -#### set_show_samples(show_samples: bool) +### set_show_samples(show_samples: bool) Show sample points. + -#### set_symbol_size(symbol_size: float) +### set_symbol_size(symbol_size: float) Set the symbol size at the visual. + -#### set_whisker_probability_content(whisker_probability_content: float) +### set_whisker_probability_content(whisker_probability_content: float) Set the probability content for the whisker. Whisker goes from median-content\*0.5 to median+content\*0.5. + -#### set_whisker_sigma_factor(whisker_sigma_factor: float) +### set_whisker_sigma_factor(whisker_sigma_factor: float) Set the sigma factor for the whisker. Whisker goes from mean-factor to mean+factor. + -#### set_whisker_type(whisker_type: [StatisticAnalysisWhiskerType](#py_monitoring_gui.StatisticAnalysisWhiskerType)) +### set_whisker_type(whisker_type: [StatisticAnalysisWhiskerType](#py_monitoring_gui.StatisticAnalysisWhiskerType)) Set the whisker type. + -#### set_x_axis_label(label_x: str) +### set_x_axis_label(label_x: str) Set the x axis label. + -#### set_y_axis_format(y_axis_format: str) +### set_y_axis_format(y_axis_format: str) Set the axis format for y axis. Will be ignored if log axis is been chosen for y-axis. + -#### set_y_axis_label(label_y: str) +### set_y_axis_label(label_y: str) Set the y axis label. + -#### update_plot() +### update_plot() Trigger an additional update on visual. + -#### *class* StatisticValues +### *class* StatisticValues + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) + -#### *static* get_display_name() → str +### *static* get_display_name() → str Get a descriptive title for this visual type. + -#### *static* get_group_name() → str +### *static* get_group_name() → str Get the name of the containing group. + -#### *class* TrafficLightPlot +### *class* TrafficLightPlot + -#### HideResponses(dimension_list: [DimensionList](py_monitoring_kernel.md#py_monitoring_kernel.DimensionList)) +### HideResponses(dimension_list: [DimensionList](py_monitoring_kernel.md#py_monitoring_kernel.DimensionList)) Hide given dimensions. + -#### SetResponseVisible(dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension), visible: bool) +### SetResponseVisible(dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension), visible: bool) Toggle the visibility of one single dimension. + -#### SetSigmaFactor(sigma: float) +### SetSigmaFactor(sigma: float) Change the sigma value used for statistical_values and for whole plot when values_sigma_based is chosen. + -#### ShowAllResponses() +### ShowAllResponses() Show all dimensions. + -#### ShowResponses(dimension_list: [DimensionList](py_monitoring_kernel.md#py_monitoring_kernel.DimensionList)) +### ShowResponses(dimension_list: [DimensionList](py_monitoring_kernel.md#py_monitoring_kernel.DimensionList)) Show given dimensions. + -#### ShowStatisticValues(visible: bool) +### ShowStatisticValues(visible: bool) Toggle visibility of statistical values, shown as additional box_plot on top of the bars. + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) + -#### get_caption() → str +### get_caption() → str Get the caption. + -#### get_data(layer_name: str) → list +### get_data(layer_name: str) → list Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text. + -#### *static* get_display_name() → str +### *static* get_display_name() → str Get a descriptive title for this visual type. + -#### *static* get_group_name() → str +### *static* get_group_name() → str Get the name of the containing group. + -#### get_header_data(layer_name: str, horizontal: bool) → list +### get_header_data(layer_name: str, horizontal: bool) → list Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header. + -#### get_x_axis_label() → str +### get_x_axis_label() → str Get the x axis label. + -#### get_y_axis_label() → str +### get_y_axis_label() → str Get the y axis label. + -#### has_legend() → bool +### has_legend() → bool + -#### hide_responses(dimension_list: [DimensionList](py_monitoring_kernel.md#py_monitoring_kernel.DimensionList)) +### hide_responses(dimension_list: [DimensionList](py_monitoring_kernel.md#py_monitoring_kernel.DimensionList)) Hide given dimensions. + -#### set_axes_enabled(enabled: bool) +### set_axes_enabled(enabled: bool) Set axes enabled state to True or False. + -#### set_axes_rotation_enabled(enable: bool) +### set_axes_rotation_enabled(enable: bool) Set axes rotation enabled. + -#### set_axes_rotation_orthogonal(enable: bool) +### set_axes_rotation_orthogonal(enable: bool) Set rotation angles to 0 degree if enough space for text exist, else to 90. + -#### set_axes_rotation_x_angle(angle: float) +### set_axes_rotation_x_angle(angle: float) Set the rotation angle for x-axis. + -#### set_caption(caption: str) +### set_caption(caption: str) Set the caption. + -#### set_legend_font_size(font_size: int) +### set_legend_font_size(font_size: int) Set the font_size used in legend. + -#### set_legend_position(x_position: float, y_position: float) +### set_legend_position(x_position: float, y_position: float) Set the position of the legend, using absolute or relative coordinates. : (Internally stored as relative.) + -#### set_legend_size(width: float, height: float) +### set_legend_size(width: float, height: float) Set the size of the legend, using absolute or relative coordinates. : (Internally stored as relative.) + -#### set_legend_visible(enabled: bool) +### set_legend_visible(enabled: bool) Set legend visibilty to True or False. + -#### set_line_width(line_width: float) +### set_line_width(line_width: float) Set the line width at the visual. + -#### set_log_y_axis(enabled: bool) +### set_log_y_axis(enabled: bool) Set the y-axis to show values logarithmic. Will be ignored if data range contains values <=0 + -#### set_ranges_x(minimum: float, maximum: float) +### set_ranges_x(minimum: float, maximum: float) Set the ranges to x-axis, Two inputs : minimum and maximum. + -#### set_ranges_y(minimum: float, maximum: float) +### set_ranges_y(minimum: float, maximum: float) Set the ranges to y-axis, Two inputs : minimum and maximum. + -#### set_response_visible(dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension), visible: bool) +### set_response_visible(dimension: [Dimension](py_monitoring_kernel.md#py_monitoring_kernel.Dimension), visible: bool) Toggle the visibility of one single dimension. + -#### set_sigma_factor(sigma: float) +### set_sigma_factor(sigma: float) Change the sigma value used for statistical_values and for whole plot when values_sigma_based is chosen. + -#### set_symbol_size(symbol_size: float) +### set_symbol_size(symbol_size: float) Set the symbol size at the visual. + -#### set_x_axis_label(label_x: str) +### set_x_axis_label(label_x: str) Set the x axis label. + -#### set_y_axis_format(y_axis_format: str) +### set_y_axis_format(y_axis_format: str) Set the axis format for y axis. Will be ignored if log axis is been chosen for y-axis. + -#### set_y_axis_label(label_y: str) +### set_y_axis_label(label_y: str) Set the y axis label. + -#### show_all_responses() +### show_all_responses() Show all dimensions. + -#### show_responses(dimension_list: [DimensionList](py_monitoring_kernel.md#py_monitoring_kernel.DimensionList)) +### show_responses(dimension_list: [DimensionList](py_monitoring_kernel.md#py_monitoring_kernel.DimensionList)) Show given dimensions. + -#### show_statistical_values(visible: bool) +### show_statistical_values(visible: bool) Toggle visibility of statistical values, shown as additional box_plot on top of the bars. + -#### show_values_sigma_based(toggle: bool) +### show_values_sigma_based(toggle: bool) Toggle the values view, base on mean and sigma vs. original values. + -#### update_plot() +### update_plot() Trigger an additional update on visual. + -#### *class* VectorElements +### *class* VectorElements + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) + -#### get_caption() → str +### get_caption() → str Get the caption. + -#### get_data(layer_name: str) → list +### get_data(layer_name: str) → list Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text. + -#### *static* get_display_name() → str +### *static* get_display_name() → str Get a descriptive title for this visual type. + -#### *static* get_group_name() → str +### *static* get_group_name() → str Get the name of the containing group. + -#### get_header_data(layer_name: str, horizontal: bool) → list +### get_header_data(layer_name: str, horizontal: bool) → list Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header. + -#### get_x_axis_label() → str +### get_x_axis_label() → str Get the x axis label. + -#### get_y_axis_label() → str +### get_y_axis_label() → str Get the y axis label. + -#### set_axes_enabled(enabled: bool) +### set_axes_enabled(enabled: bool) Set axes enabled state to True or False. + -#### set_caption(caption: str) +### set_caption(caption: str) Set the caption. + -#### set_line_width(line_width: float) +### set_line_width(line_width: float) Set the line width at the visual. + -#### set_ranges_x(minimum: float, maximum: float) +### set_ranges_x(minimum: float, maximum: float) Set the ranges to x-axis, Two inputs : minimum and maximum. + -#### set_ranges_y(minimum: float, maximum: float) +### set_ranges_y(minimum: float, maximum: float) Set the ranges to y-axis, Two inputs : minimum and maximum. + -#### set_x_axis_label(label_x: str) +### set_x_axis_label(label_x: str) Set the x axis label. + -#### set_y_axis_label(label_y: str) +### set_y_axis_label(label_y: str) Set the y axis label. + -#### update_plot() +### update_plot() Trigger an additional update on visual. + -#### *class* WebViewer +### *class* WebViewer + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) + -#### *static* get_display_name() → str +### *static* get_display_name() → str Get a descriptive title for this visual type. + -#### *static* get_group_name() → str +### *static* get_group_name() → str Get the name of the containing group. + -#### set_source(path: str) +### set_source(path: str) -#### set_source(path: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### set_source(path: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) [0] Set path to html file to be viewed [1] Set path to html file to be viewed + -#### set_source_data(content: str) +### set_source_data(content: str) Set content of html to be viewed + -#### *class* WeightedPCValues +### *class* WeightedPCValues + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) -#### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id), arg3: [py_monitoring_kernel.Id](py_monitoring_kernel.md#py_monitoring_kernel.Id)) + -#### get_caption() → str +### get_caption() → str Get the caption. + -#### get_data(layer_name: str) → list +### get_data(layer_name: str) → list Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text. + -#### *static* get_display_name() → str +### *static* get_display_name() → str Get a descriptive title for this visual type. + -#### *static* get_group_name() → str +### *static* get_group_name() → str Get the name of the containing group. + -#### get_header_data(layer_name: str, horizontal: bool) → list +### get_header_data(layer_name: str, horizontal: bool) → list Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header. + -#### get_palette_preset_names() → list +### get_palette_preset_names() → list Get a list of available palette preset names. + -#### get_x_axis_label() → str +### get_x_axis_label() → str Get the x axis label. + -#### get_y_axis_label() → str +### get_y_axis_label() → str Get the y axis label. + -#### reset_palette_limits() +### reset_palette_limits() ReSet the minimum and maximum values of palette to default. + -#### reset_palette_maximum() +### reset_palette_maximum() Reset the maximum value of palette. + -#### reset_palette_minimum() +### reset_palette_minimum() Reset the minimum value of palette. + -#### set_axes_enabled(enabled: bool) +### set_axes_enabled(enabled: bool) Set axes enabled state to True or False. + -#### set_caption(caption: str) +### set_caption(caption: str) Set the caption. + -#### set_line_width(line_width: float) +### set_line_width(line_width: float) Set the line width at the visual. + -#### set_lines_enabled(enabled: bool) +### set_lines_enabled(enabled: bool) Set lines enabled state to True or False. + -#### set_log_x_axis(enabled: bool) +### set_log_x_axis(enabled: bool) Set the x-axis to show values logarithmic. Will be ignored if data range contains values <=0. + -#### set_log_y_axis(enabled: bool) +### set_log_y_axis(enabled: bool) Set the y-axis to show values logarithmic. Will be ignored if data range contains values <=0 + -#### set_palette_limits(minimum: float, maximum: float) +### set_palette_limits(minimum: float, maximum: float) Set the minimum and maximum values of palette. + -#### set_palette_maximum(maximum: float) +### set_palette_maximum(maximum: float) Set the maximum value of palette. + -#### set_palette_minimum(minimum: float) +### set_palette_minimum(minimum: float) Set the minimum value of palette. + -#### set_palette_position(x_position: float, y_position: float) +### set_palette_position(x_position: float, y_position: float) Set the position of the palette, using absolute or relative[%] coordinates. : (Internally stored as relative[%].) + -#### set_palette_preset(name: str) +### set_palette_preset(name: str) Set palette preset with given name. + -#### set_palette_size(x_position: float, y_position: float) +### set_palette_size(x_position: float, y_position: float) Set the size of the palette, using absolute or relative[%] coordinates. : (Internally stored as relative[%].) + -#### set_palette_visible(enabled: bool) +### set_palette_visible(enabled: bool) Set palette visibility to True or False. + -#### set_ranges_x(minimum: float, maximum: float) +### set_ranges_x(minimum: float, maximum: float) Set the ranges to x-axis, Two inputs : minimum and maximum. + -#### set_ranges_y(minimum: float, maximum: float) +### set_ranges_y(minimum: float, maximum: float) Set the ranges to y-axis, Two inputs : minimum and maximum. + -#### set_surfaces_enabled(enabled: bool) +### set_surfaces_enabled(enabled: bool) Set surfaces enabled state to True or False. + -#### set_symbol_size(symbol_size: float) +### set_symbol_size(symbol_size: float) Set the symbol size at the visual. + -#### set_x_axis_label(label_x: str) +### set_x_axis_label(label_x: str) Set the x axis label. + -#### set_y_axis_label(label_y: str) +### set_y_axis_label(label_y: str) Set the y axis label. + -#### update_plot() +### update_plot() Trigger an additional update on visual. + -#### \_\_init_\_() +### \_\_init_\_() diff --git a/2025R2/optiSLang-python-api/modules/py_monitoring_kernel.md b/2025R2/optiSLang-python-api/modules/py_monitoring_kernel.md index 7e9221abe2..af0728c957 100644 --- a/2025R2/optiSLang-python-api/modules/py_monitoring_kernel.md +++ b/2025R2/optiSLang-python-api/modules/py_monitoring_kernel.md @@ -1,1178 +1,1454 @@ + -### *class* py_monitoring_kernel.Color +# py_monitoring_kernel + + + +## *class* py_monitoring_kernel.Color Color object used to style designs. + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [PredefinedColor](#py_monitoring_kernel.PredefinedColor)) +### \_\_init_\_(arg2: [PredefinedColor](#py_monitoring_kernel.PredefinedColor)) -#### \_\_init_\_(arg2: int, arg3: int, arg4: int) +### \_\_init_\_(arg2: int, arg3: int, arg4: int) -#### \_\_init_\_(arg2: int, arg3: int, arg4: int, arg5: int) +### \_\_init_\_(arg2: int, arg3: int, arg4: int, arg5: int) -#### \_\_init_\_(arg2: int, arg3: int) +### \_\_init_\_(arg2: int, arg3: int) + -#### *property* a +### *property* a Alpha component of the color. + -#### *property* b +### *property* b Blue component of the color. + -#### *property* g +### *property* g Green component of the color. + -#### *property* r +### *property* r Red component of the color. + -### *class* py_monitoring_kernel.Control +## *class* py_monitoring_kernel.Control + -#### \_\_init_\_() +### \_\_init_\_() Raises an exception This class cannot be instantiated from Python + -### *class* py_monitoring_kernel.ControlInterface +## *class* py_monitoring_kernel.ControlInterface Base interface of a monitoring control. Controls display data and/or provide data editing functionality. + -#### GetId() → [Id](#py_monitoring_kernel.Id) +### GetId() → [Id](#py_monitoring_kernel.Id) + -#### \_\_init_\_() +### \_\_init_\_() Raises an exception This class cannot be instantiated from Python + -#### get_id() → [Id](#py_monitoring_kernel.Id) +### get_id() → [Id](#py_monitoring_kernel.Id) + -### *class* py_monitoring_kernel.ControlPositioning +## *class* py_monitoring_kernel.ControlPositioning **Enumeration** Enumerates possible control positioning alternatives. + -#### ABSOLUTE_POSITIONING *= py_monitoring_kernel.ControlPositioning.ABSOLUTE_POSITIONING* +### ABSOLUTE_POSITIONING *= py_monitoring_kernel.ControlPositioning.ABSOLUTE_POSITIONING* + -#### FREE_POSITIONING *= py_monitoring_kernel.ControlPositioning.FREE_POSITIONING* +### FREE_POSITIONING *= py_monitoring_kernel.ControlPositioning.FREE_POSITIONING* + -#### RELATIVE_POSITIONING *= py_monitoring_kernel.ControlPositioning.RELATIVE_POSITIONING* +### RELATIVE_POSITIONING *= py_monitoring_kernel.ControlPositioning.RELATIVE_POSITIONING* + -### *class* py_monitoring_kernel.Controller +## *class* py_monitoring_kernel.Controller + -#### \_\_init_\_() +### \_\_init_\_() + -### *class* py_monitoring_kernel.ControllerInterface +## *class* py_monitoring_kernel.ControllerInterface Base interface of a controller object, managing monitoring data, monitoring visuals and controls, and data change requests. + -#### GetMonitoringData(arg2: [Id](#py_monitoring_kernel.Id)) → [MonitoringData](#py_monitoring_kernel.MonitoringData) +### GetMonitoringData(arg2: [Id](#py_monitoring_kernel.Id)) → [MonitoringData](#py_monitoring_kernel.MonitoringData) Get a certain monitoring data object. + -#### \_\_init_\_() +### \_\_init_\_() Raises an exception This class cannot be instantiated from Python + -#### get_monitoring_data(arg2: [Id](#py_monitoring_kernel.Id)) → [MonitoringData](#py_monitoring_kernel.MonitoringData) +### get_monitoring_data(arg2: [Id](#py_monitoring_kernel.Id)) → [MonitoringData](#py_monitoring_kernel.MonitoringData) Get a certain monitoring data object. + -### *class* py_monitoring_kernel.Convenience +## *class* py_monitoring_kernel.Convenience + -#### \_\_init_\_() +### \_\_init_\_() + -#### *static* activate_all_criteria(arg2: [Id](#py_monitoring_kernel.Id)) +### *static* activate_all_criteria(arg2: [Id](#py_monitoring_kernel.Id)) Globally activate all criteria. + -#### *static* activate_all_parameters(arg2: [Id](#py_monitoring_kernel.Id)) +### *static* activate_all_parameters(arg2: [Id](#py_monitoring_kernel.Id)) Globally activate all parameters. + -#### *static* activate_all_responses(arg2: [Id](#py_monitoring_kernel.Id)) +### *static* activate_all_responses(arg2: [Id](#py_monitoring_kernel.Id)) Globally activate all responses. + -#### *static* add_limit(arg2: [Id](#py_monitoring_kernel.Id), arg3: [Limit](#py_monitoring_kernel.Limit)) +### *static* add_limit(arg2: [Id](#py_monitoring_kernel.Id), arg3: [Limit](#py_monitoring_kernel.Limit)) Add a global limit value. + -#### *static* deactivate_all_designs(arg2: [Id](#py_monitoring_kernel.Id)) +### *static* deactivate_all_designs(arg2: [Id](#py_monitoring_kernel.Id)) Globally deactivate all designs. + -#### *static* deactivate_unimportant_parameters(arg2: [Id](#py_monitoring_kernel.Id)) +### *static* deactivate_unimportant_parameters(arg2: [Id](#py_monitoring_kernel.Id)) Globally deactivate all unimportant parameters. + -#### *static* deselect_all_designs(arg2: [Id](#py_monitoring_kernel.Id)) +### *static* deselect_all_designs(arg2: [Id](#py_monitoring_kernel.Id)) Globally deselect all designs. + -#### *static* export_palette(arg2: [Id](#py_monitoring_kernel.Id), arg3: str, arg4: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg5: bool) +### *static* export_palette(arg2: [Id](#py_monitoring_kernel.Id), arg3: str, arg4: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg5: bool) Export palette. + -#### *static* get_limit_by_name(arg2: [Id](#py_monitoring_kernel.Id), arg3: str) → [Limit](#py_monitoring_kernel.Limit) +### *static* get_limit_by_name(arg2: [Id](#py_monitoring_kernel.Id), arg3: str) → [Limit](#py_monitoring_kernel.Limit) Get limit with given name when found. + -#### *static* get_num_deactivated_parameters(arg2: [Id](#py_monitoring_kernel.Id)) → int +### *static* get_num_deactivated_parameters(arg2: [Id](#py_monitoring_kernel.Id)) → int Get number of deactivated parameters. + -#### *static* get_palette(arg2: [Id](#py_monitoring_kernel.Id), arg3: str) → [PaletteData](#py_monitoring_kernel.PaletteData) +### *static* get_palette(arg2: [Id](#py_monitoring_kernel.Id), arg3: str) → [PaletteData](#py_monitoring_kernel.PaletteData) Get palette by name. + -#### *static* get_palette_names(arg2: [Id](#py_monitoring_kernel.Id)) → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) +### *static* get_palette_names(arg2: [Id](#py_monitoring_kernel.Id)) → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) Get all exitings palette names. + -#### *static* get_unimportant_parameters(arg2: [Id](#py_monitoring_kernel.Id)) → [WStrSet](stdcpp_python_export.md#stdcpp_python_export.WStrSet) +### *static* get_unimportant_parameters(arg2: [Id](#py_monitoring_kernel.Id)) → [WStrSet](stdcpp_python_export.md#stdcpp_python_export.WStrSet) Get names of all unimportant parameters. + -#### *static* get_unused_responses(arg2: [Id](#py_monitoring_kernel.Id)) → [WStrSet](stdcpp_python_export.md#stdcpp_python_export.WStrSet) +### *static* get_unused_responses(arg2: [Id](#py_monitoring_kernel.Id)) → [WStrSet](stdcpp_python_export.md#stdcpp_python_export.WStrSet) Get names of all unused responses. + -#### *static* has_limit(arg2: [Id](#py_monitoring_kernel.Id), arg3: [Limit](#py_monitoring_kernel.Limit)) → bool +### *static* has_limit(arg2: [Id](#py_monitoring_kernel.Id), arg3: [Limit](#py_monitoring_kernel.Limit)) → bool Return true when limit is found. + -#### *static* is_parameter_active(arg2: [Id](#py_monitoring_kernel.Id), arg3: str) → bool +### *static* is_parameter_active(arg2: [Id](#py_monitoring_kernel.Id), arg3: str) → bool Returns true when parameter is active. + -#### *static* is_response_active(arg2: [Id](#py_monitoring_kernel.Id), arg3: str) → bool +### *static* is_response_active(arg2: [Id](#py_monitoring_kernel.Id), arg3: str) → bool Returns true when response is active. + -#### *static* load_palette_from_file(arg2: [Id](#py_monitoring_kernel.Id), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### *static* load_palette_from_file(arg2: [Id](#py_monitoring_kernel.Id), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) Load palette from file. + -#### *static* load_palette_from_folder(arg2: [Id](#py_monitoring_kernel.Id), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### *static* load_palette_from_folder(arg2: [Id](#py_monitoring_kernel.Id), arg3: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) Load palettes from folder. + -#### *static* preserve_param_activation() → bool +### *static* preserve_param_activation() → bool Returns true when parameter activation should be preserved. + -#### *static* remove_default_limits(arg2: [Id](#py_monitoring_kernel.Id)) +### *static* remove_default_limits(arg2: [Id](#py_monitoring_kernel.Id)) Remove all default limits. + -#### *static* remove_limit(arg2: [Id](#py_monitoring_kernel.Id), arg3: [Limit](#py_monitoring_kernel.Limit)) +### *static* remove_limit(arg2: [Id](#py_monitoring_kernel.Id), arg3: [Limit](#py_monitoring_kernel.Limit)) Remove a global limit. + -#### *static* select_best_designs(arg2: [Id](#py_monitoring_kernel.Id)) +### *static* select_best_designs(arg2: [Id](#py_monitoring_kernel.Id)) Select best designs. + -#### *static* set_1st_axis(arg2: [Id](#py_monitoring_kernel.Id), arg3: [Dimension](#py_monitoring_kernel.Dimension)) +### *static* set_1st_axis(arg2: [Id](#py_monitoring_kernel.Id), arg3: [Dimension](#py_monitoring_kernel.Dimension)) Globally change what object to display at first axis. + -#### *static* set_2nd_axis(arg2: [Id](#py_monitoring_kernel.Id), arg3: [Dimension](#py_monitoring_kernel.Dimension)) +### *static* set_2nd_axis(arg2: [Id](#py_monitoring_kernel.Id), arg3: [Dimension](#py_monitoring_kernel.Dimension)) Globally change what object to display at second axis. + -#### *static* set_3rd_axis(arg2: [Id](#py_monitoring_kernel.Id), arg3: [Dimension](#py_monitoring_kernel.Dimension)) +### *static* set_3rd_axis(arg2: [Id](#py_monitoring_kernel.Id), arg3: [Dimension](#py_monitoring_kernel.Dimension)) Globally change what object to display at third axis. + -#### *static* set_criteria_activated(arg2: [Id](#py_monitoring_kernel.Id), arg3: [WStrSet](stdcpp_python_export.md#stdcpp_python_export.WStrSet)) +### *static* set_criteria_activated(arg2: [Id](#py_monitoring_kernel.Id), arg3: [WStrSet](stdcpp_python_export.md#stdcpp_python_export.WStrSet)) Globally activate criteria. + -#### *static* set_criteria_deactivated(arg2: [Id](#py_monitoring_kernel.Id), arg3: [WStrSet](stdcpp_python_export.md#stdcpp_python_export.WStrSet)) +### *static* set_criteria_deactivated(arg2: [Id](#py_monitoring_kernel.Id), arg3: [WStrSet](stdcpp_python_export.md#stdcpp_python_export.WStrSet)) Globally deactivate criteria. + -#### *static* set_criterion_activated(arg2: [Id](#py_monitoring_kernel.Id), arg3: str) +### *static* set_criterion_activated(arg2: [Id](#py_monitoring_kernel.Id), arg3: str) Globally activate a certain criterion. + -#### *static* set_criterion_deactivated(arg2: [Id](#py_monitoring_kernel.Id), arg3: str) +### *static* set_criterion_deactivated(arg2: [Id](#py_monitoring_kernel.Id), arg3: str) Globally deactivate a certain criterion. + -#### *static* set_criterion_to_1st_axis(arg2: [Id](#py_monitoring_kernel.Id), arg3: str) +### *static* set_criterion_to_1st_axis(arg2: [Id](#py_monitoring_kernel.Id), arg3: str) Globally change what criterion to display at first axis. + -#### *static* set_criterion_to_2nd_axis(arg2: [Id](#py_monitoring_kernel.Id), arg3: str) +### *static* set_criterion_to_2nd_axis(arg2: [Id](#py_monitoring_kernel.Id), arg3: str) Globally change what criterion to display at second axis. + -#### *static* set_criterion_to_3rd_axis(arg2: [Id](#py_monitoring_kernel.Id), arg3: str) +### *static* set_criterion_to_3rd_axis(arg2: [Id](#py_monitoring_kernel.Id), arg3: str) Globally change what criterion to display at third axis. + -#### *static* set_default_palette(arg2: [Id](#py_monitoring_kernel.Id), arg3: str) +### *static* set_default_palette(arg2: [Id](#py_monitoring_kernel.Id), arg3: str) Set default palette. + -#### *static* set_design_activated(arg2: [Id](#py_monitoring_kernel.Id), arg3: [HID](id.md#id.HID), arg4: bool) +### *static* set_design_activated(arg2: [Id](#py_monitoring_kernel.Id), arg3: [HID](id.md#id.HID), arg4: bool) Globally activate/deactivate a certain design. + -#### *static* set_design_selected(arg2: [Id](#py_monitoring_kernel.Id), arg3: [HID](id.md#id.HID), arg4: bool) +### *static* set_design_selected(arg2: [Id](#py_monitoring_kernel.Id), arg3: [HID](id.md#id.HID), arg4: bool) Globally select/deselect a certain design. + -#### *static* set_design_set(arg2: [Id](#py_monitoring_kernel.Id), arg3: str) +### *static* set_design_set(arg2: [Id](#py_monitoring_kernel.Id), arg3: str) Globally change set of designs to display. + -#### *static* set_design_style(arg2: [Id](#py_monitoring_kernel.Id), arg3: [HID](id.md#id.HID), arg4: [Style](#py_monitoring_kernel.Style)) +### *static* set_design_style(arg2: [Id](#py_monitoring_kernel.Id), arg3: [HID](id.md#id.HID), arg4: [Style](#py_monitoring_kernel.Style)) Globally change the style of a certain design. + -#### *static* set_designs_selected(arg2: [Id](#py_monitoring_kernel.Id), arg3: [HIDSet](id.md#id.HIDSet), arg4: bool) +### *static* set_designs_selected(arg2: [Id](#py_monitoring_kernel.Id), arg3: [HIDSet](id.md#id.HIDSet), arg4: bool) Globally select/deselect certain designs. + -#### *static* set_designs_style(arg2: [Id](#py_monitoring_kernel.Id), arg3: [HIDSet](id.md#id.HIDSet), arg4: [Style](#py_monitoring_kernel.Style)) +### *static* set_designs_style(arg2: [Id](#py_monitoring_kernel.Id), arg3: [HIDSet](id.md#id.HIDSet), arg4: [Style](#py_monitoring_kernel.Style)) Globally change the style of a given designs. + -#### *static* set_limit_lower_value_at_dimension(arg2: [Id](#py_monitoring_kernel.Id), arg3: [Dimension](#py_monitoring_kernel.Dimension), arg4: [Limit](#py_monitoring_kernel.Limit), arg5: float) +### *static* set_limit_lower_value_at_dimension(arg2: [Id](#py_monitoring_kernel.Id), arg3: [Dimension](#py_monitoring_kernel.Dimension), arg4: [Limit](#py_monitoring_kernel.Limit), arg5: float) Set limit lower value at a dimension. + -#### *static* set_limit_target_at_dimension(arg2: [Id](#py_monitoring_kernel.Id), arg3: [Dimension](#py_monitoring_kernel.Dimension), arg4: [Limit](#py_monitoring_kernel.Limit), arg5: float) +### *static* set_limit_target_at_dimension(arg2: [Id](#py_monitoring_kernel.Id), arg3: [Dimension](#py_monitoring_kernel.Dimension), arg4: [Limit](#py_monitoring_kernel.Limit), arg5: float) Set limit target at a dimension. + -#### *static* set_limit_upper_value_at_dimension(arg2: [Id](#py_monitoring_kernel.Id), arg3: [Dimension](#py_monitoring_kernel.Dimension), arg4: [Limit](#py_monitoring_kernel.Limit), arg5: float) +### *static* set_limit_upper_value_at_dimension(arg2: [Id](#py_monitoring_kernel.Id), arg3: [Dimension](#py_monitoring_kernel.Dimension), arg4: [Limit](#py_monitoring_kernel.Limit), arg5: float) Set limit upper value at a dimension. + -#### *static* set_palette(arg2: [Id](#py_monitoring_kernel.Id), arg3: [PaletteData](#py_monitoring_kernel.PaletteData), arg4: bool) +### *static* set_palette(arg2: [Id](#py_monitoring_kernel.Id), arg3: [PaletteData](#py_monitoring_kernel.PaletteData), arg4: bool) Set palette with the option to overwrite. If overwrite is False palette name will be made unique. + -#### *static* set_parameter_activated(arg2: [Id](#py_monitoring_kernel.Id), arg3: str, arg4: bool) +### *static* set_parameter_activated(arg2: [Id](#py_monitoring_kernel.Id), arg3: str, arg4: bool) Globally activate/deactivate a certain parameter. + -#### *static* set_parameter_to_1st_axis(arg2: [Id](#py_monitoring_kernel.Id), arg3: str) +### *static* set_parameter_to_1st_axis(arg2: [Id](#py_monitoring_kernel.Id), arg3: str) Globally change what parameter to display at first axis. + -#### *static* set_parameter_to_2nd_axis(arg2: [Id](#py_monitoring_kernel.Id), arg3: str) +### *static* set_parameter_to_2nd_axis(arg2: [Id](#py_monitoring_kernel.Id), arg3: str) Globally change what parameter to display at second axis. + -#### *static* set_parameter_to_3rd_axis(arg2: [Id](#py_monitoring_kernel.Id), arg3: str) +### *static* set_parameter_to_3rd_axis(arg2: [Id](#py_monitoring_kernel.Id), arg3: str) Globally change what parameter to display at third axis. + -#### *static* set_parameter_value(arg2: [Id](#py_monitoring_kernel.Id), arg3: str, arg4: float) +### *static* set_parameter_value(arg2: [Id](#py_monitoring_kernel.Id), arg3: str, arg4: float) Globally set the value of a certain parameter. + -#### *static* set_parameter_values(arg2: [Id](#py_monitoring_kernel.Id), arg3: [string_to_double_map](stdcpp_python_export.md#stdcpp_python_export.string_to_double_map)) +### *static* set_parameter_values(arg2: [Id](#py_monitoring_kernel.Id), arg3: [string_to_double_map](stdcpp_python_export.md#stdcpp_python_export.string_to_double_map)) Globally set the value of certain parameters. + -#### *static* set_parameters_activated(arg2: [Id](#py_monitoring_kernel.Id), arg3: [WStrSet](stdcpp_python_export.md#stdcpp_python_export.WStrSet), arg4: bool) +### *static* set_parameters_activated(arg2: [Id](#py_monitoring_kernel.Id), arg3: [WStrSet](stdcpp_python_export.md#stdcpp_python_export.WStrSet), arg4: bool) Globally activate/deactivate parameters. + -#### *static* set_parameters_deactivated(arg2: [Id](#py_monitoring_kernel.Id), arg3: [WStrSet](stdcpp_python_export.md#stdcpp_python_export.WStrSet)) +### *static* set_parameters_deactivated(arg2: [Id](#py_monitoring_kernel.Id), arg3: [WStrSet](stdcpp_python_export.md#stdcpp_python_export.WStrSet)) Globally deactivate parameters. + -#### *static* set_response_activated(arg2: [Id](#py_monitoring_kernel.Id), arg3: str) +### *static* set_response_activated(arg2: [Id](#py_monitoring_kernel.Id), arg3: str) Globally activate a certain response. + -#### *static* set_response_deactivated(arg2: [Id](#py_monitoring_kernel.Id), arg3: str) +### *static* set_response_deactivated(arg2: [Id](#py_monitoring_kernel.Id), arg3: str) Globally deactivate a certain response. + -#### *static* set_response_to_1st_axis(arg2: [Id](#py_monitoring_kernel.Id), arg3: str) +### *static* set_response_to_1st_axis(arg2: [Id](#py_monitoring_kernel.Id), arg3: str) Globally change what response to display at first axis. + -#### *static* set_response_to_2nd_axis(arg2: [Id](#py_monitoring_kernel.Id), arg3: str) +### *static* set_response_to_2nd_axis(arg2: [Id](#py_monitoring_kernel.Id), arg3: str) Globally change what response to display at second axis. + -#### *static* set_response_to_3rd_axis(arg2: [Id](#py_monitoring_kernel.Id), arg3: str) +### *static* set_response_to_3rd_axis(arg2: [Id](#py_monitoring_kernel.Id), arg3: str) Globally change what response to display at third axis. + -#### *static* set_response_to_cop_axis(arg2: [Id](#py_monitoring_kernel.Id), arg3: str) +### *static* set_response_to_cop_axis(arg2: [Id](#py_monitoring_kernel.Id), arg3: str) Globally change what response to display at CoP listener axis. + -#### *static* set_responses_activated(arg2: [Id](#py_monitoring_kernel.Id), arg3: [WStrSet](stdcpp_python_export.md#stdcpp_python_export.WStrSet)) +### *static* set_responses_activated(arg2: [Id](#py_monitoring_kernel.Id), arg3: [WStrSet](stdcpp_python_export.md#stdcpp_python_export.WStrSet)) Globally activate responses. + -#### *static* set_responses_deactivated(arg2: [Id](#py_monitoring_kernel.Id), arg3: [WStrSet](stdcpp_python_export.md#stdcpp_python_export.WStrSet)) +### *static* set_responses_deactivated(arg2: [Id](#py_monitoring_kernel.Id), arg3: [WStrSet](stdcpp_python_export.md#stdcpp_python_export.WStrSet)) Globally deactivate responses. + -#### *static* switch_first_and_second_axis(arg2: [Id](#py_monitoring_kernel.Id)) +### *static* switch_first_and_second_axis(arg2: [Id](#py_monitoring_kernel.Id)) Globally switch what is being displayed at first and second axis. + -### *class* py_monitoring_kernel.CorrelationTypes +## *class* py_monitoring_kernel.CorrelationTypes **Enumeration** + -#### DistanceCorr *= py_monitoring_kernel.CorrelationTypes.DistanceCorr* +### DistanceCorr *= py_monitoring_kernel.CorrelationTypes.DistanceCorr* + -#### LinearCorr *= py_monitoring_kernel.CorrelationTypes.LinearCorr* +### LinearCorr *= py_monitoring_kernel.CorrelationTypes.LinearCorr* + -#### QuadraticCorr *= py_monitoring_kernel.CorrelationTypes.QuadraticCorr* +### QuadraticCorr *= py_monitoring_kernel.CorrelationTypes.QuadraticCorr* + -#### QuadraticMinusLinear *= py_monitoring_kernel.CorrelationTypes.QuadraticMinusLinear* +### QuadraticMinusLinear *= py_monitoring_kernel.CorrelationTypes.QuadraticMinusLinear* + -#### SpearmanRankOrder *= py_monitoring_kernel.CorrelationTypes.SpearmanRankOrder* +### SpearmanRankOrder *= py_monitoring_kernel.CorrelationTypes.SpearmanRankOrder* + -### py_monitoring_kernel.DefaultStyle() → [Style](#py_monitoring_kernel.Style) +## py_monitoring_kernel.DefaultStyle() → [Style](#py_monitoring_kernel.Style) Default style of designs. + -### *class* py_monitoring_kernel.Dimension +## *class* py_monitoring_kernel.Dimension Dimension object, which holds a dimension type (parameter/response/criterion) and a name. + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(DimensionType: [DimensionType](#py_monitoring_kernel.DimensionType), name: str) +### \_\_init_\_(DimensionType: [DimensionType](#py_monitoring_kernel.DimensionType), name: str) -#### \_\_init_\_(DimensionType: [DimensionType](#py_monitoring_kernel.DimensionType), name: str, vector_component: object) → object +### \_\_init_\_(DimensionType: [DimensionType](#py_monitoring_kernel.DimensionType), name: str, vector_component: object) → object [1] Create a Dimension with DimensionType and name. [2] Create a Dimension with DimensionType and name and additionally a vector component index indicator, either an integer value, which is directly used as index, or a boolean value, then the index is created from the name if the name contains something like [%d]. + -#### get_index() → object +### get_index() → object + -#### is_criterion() → bool +### is_criterion() → bool Return true if the dimension is a criterion. + -#### is_parameter() → bool +### is_parameter() → bool Return true if the dimension is a parameter. + -#### is_response() → bool +### is_response() → bool Return true if the dimension is a response. + -#### is_signal() → bool +### is_signal() → bool Return true if the dimension is a signal. + -#### is_vector_component() → bool +### is_vector_component() → bool Return true if the dimension is a vector component. + -#### *property* name +### *property* name The name of the dimension. + -#### *property* type +### *property* type The type of the dimension. + -### *class* py_monitoring_kernel.DimensionList +## *class* py_monitoring_kernel.DimensionList + -#### \_\_contains_\_(arg2: object) → bool +### \_\_contains_\_(arg2: object) → bool + -#### \_\_delitem_\_(arg2: object) +### \_\_delitem_\_(arg2: object) + -#### \_\_getitem_\_(arg2: object) → object +### \_\_getitem_\_(arg2: object) → object + -#### \_\_init_\_() +### \_\_init_\_() + -#### \_\_iter_\_() → object +### \_\_iter_\_() → object -#### \_\_iter_\_() → object +### \_\_iter_\_() → object + -#### \_\_len_\_() → int +### \_\_len_\_() → int + -#### \_\_setitem_\_(arg2: object, arg3: object) +### \_\_setitem_\_(arg2: object, arg3: object) + -#### append(arg2: object) +### append(arg2: object) + -#### extend(arg2: object) +### extend(arg2: object) + -#### push_back(arg2: [Dimension](#py_monitoring_kernel.Dimension)) +### push_back(arg2: [Dimension](#py_monitoring_kernel.Dimension)) + -#### size() → int +### size() → int + -### *class* py_monitoring_kernel.DimensionType +## *class* py_monitoring_kernel.DimensionType **Enumeration** Enumerates available dimension types. + -#### DIM_TYPE_CRITERION *= py_monitoring_kernel.DimensionType.DIM_TYPE_CRITERION* +### DIM_TYPE_CRITERION *= py_monitoring_kernel.DimensionType.DIM_TYPE_CRITERION* + -#### DIM_TYPE_INVALID *= py_monitoring_kernel.DimensionType.DIM_TYPE_INVALID* +### DIM_TYPE_INVALID *= py_monitoring_kernel.DimensionType.DIM_TYPE_INVALID* + -#### DIM_TYPE_PARAMETER *= py_monitoring_kernel.DimensionType.DIM_TYPE_PARAMETER* +### DIM_TYPE_PARAMETER *= py_monitoring_kernel.DimensionType.DIM_TYPE_PARAMETER* + -#### DIM_TYPE_RESPONSE *= py_monitoring_kernel.DimensionType.DIM_TYPE_RESPONSE* +### DIM_TYPE_RESPONSE *= py_monitoring_kernel.DimensionType.DIM_TYPE_RESPONSE* + -#### DIM_TYPE_SIGNAL *= py_monitoring_kernel.DimensionType.DIM_TYPE_SIGNAL* +### DIM_TYPE_SIGNAL *= py_monitoring_kernel.DimensionType.DIM_TYPE_SIGNAL* + -### *class* py_monitoring_kernel.DimensionVector +## *class* py_monitoring_kernel.DimensionVector + -#### \_\_contains_\_(arg2: object) → bool +### \_\_contains_\_(arg2: object) → bool + -#### \_\_delitem_\_(arg2: object) +### \_\_delitem_\_(arg2: object) + -#### \_\_getitem_\_(arg2: object) → object +### \_\_getitem_\_(arg2: object) → object + -#### \_\_init_\_() +### \_\_init_\_() + -#### \_\_iter_\_() → object +### \_\_iter_\_() → object -#### \_\_iter_\_() → object +### \_\_iter_\_() → object + -#### \_\_len_\_() → int +### \_\_len_\_() → int + -#### \_\_setitem_\_(arg2: object, arg3: object) +### \_\_setitem_\_(arg2: object, arg3: object) + -#### append(arg2: object) +### append(arg2: object) + -#### extend(arg2: object) +### extend(arg2: object) + -#### push_back(arg2: [Dimension](#py_monitoring_kernel.Dimension)) +### push_back(arg2: [Dimension](#py_monitoring_kernel.Dimension)) + -#### size() → int +### size() → int + -### *class* py_monitoring_kernel.Id +## *class* py_monitoring_kernel.Id An id to identify arbitrary objects within monitoring. Consists of a unique UUID and a name. + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -#### *property* name +### *property* name Name of the object. May not be unique. + -### *class* py_monitoring_kernel.Limit +## *class* py_monitoring_kernel.Limit Limit object, which holds a default lower and a default upper value, an ID and a style. + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str, arg3: LimitValue, arg4: LimitValue) +### \_\_init_\_(arg2: str, arg3: LimitValue, arg4: LimitValue) + -#### *property* default_lower_value +### *property* default_lower_value The default lower value of the limit. + -#### *property* default_upper_value +### *property* default_upper_value The default upper value of the limit. + -#### *property* name +### *property* name The name of the limit. + -#### *property* style +### *property* style The name of the limit. + -### *class* py_monitoring_kernel.LimitValue +## *class* py_monitoring_kernel.LimitValue **Enumeration** Enumerates available limit values. + -#### LIMIT_DEFAULT_FAILURE_VALUE *= py_monitoring_kernel.LimitValue.LIMIT_DEFAULT_FAILURE_VALUE* +### LIMIT_DEFAULT_FAILURE_VALUE *= py_monitoring_kernel.LimitValue.LIMIT_DEFAULT_FAILURE_VALUE* + -#### LIMIT_DEFAULT_SAFETY_VALUE *= py_monitoring_kernel.LimitValue.LIMIT_DEFAULT_SAFETY_VALUE* +### LIMIT_DEFAULT_SAFETY_VALUE *= py_monitoring_kernel.LimitValue.LIMIT_DEFAULT_SAFETY_VALUE* + -#### LIMIT_MAX_VALUE *= py_monitoring_kernel.LimitValue.LIMIT_MAX_VALUE* +### LIMIT_MAX_VALUE *= py_monitoring_kernel.LimitValue.LIMIT_MAX_VALUE* + -#### LIMIT_MEAN_PLUS_STDDEV_VALUE *= py_monitoring_kernel.LimitValue.LIMIT_MEAN_PLUS_STDDEV_VALUE* +### LIMIT_MEAN_PLUS_STDDEV_VALUE *= py_monitoring_kernel.LimitValue.LIMIT_MEAN_PLUS_STDDEV_VALUE* + -#### LIMIT_MEAN_VALUE *= py_monitoring_kernel.LimitValue.LIMIT_MEAN_VALUE* +### LIMIT_MEAN_VALUE *= py_monitoring_kernel.LimitValue.LIMIT_MEAN_VALUE* + -#### LIMIT_MIN_VALUE *= py_monitoring_kernel.LimitValue.LIMIT_MIN_VALUE* +### LIMIT_MIN_VALUE *= py_monitoring_kernel.LimitValue.LIMIT_MIN_VALUE* + -#### LIMIT_NONE_VALUE *= py_monitoring_kernel.LimitValue.LIMIT_NONE_VALUE* +### LIMIT_NONE_VALUE *= py_monitoring_kernel.LimitValue.LIMIT_NONE_VALUE* + -### *class* py_monitoring_kernel.MonitoringData +## *class* py_monitoring_kernel.MonitoringData Encapsulates a block of data to be monitored. + -#### GetAlgorithmInfo() → [AlgorithmInfo](py_algorithm_info.md#py_algorithm_info.AlgorithmInfo) +### GetAlgorithmInfo() → [AlgorithmInfo](py_algorithm_info.md#py_algorithm_info.AlgorithmInfo) Get structure providing information about the underlying algorithm that lead to the results. + -#### GetBoundsOfParameter(arg2: [Dimension](#py_monitoring_kernel.Dimension)) → object +### GetBoundsOfParameter(arg2: [Dimension](#py_monitoring_kernel.Dimension)) → object + -#### GetCriteriaNames() → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) +### GetCriteriaNames() → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) Get criteria names. + -#### GetDesignSets() → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) +### GetDesignSets() → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) Get the names of available design sets. + -#### GetNominalDesign() → [PyOSDesign](py_os_design.md#py_os_design.PyOSDesign) +### GetNominalDesign() → [PyOSDesign](py_os_design.md#py_os_design.PyOSDesign) Get the nominal design if available. + -#### GetObjectiveNames() → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) +### GetObjectiveNames() → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) Get objective names. + -#### GetOriginalDesigns() → [PyOSDesignContainer](py_os_design.md#py_os_design.PyOSDesignContainer) +### GetOriginalDesigns() → [PyOSDesignContainer](py_os_design.md#py_os_design.PyOSDesignContainer) Get the original design container. Design deactivation states are not considered. + -#### GetParameterNames() → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) +### GetParameterNames() → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) Get parameter names. + -#### GetReferenceDesign() → [PyOSDesign](py_os_design.md#py_os_design.PyOSDesign) +### GetReferenceDesign() → [PyOSDesign](py_os_design.md#py_os_design.PyOSDesign) Get the reference design if available. + -#### GetResponseNames() → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) +### GetResponseNames() → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) Get response names. + -#### GetSurrogateByName(arg2: str) → object +### GetSurrogateByName(arg2: str) → object Get a certain actual surrogate model. + -#### GetSurrogateNamesSortedByCoP() → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) +### GetSurrogateNamesSortedByCoP() → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) Get surrogate model names, sorted descending by their CoP. + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [Id](#py_monitoring_kernel.Id)) +### \_\_init_\_(arg2: [Id](#py_monitoring_kernel.Id)) + -#### get_algorithm_info() → [AlgorithmInfo](py_algorithm_info.md#py_algorithm_info.AlgorithmInfo) +### get_algorithm_info() → [AlgorithmInfo](py_algorithm_info.md#py_algorithm_info.AlgorithmInfo) Get structure providing information about the underlying algorithm that lead to the results. + -#### get_best_design_ids() → [SignalDesignList](py_monitoring_gui.md#py_monitoring_gui.Visuals.SignalDesignList) +### get_best_design_ids() → [SignalDesignList](py_monitoring_gui.md#py_monitoring_gui.Visuals.SignalDesignList) Returns a container of design IDs from the best active designs. + -#### get_bounds_of_parameter(arg2: [Dimension](#py_monitoring_kernel.Dimension)) → object +### get_bounds_of_parameter(arg2: [Dimension](#py_monitoring_kernel.Dimension)) → object + -#### get_criteria_names() → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) +### get_criteria_names() → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) Get criteria names. + -#### get_design_sets() → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) +### get_design_sets() → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) Get the names of available design sets. + -#### get_nominal_design() → [PyOSDesign](py_os_design.md#py_os_design.PyOSDesign) +### get_nominal_design() → [PyOSDesign](py_os_design.md#py_os_design.PyOSDesign) Get the nominal design if available. + -#### get_objective_names() → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) +### get_objective_names() → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) Get objective names. + -#### get_original_designs() → [PyOSDesignContainer](py_os_design.md#py_os_design.PyOSDesignContainer) +### get_original_designs() → [PyOSDesignContainer](py_os_design.md#py_os_design.PyOSDesignContainer) Get the original design container. Design deactivation states are not considered. + -#### get_original_parameter_manager() → [PyParameterManager](py_os_parameter.md#py_os_parameter.PyParameterManager) +### get_original_parameter_manager() → [PyParameterManager](py_os_parameter.md#py_os_parameter.PyParameterManager) Get the original parameter manager. Parameter deactivation states are not considered. + -#### get_parameter_names() → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) +### get_parameter_names() → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) Get parameter names. + -#### get_reference_design() → [PyOSDesign](py_os_design.md#py_os_design.PyOSDesign) +### get_reference_design() → [PyOSDesign](py_os_design.md#py_os_design.PyOSDesign) Get the reference design if available. + -#### get_response_names() → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) +### get_response_names() → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) Get response names. + -#### get_signal_names() → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) +### get_signal_names() → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) Get signal names. + -#### get_surrogate_by_name(arg2: str) → object +### get_surrogate_by_name(arg2: str) → object Get a certain actual surrogate model. + -#### get_surrogate_names_sorted_by_cop() → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) +### get_surrogate_names_sorted_by_cop() → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) Get surrogate model names, sorted descending by their CoP. + -#### get_surrogates() → list +### get_surrogates() → list Get all surrogate models. + -#### has_embedded_user_settings() → bool +### has_embedded_user_settings() → bool Returns whether data container has embedded user settings. + -#### *property* id +### *property* id The identifier of the data object. + -### *class* py_monitoring_kernel.PaletteColor +## *class* py_monitoring_kernel.PaletteColor Color object which holds value, value_type and color. PALETTE_VALUE_MINIMUM and PALETTE_VALUE_MAXIMUM should only occur once because they define the colors below and above of the value range. + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_() +### \_\_init_\_() + -#### *property* color +### *property* color + -#### *property* value +### *property* value + -#### *property* value_type +### *property* value_type + -### *class* py_monitoring_kernel.PaletteColorData +## *class* py_monitoring_kernel.PaletteColorData Color data object which holds PaletteColors, gradient and value type. + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_() +### \_\_init_\_() + -#### *property* color_vec +### *property* color_vec + -#### *property* gradient +### *property* gradient + -#### *property* value_type +### *property* value_type + -### *class* py_monitoring_kernel.PaletteColorValueType +## *class* py_monitoring_kernel.PaletteColorValueType **Enumeration** Enumerates available palette_colore value types. Default is PALETTE_VALUE_CUSTOM + -#### PALETTE_VALUE_CUSTOM *= py_monitoring_kernel.PaletteColorValueType.PALETTE_VALUE_CUSTOM* +### PALETTE_VALUE_CUSTOM *= py_monitoring_kernel.PaletteColorValueType.PALETTE_VALUE_CUSTOM* + -#### PALETTE_VALUE_MAXIMUM *= py_monitoring_kernel.PaletteColorValueType.PALETTE_VALUE_MAXIMUM* +### PALETTE_VALUE_MAXIMUM *= py_monitoring_kernel.PaletteColorValueType.PALETTE_VALUE_MAXIMUM* + -#### PALETTE_VALUE_MINIMUM *= py_monitoring_kernel.PaletteColorValueType.PALETTE_VALUE_MINIMUM* +### PALETTE_VALUE_MINIMUM *= py_monitoring_kernel.PaletteColorValueType.PALETTE_VALUE_MINIMUM* + -### *class* py_monitoring_kernel.PaletteColorVector +## *class* py_monitoring_kernel.PaletteColorVector + -#### \_\_contains_\_(arg2: object) → bool +### \_\_contains_\_(arg2: object) → bool + -#### \_\_delitem_\_(arg2: object) +### \_\_delitem_\_(arg2: object) + -#### \_\_getitem_\_(arg2: object) → object +### \_\_getitem_\_(arg2: object) → object + -#### \_\_init_\_() +### \_\_init_\_() + -#### \_\_iter_\_() → object +### \_\_iter_\_() → object -#### \_\_iter_\_() → object +### \_\_iter_\_() → object + -#### \_\_len_\_() → int +### \_\_len_\_() → int + -#### \_\_setitem_\_(arg2: object, arg3: object) +### \_\_setitem_\_(arg2: object, arg3: object) + -#### append(arg2: object) +### append(arg2: object) + -#### extend(arg2: object) +### extend(arg2: object) + -#### push_back(arg2: [PaletteColor](#py_monitoring_kernel.PaletteColor)) +### push_back(arg2: [PaletteColor](#py_monitoring_kernel.PaletteColor)) + -#### size() → int +### size() → int + -### *class* py_monitoring_kernel.PaletteData +## *class* py_monitoring_kernel.PaletteData Data object which contains name, is_default, save_in_file and PaletteColorData. + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_() +### \_\_init_\_() + -#### *property* color_data +### *property* color_data + -#### *property* default +### *property* default + -#### *property* name +### *property* name + -#### *property* save_in_file +### *property* save_in_file + -### *class* py_monitoring_kernel.PaletteGradient +## *class* py_monitoring_kernel.PaletteGradient **Enumeration** Enumerates color gradient types. Default is PALETTE_GRADIENT_INTERPOLATING. + -#### PALETTE_GRADIENT_Discrete *= py_monitoring_kernel.PaletteGradient.PALETTE_GRADIENT_Discrete* +### PALETTE_GRADIENT_Discrete *= py_monitoring_kernel.PaletteGradient.PALETTE_GRADIENT_Discrete* + -#### PALETTE_GRADIENT_INTERPOLATING *= py_monitoring_kernel.PaletteGradient.PALETTE_GRADIENT_INTERPOLATING* +### PALETTE_GRADIENT_INTERPOLATING *= py_monitoring_kernel.PaletteGradient.PALETTE_GRADIENT_INTERPOLATING* + -### *class* py_monitoring_kernel.PaletteValueType +## *class* py_monitoring_kernel.PaletteValueType **Enumeration** Enumerates value_types. Default is PALETTE_GRADIENT_INTERPOLATING. + -#### PALETTE_VALUE_TYPE_ABSOLUTE *= py_monitoring_kernel.PaletteValueType.PALETTE_VALUE_TYPE_ABSOLUTE* +### PALETTE_VALUE_TYPE_ABSOLUTE *= py_monitoring_kernel.PaletteValueType.PALETTE_VALUE_TYPE_ABSOLUTE* + -#### PALETTE_VALUE_TYPE_PERCENTUAL *= py_monitoring_kernel.PaletteValueType.PALETTE_VALUE_TYPE_PERCENTUAL* +### PALETTE_VALUE_TYPE_PERCENTUAL *= py_monitoring_kernel.PaletteValueType.PALETTE_VALUE_TYPE_PERCENTUAL* + -### *class* py_monitoring_kernel.PredefinedColor +## *class* py_monitoring_kernel.PredefinedColor **Enumeration** Enumerates predefined colors. + -#### COLOR_BLACK *= py_monitoring_kernel.PredefinedColor.COLOR_BLACK* +### COLOR_BLACK *= py_monitoring_kernel.PredefinedColor.COLOR_BLACK* + -#### COLOR_BLUE *= py_monitoring_kernel.PredefinedColor.COLOR_BLUE* +### COLOR_BLUE *= py_monitoring_kernel.PredefinedColor.COLOR_BLUE* + -#### COLOR_CYAN *= py_monitoring_kernel.PredefinedColor.COLOR_CYAN* +### COLOR_CYAN *= py_monitoring_kernel.PredefinedColor.COLOR_CYAN* + -#### COLOR_DEFAULT *= py_monitoring_kernel.PredefinedColor.COLOR_DEFAULT* +### COLOR_DEFAULT *= py_monitoring_kernel.PredefinedColor.COLOR_DEFAULT* + -#### COLOR_GREEN *= py_monitoring_kernel.PredefinedColor.COLOR_GREEN* +### COLOR_GREEN *= py_monitoring_kernel.PredefinedColor.COLOR_GREEN* + -#### COLOR_MAGENTA *= py_monitoring_kernel.PredefinedColor.COLOR_MAGENTA* +### COLOR_MAGENTA *= py_monitoring_kernel.PredefinedColor.COLOR_MAGENTA* + -#### COLOR_ORANGE *= py_monitoring_kernel.PredefinedColor.COLOR_ORANGE* +### COLOR_ORANGE *= py_monitoring_kernel.PredefinedColor.COLOR_ORANGE* + -#### COLOR_PINK *= py_monitoring_kernel.PredefinedColor.COLOR_PINK* +### COLOR_PINK *= py_monitoring_kernel.PredefinedColor.COLOR_PINK* + -#### COLOR_RED *= py_monitoring_kernel.PredefinedColor.COLOR_RED* +### COLOR_RED *= py_monitoring_kernel.PredefinedColor.COLOR_RED* + -#### COLOR_VIOLET *= py_monitoring_kernel.PredefinedColor.COLOR_VIOLET* +### COLOR_VIOLET *= py_monitoring_kernel.PredefinedColor.COLOR_VIOLET* + -#### COLOR_YELLOW *= py_monitoring_kernel.PredefinedColor.COLOR_YELLOW* +### COLOR_YELLOW *= py_monitoring_kernel.PredefinedColor.COLOR_YELLOW* + -### *class* py_monitoring_kernel.PredefinedStipple +## *class* py_monitoring_kernel.PredefinedStipple **Enumeration** Enumerates available style stipplings. + -#### STIPPLE_DASHED *= py_monitoring_kernel.PredefinedStipple.STIPPLE_DASHED* +### STIPPLE_DASHED *= py_monitoring_kernel.PredefinedStipple.STIPPLE_DASHED* + -#### STIPPLE_DOTTED *= py_monitoring_kernel.PredefinedStipple.STIPPLE_DOTTED* +### STIPPLE_DOTTED *= py_monitoring_kernel.PredefinedStipple.STIPPLE_DOTTED* + -#### STIPPLE_NONE *= py_monitoring_kernel.PredefinedStipple.STIPPLE_NONE* +### STIPPLE_NONE *= py_monitoring_kernel.PredefinedStipple.STIPPLE_NONE* + -#### STIPPLE_SOLID *= py_monitoring_kernel.PredefinedStipple.STIPPLE_SOLID* +### STIPPLE_SOLID *= py_monitoring_kernel.PredefinedStipple.STIPPLE_SOLID* + -### *class* py_monitoring_kernel.PredefinedSymbol +## *class* py_monitoring_kernel.PredefinedSymbol **Enumeration** Enumerates available style symbols. + -#### SYMBOL_CIRCLE *= py_monitoring_kernel.PredefinedSymbol.SYMBOL_CIRCLE* +### SYMBOL_CIRCLE *= py_monitoring_kernel.PredefinedSymbol.SYMBOL_CIRCLE* + -#### SYMBOL_DIAMOND *= py_monitoring_kernel.PredefinedSymbol.SYMBOL_DIAMOND* +### SYMBOL_DIAMOND *= py_monitoring_kernel.PredefinedSymbol.SYMBOL_DIAMOND* + -#### SYMBOL_NONE *= py_monitoring_kernel.PredefinedSymbol.SYMBOL_NONE* +### SYMBOL_NONE *= py_monitoring_kernel.PredefinedSymbol.SYMBOL_NONE* + -#### SYMBOL_RECTANGLE *= py_monitoring_kernel.PredefinedSymbol.SYMBOL_RECTANGLE* +### SYMBOL_RECTANGLE *= py_monitoring_kernel.PredefinedSymbol.SYMBOL_RECTANGLE* + -#### SYMBOL_TRIANGLE *= py_monitoring_kernel.PredefinedSymbol.SYMBOL_TRIANGLE* +### SYMBOL_TRIANGLE *= py_monitoring_kernel.PredefinedSymbol.SYMBOL_TRIANGLE* + -### *class* py_monitoring_kernel.PyControlContainer +## *class* py_monitoring_kernel.PyControlContainer A (visual) container object, managing and displaying controls. + -#### \_\_init_\_() +### \_\_init_\_() Raises an exception This class cannot be instantiated from Python + -#### \_\_iter_\_() → object +### \_\_iter_\_() → object + -#### \_\_len_\_() → int +### \_\_len_\_() → int + -#### add_control(arg2: ControlInterface) +### add_control(arg2: ControlInterface) + -#### find_control_by_name(arg2: str) → [ControlInterface](#py_monitoring_kernel.ControlInterface) +### find_control_by_name(arg2: str) → [ControlInterface](#py_monitoring_kernel.ControlInterface) Find control by name + -#### get_control(arg2: [Id](#py_monitoring_kernel.Id)) → [ControlInterface](#py_monitoring_kernel.ControlInterface) +### get_control(arg2: [Id](#py_monitoring_kernel.Id)) → [ControlInterface](#py_monitoring_kernel.ControlInterface) Get control by ID + -#### open(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### open(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) Open a monitoring database + -#### remove_all_controls() +### remove_all_controls() Remove all controls from the container + -#### remove_control(arg2: [Id](#py_monitoring_kernel.Id)) +### remove_control(arg2: [Id](#py_monitoring_kernel.Id)) Remove a control from the container + -#### set_control_visible(arg2: [Id](#py_monitoring_kernel.Id), arg3: bool) +### set_control_visible(arg2: [Id](#py_monitoring_kernel.Id), arg3: bool) Show/Hide a control + -#### set_positioning(arg2: Id) +### set_positioning(arg2: Id) + -### *class* py_monitoring_kernel.Stipple +## *class* py_monitoring_kernel.Stipple Stipple object used to style designs. + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [PredefinedStipple](#py_monitoring_kernel.PredefinedStipple), arg3: float) +### \_\_init_\_(arg2: [PredefinedStipple](#py_monitoring_kernel.PredefinedStipple), arg3: float) + -#### *property* stipple +### *property* stipple The actual stipple id. + -### *class* py_monitoring_kernel.Style +## *class* py_monitoring_kernel.Style Style object used to style designs. + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [Color](#py_monitoring_kernel.Color)) +### \_\_init_\_(arg2: [Color](#py_monitoring_kernel.Color)) -#### \_\_init_\_(arg2: [Color](#py_monitoring_kernel.Color), arg3: [Symbol](#py_monitoring_kernel.Symbol)) +### \_\_init_\_(arg2: [Color](#py_monitoring_kernel.Color), arg3: [Symbol](#py_monitoring_kernel.Symbol)) -#### \_\_init_\_(arg2: [Color](#py_monitoring_kernel.Color), arg3: [Symbol](#py_monitoring_kernel.Symbol), arg4: [Stipple](#py_monitoring_kernel.Stipple)) +### \_\_init_\_(arg2: [Color](#py_monitoring_kernel.Color), arg3: [Symbol](#py_monitoring_kernel.Symbol), arg4: [Stipple](#py_monitoring_kernel.Stipple)) + -#### *property* color +### *property* color The color of the style. + -#### *property* stipple +### *property* stipple The stipple of the style. + -#### *property* symbol +### *property* symbol The symbol of the style. + -### *class* py_monitoring_kernel.StyleList +## *class* py_monitoring_kernel.StyleList + -#### \_\_init_\_() +### \_\_init_\_() + -#### \_\_iter_\_() → object +### \_\_iter_\_() → object + -#### push_back(arg2: [Style](#py_monitoring_kernel.Style)) +### push_back(arg2: [Style](#py_monitoring_kernel.Style)) + -#### size() → int +### size() → int + -#### style_export_list() → [StyleList](#py_monitoring_kernel.StyleList) +### style_export_list() → [StyleList](#py_monitoring_kernel.StyleList) + -### *class* py_monitoring_kernel.Symbol +## *class* py_monitoring_kernel.Symbol Symbol object used to style designs. + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [PredefinedSymbol](#py_monitoring_kernel.PredefinedSymbol), arg3: float) +### \_\_init_\_(arg2: [PredefinedSymbol](#py_monitoring_kernel.PredefinedSymbol), arg3: float) + -#### *property* symbol +### *property* symbol The actual symbol id. + -### py_monitoring_kernel.default_style() → [Style](#py_monitoring_kernel.Style) +## py_monitoring_kernel.default_style() → [Style](#py_monitoring_kernel.Style) Default style of designs. diff --git a/2025R2/optiSLang-python-api/modules/py_mop_fmu_export.md b/2025R2/optiSLang-python-api/modules/py_mop_fmu_export.md index 46ac6ba441..c24440a10d 100644 --- a/2025R2/optiSLang-python-api/modules/py_mop_fmu_export.md +++ b/2025R2/optiSLang-python-api/modules/py_mop_fmu_export.md @@ -1,37 +1,52 @@ + -### *class* py_mop_fmu_export.activation_option +# py_mop_fmu_export + + + +## *class* py_mop_fmu_export.activation_option **Enumeration** + -#### always *= py_mop_fmu_export.activation_option.always* +### always *= py_mop_fmu_export.activation_option.always* + -#### never *= py_mop_fmu_export.activation_option.never* +### never *= py_mop_fmu_export.activation_option.never* + -#### pin_decides *= py_mop_fmu_export.activation_option.pin_decides* +### pin_decides *= py_mop_fmu_export.activation_option.pin_decides* + -### py_mop_fmu_export.create_mop_fmu(omdb_path: str, optislang_install_path: str, fmu_path: str) +## py_mop_fmu_export.create_mop_fmu(omdb_path: str, optislang_install_path: str, fmu_path: str) creates FMU file from OMDB + -### *class* py_mop_fmu_export.mop_fmu_export_options +## *class* py_mop_fmu_export.mop_fmu_export_options + -#### *property* enable_criteria +### *property* enable_criteria + -#### *property* enable_densities +### *property* enable_densities + -#### *property* enable_error_values +### *property* enable_error_values + -#### *property* enable_extrapolation +### *property* enable_extrapolation + -#### *property* enable_gradients +### *property* enable_gradients diff --git a/2025R2/optiSLang-python-api/modules/py_omdb.md b/2025R2/optiSLang-python-api/modules/py_omdb.md index fe8be56929..fdf6eee0e9 100644 --- a/2025R2/optiSLang-python-api/modules/py_omdb.md +++ b/2025R2/optiSLang-python-api/modules/py_omdb.md @@ -1,3 +1,6 @@ + +# py_omdb + Load and inspect optiSLang OMDB files with Python: ```default @@ -12,237 +15,296 @@ for best_design in omdb.get_best_designs(): print(best_design.get_id()) ``` + + -### *class* py_omdb.AttachedPath +## *class* py_omdb.AttachedPath + -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) + -#### *property* auto_insert_placeholders +### *property* auto_insert_placeholders Automatically detect the design directory format and replace it by a placeholder. + -#### *property* path +### *property* path Path to an external file. + -#### *property* title +### *property* title User-defined title. + -### *class* py_omdb.PyOMDB +## *class* py_omdb.PyOMDB + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -#### *property* algorithm_info +### *property* algorithm_info Structure providing information about the underlying algorithm that lead to the results. + -#### attach_file_path(file: [AttachedPath](#py_omdb.AttachedPath)) +### attach_file_path(file: [AttachedPath](#py_omdb.AttachedPath)) -#### attach_file_path(id: [UUID](id.md#id.UUID), file: [AttachedPath](#py_omdb.AttachedPath)) +### attach_file_path(id: [UUID](id.md#id.UUID), file: [AttachedPath](#py_omdb.AttachedPath)) [0] Attach a path to an external file. [1] Attach a path to an external file by id. + -#### check_consistency() +### check_consistency() Must be called after changes to OMDB. + -#### clear_meta_data() +### clear_meta_data() Clear the monitoring meta data. + -#### *property* criteria +### *property* criteria Criteria contained in monitoring database + -#### *property* design_container +### *property* design_container Design container contained in monitoring database + -#### extract_important_parameter_name_list(, design_set: str]) → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) +### extract_important_parameter_name_list(, design_set: str]) → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) + -#### get_attached_file_paths() → dict +### get_attached_file_paths() → dict Return a dictionay with ids as keys and attached paths as values. + -#### get_best_designs() → [PyOSDesignContainer](py_os_design.md#py_os_design.PyOSDesignContainer) +### get_best_designs() → [PyOSDesignContainer](py_os_design.md#py_os_design.PyOSDesignContainer) Get the best designs. Takes design activation state into account. + -#### get_best_subspaces(, design_set: str]) → [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint) +### get_best_subspaces(, design_set: str]) → [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint) + -#### get_build_date() → str +### get_build_date() → str Return the build date of the application this database file has been created with. + -#### get_design_duplication(arg2: [PyOSDesign](py_os_design.md#py_os_design.PyOSDesign)) → object +### get_design_duplication(arg2: [PyOSDesign](py_os_design.md#py_os_design.PyOSDesign)) → object -#### get_design_duplication(arg2: [HID](id.md#id.HID)) → object +### get_design_duplication(arg2: [HID](id.md#id.HID)) → object + -#### get_nominal_design() → [PyOSDesign](py_os_design.md#py_os_design.PyOSDesign) +### get_nominal_design() → [PyOSDesign](py_os_design.md#py_os_design.PyOSDesign) + -#### get_parameter_names() → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) +### get_parameter_names() → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) + -#### get_reference_design() → [PyOSDesign](py_os_design.md#py_os_design.PyOSDesign) +### get_reference_design() → [PyOSDesign](py_os_design.md#py_os_design.PyOSDesign) + -#### get_response_names() → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) +### get_response_names() → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) + -#### get_signal_names() → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) +### get_signal_names() → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) + -#### get_surrogate_info(, design_set: str]) → [SurrogateInfoContainerList](#py_omdb.SurrogateInfoContainerList) +### get_surrogate_info(, design_set: str]) → [SurrogateInfoContainerList](#py_omdb.SurrogateInfoContainerList) + -#### get_surrogate_info_names(, design_set: str]) → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) +### get_surrogate_info_names(, design_set: str]) → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) + -#### get_version() → int +### get_version() → int Return the version of the application this database file has been created with in the format 0xMMNNPP (MM = major, NN = minor, PP = maintenance). + -#### get_version_str() → str +### get_version_str() → str Return the version of the application this database file has been created with. + -#### get_version_suffix() → str +### get_version_suffix() → str Return the version suffix of the application this database file has been created with. + -#### is_design_active(design: [PyOSDesign](py_os_design.md#py_os_design.PyOSDesign)) → bool +### is_design_active(design: [PyOSDesign](py_os_design.md#py_os_design.PyOSDesign)) → bool -#### is_design_active(design: [HID](id.md#id.HID)) → bool +### is_design_active(design: [HID](id.md#id.HID)) → bool [0] Returns whether a design is active. [1] Returns whether a design is active. + -#### *property* parameter_manager +### *property* parameter_manager Parameter manager contained in monitoring database + -#### remove_file_path(id: [UUID](id.md#id.UUID)) +### remove_file_path(id: [UUID](id.md#id.UUID)) Remove attached file path by id. + -#### save_to_file(output: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### save_to_file(output: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) + -### *class* py_omdb.PySurrogateInfo +## *class* py_omdb.PySurrogateInfo + -#### \_\_init_\_() +### \_\_init_\_() Raises an exception This class cannot be instantiated from Python + -#### get_cop() → float +### get_cop() → float + -#### get_important_parameter_names() → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) +### get_important_parameter_names() → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) + -#### get_name() → str +### get_name() → str + -#### get_params_sorted_by_cop() → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) +### get_params_sorted_by_cop() → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) + -#### get_response_component_name() → str +### get_response_component_name() → str + -#### get_single_cop(parameter_name: str) → float +### get_single_cop(parameter_name: str) → float + -#### get_testing_type() → [TestingType](#py_omdb.TestingType) +### get_testing_type() → [TestingType](#py_omdb.TestingType) + -#### has_cop() → bool +### has_cop() → bool + -#### has_single_cop(parameter_name: str) → bool +### has_single_cop(parameter_name: str) → bool + -### *class* py_omdb.SurrogateInfoContainerList +## *class* py_omdb.SurrogateInfoContainerList + -#### \_\_contains_\_(arg2: object) → bool +### \_\_contains_\_(arg2: object) → bool + -#### \_\_delitem_\_(arg2: object) +### \_\_delitem_\_(arg2: object) + -#### \_\_getitem_\_(arg2: object) → object +### \_\_getitem_\_(arg2: object) → object + -#### \_\_init_\_() +### \_\_init_\_() Raises an exception This class cannot be instantiated from Python + -#### \_\_iter_\_() → object +### \_\_iter_\_() → object + -#### \_\_len_\_() → int +### \_\_len_\_() → int + -#### \_\_setitem_\_(arg2: object, arg3: object) +### \_\_setitem_\_(arg2: object, arg3: object) + -#### append(arg2: object) +### append(arg2: object) + -#### extend(arg2: object) +### extend(arg2: object) + -### *class* py_omdb.TestingType +## *class* py_omdb.TestingType **Enumeration** + -#### CROSSVALIDATION *= py_omdb.TestingType.CROSSVALIDATION* +### CROSSVALIDATION *= py_omdb.TestingType.CROSSVALIDATION* + -#### LEAVEONEOUT *= py_omdb.TestingType.LEAVEONEOUT* +### LEAVEONEOUT *= py_omdb.TestingType.LEAVEONEOUT* + -### py_omdb.write_cop_matrix_to_file(omdb: PyOMDB, file: Path) +## py_omdb.write_cop_matrix_to_file(omdb: PyOMDB, file: Path) Write COP matrix from omdb to file. diff --git a/2025R2/optiSLang-python-api/modules/py_os_criterion.md b/2025R2/optiSLang-python-api/modules/py_os_criterion.md index 70234e3010..d1eb2b9c8d 100644 --- a/2025R2/optiSLang-python-api/modules/py_os_criterion.md +++ b/2025R2/optiSLang-python-api/modules/py_os_criterion.md @@ -1,3 +1,6 @@ + +# py_os_criterion + This module provides classes to handle design criteria. A collection of criteria can be constructed in the following way: @@ -19,134 +22,176 @@ crit_names = [crit[0] for crit in criteria] print(crit_names) ``` + + -### *class* py_os_criterion.DesignStatus +## *class* py_os_criterion.DesignStatus **Enumeration** + -#### EQUAL *= py_os_criterion.DesignStatus.EQUAL* +### EQUAL *= py_os_criterion.DesignStatus.EQUAL* + -#### GREATEREQUAL *= py_os_criterion.DesignStatus.GREATEREQUAL* +### GREATEREQUAL *= py_os_criterion.DesignStatus.GREATEREQUAL* + -#### GREATERLIMITSTATE *= py_os_criterion.DesignStatus.GREATERLIMITSTATE* +### GREATERLIMITSTATE *= py_os_criterion.DesignStatus.GREATERLIMITSTATE* + -#### IGNORE *= py_os_criterion.DesignStatus.IGNORE* +### IGNORE *= py_os_criterion.DesignStatus.IGNORE* + -#### LESSEQUAL *= py_os_criterion.DesignStatus.LESSEQUAL* +### LESSEQUAL *= py_os_criterion.DesignStatus.LESSEQUAL* + -#### LESSLIMITSTATE *= py_os_criterion.DesignStatus.LESSLIMITSTATE* +### LESSLIMITSTATE *= py_os_criterion.DesignStatus.LESSLIMITSTATE* + -#### MAX *= py_os_criterion.DesignStatus.MAX* +### MAX *= py_os_criterion.DesignStatus.MAX* + -#### MIN *= py_os_criterion.DesignStatus.MIN* +### MIN *= py_os_criterion.DesignStatus.MIN* + -### *class* py_os_criterion.PyOSCriterion +## *class* py_os_criterion.PyOSCriterion + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [DesignStatus](#py_os_criterion.DesignStatus), arg3: str) +### \_\_init_\_(arg2: [DesignStatus](#py_os_criterion.DesignStatus), arg3: str) -#### \_\_init_\_(arg2: [DesignStatus](#py_os_criterion.DesignStatus), arg3: str, arg4: str) +### \_\_init_\_(arg2: [DesignStatus](#py_os_criterion.DesignStatus), arg3: str, arg4: str) + -#### get_expression() → str +### get_expression() → str + -#### get_float_value() → float +### get_float_value() → float + -#### get_left_expression() → str +### get_left_expression() → str + -#### get_right_expression() → str +### get_right_expression() → str + -#### get_type() → [DesignStatus](#py_os_criterion.DesignStatus) +### get_type() → [DesignStatus](#py_os_criterion.DesignStatus) + -#### get_value() → [PyOSDesignEntry](py_os_design.md#py_os_design.PyOSDesignEntry) +### get_value() → [PyOSDesignEntry](py_os_design.md#py_os_design.PyOSDesignEntry) + -#### is_constraint() → bool +### is_constraint() → bool + -#### is_equal_zero() → bool +### is_equal_zero() → bool + -#### is_equality_constraint() → bool +### is_equality_constraint() → bool + -#### is_equality_constraint_violated() → bool +### is_equality_constraint_violated() → bool + -#### is_inequality_constraint() → bool +### is_inequality_constraint() → bool + -#### is_inequality_constraint_violated() → bool +### is_inequality_constraint_violated() → bool + -#### is_objective() → bool +### is_objective() → bool + -#### needs_eval() → bool +### needs_eval() → bool + -#### set_constraint(type: [DesignStatus](#py_os_criterion.DesignStatus), expression_left: str, expression_right: str) +### set_constraint(type: [DesignStatus](#py_os_criterion.DesignStatus), expression_left: str, expression_right: str) + -#### set_left(expression: str) +### set_left(expression: str) + -#### set_objective(type: [DesignStatus](#py_os_criterion.DesignStatus), expression: str) +### set_objective(type: [DesignStatus](#py_os_criterion.DesignStatus), expression: str) + -#### set_right(expression: str) +### set_right(expression: str) + -#### set_type(type: [DesignStatus](#py_os_criterion.DesignStatus)) +### set_type(type: [DesignStatus](#py_os_criterion.DesignStatus)) + -#### set_value(value: float) +### set_value(value: float) -#### set_value(value: [PyOSDesignEntry](py_os_design.md#py_os_design.PyOSDesignEntry)) +### set_value(value: [PyOSDesignEntry](py_os_design.md#py_os_design.PyOSDesignEntry)) + -### *class* py_os_criterion.PyOSCriterionContainer +## *class* py_os_criterion.PyOSCriterionContainer + -#### \_\_getitem_\_(arg2: str) → [PyOSCriterion](#py_os_criterion.PyOSCriterion) +### \_\_getitem_\_(arg2: str) → [PyOSCriterion](#py_os_criterion.PyOSCriterion) + -#### \_\_init_\_() +### \_\_init_\_() + -#### \_\_iter_\_() → object +### \_\_iter_\_() → object + -#### \_\_len_\_() → int +### \_\_len_\_() → int + -#### \_\_setitem_\_(arg2: str) → [PyOSCriterion](#py_os_criterion.PyOSCriterion) +### \_\_setitem_\_(arg2: str) → [PyOSCriterion](#py_os_criterion.PyOSCriterion) + -#### add(name: str, value: [PyOSCriterion](#py_os_criterion.PyOSCriterion)) +### add(name: str, value: [PyOSCriterion](#py_os_criterion.PyOSCriterion)) + -#### add_expression(name: str, value: [PyOSCriterion](#py_os_criterion.PyOSCriterion)) +### add_expression(name: str, value: [PyOSCriterion](#py_os_criterion.PyOSCriterion)) + -#### remove(name: str) +### remove(name: str) + -#### remove_expression(name: str) +### remove_expression(name: str) diff --git a/2025R2/optiSLang-python-api/modules/py_os_design.md b/2025R2/optiSLang-python-api/modules/py_os_design.md index 9f3d7d7135..6a0e913da2 100644 --- a/2025R2/optiSLang-python-api/modules/py_os_design.md +++ b/2025R2/optiSLang-python-api/modules/py_os_design.md @@ -1,3 +1,6 @@ + +# py_os_design + Functionality to handle individual designs and DOEs. These can either emerge from Actor calculation results or be manually constructed.: ```default @@ -80,258 +83,329 @@ db_file.check_consistency() db_file.save_to_file(os.path.join(OSL_PROJECT_DIR, 'my_design_data.omdb') ``` + + -### *class* py_os_design.DesignExporterCSV +## *class* py_os_design.DesignExporterCSV + -#### \_\_init_\_() +### \_\_init_\_() + -### *class* py_os_design.DesignExporterGeneric +## *class* py_os_design.DesignExporterGeneric + -#### \_\_call_\_(path: [PyOSDesign](#py_os_design.PyOSDesign), logger: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) → bool +### \_\_call_\_(path: [PyOSDesign](#py_os_design.PyOSDesign), logger: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) → bool -#### \_\_call_\_(path: [PyOSDesignContainer](#py_os_design.PyOSDesignContainer), logger: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) → bool +### \_\_call_\_(path: [PyOSDesignContainer](#py_os_design.PyOSDesignContainer), logger: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) → bool + -#### \_\_init_\_() +### \_\_init_\_() Raises an exception This class cannot be instantiated from Python + -### *class* py_os_design.DesignExporterJson +## *class* py_os_design.DesignExporterJson + -#### \_\_init_\_() +### \_\_init_\_() + -### *class* py_os_design.DesignExporterOIA +## *class* py_os_design.DesignExporterOIA + -#### \_\_init_\_() +### \_\_init_\_() + -### *class* py_os_design.DesignImporterCSV +## *class* py_os_design.DesignImporterCSV + -#### \_\_init_\_() +### \_\_init_\_() + -### *class* py_os_design.DesignImporterGeneric +## *class* py_os_design.DesignImporterGeneric + -#### \_\_call_\_(inputs: [PyOSDesign](#py_os_design.PyOSDesign), criteria: [PyOSDesignPoint](#py_os_design.PyOSDesignPoint), path: [PyOSCriterionContainer](py_os_criterion.md#py_os_criterion.PyOSCriterionContainer), logger: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) → bool +### \_\_call_\_(inputs: [PyOSDesign](#py_os_design.PyOSDesign), criteria: [PyOSDesignPoint](#py_os_design.PyOSDesignPoint), path: [PyOSCriterionContainer](py_os_criterion.md#py_os_criterion.PyOSCriterionContainer), logger: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) → bool -#### \_\_call_\_(inputs: [PyOSDesignContainer](#py_os_design.PyOSDesignContainer), criteria: [PyOSDesignPoint](#py_os_design.PyOSDesignPoint), path: [PyOSCriterionContainer](py_os_criterion.md#py_os_criterion.PyOSCriterionContainer), logger: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) → bool +### \_\_call_\_(inputs: [PyOSDesignContainer](#py_os_design.PyOSDesignContainer), criteria: [PyOSDesignPoint](#py_os_design.PyOSDesignPoint), path: [PyOSCriterionContainer](py_os_criterion.md#py_os_criterion.PyOSCriterionContainer), logger: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) → bool + -#### \_\_init_\_() +### \_\_init_\_() Raises an exception This class cannot be instantiated from Python + -### *class* py_os_design.DesignImporterJson +## *class* py_os_design.DesignImporterJson + -#### \_\_init_\_() +### \_\_init_\_() + -### *class* py_os_design.DesignImporterOIA +## *class* py_os_design.DesignImporterOIA + -#### \_\_init_\_() +### \_\_init_\_() + -### *class* py_os_design.DesignRunStatus +## *class* py_os_design.DesignRunStatus **Enumeration** + -#### AWAITING *= py_os_design.DesignRunStatus.AWAITING* +### AWAITING *= py_os_design.DesignRunStatus.AWAITING* + -#### DONE *= py_os_design.DesignRunStatus.DONE* +### DONE *= py_os_design.DesignRunStatus.DONE* + -#### INPROCESS *= py_os_design.DesignRunStatus.INPROCESS* +### INPROCESS *= py_os_design.DesignRunStatus.INPROCESS* + -### *class* py_os_design.DesignStatus +## *class* py_os_design.DesignStatus **Enumeration** + -#### CRITERIA_FAIL *= py_os_design.DesignStatus.CRITERIA_FAIL* +### CRITERIA_FAIL *= py_os_design.DesignStatus.CRITERIA_FAIL* + -#### NO_FAIL *= py_os_design.DesignStatus.NO_FAIL* +### NO_FAIL *= py_os_design.DesignStatus.NO_FAIL* + -#### NO_SOLVER_FAIL *= py_os_design.DesignStatus.NO_SOLVER_FAIL* +### NO_SOLVER_FAIL *= py_os_design.DesignStatus.NO_SOLVER_FAIL* + -#### RESPONSE_NAN *= py_os_design.DesignStatus.RESPONSE_NAN* +### RESPONSE_NAN *= py_os_design.DesignStatus.RESPONSE_NAN* + -#### SOLVER_FAIL *= py_os_design.DesignStatus.SOLVER_FAIL* +### SOLVER_FAIL *= py_os_design.DesignStatus.SOLVER_FAIL* + -### *class* py_os_design.EntryType +## *class* py_os_design.EntryType **Enumeration** + -#### BOOL *= py_os_design.EntryType.BOOL* +### BOOL *= py_os_design.EntryType.BOOL* + -#### INTEGER *= py_os_design.EntryType.INTEGER* +### INTEGER *= py_os_design.EntryType.INTEGER* + -#### REAL *= py_os_design.EntryType.REAL* +### REAL *= py_os_design.EntryType.REAL* + -#### STRING *= py_os_design.EntryType.STRING* +### STRING *= py_os_design.EntryType.STRING* + -#### UNINITIALIZED *= py_os_design.EntryType.UNINITIALIZED* +### UNINITIALIZED *= py_os_design.EntryType.UNINITIALIZED* + -#### VARIANT *= py_os_design.EntryType.VARIANT* +### VARIANT *= py_os_design.EntryType.VARIANT* + -### *class* py_os_design.PyOSDesign +## *class* py_os_design.PyOSDesign Represents a single design in a DOE. Usually consists of parameters, responses, criteria and additional status information. + -#### IsDuplicated() → bool +### IsDuplicated() → bool + -#### \_\_init_\_() +### \_\_init_\_() + -#### add_missing_criteria(reference: [PyOSDesign](#py_os_design.PyOSDesign)) +### add_missing_criteria(reference: [PyOSDesign](#py_os_design.PyOSDesign)) Add criteria from reference that are not defined in self. + -#### add_missing_parameters(reference: [PyOSDesign](#py_os_design.PyOSDesign)) +### add_missing_parameters(reference: [PyOSDesign](#py_os_design.PyOSDesign)) Add parameters from reference that are not defined in self. + -#### add_missing_responses(reference: [PyOSDesign](#py_os_design.PyOSDesign)) +### add_missing_responses(reference: [PyOSDesign](#py_os_design.PyOSDesign)) Add responses from reference that are not defined in self. + -#### add_status(status: [RunInfoMeta](#py_os_design.RunInfoMeta)) +### add_status(status: [RunInfoMeta](#py_os_design.RunInfoMeta)) + -#### dominates(design: [PyOSDesign](#py_os_design.PyOSDesign)) → bool +### dominates(design: [PyOSDesign](#py_os_design.PyOSDesign)) → bool Whether the provided design dominates this design regarding fulfilment of criteria. + -#### get_algorithm_iteration() → int +### get_algorithm_iteration() → int + -#### get_criteria() → [PyOSCriterionContainer](py_os_criterion.md#py_os_criterion.PyOSCriterionContainer) +### get_criteria() → [PyOSCriterionContainer](py_os_criterion.md#py_os_criterion.PyOSCriterionContainer) + -#### get_design_leaf_number() → int +### get_design_leaf_number() → int Return the leaf number of the design’s ID. + -#### get_design_type() → [DesignTypes](dynardo_py_algorithms.md#dynardo_py_algorithms.DesignTypes) +### get_design_type() → [DesignTypes](dynardo_py_algorithms.md#dynardo_py_algorithms.DesignTypes) + -#### get_id() → [HID](id.md#id.HID) +### get_id() → [HID](id.md#id.HID) + -#### get_parameters() → [PyOSDesignPoint](#py_os_design.PyOSDesignPoint) +### get_parameters() → [PyOSDesignPoint](#py_os_design.PyOSDesignPoint) ```default for name, value in design.get_parameters(): print(name, value.get()) ``` + -#### get_responses() → [PyOSDesignPoint](#py_os_design.PyOSDesignPoint) +### get_responses() → [PyOSDesignPoint](#py_os_design.PyOSDesignPoint) ```default for name, value in design.get_responses(): print(name, value.get_scalar()) ``` + -#### get_run_status() → [DesignRunStatus](#py_os_design.DesignRunStatus) +### get_run_status() → [DesignRunStatus](#py_os_design.DesignRunStatus) + -#### get_status() → [RunInfoContainer](#py_os_design.RunInfoContainer) +### get_status() → [RunInfoContainer](#py_os_design.RunInfoContainer) + -#### get_workflow_id() → [SupportedAlgorithms](dynardo_py_algorithms.md#dynardo_py_algorithms.SupportedAlgorithms) +### get_workflow_id() → [SupportedAlgorithms](dynardo_py_algorithms.md#dynardo_py_algorithms.SupportedAlgorithms) + -#### has_error_state() → bool +### has_error_state() → bool + -#### is_active() → bool +### is_active() → bool + -#### is_awaiting() → bool +### is_awaiting() → bool + -#### is_done() → bool +### is_done() → bool + -#### is_failed() → bool +### is_failed() → bool + -#### is_feasible() → object +### is_feasible() → object Return True if the design is feasible. Return False if it is not. Return None if feasibility is unknown. + -#### is_incomplete() → bool +### is_incomplete() → bool + -#### is_succeeded() → bool +### is_succeeded() → bool + -#### is_violated() → bool +### is_violated() → bool + -#### needs_reevaluation() → bool +### needs_reevaluation() → bool + -#### set_awaiting() +### set_awaiting() + -#### set_criteria(criteria: [PyOSCriterionContainer](py_os_criterion.md#py_os_criterion.PyOSCriterionContainer)) +### set_criteria(criteria: [PyOSCriterionContainer](py_os_criterion.md#py_os_criterion.PyOSCriterionContainer)) + -#### set_design_type(type: [DesignTypes](dynardo_py_algorithms.md#dynardo_py_algorithms.DesignTypes)) +### set_design_type(type: [DesignTypes](dynardo_py_algorithms.md#dynardo_py_algorithms.DesignTypes)) + -#### set_duplication(id: [HID](id.md#id.HID)) +### set_duplication(id: [HID](id.md#id.HID)) Specifiy a duplicate of this design. + -#### set_id(id: [HID](id.md#id.HID)) +### set_id(id: [HID](id.md#id.HID)) + -#### set_number(number: int) +### set_number(number: int) + -#### set_parameters(parameters: [PyOSDesignPoint](#py_os_design.PyOSDesignPoint)) +### set_parameters(parameters: [PyOSDesignPoint](#py_os_design.PyOSDesignPoint)) ```default design = PyOSDesign() @@ -340,8 +414,9 @@ params.add("input", 5) design.set_parameters(params) ``` + -#### set_responses(responses: [PyOSDesignPoint](#py_os_design.PyOSDesignPoint)) +### set_responses(responses: [PyOSDesignPoint](#py_os_design.PyOSDesignPoint)) ```default design = PyOSDesign() @@ -350,14 +425,17 @@ responses.add("output", 200) design.set_responses(responses) ``` + -#### set_run_status(status: [DesignRunStatus](#py_os_design.DesignRunStatus)) +### set_run_status(status: [DesignRunStatus](#py_os_design.DesignRunStatus)) + -#### set_workflow_id(id: [SupportedAlgorithms](dynardo_py_algorithms.md#dynardo_py_algorithms.SupportedAlgorithms)) +### set_workflow_id(id: [SupportedAlgorithms](dynardo_py_algorithms.md#dynardo_py_algorithms.SupportedAlgorithms)) + -### *class* py_os_design.PyOSDesignContainer +## *class* py_os_design.PyOSDesignContainer Provides access to designs within a DOE @@ -366,44 +444,57 @@ for des in design_container: print(des.is_succeeded()) ``` + -#### \_\_init_\_() +### \_\_init_\_() + -#### \_\_iter_\_() → object +### \_\_iter_\_() → object + -#### \_\_len_\_() → int +### \_\_len_\_() → int + -#### append_designs(designs: [PyOSDesignContainer](#py_os_design.PyOSDesignContainer)) +### append_designs(designs: [PyOSDesignContainer](#py_os_design.PyOSDesignContainer)) + -#### get_best_designs() → [PyOSDesignContainer](#py_os_design.PyOSDesignContainer) +### get_best_designs() → [PyOSDesignContainer](#py_os_design.PyOSDesignContainer) + -#### get_design(id: HID) → [PyOSDesign](#py_os_design.PyOSDesign) +### get_design(id: HID) → [PyOSDesign](#py_os_design.PyOSDesign) + -#### has_design(id: HID) → bool +### has_design(id: HID) → bool + -#### push_back(design: [PyOSDesign](#py_os_design.PyOSDesign)) +### push_back(design: [PyOSDesign](#py_os_design.PyOSDesign)) + -#### rename_parameter(from: str, to: str, adapt_criteria: bool) +### rename_parameter(from: str, to: str, adapt_criteria: bool) + -#### rename_response(from: str, to: str, adapt_criteria: bool) +### rename_response(from: str, to: str, adapt_criteria: bool) + -#### set_design_awaiting(id: [HID](id.md#id.HID)) +### set_design_awaiting(id: [HID](id.md#id.HID)) + -#### set_designs_done(, force: bool=False]) +### set_designs_done(, force: bool=False]) + -### *class* py_os_design.PyOSDesignEntry +## *class* py_os_design.PyOSDesignEntry Wraps a single entry as part of a design. @@ -412,102 +503,125 @@ entry = PyOSDesignEntry(3.5) entry.get_scalar().real ``` + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: object) → object +### \_\_init_\_(arg2: object) → object -#### \_\_init_\_(arg2: [UninitializedType](#py_os_design.UninitializedType)) +### \_\_init_\_(arg2: [UninitializedType](#py_os_design.UninitializedType)) -#### \_\_init_\_(arg2: [VariantD](pyvariant.md#pyvariant.VariantD)) +### \_\_init_\_(arg2: [VariantD](pyvariant.md#pyvariant.VariantD)) [1] Create a design entry by passing a builtin Python type. Accepted types are str, int, bool and float. + -#### get() → object +### get() → object Extract as Python bultin type. + -#### get_domain_type() → [EntryType](#py_os_design.EntryType) +### get_domain_type() → [EntryType](#py_os_design.EntryType) Get the entry’s domain type. + -#### get_scalar() → complex +### get_scalar() → complex Try to extract as scalar. + -#### get_variant() → [VariantD](pyvariant.md#pyvariant.VariantD) +### get_variant() → [VariantD](pyvariant.md#pyvariant.VariantD) Try to extract as variant. + -#### is_inf() → bool +### is_inf() → bool Whether the value is infinity. + -#### is_nan() → bool +### is_nan() → bool Whether the value is NaN. + -#### is_scalar() → bool +### is_scalar() → bool Whether entry is scalar. + -#### is_uninitialized() → bool +### is_uninitialized() → bool Whether the entry is not initialized with a value. + -#### size() → int +### size() → int Get the entry’s size in case it is non-scalar. + -### *class* py_os_design.PyOSDesignEntryVec +## *class* py_os_design.PyOSDesignEntryVec Array of design entries. + -#### \_\_contains_\_(arg2: object) → bool +### \_\_contains_\_(arg2: object) → bool + -#### \_\_delitem_\_(arg2: object) +### \_\_delitem_\_(arg2: object) + -#### \_\_getitem_\_(arg2: object) → object +### \_\_getitem_\_(arg2: object) → object + -#### \_\_init_\_() +### \_\_init_\_() + -#### \_\_iter_\_() → object +### \_\_iter_\_() → object + -#### \_\_len_\_() → int +### \_\_len_\_() → int + -#### \_\_setitem_\_(arg2: object, arg3: object) +### \_\_setitem_\_(arg2: object, arg3: object) + -#### append(arg2: object) +### append(arg2: object) + -#### extend(arg2: object) +### extend(arg2: object) + -#### push_back(arg2: [PyOSDesignEntry](#py_os_design.PyOSDesignEntry)) +### push_back(arg2: [PyOSDesignEntry](#py_os_design.PyOSDesignEntry)) + -#### size() → int +### size() → int + -### *class* py_os_design.PyOSDesignPoint +## *class* py_os_design.PyOSDesignPoint Collection of design entries keyed by name. @@ -517,27 +631,33 @@ dp.add("param_01", 3.5) dp.add("param_02", PyOSDesignEntry(4.5)) ``` + -#### \_\_getitem_\_(arg2: str) → [PyOSDesignEntry](#py_os_design.PyOSDesignEntry) +### \_\_getitem_\_(arg2: str) → [PyOSDesignEntry](#py_os_design.PyOSDesignEntry) + -#### \_\_init_\_() +### \_\_init_\_() + -#### \_\_iter_\_() → object +### \_\_iter_\_() → object + -#### \_\_len_\_() → int +### \_\_len_\_() → int + -#### \_\_setitem_\_(arg2: str) → [PyOSDesignEntry](#py_os_design.PyOSDesignEntry) +### \_\_setitem_\_(arg2: str) → [PyOSDesignEntry](#py_os_design.PyOSDesignEntry) + -#### add(name: str, value: object) +### add(name: str, value: object) -#### add(name: str, value: [VariantD](pyvariant.md#pyvariant.VariantD)) +### add(name: str, value: [VariantD](pyvariant.md#pyvariant.VariantD)) -#### add(name: str, value: [PyOSDesignEntry](#py_os_design.PyOSDesignEntry)) +### add(name: str, value: [PyOSDesignEntry](#py_os_design.PyOSDesignEntry)) [0] Extend design point using a Python builtin type. Accepted types are str, int, bool and float. @@ -545,505 +665,632 @@ dp.add("param_02", PyOSDesignEntry(4.5)) [2] Extend design point using a design entry. + -### *class* py_os_design.PyOSDesignPointContainer +## *class* py_os_design.PyOSDesignPointContainer Array of design points. + -#### \_\_init_\_() +### \_\_init_\_() + -#### \_\_iter_\_() → object +### \_\_iter_\_() → object + -#### \_\_len_\_() → int +### \_\_len_\_() → int + -#### push_back(arg2: [PyOSDesignPoint](#py_os_design.PyOSDesignPoint)) +### push_back(arg2: [PyOSDesignPoint](#py_os_design.PyOSDesignPoint)) + -### py_os_design.PyParameters +## py_os_design.PyParameters alias of [`PyOSDesignPoint`](#py_os_design.PyOSDesignPoint) + -### py_os_design.PyResponses +## py_os_design.PyResponses alias of [`PyOSDesignPoint`](#py_os_design.PyOSDesignPoint) + -### *class* py_os_design.RunInfoContainer +## *class* py_os_design.RunInfoContainer + -#### \_\_init_\_() +### \_\_init_\_() + -#### \_\_iter_\_() → object +### \_\_iter_\_() → object + -#### \_\_len_\_() → int +### \_\_len_\_() → int + -#### add_run_info(arg2: [RunInfoMeta](#py_os_design.RunInfoMeta)) +### add_run_info(arg2: [RunInfoMeta](#py_os_design.RunInfoMeta)) + -#### succeeded() → bool +### succeeded() → bool + -### *class* py_os_design.RunInfoMeta +## *class* py_os_design.RunInfoMeta + -#### \_\_init_\_(arg2: [DesignStatus](#py_os_design.DesignStatus)) +### \_\_init_\_(arg2: [DesignStatus](#py_os_design.DesignStatus)) + -### *class* py_os_design.TextImportAdditionalDimension +## *class* py_os_design.TextImportAdditionalDimension Additional dimension item. + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_() +### \_\_init_\_() + -#### *property* expression +### *property* expression Expression for the additional dimension. + -#### *property* name +### *property* name Name of the dimension to be added. + -### *class* py_os_design.TextImportAdditionalDimensionVector +## *class* py_os_design.TextImportAdditionalDimensionVector + -#### \_\_contains_\_(arg2: object) → bool +### \_\_contains_\_(arg2: object) → bool + -#### \_\_delitem_\_(arg2: object) +### \_\_delitem_\_(arg2: object) + -#### \_\_getitem_\_(arg2: object) → object +### \_\_getitem_\_(arg2: object) → object + -#### \_\_init_\_() +### \_\_init_\_() + -#### \_\_iter_\_() → object +### \_\_iter_\_() → object -#### \_\_iter_\_() → object +### \_\_iter_\_() → object + -#### \_\_len_\_() → int +### \_\_len_\_() → int + -#### \_\_setitem_\_(arg2: object, arg3: object) +### \_\_setitem_\_(arg2: object, arg3: object) + -#### append(arg2: object) +### append(arg2: object) + -#### extend(arg2: object) +### extend(arg2: object) + -#### push_back(arg2: [TextImportAdditionalDimension](#py_os_design.TextImportAdditionalDimension)) +### push_back(arg2: [TextImportAdditionalDimension](#py_os_design.TextImportAdditionalDimension)) + -#### size() → int +### size() → int + -### *class* py_os_design.TextImportDataType +## *class* py_os_design.TextImportDataType **Enumeration** + -#### AutoDetect *= py_os_design.TextImportDataType.AutoDetect* +### AutoDetect *= py_os_design.TextImportDataType.AutoDetect* + -#### Bool *= py_os_design.TextImportDataType.Bool* +### Bool *= py_os_design.TextImportDataType.Bool* + -#### Integer *= py_os_design.TextImportDataType.Integer* +### Integer *= py_os_design.TextImportDataType.Integer* + -#### Real *= py_os_design.TextImportDataType.Real* +### Real *= py_os_design.TextImportDataType.Real* + -#### String *= py_os_design.TextImportDataType.String* +### String *= py_os_design.TextImportDataType.String* + -### *class* py_os_design.TextImportDesignFilterType +## *class* py_os_design.TextImportDesignFilterType **Enumeration** + -#### DontImport *= py_os_design.TextImportDesignFilterType.DontImport* +### DontImport *= py_os_design.TextImportDesignFilterType.DontImport* + -#### ImportAsActivated *= py_os_design.TextImportDesignFilterType.ImportAsActivated* +### ImportAsActivated *= py_os_design.TextImportDesignFilterType.ImportAsActivated* + -#### ImportAsDeactivated *= py_os_design.TextImportDesignFilterType.ImportAsDeactivated* +### ImportAsDeactivated *= py_os_design.TextImportDesignFilterType.ImportAsDeactivated* + -### *class* py_os_design.TextImportDimensionSettings +## *class* py_os_design.TextImportDimensionSettings Dimension settings item. + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_() +### \_\_init_\_() + -#### *property* alias +### *property* alias Alternative name of the dimension. + -#### *property* data_index +### *property* data_index Index where the dimension is located in data set (header line). + -#### *property* data_type +### *property* data_type Data type: either AutoDetect (wathever data fits best), String, Bool, Integer or Real. + -#### *property* dimension_type +### *property* dimension_type Dimension type: either Parameter, Response, DesignId or DontImport. + -#### *property* name +### *property* name Name of the dimension. + -#### *property* vector_size +### *property* vector_size Vector size, when this is a vector response. + -### *class* py_os_design.TextImportDimensionSettingsVector +## *class* py_os_design.TextImportDimensionSettingsVector + -#### \_\_contains_\_(arg2: object) → bool +### \_\_contains_\_(arg2: object) → bool + -#### \_\_delitem_\_(arg2: object) +### \_\_delitem_\_(arg2: object) + -#### \_\_getitem_\_(arg2: object) → object +### \_\_getitem_\_(arg2: object) → object + -#### \_\_init_\_() +### \_\_init_\_() + -#### \_\_iter_\_() → object +### \_\_iter_\_() → object -#### \_\_iter_\_() → object +### \_\_iter_\_() → object + -#### \_\_len_\_() → int +### \_\_len_\_() → int + -#### \_\_setitem_\_(arg2: object, arg3: object) +### \_\_setitem_\_(arg2: object, arg3: object) + -#### append(arg2: object) +### append(arg2: object) + -#### extend(arg2: object) +### extend(arg2: object) + -#### push_back(arg2: [TextImportDimensionSettings](#py_os_design.TextImportDimensionSettings)) +### push_back(arg2: [TextImportDimensionSettings](#py_os_design.TextImportDimensionSettings)) + -#### size() → int +### size() → int + -### *class* py_os_design.TextImportDimensionType +## *class* py_os_design.TextImportDimensionType **Enumeration** + -#### DesignId *= py_os_design.TextImportDimensionType.DesignId* +### DesignId *= py_os_design.TextImportDimensionType.DesignId* + -#### DontImport *= py_os_design.TextImportDimensionType.DontImport* +### DontImport *= py_os_design.TextImportDimensionType.DontImport* + -#### Parameter *= py_os_design.TextImportDimensionType.Parameter* +### Parameter *= py_os_design.TextImportDimensionType.Parameter* + -#### Response *= py_os_design.TextImportDimensionType.Response* +### Response *= py_os_design.TextImportDimensionType.Response* + -### *class* py_os_design.TextImportReplaceValues +## *class* py_os_design.TextImportReplaceValues Replace text item. + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_() +### \_\_init_\_() + -#### *property* complete +### *property* complete Value has to fit complete if True, else also wordparts will be replaced. + -#### *property* dimension +### *property* dimension When replacement should only be done in one column, put dimension name in here, else leave empty for replacement in all dimensions. + -#### *property* replacement +### *property* replacement Replacement text. + -#### *property* text +### *property* text Text to be replaced. + -### *class* py_os_design.TextImportReplaceValuesVector +## *class* py_os_design.TextImportReplaceValuesVector + -#### \_\_contains_\_(arg2: object) → bool +### \_\_contains_\_(arg2: object) → bool + -#### \_\_delitem_\_(arg2: object) +### \_\_delitem_\_(arg2: object) + -#### \_\_getitem_\_(arg2: object) → object +### \_\_getitem_\_(arg2: object) → object + -#### \_\_init_\_() +### \_\_init_\_() + -#### \_\_iter_\_() → object +### \_\_iter_\_() → object -#### \_\_iter_\_() → object +### \_\_iter_\_() → object + -#### \_\_len_\_() → int +### \_\_len_\_() → int + -#### \_\_setitem_\_(arg2: object, arg3: object) +### \_\_setitem_\_(arg2: object, arg3: object) + -#### append(arg2: object) +### append(arg2: object) + -#### extend(arg2: object) +### extend(arg2: object) + -#### push_back(arg2: [TextImportReplaceValues](#py_os_design.TextImportReplaceValues)) +### push_back(arg2: [TextImportReplaceValues](#py_os_design.TextImportReplaceValues)) + -#### size() → int +### size() → int + -### *class* py_os_design.TextImportSettings +## *class* py_os_design.TextImportSettings Settings object for determining settings for text import. + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_() +### \_\_init_\_() + -#### *property* additional_columns +### *property* additional_columns Vector with additional dimensions, defined by name and expression. + -#### *property* assume_has_header +### *property* assume_has_header Determine the existance of a header line. + -#### *property* automatically_indentify_vector_responses +### *property* automatically_indentify_vector_responses Dimension names e.g. “response_name[%d]” will be grouped together as one vector response “response_name”. + -#### *property* column_exclude +### *property* column_exclude Columns to exclude. + -#### *property* column_include +### *property* column_include Columns to include. + -#### *property* column_increment +### *property* column_increment Import every nth column - has to be strictly positive. + -#### *property* column_maximum +### *property* column_maximum The last column to be read. + -#### *property* delimiters +### *property* delimiters Delimiters to split the lines. + -#### *property* design_layout_horizontal +### *property* design_layout_horizontal Set True for horizontal layout. Else False. + -#### *property* dimension_settings +### *property* dimension_settings Define the dimensions. + -#### export_settings(path_to_settings_file: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### export_settings(path_to_settings_file: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) Export text import settings to file. + -#### *property* header_line +### *property* header_line Line number of header line. + -#### *property* import_deactivated_designs +### *property* import_deactivated_designs Import deactivated designs, or not. + -#### *property* import_designs_with_infinity_as +### *property* import_designs_with_infinity_as Designs containing infinity values will be imported either as activated or deactivated, or won’t be imported. + -#### *property* import_designs_with_nan_as +### *property* import_designs_with_nan_as Designs containing nan values will be imported either as activated or deactivated, or won’t be imported. + -#### *property* import_duplicated_designs +### *property* import_duplicated_designs Import duplicated designs, or not. + -#### *property* import_incomplete_designs_as +### *property* import_incomplete_designs_as Incomplete designs will be imported either as activated or deactivated, or won’t be imported. + -#### import_settings(path_to_settings_file: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### import_settings(path_to_settings_file: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) Import text import settings from file. + -#### *property* is_read_from_line_offset +### *property* is_read_from_line_offset Read the text file from line is active. + -#### *property* is_read_from_marker +### *property* is_read_from_marker Read the text file from marker is active. + -#### *property* lines +### *property* lines Lines to include. + -#### *property* read_from_beginning +### *property* read_from_beginning Read the text file from beginning. + -#### *property* read_from_line_offset +### *property* read_from_line_offset Read the text file from given line. + -#### *property* read_from_marker +### *property* read_from_marker Read the text file from marker. + -#### *property* replace_entries +### *property* replace_entries Vector with entries for replacing text entries. + -#### *property* row_increment +### *property* row_increment Import every nth line - has to be strictly positive. + -#### *property* start_design_id_numbering_with +### *property* start_design_id_numbering_with When no design id dimension is chosen, design numbering starts with this id. + -### *class* py_os_design.UninitializedType +## *class* py_os_design.UninitializedType + -#### \_\_init_\_() +### \_\_init_\_() + -### py_os_design.calculate_criteria(design: PyOSDesign) → [PyOSDesign](#py_os_design.PyOSDesign) +## py_os_design.calculate_criteria(design: PyOSDesign) → [PyOSDesign](#py_os_design.PyOSDesign) Returns the given design with calculated criteria values. For the calculation an internally initialized calculator is used. + -### py_os_design.calculate_criteria_container(design_container: PyOSDesignContainer) → [PyOSDesignContainer](#py_os_design.PyOSDesignContainer) +## py_os_design.calculate_criteria_container(design_container: PyOSDesignContainer) → [PyOSDesignContainer](#py_os_design.PyOSDesignContainer) Returns the given design container with calculated criteria values for all containing designs. + -### py_os_design.calculate_criteria_with_calc(design: PyOSDesign, calculator: object) → [PyOSDesign](#py_os_design.PyOSDesign) +## py_os_design.calculate_criteria_with_calc(design: PyOSDesign, calculator: object) → [PyOSDesign](#py_os_design.PyOSDesign) Returns the given design with calculated criteria values. For the calculation the externally initialized calculator is used. + -### py_os_design.calculate_dependent_container(design_container: [PyOSDesignContainer](#py_os_design.PyOSDesignContainer), parameter_manager: [PyParameterManager](py_os_parameter.md#py_os_parameter.PyParameterManager)) +## py_os_design.calculate_dependent_container(design_container: [PyOSDesignContainer](#py_os_design.PyOSDesignContainer), parameter_manager: [PyParameterManager](py_os_parameter.md#py_os_parameter.PyParameterManager)) Calculates the dependent input parameter values for all designs of the given design container. + -### py_os_design.create_nvp_design_entry(name: str, value: [PyOSDesignEntry](#py_os_design.PyOSDesignEntry)) → object +## py_os_design.create_nvp_design_entry(name: str, value: [PyOSDesignEntry](#py_os_design.PyOSDesignEntry)) → object Create entry pair with name and value. + -### py_os_design.designs_to_python_object(designs: PyOSDesignContainer) → object +## py_os_design.designs_to_python_object(designs: PyOSDesignContainer) → object + -### py_os_design.export_designs_to_csv(designs: [PyOSDesignContainer](#py_os_design.PyOSDesignContainer), file: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), delimiter: str) +## py_os_design.export_designs_to_csv(designs: [PyOSDesignContainer](#py_os_design.PyOSDesignContainer), file: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), delimiter: str) + -### py_os_design.export_designs_to_json(designs: PyOSDesignContainer, path: Path) +## py_os_design.export_designs_to_json(designs: PyOSDesignContainer, path: Path) + -### py_os_design.import_designs_from_csv(inputs: [PyOSDesignPoint](#py_os_design.PyOSDesignPoint), criteria: [PyOSCriterionContainer](py_os_criterion.md#py_os_criterion.PyOSCriterionContainer), file: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), delimiter: str) → [PyOSDesignContainer](#py_os_design.PyOSDesignContainer) +## py_os_design.import_designs_from_csv(inputs: [PyOSDesignPoint](#py_os_design.PyOSDesignPoint), criteria: [PyOSCriterionContainer](py_os_criterion.md#py_os_criterion.PyOSCriterionContainer), file: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), delimiter: str) → [PyOSDesignContainer](#py_os_design.PyOSDesignContainer) + -### py_os_design.import_designs_from_json(path: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) → [PyOSDesignContainer](#py_os_design.PyOSDesignContainer) +## py_os_design.import_designs_from_json(path: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) → [PyOSDesignContainer](#py_os_design.PyOSDesignContainer) + -### py_os_design.read_design_from_file(file: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), parsed_filename: str) → [PyOSDesign](#py_os_design.PyOSDesign) +## py_os_design.read_design_from_file(file: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), parsed_filename: str) → [PyOSDesign](#py_os_design.PyOSDesign) + -### py_os_design.write_design_to_file(design: [PyOSDesign](#py_os_design.PyOSDesign), file: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), inputs_only: bool, source_file: str) +## py_os_design.write_design_to_file(design: [PyOSDesign](#py_os_design.PyOSDesign), file: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), inputs_only: bool, source_file: str) diff --git a/2025R2/optiSLang-python-api/modules/py_os_parameter.md b/2025R2/optiSLang-python-api/modules/py_os_parameter.md index ffb62b25f1..522bd54280 100644 --- a/2025R2/optiSLang-python-api/modules/py_os_parameter.md +++ b/2025R2/optiSLang-python-api/modules/py_os_parameter.md @@ -1,305 +1,405 @@ + -### *class* py_os_parameter.DProp +# py_os_parameter + -#### \_\_init_\_() +## *class* py_os_parameter.DProp + -### *class* py_os_parameter.DPropList +### \_\_init_\_() + -#### \_\_init_\_() +## *class* py_os_parameter.DPropList + -#### \_\_iter_\_() → object +### \_\_init_\_() + -#### dprop_export_list() → [DPropList](#py_os_parameter.DPropList) +### \_\_iter_\_() → object + -#### push_back(arg2: [DPropPair](#py_os_parameter.DPropPair)) +### dprop_export_list() → [DPropList](#py_os_parameter.DPropList) + -#### size() → int +### push_back(arg2: [DPropPair](#py_os_parameter.DPropPair)) + -### *class* py_os_parameter.DPropPair +### size() → int + -#### \_\_init_\_() +## *class* py_os_parameter.DPropPair + -#### *property* first +### \_\_init_\_() + -#### *property* second +### *property* first + -### *class* py_os_parameter.ParameterList +### *property* second + -#### \_\_init_\_() +## *class* py_os_parameter.ParameterList + -#### \_\_iter_\_() → object +### \_\_init_\_() + -#### param_export_list() → [ParameterList](#py_os_parameter.ParameterList) +### \_\_iter_\_() → object + -#### push_back(arg2: [PyParameter](#py_os_parameter.PyParameter)) +### param_export_list() → [ParameterList](#py_os_parameter.ParameterList) + -#### size() → int +### push_back(arg2: [PyParameter](#py_os_parameter.PyParameter)) + -### *class* py_os_parameter.PyParameter +### size() → int + -#### \_\_eq_\_(arg2: PyParameter) → bool +## *class* py_os_parameter.PyParameter + -#### \_\_init_\_() +### \_\_eq_\_(arg2: PyParameter) → bool -#### \_\_init_\_(arg2: str) + -#### \_\_init_\_(arg2: str, arg3: float, arg4: float, arg5: float, arg6: int) +### \_\_init_\_() -#### \_\_init_\_(arg2: str, arg3: float, arg4: float, arg5: [PyOSDesignEntry](py_os_design.md#py_os_design.PyOSDesignEntry), arg6: int) +### \_\_init_\_(arg2: str) -#### \_\_init_\_(arg2: str, arg3: [PyOSDesignEntryVec](py_os_design.md#py_os_design.PyOSDesignEntryVec), arg4: [DeterministicType](dynardo_py_algorithms.md#dynardo_py_algorithms.DeterministicType)) +### \_\_init_\_(arg2: str, arg3: float, arg4: float, arg5: float, arg6: int) -#### \_\_init_\_(arg2: str, arg3: str) +### \_\_init_\_(arg2: str, arg3: float, arg4: float, arg5: [PyOSDesignEntry](py_os_design.md#py_os_design.PyOSDesignEntry), arg6: int) -#### \_\_init_\_(arg2: str, arg3: [RandomVariableType](dynardo_py_algorithms.md#dynardo_py_algorithms.RandomVariableType), arg4: [RandomVariableKind](dynardo_py_algorithms.md#dynardo_py_algorithms.RandomVariableKind), arg5: [PyOSDesignEntry](py_os_design.md#py_os_design.PyOSDesignEntry)) +### \_\_init_\_(arg2: str, arg3: [PyOSDesignEntryVec](py_os_design.md#py_os_design.PyOSDesignEntryVec), arg4: [DeterministicType](dynardo_py_algorithms.md#dynardo_py_algorithms.DeterministicType)) +### \_\_init_\_(arg2: str, arg3: str) -#### \_\_is_equal_\_(arg2: PyParameter) → bool +### \_\_init_\_(arg2: str, arg3: [RandomVariableType](dynardo_py_algorithms.md#dynardo_py_algorithms.RandomVariableType), arg4: [RandomVariableKind](dynardo_py_algorithms.md#dynardo_py_algorithms.RandomVariableKind), arg5: [PyOSDesignEntry](py_os_design.md#py_os_design.PyOSDesignEntry)) + -#### \_\_is_not_equal_\_(arg2: [PyParameter](#py_os_parameter.PyParameter)) → bool +### \_\_is_equal_\_(arg2: PyParameter) → bool + -#### \_\_ne_\_(arg2: [PyParameter](#py_os_parameter.PyParameter)) → bool +### \_\_is_not_equal_\_(arg2: [PyParameter](#py_os_parameter.PyParameter)) → bool + -#### erase_det_prop(name: str) +### \_\_ne_\_(arg2: [PyParameter](#py_os_parameter.PyParameter)) → bool + -#### get_dependency_expression() → str +### erase_det_prop(name: str) + -#### get_det_discrete_states() → [PyOSDesignEntryVec](py_os_design.md#py_os_design.PyOSDesignEntryVec) +### get_dependency_expression() → str + -#### get_det_kind() → [DeterministicType](dynardo_py_algorithms.md#dynardo_py_algorithms.DeterministicType) +### get_det_discrete_states() → [PyOSDesignEntryVec](py_os_design.md#py_os_design.PyOSDesignEntryVec) + -#### get_det_prop_by_index(index: int) → [DProp](#py_os_parameter.DProp) +### get_det_kind() → [DeterministicType](dynardo_py_algorithms.md#dynardo_py_algorithms.DeterministicType) + -#### get_det_prop_name(index: int) → object +### get_det_prop_by_index(index: int) → [DProp](#py_os_parameter.DProp) + -#### get_det_props() → [DPropList](#py_os_parameter.DPropList) +### get_det_prop_name(index: int) → object + -#### get_det_type() → [EntryType](py_os_design.md#py_os_design.EntryType) +### get_det_props() → [DPropList](#py_os_parameter.DPropList) + -#### get_id() → [UUID](id.md#id.UUID) +### get_det_type() → [EntryType](py_os_design.md#py_os_design.EntryType) + -#### get_lower_bound() → [PyOSDesignEntry](py_os_design.md#py_os_design.PyOSDesignEntry) +### get_id() → [UUID](id.md#id.UUID) + -#### get_mutable_map() → object +### get_lower_bound() → [PyOSDesignEntry](py_os_design.md#py_os_design.PyOSDesignEntry) + -#### get_name() → str +### get_mutable_map() → object + -#### get_parameter_type() → [ParameterType](dynardo_py_algorithms.md#dynardo_py_algorithms.ParameterType) +### get_name() → str + -#### get_ran_cov() → float +### get_parameter_type() → [ParameterType](dynardo_py_algorithms.md#dynardo_py_algorithms.ParameterType) + -#### get_ran_kind() → [RandomVariableKind](dynardo_py_algorithms.md#dynardo_py_algorithms.RandomVariableKind) +### get_ran_cov() → float + -#### get_ran_parameters() → [doubleVec](stdcpp_python_export.md#stdcpp_python_export.doubleVec) +### get_ran_kind() → [RandomVariableKind](dynardo_py_algorithms.md#dynardo_py_algorithms.RandomVariableKind) + -#### get_ran_prop() → [RanProp](#py_os_parameter.RanProp) +### get_ran_parameters() → [doubleVec](stdcpp_python_export.md#stdcpp_python_export.doubleVec) + -#### get_ran_statistical_moments() → [doubleVec](stdcpp_python_export.md#stdcpp_python_export.doubleVec) +### get_ran_prop() → [RanProp](#py_os_parameter.RanProp) + -#### get_ran_type() → [RandomVariableType](dynardo_py_algorithms.md#dynardo_py_algorithms.RandomVariableType) +### get_ran_statistical_moments() → [doubleVec](stdcpp_python_export.md#stdcpp_python_export.doubleVec) + -#### get_reference_value() → [PyOSDesignEntry](py_os_design.md#py_os_design.PyOSDesignEntry) +### get_ran_type() → [RandomVariableType](dynardo_py_algorithms.md#dynardo_py_algorithms.RandomVariableType) + -#### get_upper_bound() → [PyOSDesignEntry](py_os_design.md#py_os_design.PyOSDesignEntry) +### get_reference_value() → [PyOSDesignEntry](py_os_design.md#py_os_design.PyOSDesignEntry) + -#### has_continuous_distribution() → bool +### get_upper_bound() → [PyOSDesignEntry](py_os_design.md#py_os_design.PyOSDesignEntry) + -#### has_marginal_distribution() → bool +### has_continuous_distribution() → bool + -#### has_set_ran_cov() → bool +### has_marginal_distribution() → bool + -#### has_set_ran_parameters() → bool +### has_set_ran_cov() → bool + -#### has_set_ran_statistical_moments() → bool +### has_set_ran_parameters() → bool + -#### is_active() → bool +### has_set_ran_statistical_moments() → bool + -#### is_const() → bool +### is_active() → bool + -#### is_continuous() → bool +### is_const() → bool + -#### is_dependent() → bool +### is_continuous() → bool + -#### is_empirical() → bool +### is_dependent() → bool + -#### is_mixed() → bool +### is_empirical() → bool + -#### is_modifiable() → bool +### is_mixed() → bool + -#### is_mutable(member: object) → bool +### is_modifiable() → bool + -#### is_optimization() → bool +### is_mutable(member: object) → bool + -#### is_pure_optimization() → bool +### is_optimization() → bool + -#### is_pure_stochastic() → bool +### is_pure_optimization() → bool + -#### is_ran_prop_validated() → bool +### is_pure_stochastic() → bool + -#### is_stochastic() → bool +### is_ran_prop_validated() → bool + -#### rename_det_prop(arg2: str) +### is_stochastic() → bool -#### rename_det_prop(arg2: str, to: str) + +### rename_det_prop(arg2: str) -#### rename_parameter(to: str) +### rename_det_prop(arg2: str, to: str) + -#### set_active(active: bool) +### rename_parameter(to: str) + -#### set_bounds(lower_bound: PyOSDesignEntry, upper_bound: PyOSDesignEntry) +### set_active(active: bool) + -#### set_const(constant: bool) +### set_bounds(lower_bound: PyOSDesignEntry, upper_bound: PyOSDesignEntry) + -#### set_dependent(expression: str) +### set_const(constant: bool) + -#### set_det_prop_by_index(value: [DProp](#py_os_parameter.DProp), index: int) +### set_dependent(expression: str) + -#### set_discrete_states(states: PyOSDesignEntryVec) +### set_det_prop_by_index(value: [DProp](#py_os_parameter.DProp), index: int) + -#### set_kind(kind: [DeterministicType](dynardo_py_algorithms.md#dynardo_py_algorithms.DeterministicType)) +### set_discrete_states(states: PyOSDesignEntryVec) + -#### set_lower_bound(value: PyOSDesignEntry) +### set_kind(kind: [DeterministicType](dynardo_py_algorithms.md#dynardo_py_algorithms.DeterministicType)) + -#### set_modifiable(arg2: bool) +### set_lower_bound(value: PyOSDesignEntry) + -#### set_mutable(member: object, state: bool) +### set_modifiable(arg2: bool) + -#### set_mutable_map(arg2: object) +### set_mutable(member: object, state: bool) + -#### set_parameter_type(type: [ParameterType](dynardo_py_algorithms.md#dynardo_py_algorithms.ParameterType)) +### set_mutable_map(arg2: object) + -#### set_ran_cov(cov: float) → float +### set_parameter_type(type: [ParameterType](dynardo_py_algorithms.md#dynardo_py_algorithms.ParameterType)) + -#### set_ran_kind(kind: [RandomVariableKind](dynardo_py_algorithms.md#dynardo_py_algorithms.RandomVariableKind)) +### set_ran_cov(cov: float) → float + -#### set_ran_parameters(parameters: [doubleVec](stdcpp_python_export.md#stdcpp_python_export.doubleVec)) +### set_ran_kind(kind: [RandomVariableKind](dynardo_py_algorithms.md#dynardo_py_algorithms.RandomVariableKind)) + -#### set_ran_prop_validated(arg2: bool) +### set_ran_parameters(parameters: [doubleVec](stdcpp_python_export.md#stdcpp_python_export.doubleVec)) + -#### set_ran_statistical_moments(moments: [doubleVec](stdcpp_python_export.md#stdcpp_python_export.doubleVec)) +### set_ran_prop_validated(arg2: bool) + -#### set_ran_type(type: [RandomVariableType](dynardo_py_algorithms.md#dynardo_py_algorithms.RandomVariableType)) +### set_ran_statistical_moments(moments: [doubleVec](stdcpp_python_export.md#stdcpp_python_export.doubleVec)) + -#### set_reference_value(value: PyOSDesignEntry) +### set_ran_type(type: [RandomVariableType](dynardo_py_algorithms.md#dynardo_py_algorithms.RandomVariableType)) + -#### set_type(type: [EntryType](py_os_design.md#py_os_design.EntryType)) +### set_reference_value(value: PyOSDesignEntry) + -#### set_upper_bound(value: PyOSDesignEntry) +### set_type(type: [EntryType](py_os_design.md#py_os_design.EntryType)) + -### *class* py_os_parameter.PyParameterManager +### set_upper_bound(value: PyOSDesignEntry) + -#### \_\_eq_\_(arg2: PyParameterManager) → bool +## *class* py_os_parameter.PyParameterManager + -#### \_\_init_\_() +### \_\_eq_\_(arg2: PyParameterManager) → bool + -#### \_\_is_equal_\_(arg2: PyParameterManager) → bool +### \_\_init_\_() + -#### \_\_is_not_equal_\_(arg2: [PyParameterManager](#py_os_parameter.PyParameterManager)) → bool +### \_\_is_equal_\_(arg2: PyParameterManager) → bool + -#### \_\_iter_\_() → object +### \_\_is_not_equal_\_(arg2: [PyParameterManager](#py_os_parameter.PyParameterManager)) → bool + -#### \_\_len_\_() → int +### \_\_iter_\_() → object + -#### \_\_ne_\_(arg2: [PyParameterManager](#py_os_parameter.PyParameterManager)) → bool +### \_\_len_\_() → int + -#### add_dependent_parameter(parameter_name: str, expression: str) +### \_\_ne_\_(arg2: [PyParameterManager](#py_os_parameter.PyParameterManager)) → bool + -#### add_deterministic_continuous_parameter(name: str, lower_bound: float, upper_bound: float, reference_value: float) +### add_dependent_parameter(parameter_name: str, expression: str) + + + +### add_deterministic_continuous_parameter(name: str, lower_bound: float, upper_bound: float, reference_value: float) Add a new deterministic continuous parameter. A range_mode of 1 or 2 sets a relative lower respectively upper bound. A range_mode of 3 sets both bounds relative. @@ -308,11 +408,13 @@ pm = PyParameterManager() pm.add_deterministic_continuous_parameter('a', 0., 3., 1.5) ``` + -#### add_parameter(name: str) +### add_parameter(name: str) + -#### add_stochastic_parameter(name: str, type: [RandomVariableType](dynardo_py_algorithms.md#dynardo_py_algorithms.RandomVariableType), kind: [RandomVariableKind](dynardo_py_algorithms.md#dynardo_py_algorithms.RandomVariableKind), reference_value: [PyOSDesignEntry](py_os_design.md#py_os_design.PyOSDesignEntry)) +### add_stochastic_parameter(name: str, type: [RandomVariableType](dynardo_py_algorithms.md#dynardo_py_algorithms.RandomVariableType), kind: [RandomVariableKind](dynardo_py_algorithms.md#dynardo_py_algorithms.RandomVariableKind), reference_value: [PyOSDesignEntry](py_os_design.md#py_os_design.PyOSDesignEntry)) Add a new stochastic parameter. It is required to set a parameter type and random parameters afterwards. @@ -323,235 +425,306 @@ pm.set_parameter_type('s1', ParameterType.STOCHASTIC) pm.set_ran_parameters('s1', double_list_to_vec([0.72, 0.3])) # normal distribution: mu, sigmah ``` + -#### clear() +### clear() + -#### contains_parameter(name: str) → bool +### contains_parameter(name: str) → bool -#### contains_parameter(id: [UUID](id.md#id.UUID)) → bool +### contains_parameter(id: [UUID](id.md#id.UUID)) → bool + -#### empty() → bool +### empty() → bool + -#### erase_correlation(arg2: str, parameter_name: str) → bool +### erase_correlation(arg2: str, parameter_name: str) → bool + -#### erase_correlations(parameter_name_b: str) → bool +### erase_correlations(parameter_name_b: str) → bool + -#### erase_parameter(parameter_name: str) +### erase_parameter(parameter_name: str) + -#### get_bounds(parameter_name: str, lower_bound: [PyOSDesignEntry](py_os_design.md#py_os_design.PyOSDesignEntry), upper_bound: [PyOSDesignEntry](py_os_design.md#py_os_design.PyOSDesignEntry)) +### get_bounds(parameter_name: str, lower_bound: [PyOSDesignEntry](py_os_design.md#py_os_design.PyOSDesignEntry), upper_bound: [PyOSDesignEntry](py_os_design.md#py_os_design.PyOSDesignEntry)) -#### get_bounds(parameter_name: str) → tuple +### get_bounds(parameter_name: str) → tuple [0] Note, that lower_bound and upper_bound are output arguments. [1] Return a parameter’s boundaries as a tuple. + -#### get_det_props() → [DPropList](#py_os_parameter.DPropList) +### get_det_props() → [DPropList](#py_os_parameter.DPropList) + -#### get_det_props_by_index(parameter_name: str, index: int) → [DProp](#py_os_parameter.DProp) +### get_det_props_by_index(parameter_name: str, index: int) → [DProp](#py_os_parameter.DProp) + -#### get_parameter(parameter_name: str) → [PyParameter](#py_os_parameter.PyParameter) +### get_parameter(parameter_name: str) → [PyParameter](#py_os_parameter.PyParameter) -#### get_parameter(parameter_id: [UUID](id.md#id.UUID)) → [PyParameter](#py_os_parameter.PyParameter) +### get_parameter(parameter_id: [UUID](id.md#id.UUID)) → [PyParameter](#py_os_parameter.PyParameter) + -#### get_parameter_by_index(index: int) → [PyParameter](#py_os_parameter.PyParameter) +### get_parameter_by_index(index: int) → [PyParameter](#py_os_parameter.PyParameter) + -#### get_parameters() → [ParameterList](#py_os_parameter.ParameterList) +### get_parameters() → [ParameterList](#py_os_parameter.ParameterList) + -#### get_ran_prop(parameter_name: str) → [RanProp](#py_os_parameter.RanProp) +### get_ran_prop(parameter_name: str) → [RanProp](#py_os_parameter.RanProp) + -#### get_ran_props() → [RanPropList](#py_os_parameter.RanPropList) +### get_ran_props() → [RanPropList](#py_os_parameter.RanPropList) + -#### get_reference_design() → [PyOSDesignEntryVec](py_os_design.md#py_os_design.PyOSDesignEntryVec) +### get_reference_design() → [PyOSDesignEntryVec](py_os_design.md#py_os_design.PyOSDesignEntryVec) + -#### get_reference_design_point() → [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint) +### get_reference_design_point() → [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint) + -#### get_size() → int +### get_size() → int + -#### get_unique_name() → str +### get_unique_name() → str + -#### import_from_csv(csv: Path path) +### import_from_csv(csv: Path path) Add parameters from csv to parameter manager. + -#### import_from_json(path: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### import_from_json(path: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) Add parameters from json to parameter manager. + -#### import_from_json_string(content: str) +### import_from_json_string(content: str) Add parameters from json string to parameter manager. + -#### insert_parameter(parameter: [PyParameter](#py_os_parameter.PyParameter)) +### insert_parameter(parameter: [PyParameter](#py_os_parameter.PyParameter)) + -#### rename_det_prop(parameter_name: str, from: str, to: str) +### rename_det_prop(parameter_name: str, from: str, to: str) + -#### rename_parameter(from: str, to: str) +### rename_parameter(from: str, to: str) + -#### reset_correlations() +### reset_correlations() + -#### save_to_csv(csv: Path path) +### save_to_csv(csv: Path path) Save parameter manager to a csv file. + -#### save_to_json(path: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +### save_to_json(path: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) Save parameter manager to a json file. + -#### set_active(parameter_name: str, active: bool) +### set_active(parameter_name: str, active: bool) + -#### set_bounds(parameter_name: str, lower_bound: PyOSDesignEntry, upper_bound: PyOSDesignEntry) +### set_bounds(parameter_name: str, lower_bound: PyOSDesignEntry, upper_bound: PyOSDesignEntry) + -#### set_const_all_in_list(names: WStrList) → [PyParameterManager](#py_os_parameter.PyParameterManager) +### set_const_all_in_list(names: WStrList) → [PyParameterManager](#py_os_parameter.PyParameterManager) + -#### set_const_flag(parameter_name: str) +### set_const_flag(parameter_name: str) + -#### set_correlation(parameter_name_a: str, parameter_name_b: str, value: float) → bool +### set_correlation(parameter_name_a: str, parameter_name_b: str, value: float) → bool + -#### set_dependent(parameter_name: str, expression: str) +### set_dependent(parameter_name: str, expression: str) + -#### set_discrete_states(parameter_name: str, discrete_states: [PyOSDesignEntryVec](py_os_design.md#py_os_design.PyOSDesignEntryVec)) +### set_discrete_states(parameter_name: str, discrete_states: [PyOSDesignEntryVec](py_os_design.md#py_os_design.PyOSDesignEntryVec)) + -#### set_kind(parameter_name: str, kind: [DeterministicType](dynardo_py_algorithms.md#dynardo_py_algorithms.DeterministicType)) +### set_kind(parameter_name: str, kind: [DeterministicType](dynardo_py_algorithms.md#dynardo_py_algorithms.DeterministicType)) + -#### set_lower_bound(parameter_name: str, value: PyOSDesignEntry) +### set_lower_bound(parameter_name: str, value: PyOSDesignEntry) + -#### set_modifiable(parameter_name: str, modifiable: bool) +### set_modifiable(parameter_name: str, modifiable: bool) + -#### set_parameter_type(parameter_name: str, type: [ParameterType](dynardo_py_algorithms.md#dynardo_py_algorithms.ParameterType)) +### set_parameter_type(parameter_name: str, type: [ParameterType](dynardo_py_algorithms.md#dynardo_py_algorithms.ParameterType)) + -#### set_ran_cov(parameter_name: str, cov: float) → float +### set_ran_cov(parameter_name: str, cov: float) → float + -#### set_ran_kind(parameter_name: str, kind: [RandomVariableKind](dynardo_py_algorithms.md#dynardo_py_algorithms.RandomVariableKind)) +### set_ran_kind(parameter_name: str, kind: [RandomVariableKind](dynardo_py_algorithms.md#dynardo_py_algorithms.RandomVariableKind)) + -#### set_ran_parameters(parameter_name: str, parameters: [doubleVec](stdcpp_python_export.md#stdcpp_python_export.doubleVec)) +### set_ran_parameters(parameter_name: str, parameters: [doubleVec](stdcpp_python_export.md#stdcpp_python_export.doubleVec)) + -#### set_ran_statistical_moments(parameter_name: str, moments: [doubleVec](stdcpp_python_export.md#stdcpp_python_export.doubleVec)) +### set_ran_statistical_moments(parameter_name: str, moments: [doubleVec](stdcpp_python_export.md#stdcpp_python_export.doubleVec)) + -#### set_ran_type(parameter_name: str, type: [RandomVariableType](dynardo_py_algorithms.md#dynardo_py_algorithms.RandomVariableType)) +### set_ran_type(parameter_name: str, type: [RandomVariableType](dynardo_py_algorithms.md#dynardo_py_algorithms.RandomVariableType)) + -#### set_reference_design_point(design_point: [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint)) +### set_reference_design_point(design_point: [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint)) + -#### set_reference_value(parameter_name: str, value: PyOSDesignEntry) +### set_reference_value(parameter_name: str, value: PyOSDesignEntry) + -#### set_type(parameter_name: str, type: [EntryType](py_os_design.md#py_os_design.EntryType)) +### set_type(parameter_name: str, type: [EntryType](py_os_design.md#py_os_design.EntryType)) + -#### set_upper_bound(parameter_name: str, value: PyOSDesignEntry) +### set_upper_bound(parameter_name: str, value: PyOSDesignEntry) + -### *class* py_os_parameter.RanProp +## *class* py_os_parameter.RanProp + -#### \_\_init_\_() +### \_\_init_\_() + -### *class* py_os_parameter.RanPropList +## *class* py_os_parameter.RanPropList + -#### \_\_init_\_() +### \_\_init_\_() + -#### \_\_iter_\_() → object +### \_\_iter_\_() → object + -#### push_back(arg2: [RanPropPair](#py_os_parameter.RanPropPair)) +### push_back(arg2: [RanPropPair](#py_os_parameter.RanPropPair)) + -#### ran_prop_export_list() → [RanPropList](#py_os_parameter.RanPropList) +### ran_prop_export_list() → [RanPropList](#py_os_parameter.RanPropList) + -#### size() → int +### size() → int + -### *class* py_os_parameter.RanPropPair +## *class* py_os_parameter.RanPropPair + -#### \_\_init_\_() +### \_\_init_\_() + -#### *property* first +### *property* first + -#### *property* second +### *property* second + -### py_os_parameter.get_const_parameter_names(parameter_manager: [PyParameterManager](#py_os_parameter.PyParameterManager), exclude_dependent: bool) → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) +## py_os_parameter.get_const_parameter_names(parameter_manager: [PyParameterManager](#py_os_parameter.PyParameterManager), exclude_dependent: bool) → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) + -### py_os_parameter.get_dependent_parameter_names(parameter_manager: [PyParameterManager](#py_os_parameter.PyParameterManager)) → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) +## py_os_parameter.get_dependent_parameter_names(parameter_manager: [PyParameterManager](#py_os_parameter.PyParameterManager)) → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) + -### py_os_parameter.get_lower_bound_values(parameter_manager: [PyParameterManager](#py_os_parameter.PyParameterManager)) → [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint) +## py_os_parameter.get_lower_bound_values(parameter_manager: [PyParameterManager](#py_os_parameter.PyParameterManager)) → [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint) + -### py_os_parameter.get_non_const_det_props(parameter_manager: [PyParameterManager](#py_os_parameter.PyParameterManager)) → [DPropList](#py_os_parameter.DPropList) +## py_os_parameter.get_non_const_det_props(parameter_manager: [PyParameterManager](#py_os_parameter.PyParameterManager)) → [DPropList](#py_os_parameter.DPropList) + -### py_os_parameter.get_non_const_parameter_names(parameter_manager: [PyParameterManager](#py_os_parameter.PyParameterManager), exclude_dependent: bool) → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) +## py_os_parameter.get_non_const_parameter_names(parameter_manager: [PyParameterManager](#py_os_parameter.PyParameterManager), exclude_dependent: bool) → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) + -### py_os_parameter.get_non_const_ran_props(parameter_manager: [PyParameterManager](#py_os_parameter.PyParameterManager)) → [ParameterList](#py_os_parameter.ParameterList) +## py_os_parameter.get_non_const_ran_props(parameter_manager: [PyParameterManager](#py_os_parameter.PyParameterManager)) → [ParameterList](#py_os_parameter.ParameterList) + -### py_os_parameter.get_num_non_const_det_props(parameter_manager: [PyParameterManager](#py_os_parameter.PyParameterManager)) → int +## py_os_parameter.get_num_non_const_det_props(parameter_manager: [PyParameterManager](#py_os_parameter.PyParameterManager)) → int + -### py_os_parameter.get_num_non_const_ran_props(parameter_manager: [PyParameterManager](#py_os_parameter.PyParameterManager)) → int +## py_os_parameter.get_num_non_const_ran_props(parameter_manager: [PyParameterManager](#py_os_parameter.PyParameterManager)) → int + -### py_os_parameter.get_parameter_names(parameter_manager: [PyParameterManager](#py_os_parameter.PyParameterManager)) → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) +## py_os_parameter.get_parameter_names(parameter_manager: [PyParameterManager](#py_os_parameter.PyParameterManager)) → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) + -### py_os_parameter.get_pure_deterministic_parameter_names(parameter_manager: [PyParameterManager](#py_os_parameter.PyParameterManager)) → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) +## py_os_parameter.get_pure_deterministic_parameter_names(parameter_manager: [PyParameterManager](#py_os_parameter.PyParameterManager)) → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) + -### py_os_parameter.get_pure_stochastic_parameter_names(parameter_manager: [PyParameterManager](#py_os_parameter.PyParameterManager)) → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) +## py_os_parameter.get_pure_stochastic_parameter_names(parameter_manager: [PyParameterManager](#py_os_parameter.PyParameterManager)) → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) + -### py_os_parameter.get_upper_bound_values(parameter_manager: [PyParameterManager](#py_os_parameter.PyParameterManager)) → [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint) +## py_os_parameter.get_upper_bound_values(parameter_manager: [PyParameterManager](#py_os_parameter.PyParameterManager)) → [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint) diff --git a/2025R2/optiSLang-python-api/modules/py_osl3binfile.md b/2025R2/optiSLang-python-api/modules/py_osl3binfile.md index c68b8fd0d5..baa3e051ab 100644 --- a/2025R2/optiSLang-python-api/modules/py_osl3binfile.md +++ b/2025R2/optiSLang-python-api/modules/py_osl3binfile.md @@ -1,53 +1,74 @@ + -### py_osl3binfile.CalcRanParameters(arg1: [RandomVariableType](dynardo_py_algorithms.md#dynardo_py_algorithms.RandomVariableType), arg2: [doubleVec](stdcpp_python_export.md#stdcpp_python_export.doubleVec), arg3: float, arg4: float, arg5: float, arg6: float) +# py_osl3binfile + -### *class* py_osl3binfile.OSL3Binfile +## py_osl3binfile.CalcRanParameters(arg1: [RandomVariableType](dynardo_py_algorithms.md#dynardo_py_algorithms.RandomVariableType), arg2: [doubleVec](stdcpp_python_export.md#stdcpp_python_export.doubleVec), arg3: float, arg4: float, arg5: float, arg6: float) + -#### AddRecalculatedBestDesignData(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [PyParameterManager](py_os_parameter.md#py_os_parameter.PyParameterManager), arg4: [PyOSDesignContainer](py_os_design.md#py_os_design.PyOSDesignContainer), arg5: [uintVec](stdcpp_python_export.md#stdcpp_python_export.uintVec), arg6: [doubleVec](stdcpp_python_export.md#stdcpp_python_export.doubleVec), arg7: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) +## *class* py_osl3binfile.OSL3Binfile + -#### ConvertBinFile(, arg2: Path [, arg3: bool]]) → object +### AddRecalculatedBestDesignData(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path), arg3: [PyParameterManager](py_os_parameter.md#py_os_parameter.PyParameterManager), arg4: [PyOSDesignContainer](py_os_design.md#py_os_design.PyOSDesignContainer), arg5: [uintVec](stdcpp_python_export.md#stdcpp_python_export.uintVec), arg6: [doubleVec](stdcpp_python_export.md#stdcpp_python_export.doubleVec), arg7: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) + -#### WriteArsmBinfile(arg2: PyParameterManager, arg3: PyOSDesignContainer, arg4: object, arg5: Path) +### ConvertBinFile(, arg2: Path [, arg3: bool]]) → object + -#### WriteDOEBinfile(arg2: PyParameterManager, arg3: PyOSDesignContainer, arg4: Path) +### WriteArsmBinfile(arg2: PyParameterManager, arg3: PyOSDesignContainer, arg4: object, arg5: Path) + -#### WriteNLPQLBinfile(arg2: PyParameterManager, arg3: PyOSDesignContainer, arg4: Path) +### WriteDOEBinfile(arg2: PyParameterManager, arg3: PyOSDesignContainer, arg4: Path) + -#### WriteNOABinfile(arg2: PyParameterManager, arg3: PyOSDesignContainer, arg4: object, arg5: Path) +### WriteNLPQLBinfile(arg2: PyParameterManager, arg3: PyOSDesignContainer, arg4: Path) + -#### WriteRobustnessBinfile(arg2: PyParameterManager, arg3: PyOSDesignContainer, arg4: PyOSDesignPoint, arg5: Path) +### WriteNOABinfile(arg2: PyParameterManager, arg3: PyOSDesignContainer, arg4: object, arg5: Path) + -#### \_\_init_\_() +### WriteRobustnessBinfile(arg2: PyParameterManager, arg3: PyOSDesignContainer, arg4: PyOSDesignPoint, arg5: Path) -#### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) + +### \_\_init_\_() -#### convert_binfile(, arg2: Path [, arg3: bool]]) → object +### \_\_init_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) + -#### write_arsm_binfile(arg2: PyParameterManager, arg3: PyOSDesignContainer, arg4: object, arg5: Path) +### convert_binfile(, arg2: Path [, arg3: bool]]) → object + -#### write_doe_binfile(arg2: PyParameterManager, arg3: PyOSDesignContainer, arg4: Path) +### write_arsm_binfile(arg2: PyParameterManager, arg3: PyOSDesignContainer, arg4: object, arg5: Path) + -#### write_nlpqlp_binfile(arg2: PyParameterManager, arg3: PyOSDesignContainer, arg4: Path) +### write_doe_binfile(arg2: PyParameterManager, arg3: PyOSDesignContainer, arg4: Path) + -#### write_noa_binfile(arg2: PyParameterManager, arg3: PyOSDesignContainer, arg4: object, arg5: Path) +### write_nlpqlp_binfile(arg2: PyParameterManager, arg3: PyOSDesignContainer, arg4: Path) + -#### write_robustness_binfile(arg2: PyParameterManager, arg3: PyOSDesignContainer, arg4: PyOSDesignPoint, arg5: Path) +### write_noa_binfile(arg2: PyParameterManager, arg3: PyOSDesignContainer, arg4: object, arg5: Path) + -### py_osl3binfile.calc_ran_parameters(arg1: [RandomVariableType](dynardo_py_algorithms.md#dynardo_py_algorithms.RandomVariableType), arg2: [doubleVec](stdcpp_python_export.md#stdcpp_python_export.doubleVec), arg3: float, arg4: float, arg5: float, arg6: float) +### write_robustness_binfile(arg2: PyParameterManager, arg3: PyOSDesignContainer, arg4: PyOSDesignPoint, arg5: Path) + + + +## py_osl3binfile.calc_ran_parameters(arg1: [RandomVariableType](dynardo_py_algorithms.md#dynardo_py_algorithms.RandomVariableType), arg2: [doubleVec](stdcpp_python_export.md#stdcpp_python_export.doubleVec), arg3: float, arg4: float, arg5: float, arg6: float) diff --git a/2025R2/optiSLang-python-api/modules/py_project.md b/2025R2/optiSLang-python-api/modules/py_project.md index e5ec91587e..885bb90780 100644 --- a/2025R2/optiSLang-python-api/modules/py_project.md +++ b/2025R2/optiSLang-python-api/modules/py_project.md @@ -1,3 +1,6 @@ + +# py_project + This module provides access to project settings. Placeholders in project can be constructed in the following way (based on a oscillator example): @@ -38,30 +41,37 @@ pm_expression_string = """ project.set_placeholder( name = 'ParameterManager', overwrite = True, expression = pm_expression_string ) ``` + + -### *class* py_project.OSLFileProvider +## *class* py_project.OSLFileProvider + -#### \_\_init_\_() +### \_\_init_\_() Raises an exception This class cannot be instantiated from Python + -### *class* py_project.Project +## *class* py_project.Project + -#### \_\_init_\_() +### \_\_init_\_() Raises an exception This class cannot be instantiated from Python + -#### assign_placeholder(actor_uuid: [UUID](id.md#id.UUID), property_id: str, placeholder_id: str) +### assign_placeholder(actor_uuid: [UUID](id.md#id.UUID), property_id: str, placeholder_id: str) Assign a placeholder in this project. + # Parameters @@ -74,6 +84,7 @@ property_id placeholder_id : Placeholder ID. + # Raises @@ -82,11 +93,13 @@ RuntimeError when property does not exist, or when placeholder type and property type does not match. + -#### create_placeholder_from_actor_property(actor_uuid: UUID, property_id: str) → str +### create_placeholder_from_actor_property(actor_uuid: UUID, property_id: str) → str Create placeholder from actor property with new id if id already exist + # Parameters @@ -99,44 +112,52 @@ property_id create_as_expression : Decide if the placeholder is created as value or as macro expression. False by default. + # Returns str : Actual ID of the generated placeholder. + # Raises RuntimeError : Raised when property id is not accessible at actor. + -#### get_actions() → [ProjectActions](#py_project.ProjectActions) +### get_actions() → [ProjectActions](#py_project.ProjectActions) Get defined actions for project. + -#### get_file_provider() → [OSLFileProvider](#py_project.OSLFileProvider) +### get_file_provider() → [OSLFileProvider](#py_project.OSLFileProvider) Get central file registration for project. + -#### get_maximum_threads() → int +### get_maximum_threads() → int Get the maximum number of threads used by this project. + -#### get_placeholder(placeholder_id: str) → dict +### get_placeholder(placeholder_id: str) → dict Get placeholder by id from this project as dict. + # Parameters placeholder_id : Placeholder ID. + # Returns @@ -163,84 +184,100 @@ type expression : Placeholder macro expression. + # Raises RuntimeError : Raised when the placeholder does not exist. + -#### get_placeholder_ids() → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) +### get_placeholder_ids() → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) Get placeholder ids from this project. + # Returns list : List of placeholder ids. + -#### get_protocol_file_path() → [Path](stdcpp_python_export.md#stdcpp_python_export.Path) +### get_protocol_file_path() → [Path](stdcpp_python_export.md#stdcpp_python_export.Path) Get the path of the protocol file. + -#### get_root_system() → [RunnableSystem](_optiSLang_Actors.md#optiSLang_Actors.RunnableSystem) +### get_root_system() → [RunnableSystem](_optiSLang_Actors.md#optiSLang_Actors.RunnableSystem) Get root system. + -#### get_run_scenario() → [ProjectRunScenario](#py_project.ProjectRunScenario) +### get_run_scenario() → [ProjectRunScenario](#py_project.ProjectRunScenario) Get run scenario for project. + -#### get_state() → [ProjectStatus](#py_project.ProjectStatus) +### get_state() → [ProjectStatus](#py_project.ProjectStatus) Get state of project. + -#### *property* name +### *property* name The project’s name as displayed. + -#### *property* project_dir +### *property* project_dir The project directory. Empty string if the project has not yet been saved. + -#### *property* project_path +### *property* project_path The project file path. Empty string if the project has not yet been saved. + -#### *property* project_working_dir +### *property* project_working_dir The project working dir path. Empty string if the project has not yet been saved. + -#### *property* reference_files_dir +### *property* reference_files_dir The reference files directory path. + -#### remove_placeholder(placeholder_id: str) +### remove_placeholder(placeholder_id: str) Remove a placeholder from this project. + # Parameters placeholder_id : Placeholder ID. + -#### rename_placeholder(existing_placdeholder_id: str, new_placdeholder_id: str) +### rename_placeholder(existing_placdeholder_id: str, new_placdeholder_id: str) Rename a placeholder in this project. + # Parameters @@ -250,27 +287,32 @@ placeholder_id new_placeholder_id : New placeholder ID. + # Raises RuntimeError : Raised when placeholder does not exist. + -#### set_actions(actions: [ProjectActions](#py_project.ProjectActions)) +### set_actions(actions: [ProjectActions](#py_project.ProjectActions)) Set defined actions for project. + -#### set_maximum_threads(num_threads: int) +### set_maximum_threads(num_threads: int) Get the maximum number of threads used by this project. + -#### set_placeholder(, name: object=None [, user_level: object=None [, description: object=None [, range: object=None [, value: object=None [, value_type: object=None [, expression: object=None [, overwrite: bool=False]]]]]]]]) → str +### set_placeholder(, name: object=None [, user_level: object=None [, description: object=None [, range: object=None [, value: object=None [, value_type: object=None [, expression: object=None [, overwrite: bool=False]]]]]]]]) → str Create a new placeholder or overwrite an existing one. + # Parameters @@ -298,28 +340,33 @@ expression overwrite : In case overwrite is True and placeholder is found by name, specified attributes will be overwritten. A new placeholder is created otherwise. False by default. + # Returns str : Actual ID of the generated/modified placeholder. + # Raises RuntimeError : Raised when the placeholder cannot be created/modified. + -#### *property* settings +### *property* settings Project settings. + -#### unassign_placeholder(actor_uuid: UUID, placeholder: str id) +### unassign_placeholder(actor_uuid: UUID, placeholder: str id) Remove a placeholder assignment in this project. + # Parameters @@ -329,386 +376,481 @@ actor_uuid property_id : Property ID. + -### *class* py_project.ProjectAction +## *class* py_project.ProjectAction + -#### \_\_init_\_() +### \_\_init_\_() Raises an exception This class cannot be instantiated from Python + -#### *property* name +### *property* name Action name. + -#### *property* point +### *property* point Action point. + -#### type() → [ProjectActionType](#py_project.ProjectActionType) +### type() → [ProjectActionType](#py_project.ProjectActionType) Action type. + -### *class* py_project.ProjectActionList +## *class* py_project.ProjectActionList + -#### \_\_contains_\_(arg2: object) → bool +### \_\_contains_\_(arg2: object) → bool + -#### \_\_delitem_\_(arg2: object) +### \_\_delitem_\_(arg2: object) + -#### \_\_getitem_\_(arg2: object) → object +### \_\_getitem_\_(arg2: object) → object + -#### \_\_init_\_() +### \_\_init_\_() + -#### \_\_iter_\_() → object +### \_\_iter_\_() → object + -#### \_\_len_\_() → int +### \_\_len_\_() → int + -#### \_\_setitem_\_(arg2: object, arg3: object) +### \_\_setitem_\_(arg2: object, arg3: object) + -#### append(arg2: object) +### append(arg2: object) + -#### extend(arg2: object) +### extend(arg2: object) + -#### push(action: [ProjectAction](#py_project.ProjectAction)) +### push(action: [ProjectAction](#py_project.ProjectAction)) + -#### size() → int +### size() → int + -### *class* py_project.ProjectActionPoint +## *class* py_project.ProjectActionPoint **Enumeration** Enumerates possible project action points. + -#### PROJECT_ACTION_POINT_ANY *= py_project.ProjectActionPoint.PROJECT_ACTION_POINT_ANY* +### PROJECT_ACTION_POINT_ANY *= py_project.ProjectActionPoint.PROJECT_ACTION_POINT_ANY* + -#### PROJECT_ACTION_POINT_NONE *= py_project.ProjectActionPoint.PROJECT_ACTION_POINT_NONE* +### PROJECT_ACTION_POINT_NONE *= py_project.ProjectActionPoint.PROJECT_ACTION_POINT_NONE* + -#### PROJECT_ACTION_POINT_ON_PROJECT_ABOUT_TO_START *= py_project.ProjectActionPoint.PROJECT_ACTION_POINT_ON_PROJECT_ABOUT_TO_START* +### PROJECT_ACTION_POINT_ON_PROJECT_ABOUT_TO_START *= py_project.ProjectActionPoint.PROJECT_ACTION_POINT_ON_PROJECT_ABOUT_TO_START* + -#### PROJECT_ACTION_POINT_ON_PROJECT_OPEN *= py_project.ProjectActionPoint.PROJECT_ACTION_POINT_ON_PROJECT_OPEN* +### PROJECT_ACTION_POINT_ON_PROJECT_OPEN *= py_project.ProjectActionPoint.PROJECT_ACTION_POINT_ON_PROJECT_OPEN* + -#### PROJECT_ACTION_POINT_ON_PROJECT_OPENED *= py_project.ProjectActionPoint.PROJECT_ACTION_POINT_ON_PROJECT_OPENED* +### PROJECT_ACTION_POINT_ON_PROJECT_OPENED *= py_project.ProjectActionPoint.PROJECT_ACTION_POINT_ON_PROJECT_OPENED* + -#### PROJECT_ACTION_POINT_ON_PROJECT_SAVE *= py_project.ProjectActionPoint.PROJECT_ACTION_POINT_ON_PROJECT_SAVE* +### PROJECT_ACTION_POINT_ON_PROJECT_SAVE *= py_project.ProjectActionPoint.PROJECT_ACTION_POINT_ON_PROJECT_SAVE* + -#### PROJECT_ACTION_POINT_ON_PROJECT_SAVED *= py_project.ProjectActionPoint.PROJECT_ACTION_POINT_ON_PROJECT_SAVED* +### PROJECT_ACTION_POINT_ON_PROJECT_SAVED *= py_project.ProjectActionPoint.PROJECT_ACTION_POINT_ON_PROJECT_SAVED* + -#### PROJECT_ACTION_POINT_ON_PROJECT_STARTED *= py_project.ProjectActionPoint.PROJECT_ACTION_POINT_ON_PROJECT_STARTED* +### PROJECT_ACTION_POINT_ON_PROJECT_STARTED *= py_project.ProjectActionPoint.PROJECT_ACTION_POINT_ON_PROJECT_STARTED* + -#### PROJECT_ACTION_POINT_ON_PROJECT_STOPPED *= py_project.ProjectActionPoint.PROJECT_ACTION_POINT_ON_PROJECT_STOPPED* +### PROJECT_ACTION_POINT_ON_PROJECT_STOPPED *= py_project.ProjectActionPoint.PROJECT_ACTION_POINT_ON_PROJECT_STOPPED* + -#### PROJECT_ACTION_POINT_ON_PROJECT_STOP_REQUESTED *= py_project.ProjectActionPoint.PROJECT_ACTION_POINT_ON_PROJECT_STOP_REQUESTED* +### PROJECT_ACTION_POINT_ON_PROJECT_STOP_REQUESTED *= py_project.ProjectActionPoint.PROJECT_ACTION_POINT_ON_PROJECT_STOP_REQUESTED* + -### *class* py_project.ProjectActionRunScript +## *class* py_project.ProjectActionRunScript + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str, arg3: str, arg4: [ProjectActionPoint](#py_project.ProjectActionPoint)) +### \_\_init_\_(arg2: str, arg3: str, arg4: [ProjectActionPoint](#py_project.ProjectActionPoint)) + -#### *property* script +### *property* script Script content to execute. + -### *class* py_project.ProjectActionRunScriptFile +## *class* py_project.ProjectActionRunScriptFile + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str, arg3: [ProvidedPath](py_file_access.md#py_file_access.ProvidedPath), arg4: [ProjectActionPoint](#py_project.ProjectActionPoint)) +### \_\_init_\_(arg2: str, arg3: [ProvidedPath](py_file_access.md#py_file_access.ProvidedPath), arg4: [ProjectActionPoint](#py_project.ProjectActionPoint)) + -#### *property* script +### *property* script Script file to execute. + -### *class* py_project.ProjectActionType +## *class* py_project.ProjectActionType **Enumeration** Enumerates possible project action types. + -#### PROJECT_ACTION_RUN_SCRIPT *= py_project.ProjectActionType.PROJECT_ACTION_RUN_SCRIPT* +### PROJECT_ACTION_RUN_SCRIPT *= py_project.ProjectActionType.PROJECT_ACTION_RUN_SCRIPT* + -#### PROJECT_ACTION_RUN_SCRIPT_FILE *= py_project.ProjectActionType.PROJECT_ACTION_RUN_SCRIPT_FILE* +### PROJECT_ACTION_RUN_SCRIPT_FILE *= py_project.ProjectActionType.PROJECT_ACTION_RUN_SCRIPT_FILE* + -### *class* py_project.ProjectActions +## *class* py_project.ProjectActions + -#### \_\_init_\_() +### \_\_init_\_() + -#### *property* actions +### *property* actions Actions container. + -#### contains(name: str) → bool +### contains(name: str) → bool Test if action exists. + -#### register(action: [ProjectAction](#py_project.ProjectAction)) → bool +### register(action: [ProjectAction](#py_project.ProjectAction)) → bool Register project action. + -#### unique_name(base: str) → str +### unique_name(base: str) → str Get unique action name. + -#### unregister(name: str) → bool +### unregister(name: str) → bool Unregister project action by name. + -### *class* py_project.ProjectFilenameEscape +## *class* py_project.ProjectFilenameEscape **Enumeration** Enumerates possible filename escape modes. + -#### PROJECT_FE_FULL *= py_project.ProjectFilenameEscape.PROJECT_FE_FULL* +### PROJECT_FE_FULL *= py_project.ProjectFilenameEscape.PROJECT_FE_FULL* + -#### PROJECT_FE_RESERVED_ONLY *= py_project.ProjectFilenameEscape.PROJECT_FE_RESERVED_ONLY* +### PROJECT_FE_RESERVED_ONLY *= py_project.ProjectFilenameEscape.PROJECT_FE_RESERVED_ONLY* + -### *class* py_project.ProjectRunScenario +## *class* py_project.ProjectRunScenario **Enumeration** Enumerates possible project run scenarios. + -#### PROJECT_RUN_SCENARIO_ABORTED *= py_project.ProjectRunScenario.PROJECT_RUN_SCENARIO_ABORTED* +### PROJECT_RUN_SCENARIO_ABORTED *= py_project.ProjectRunScenario.PROJECT_RUN_SCENARIO_ABORTED* + -#### PROJECT_RUN_SCENARIO_FINISHED *= py_project.ProjectRunScenario.PROJECT_RUN_SCENARIO_FINISHED* +### PROJECT_RUN_SCENARIO_FINISHED *= py_project.ProjectRunScenario.PROJECT_RUN_SCENARIO_FINISHED* + -#### PROJECT_RUN_SCENARIO_MODIFIED_ALL *= py_project.ProjectRunScenario.PROJECT_RUN_SCENARIO_MODIFIED_ALL* +### PROJECT_RUN_SCENARIO_MODIFIED_ALL *= py_project.ProjectRunScenario.PROJECT_RUN_SCENARIO_MODIFIED_ALL* + -#### PROJECT_RUN_SCENARIO_MODIFIED_SOME *= py_project.ProjectRunScenario.PROJECT_RUN_SCENARIO_MODIFIED_SOME* +### PROJECT_RUN_SCENARIO_MODIFIED_SOME *= py_project.ProjectRunScenario.PROJECT_RUN_SCENARIO_MODIFIED_SOME* + -#### PROJECT_RUN_SCENARIO_PARTIAL *= py_project.ProjectRunScenario.PROJECT_RUN_SCENARIO_PARTIAL* +### PROJECT_RUN_SCENARIO_PARTIAL *= py_project.ProjectRunScenario.PROJECT_RUN_SCENARIO_PARTIAL* + -#### PROJECT_RUN_SCENARIO_PAUSED *= py_project.ProjectRunScenario.PROJECT_RUN_SCENARIO_PAUSED* +### PROJECT_RUN_SCENARIO_PAUSED *= py_project.ProjectRunScenario.PROJECT_RUN_SCENARIO_PAUSED* + -#### PROJECT_RUN_SCENARIO_PRISTINE *= py_project.ProjectRunScenario.PROJECT_RUN_SCENARIO_PRISTINE* +### PROJECT_RUN_SCENARIO_PRISTINE *= py_project.ProjectRunScenario.PROJECT_RUN_SCENARIO_PRISTINE* + -### *class* py_project.ProjectSettings +## *class* py_project.ProjectSettings + -#### \_\_init_\_() +### \_\_init_\_() + -#### *property* actors_ignore_predecessor_failure +### *property* actors_ignore_predecessor_failure Actors ignore predecessor failure flag. + -#### *property* auto_save_enabled +### *property* auto_save_enabled Auto save enabled flag. + -#### *property* custom_location +### *property* custom_location Custom working directory location. + -#### *property* filename_escape_mode +### *property* filename_escape_mode Filename escape mode. + -#### *property* hide_number_of_message_queue_threads_warning +### *property* hide_number_of_message_queue_threads_warning Hide number of message queue threads warning flag. + -#### *property* maximum_auto_relocation_depth +### *property* maximum_auto_relocation_depth Maximum auto relocation depth. + -#### *property* number_of_message_queue_threads +### *property* number_of_message_queue_threads Number of message queue threads. + -#### *property* project_actions +### *property* project_actions Project actions. + -#### *property* project_id +### *property* project_id Project id. + -#### *property* project_manager_id +### *property* project_manager_id Project manager id. + -#### *property* purge_on_save +### *property* purge_on_save Purge on save flag. + -#### *property* reference_files_directory_name +### *property* reference_files_directory_name Reference files directory name. + -#### *property* remove_empty_directories_on_purge +### *property* remove_empty_directories_on_purge Remove empty directories on purge flag. + -#### *property* short_description +### *property* short_description Project short description. + -#### *property* show_conditional_exec_ui +### *property* show_conditional_exec_ui Conditional execution ui visibility flag. + -#### *property* show_environment_ui +### *property* show_environment_ui Environment ui visibility flag. + -#### *property* show_files_ui +### *property* show_files_ui Files ui visibility flag. + -#### *property* show_placeholders_ui +### *property* show_placeholders_ui Placeholders ui visibility flag. + -#### *property* show_run_options_ui +### *property* show_run_options_ui Run options ui visibility flag. + -#### *property* show_variables_ui +### *property* show_variables_ui Variables ui visibility flag. + -#### *property* working_data_storage +### *property* working_data_storage Working data storage mode. + -#### *property* working_directory_location +### *property* working_directory_location Working directory location. + -### *class* py_project.ProjectStatus +## *class* py_project.ProjectStatus **Enumeration** Enumerates possible project states. + -#### PROJECT_STATUS_ABORTED *= py_project.ProjectStatus.PROJECT_STATUS_ABORTED* +### PROJECT_STATUS_ABORTED *= py_project.ProjectStatus.PROJECT_STATUS_ABORTED* + -#### PROJECT_STATUS_ABORT_REQUESTED *= py_project.ProjectStatus.PROJECT_STATUS_ABORT_REQUESTED* +### PROJECT_STATUS_ABORT_REQUESTED *= py_project.ProjectStatus.PROJECT_STATUS_ABORT_REQUESTED* + -#### PROJECT_STATUS_FINISHED *= py_project.ProjectStatus.PROJECT_STATUS_FINISHED* +### PROJECT_STATUS_FINISHED *= py_project.ProjectStatus.PROJECT_STATUS_FINISHED* + -#### PROJECT_STATUS_IDLE *= py_project.ProjectStatus.PROJECT_STATUS_IDLE* +### PROJECT_STATUS_IDLE *= py_project.ProjectStatus.PROJECT_STATUS_IDLE* + -#### PROJECT_STATUS_PAUSED *= py_project.ProjectStatus.PROJECT_STATUS_PAUSED* +### PROJECT_STATUS_PAUSED *= py_project.ProjectStatus.PROJECT_STATUS_PAUSED* + -#### PROJECT_STATUS_PAUSE_REQUESTED *= py_project.ProjectStatus.PROJECT_STATUS_PAUSE_REQUESTED* +### PROJECT_STATUS_PAUSE_REQUESTED *= py_project.ProjectStatus.PROJECT_STATUS_PAUSE_REQUESTED* + -#### PROJECT_STATUS_PROCESSING *= py_project.ProjectStatus.PROJECT_STATUS_PROCESSING* +### PROJECT_STATUS_PROCESSING *= py_project.ProjectStatus.PROJECT_STATUS_PROCESSING* + -#### PROJECT_STATUS_STOPPED *= py_project.ProjectStatus.PROJECT_STATUS_STOPPED* +### PROJECT_STATUS_STOPPED *= py_project.ProjectStatus.PROJECT_STATUS_STOPPED* + -#### PROJECT_STATUS_STOP_REQUESTED *= py_project.ProjectStatus.PROJECT_STATUS_STOP_REQUESTED* +### PROJECT_STATUS_STOP_REQUESTED *= py_project.ProjectStatus.PROJECT_STATUS_STOP_REQUESTED* + -### *class* py_project.ProjectWorkingDataStorage +## *class* py_project.ProjectWorkingDataStorage **Enumeration** Enumerates possible project working data storage modes. + -#### PROJECT_WDL_EXTERNAL *= py_project.ProjectWorkingDataStorage.PROJECT_WDL_EXTERNAL* +### PROJECT_WDL_EXTERNAL *= py_project.ProjectWorkingDataStorage.PROJECT_WDL_EXTERNAL* + -#### PROJECT_WDS_EMBEDDED *= py_project.ProjectWorkingDataStorage.PROJECT_WDS_EMBEDDED* +### PROJECT_WDS_EMBEDDED *= py_project.ProjectWorkingDataStorage.PROJECT_WDS_EMBEDDED* + -### *class* py_project.ProjectWorkingDirectoryLocation +## *class* py_project.ProjectWorkingDirectoryLocation **Enumeration** Enumerates possible project working diretory locations. + -#### PROJECT_WDL_ALONGSIDE_PROJECT *= py_project.ProjectWorkingDirectoryLocation.PROJECT_WDL_ALONGSIDE_PROJECT* +### PROJECT_WDL_ALONGSIDE_PROJECT *= py_project.ProjectWorkingDirectoryLocation.PROJECT_WDL_ALONGSIDE_PROJECT* + -#### PROJECT_WDL_CUSTOM *= py_project.ProjectWorkingDirectoryLocation.PROJECT_WDL_CUSTOM* +### PROJECT_WDL_CUSTOM *= py_project.ProjectWorkingDirectoryLocation.PROJECT_WDL_CUSTOM* diff --git a/2025R2/optiSLang-python-api/modules/py_random_variables.md b/2025R2/optiSLang-python-api/modules/py_random_variables.md index fe1dda1b6b..95eb7fb9c9 100644 --- a/2025R2/optiSLang-python-api/modules/py_random_variables.md +++ b/2025R2/optiSLang-python-api/modules/py_random_variables.md @@ -1,71 +1,96 @@ + -### *class* py_random_variables.FitRV +# py_random_variables + -#### \_\_init_\_() +## *class* py_random_variables.FitRV -#### \_\_init_\_(arg2: [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type)) + -#### \_\_init_\_(arg2: [vector_type](dynardo_py_algorithms.md#dynardo_py_algorithms.vector_type)) +### \_\_init_\_() -#### \_\_init_\_(arg2: [vector_type](dynardo_py_algorithms.md#dynardo_py_algorithms.vector_type), arg3: str) +### \_\_init_\_(arg2: [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type)) +### \_\_init_\_(arg2: [vector_type](dynardo_py_algorithms.md#dynardo_py_algorithms.vector_type)) -#### get_cdf(arg2: float) → float +### \_\_init_\_(arg2: [vector_type](dynardo_py_algorithms.md#dynardo_py_algorithms.vector_type), arg3: str) + -#### get_cdf_inv(arg2: float) → float +### get_cdf(arg2: float) → float + -#### get_mean() → float +### get_cdf_inv(arg2: float) → float + -#### get_moments(arg2: int) → float +### get_mean() → float + -#### get_name() → str +### get_moments(arg2: int) → float + -#### get_num_moments() → int +### get_name() → str + -#### get_num_parameters() → int +### get_num_moments() → int + -#### get_parameter(arg2: int) → float +### get_num_parameters() → int + -#### get_pdf(arg2: float) → float +### get_parameter(arg2: int) → float + -#### get_stddev() → float +### get_pdf(arg2: float) → float + -#### is_valid() → bool +### get_stddev() → float + -#### set_moments(arg2: [vector_type](dynardo_py_algorithms.md#dynardo_py_algorithms.vector_type)) +### is_valid() → bool + -#### set_parameters(arg2: [vector_type](dynardo_py_algorithms.md#dynardo_py_algorithms.vector_type)) +### set_moments(arg2: [vector_type](dynardo_py_algorithms.md#dynardo_py_algorithms.vector_type)) + -### *class* py_random_variables.RVSet +### set_parameters(arg2: [vector_type](dynardo_py_algorithms.md#dynardo_py_algorithms.vector_type)) + -#### \_\_init_\_(parameter: PyParameterManager manager, design: PyOSDesignPoint point to extract from) → object +## *class* py_random_variables.RVSet + + + +### \_\_init_\_(parameter: PyParameterManager manager, design: PyOSDesignPoint point to extract from) → object Extract mixed and stochastic parameters from a design point and convert them into an RVSet. + -### *class* py_random_variables.RVSet_Independent +## *class* py_random_variables.RVSet_Independent + -#### \_\_init_\_() +### \_\_init_\_() + -### *class* py_random_variables.RVSet_Nataf +## *class* py_random_variables.RVSet_Nataf + -#### \_\_init_\_() +### \_\_init_\_() diff --git a/2025R2/optiSLang-python-api/modules/py_reliability_adaptive.md b/2025R2/optiSLang-python-api/modules/py_reliability_adaptive.md index e69de29bb2..638b51a78d 100644 --- a/2025R2/optiSLang-python-api/modules/py_reliability_adaptive.md +++ b/2025R2/optiSLang-python-api/modules/py_reliability_adaptive.md @@ -0,0 +1,4 @@ + + + +# py_reliability_adaptive diff --git a/2025R2/optiSLang-python-api/modules/py_reliability_montecarlo.md b/2025R2/optiSLang-python-api/modules/py_reliability_montecarlo.md index 6c6c4817e4..2868c2d406 100644 --- a/2025R2/optiSLang-python-api/modules/py_reliability_montecarlo.md +++ b/2025R2/optiSLang-python-api/modules/py_reliability_montecarlo.md @@ -1,38 +1,52 @@ + -### *class* py_reliability_montecarlo.ReliabilityMonteCarlo +# py_reliability_montecarlo + + + +## *class* py_reliability_montecarlo.ReliabilityMonteCarlo This algorithm implements Monte Carlo sampling. The algorithm can be controlled either by a predefined number of samples, or by a desired accuracy (c.o.v.) of the estimator of Pf (or of (1-Pf) if Pf>0.5). In the latter case, the number of required samples will be selected by the algorithm during the iteration. The convergence test is carried out after each request of n parallel designs. If the desired accuracy can not be reached within the maximum allowed number of samples, the algorithm terminates without success. If any of the solver requests fails (success_info=false for a specific design) the algorithm either ignores this design, or it counts it as a failure event. + -#### \_\_init_\_() +### \_\_init_\_() + -### *class* py_reliability_montecarlo.SettingsMonteCarlo +## *class* py_reliability_montecarlo.SettingsMonteCarlo Reliability algorithm settings for Monte Carlo. + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [RVSet](py_random_variables.md#py_random_variables.RVSet), arg3: int) +### \_\_init_\_(arg2: [RVSet](py_random_variables.md#py_random_variables.RVSet), arg3: int) + -#### *property* accuracy +### *property* accuracy + -#### *property* automatic_sample_size +### *property* automatic_sample_size + -#### *property* min_num_samples +### *property* min_num_samples + -#### *property* num_designs_per_sample +### *property* num_designs_per_sample + -#### *property* num_total_samples +### *property* num_total_samples + -#### *property* scaling_factor +### *property* scaling_factor diff --git a/2025R2/optiSLang-python-api/modules/py_transform.md b/2025R2/optiSLang-python-api/modules/py_transform.md index cc7661c9e7..3486f31a9a 100644 --- a/2025R2/optiSLang-python-api/modules/py_transform.md +++ b/2025R2/optiSLang-python-api/modules/py_transform.md @@ -1,52 +1,70 @@ + -### py_transform.DesignToVector(arg1: [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint), arg2: [DPropList](py_os_parameter.md#py_os_parameter.DPropList), arg3: bool) → [vector_type](dynardo_py_algorithms.md#dynardo_py_algorithms.vector_type) +# py_transform + -### py_transform.DesigncontainerToMatrix(arg1: [PyOSDesignPointContainer](py_os_design.md#py_os_design.PyOSDesignPointContainer), arg2: [DPropList](py_os_parameter.md#py_os_parameter.DPropList), arg3: bool) → [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type) +## py_transform.DesignToVector(arg1: [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint), arg2: [DPropList](py_os_parameter.md#py_os_parameter.DPropList), arg3: bool) → [vector_type](dynardo_py_algorithms.md#dynardo_py_algorithms.vector_type) + -### py_transform.MatrixToDesigncontainer(arg1: [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type), arg2: [DPropList](py_os_parameter.md#py_os_parameter.DPropList), arg3: bool) → [PyOSDesignPointContainer](py_os_design.md#py_os_design.PyOSDesignPointContainer) +## py_transform.DesigncontainerToMatrix(arg1: [PyOSDesignPointContainer](py_os_design.md#py_os_design.PyOSDesignPointContainer), arg2: [DPropList](py_os_parameter.md#py_os_parameter.DPropList), arg3: bool) → [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type) + -### *class* py_transform.TransformationFlags +## py_transform.MatrixToDesigncontainer(arg1: [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type), arg2: [DPropList](py_os_parameter.md#py_os_parameter.DPropList), arg3: bool) → [PyOSDesignPointContainer](py_os_design.md#py_os_design.PyOSDesignPointContainer) + + + +## *class* py_transform.TransformationFlags **Enumeration** + -#### AllProps *= py_transform.TransformationFlags.AllProps* +### AllProps *= py_transform.TransformationFlags.AllProps* + -#### DetProps *= py_transform.TransformationFlags.DetProps* +### DetProps *= py_transform.TransformationFlags.DetProps* + -#### NoTransformation *= py_transform.TransformationFlags.NoTransformation* +### NoTransformation *= py_transform.TransformationFlags.NoTransformation* + -#### RanProps *= py_transform.TransformationFlags.RanProps* +### RanProps *= py_transform.TransformationFlags.RanProps* + -### py_transform.VectorToDesign(arg1: [vector_type](dynardo_py_algorithms.md#dynardo_py_algorithms.vector_type), arg2: [DPropList](py_os_parameter.md#py_os_parameter.DPropList), arg3: bool) → [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint) +## py_transform.VectorToDesign(arg1: [vector_type](dynardo_py_algorithms.md#dynardo_py_algorithms.vector_type), arg2: [DPropList](py_os_parameter.md#py_os_parameter.DPropList), arg3: bool) → [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint) + -### py_transform.design_point_to_rv_set(arg1: [PyParameterManager](py_os_parameter.md#py_os_parameter.PyParameterManager), arg2: [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint)) → [RVSet](py_random_variables.md#py_random_variables.RVSet) +## py_transform.design_point_to_rv_set(arg1: [PyParameterManager](py_os_parameter.md#py_os_parameter.PyParameterManager), arg2: [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint)) → [RVSet](py_random_variables.md#py_random_variables.RVSet) + -### py_transform.design_to_standard_gauss(arg1: [PyOSDesignPointContainer](py_os_design.md#py_os_design.PyOSDesignPointContainer), arg2: [RVSet](py_random_variables.md#py_random_variables.RVSet)) → [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type) +## py_transform.design_to_standard_gauss(arg1: [PyOSDesignPointContainer](py_os_design.md#py_os_design.PyOSDesignPointContainer), arg2: [RVSet](py_random_variables.md#py_random_variables.RVSet)) → [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type) + -### py_transform.design_to_unit_cube(arg1: [PyOSDesignPointContainer](py_os_design.md#py_os_design.PyOSDesignPointContainer), arg2: [PyParameterManager](py_os_parameter.md#py_os_parameter.PyParameterManager), arg3: [TransformationFlags](#py_transform.TransformationFlags), arg4: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList), arg5: [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint)) → [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type) +## py_transform.design_to_unit_cube(arg1: [PyOSDesignPointContainer](py_os_design.md#py_os_design.PyOSDesignPointContainer), arg2: [PyParameterManager](py_os_parameter.md#py_os_parameter.PyParameterManager), arg3: [TransformationFlags](#py_transform.TransformationFlags), arg4: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList), arg5: [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint)) → [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type) -### py_transform.design_to_unit_cube(arg1: [PyOSDesignPointContainer](py_os_design.md#py_os_design.PyOSDesignPointContainer), arg2: [DPropList](py_os_parameter.md#py_os_parameter.DPropList)) → [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type) +## py_transform.design_to_unit_cube(arg1: [PyOSDesignPointContainer](py_os_design.md#py_os_design.PyOSDesignPointContainer), arg2: [DPropList](py_os_parameter.md#py_os_parameter.DPropList)) → [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type) -### py_transform.design_to_unit_cube(arg1: [PyOSDesignPointContainer](py_os_design.md#py_os_design.PyOSDesignPointContainer), arg2: [RVSet](py_random_variables.md#py_random_variables.RVSet)) → [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type) +## py_transform.design_to_unit_cube(arg1: [PyOSDesignPointContainer](py_os_design.md#py_os_design.PyOSDesignPointContainer), arg2: [RVSet](py_random_variables.md#py_random_variables.RVSet)) → [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type) + -### py_transform.standard_gauss_to_design(arg1: [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type), arg2: [RVSet](py_random_variables.md#py_random_variables.RVSet)) → [PyOSDesignPointContainer](py_os_design.md#py_os_design.PyOSDesignPointContainer) +## py_transform.standard_gauss_to_design(arg1: [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type), arg2: [RVSet](py_random_variables.md#py_random_variables.RVSet)) → [PyOSDesignPointContainer](py_os_design.md#py_os_design.PyOSDesignPointContainer) + -### py_transform.unit_cube_to_design(arg1: [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type), arg2: [PyParameterManager](py_os_parameter.md#py_os_parameter.PyParameterManager), arg3: [TransformationFlags](#py_transform.TransformationFlags), arg4: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList), arg5: [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint)) → [PyOSDesignPointContainer](py_os_design.md#py_os_design.PyOSDesignPointContainer) +## py_transform.unit_cube_to_design(arg1: [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type), arg2: [PyParameterManager](py_os_parameter.md#py_os_parameter.PyParameterManager), arg3: [TransformationFlags](#py_transform.TransformationFlags), arg4: [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList), arg5: [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint)) → [PyOSDesignPointContainer](py_os_design.md#py_os_design.PyOSDesignPointContainer) -### py_transform.unit_cube_to_design(arg1: [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type), arg2: [DPropList](py_os_parameter.md#py_os_parameter.DPropList)) → [PyOSDesignPointContainer](py_os_design.md#py_os_design.PyOSDesignPointContainer) +## py_transform.unit_cube_to_design(arg1: [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type), arg2: [DPropList](py_os_parameter.md#py_os_parameter.DPropList)) → [PyOSDesignPointContainer](py_os_design.md#py_os_design.PyOSDesignPointContainer) -### py_transform.unit_cube_to_design(arg1: [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type), arg2: [RVSet](py_random_variables.md#py_random_variables.RVSet)) → [PyOSDesignPointContainer](py_os_design.md#py_os_design.PyOSDesignPointContainer) +## py_transform.unit_cube_to_design(arg1: [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type), arg2: [RVSet](py_random_variables.md#py_random_variables.RVSet)) → [PyOSDesignPointContainer](py_os_design.md#py_os_design.PyOSDesignPointContainer) diff --git a/2025R2/optiSLang-python-api/modules/pyvariant.md b/2025R2/optiSLang-python-api/modules/pyvariant.md index 98a898c073..8c9815800a 100644 --- a/2025R2/optiSLang-python-api/modules/pyvariant.md +++ b/2025R2/optiSLang-python-api/modules/pyvariant.md @@ -1,57 +1,75 @@ + -### *class* pyvariant.InterpolationType +# pyvariant + + + +## *class* pyvariant.InterpolationType **Enumeration** + -#### Linear *= pyvariant.InterpolationType.Linear* +### Linear *= pyvariant.InterpolationType.Linear* + -#### Quadratic *= pyvariant.InterpolationType.Quadratic* +### Quadratic *= pyvariant.InterpolationType.Quadratic* + -#### Spline *= pyvariant.InterpolationType.Spline* +### Spline *= pyvariant.InterpolationType.Spline* + -### *class* pyvariant.VariantD +## *class* pyvariant.VariantD + -#### \_\_add_\_(arg2: [VariantD](#pyvariant.VariantD)) → object +### \_\_add_\_(arg2: [VariantD](#pyvariant.VariantD)) → object + -#### \_\_complex_\_() → object +### \_\_complex_\_() → object + -#### \_\_eq_\_(arg2: [VariantD](#pyvariant.VariantD)) → object +### \_\_eq_\_(arg2: [VariantD](#pyvariant.VariantD)) → object + -#### \_\_ge_\_(arg2: [VariantD](#pyvariant.VariantD)) → object +### \_\_ge_\_(arg2: [VariantD](#pyvariant.VariantD)) → object + -#### \_\_getinitargs_\_() → tuple +### \_\_getinitargs_\_() → tuple + -#### \_\_getstate_\_() → tuple +### \_\_getstate_\_() → tuple + -#### \_\_getstate_manages_dict_\_ *= True* +### \_\_getstate_manages_dict_\_ *= True* + -#### \_\_gt_\_(arg2: [VariantD](#pyvariant.VariantD)) → object +### \_\_gt_\_(arg2: [VariantD](#pyvariant.VariantD)) → object + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: float, arg3: float) +### \_\_init_\_(arg2: float, arg3: float) -#### \_\_init_\_(scalar_value: object) → object +### \_\_init_\_(scalar_value: object) → object -#### \_\_init_\_(row: list) → object +### \_\_init_\_(row: list) → object -#### \_\_init_\_(channels: list, abscissa: list) → object +### \_\_init_\_(channels: list, abscissa: list) → object -#### \_\_init_\_(channels: list, abscissa: list, transpose: bool) → object +### \_\_init_\_(channels: list, abscissa: list, transpose: bool) → object [2] Create a scalar variant using Python’s builtin types. Accepts bool, integer, float and complex. @@ -61,37 +79,47 @@ [5] Create a signal or xydata by passing channels and abscissa as nested lists resp. list. The matrix containing the channels can be transposed on demand. + -#### \_\_le_\_(arg2: [VariantD](#pyvariant.VariantD)) → object +### \_\_le_\_(arg2: [VariantD](#pyvariant.VariantD)) → object + -#### \_\_lt_\_(arg2: [VariantD](#pyvariant.VariantD)) → object +### \_\_lt_\_(arg2: [VariantD](#pyvariant.VariantD)) → object + -#### \_\_mul_\_(arg2: [VariantD](#pyvariant.VariantD)) → object +### \_\_mul_\_(arg2: [VariantD](#pyvariant.VariantD)) → object + -#### \_\_repr_\_() → object +### \_\_repr_\_() → object + -#### \_\_safe_for_unpickling_\_ *= True* +### \_\_safe_for_unpickling_\_ *= True* + -#### \_\_setstate_\_(arg2: tuple) +### \_\_setstate_\_(arg2: tuple) + -#### \_\_str_\_() → object +### \_\_str_\_() → object + -#### \_\_sub_\_(arg2: [VariantD](#pyvariant.VariantD)) → object +### \_\_sub_\_(arg2: [VariantD](#pyvariant.VariantD)) → object + -#### \_\_truediv_\_(arg2: [VariantD](#pyvariant.VariantD)) → object +### \_\_truediv_\_(arg2: [VariantD](#pyvariant.VariantD)) → object + -#### get_value(row: int) → complex +### get_value(row: int) → complex -#### get_value(row: int, col: int) → complex +### get_value(row: int, col: int) → complex [0] Return the complex value from index (row). @@ -114,8 +142,9 @@ print('Value from index ({}, {}) is {}.'.format(row, col, variant.get_value(row, # Value from index (0, 1) is 0.2. ``` + -#### size1() → int +### size1() → int Return the length of dimension 1. If VariantD is a scalar, size1 is equal to ‘1’. @@ -131,8 +160,9 @@ print('size1 of variant is {}.'.format(variant.size1())) # size1 of variant is 1. ``` + -#### size2() → int +### size2() → int Return the length of dimension 2. If VariantD is a scalar or vector, size2 is equal to ‘1’. @@ -147,8 +177,9 @@ print('size2 of variant is {}.'.format(variant.size2())) # size2 of variant is 3. ``` + -### pyvariant.extract_abscissae(item: [VariantD](#pyvariant.VariantD)) → [VariantD](#pyvariant.VariantD) +## pyvariant.extract_abscissae(item: [VariantD](#pyvariant.VariantD)) → [VariantD](#pyvariant.VariantD) Extract the abscissae from ‘item’ and returns a VariantD vector. If ‘item’ is a matrix, the first matrix row will be extracted. @@ -165,8 +196,9 @@ print(extract_abscissae(variant)) # (2,0) ``` + -### pyvariant.extract_channel(item: [VariantD](#pyvariant.VariantD), axis_nr: int) → [VariantD](#pyvariant.VariantD) +## pyvariant.extract_channel(item: [VariantD](#pyvariant.VariantD), axis_nr: int) → [VariantD](#pyvariant.VariantD) Extract a channel ‘axis_nr’ from ‘item’ and returns a VariantD vector. If ‘item’ is a matrix, extract_channel returns the row number ‘axis_nr’. @@ -183,8 +215,9 @@ print(extract_channel(variant, 1)) # (0.3,0) ``` + -### pyvariant.get_boolean(item: [VariantD](#pyvariant.VariantD)) → bool +## pyvariant.get_boolean(item: [VariantD](#pyvariant.VariantD)) → bool Return the value if ‘item’ is a boolean. @@ -195,8 +228,9 @@ print(get_boolean(variant)) # True ``` + -### pyvariant.get_scalar(item: [VariantD](#pyvariant.VariantD)) → complex +## pyvariant.get_scalar(item: [VariantD](#pyvariant.VariantD)) → complex Return the complex value if ‘item’ is a scalar. @@ -207,13 +241,15 @@ print(get_scalar(variant)) # (1.0+0j) ``` + -### pyvariant.interpolate(signal: VariantD) → [VariantD](#pyvariant.VariantD) +## pyvariant.interpolate(signal: VariantD) → [VariantD](#pyvariant.VariantD) Perform interpolation on input signal. Optionally pass a value for x-increment and interpolation type. + -### pyvariant.is_boolean(item: [VariantD](#pyvariant.VariantD)) → bool +## pyvariant.is_boolean(item: [VariantD](#pyvariant.VariantD)) → bool Return ‘True’ if ‘item’ is a bool value and ‘False’ otherwise. @@ -225,8 +261,9 @@ print(is_boolean(variant_a), is_boolean(variant_b)) # False True ``` + -### pyvariant.is_matrix(item: [VariantD](#pyvariant.VariantD)) → bool +## pyvariant.is_matrix(item: [VariantD](#pyvariant.VariantD)) → bool Return ‘True’ if ‘item’ is a matrix and ‘False’ otherwise. @@ -238,8 +275,9 @@ print(is_matrix(variant_a), is_matrix(variant_b)) # False True ``` + -### pyvariant.is_scalar(item: [VariantD](#pyvariant.VariantD)) → bool +## pyvariant.is_scalar(item: [VariantD](#pyvariant.VariantD)) → bool Return ‘True’ if ‘item’ is a scalar value and ‘False’ otherwise. @@ -251,8 +289,9 @@ print(is_scalar(variant_a), is_scalar(variant_b)) # True False ``` + -### pyvariant.is_signal(item: [VariantD](#pyvariant.VariantD)) → bool +## pyvariant.is_signal(item: [VariantD](#pyvariant.VariantD)) → bool Return ‘True’ if ‘item’ is a signal and ‘False’ otherwise. @@ -266,8 +305,9 @@ print(is_signal(variant_a), is_signal(variant_b)) # False True ``` + -### pyvariant.is_uninitialized(item: [VariantD](#pyvariant.VariantD)) → bool +## pyvariant.is_uninitialized(item: [VariantD](#pyvariant.VariantD)) → bool Return ‘True’ if ‘item’ is a uninitialized and ‘False’ otherwise. @@ -279,8 +319,9 @@ print(is_uninitialized(variant_a), is_uninitialized(variant_b)) # False True ``` + -### pyvariant.is_vector(item: [VariantD](#pyvariant.VariantD)) → bool +## pyvariant.is_vector(item: [VariantD](#pyvariant.VariantD)) → bool Return ‘True’ if ‘item’ is a vector and ‘False’ otherwise. @@ -292,8 +333,9 @@ print(is_vector(variant_a), is_vector(variant_b)) # False True ``` + -### pyvariant.is_xy_data(item: [VariantD](#pyvariant.VariantD)) → bool +## pyvariant.is_xy_data(item: [VariantD](#pyvariant.VariantD)) → bool Return ‘True’ if ‘item’ is a xy-data and ‘False’ otherwise. @@ -306,8 +348,9 @@ print(is_xy_data(variant_a), is_xy_data(variant_b)) # False True ``` + -### pyvariant.list_2_variant_vector(values: list) → [VariantD](#pyvariant.VariantD) +## pyvariant.list_2_variant_vector(values: list) → [VariantD](#pyvariant.VariantD) Convert a python list of values into VariantD vector type. @@ -321,8 +364,9 @@ print(list_2_variant_vector(values)) # (3.0,0) ``` + -### pyvariant.list_2_variant_xy_data(y_axis: list, x_axis: list) → [VariantD](#pyvariant.VariantD) +## pyvariant.list_2_variant_xy_data(y_axis: list, x_axis: list) → [VariantD](#pyvariant.VariantD) Convert a python list of x-values and a list of y-values into VariantD xy-data type. @@ -337,8 +381,9 @@ print(list_2_variant_xy_data(y_axis, x_axis)) # (3,0) - (0.3,0) ``` + -### pyvariant.list_list_2_variant_matrix(values: list) → [VariantD](#pyvariant.VariantD) +## pyvariant.list_list_2_variant_matrix(values: list) → [VariantD](#pyvariant.VariantD) Convert a python list of lists of values into VariantD matrix type. @@ -352,8 +397,9 @@ print(list_list_2_variant_matrix(values)) # (5,0) (6,0) ``` + -### pyvariant.list_list_2_variant_signal(y_axes: list, x_axis: list) → [VariantD](#pyvariant.VariantD) +## pyvariant.list_list_2_variant_signal(y_axes: list, x_axis: list) → [VariantD](#pyvariant.VariantD) Convert a python list of x-values and a list of lists of y-values into VariantD signal type. @@ -368,8 +414,9 @@ print(list_list_2_variant_signal(y_axes, x_axis)) # (3,0) - (0.3,0) (1.1,0) ``` + -### pyvariant.size1(item: [VariantD](#pyvariant.VariantD)) → int +## pyvariant.size1(item: [VariantD](#pyvariant.VariantD)) → int Return the length of dimension 1. If ‘item’ is a scalar, size1 is equal to ‘1’. @@ -385,8 +432,9 @@ print('size1 of variant is {}.'.format(variant.size1())) # size1 of variant is 1. ``` + -### pyvariant.size2(item: [VariantD](#pyvariant.VariantD)) → int +## pyvariant.size2(item: [VariantD](#pyvariant.VariantD)) → int Return the length of dimension 2. If ‘item’ is a scalar or vector, size2 is equal to ‘1’. diff --git a/2025R2/optiSLang-python-api/modules/reliability.md b/2025R2/optiSLang-python-api/modules/reliability.md index 4a5d46ca1c..2ce35367f8 100644 --- a/2025R2/optiSLang-python-api/modules/reliability.md +++ b/2025R2/optiSLang-python-api/modules/reliability.md @@ -1,17 +1,25 @@ + -### *class* reliability.LineSearchMethod +# reliability + + + +## *class* reliability.LineSearchMethod **Enumeration** + -#### Bisection *= reliability.LineSearchMethod.Bisection* +### Bisection *= reliability.LineSearchMethod.Bisection* + -#### RegulaFalsi *= reliability.LineSearchMethod.RegulaFalsi* +### RegulaFalsi *= reliability.LineSearchMethod.RegulaFalsi* + -### *class* reliability.ReliabilityAdaptiveSampling +## *class* reliability.ReliabilityAdaptiveSampling Adaptive sampling implements importance sampling using multiple adaptation steps. The first step scales all designs by an initial blow up factor in standard-normal space. The objective of the scaling is to obtain a reasonable number of samples in the failure domain during the 1st step. Hence, the blow up factor should be chosen according to the failure probability pf the problem. While generating the samples one ignores samples which are further away than @@ -23,387 +31,486 @@ max_allowed_sigma_ After sampling the user-defined number of samples in a single step, the median and covariance matrix of the sampling density function of the next step will be determined according to the statistics of the samples lying in the failure domain. A modified eigenvalue decomposition of the covariance matrix ensures positive definiteness. Furthermore, if the C.O.V. of Pf is relatively large, the covariance matrix is scaled such that it is closer to the identity matrix. The user defines the number of steps and the number of samples per step. If any of the solver calls fails, the corresponding sample is either ignored or (if one tells the algorithm to interpret the failed run as a failure event) is accounted to the failure domain. + -#### \_\_init_\_() +### \_\_init_\_() + -#### get_current_step() → int +### get_current_step() → int Returns the current iteration step number. + -#### get_current_weights() → [vector_type](dynardo_py_algorithms.md#dynardo_py_algorithms.vector_type) +### get_current_weights() → [vector_type](dynardo_py_algorithms.md#dynardo_py_algorithms.vector_type) Returns the current importance sampling weights. + -### *class* reliability.ReliabilityBase +## *class* reliability.ReliabilityBase + -#### \_\_init_\_() +### \_\_init_\_() Raises an exception This class cannot be instantiated from Python + -#### adapt() +### adapt() Creates internally the next set of designs. This is called within the loop after Appraise and prepares the next call of get_next_designs. + -#### appraise() +### appraise() Performs a search step by the internal reliability algorithm. This is called after simulation and setting results and used inputs. The method reads all given information (and eventually performs one internal search step). After calling this method it should be possible to check the state of the iteration by is_terminated(). + -#### can_provide_probability_of_failure() → bool +### can_provide_probability_of_failure() → bool Returns true when the probability of failure can be calculated. + -#### finalize() +### finalize() Finalizes the iteration. Does whatever is neccessary to finalize - delete pointers, collect data… + -#### get_criteria_success_info() → [bitset_type](dynardo_py_algorithms.md#dynardo_py_algorithms.bitset_type) +### get_criteria_success_info() → [bitset_type](dynardo_py_algorithms.md#dynardo_py_algorithms.bitset_type) + -#### get_estimators_std_dev() → float +### get_estimators_std_dev() → float Returns the standard deviation of the estimator of the probability of failure. It should be called after finalize(). If this quantity does not make sense (i.e. in case of FORM), it returns zero. + -#### get_inputs() → [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type) +### get_inputs() → [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type) + -#### get_iteration_name() → str +### get_iteration_name() → str Returns the name of the current iteration. + -#### get_next_design_ids() → [uintVec](stdcpp_python_export.md#stdcpp_python_export.uintVec) +### get_next_design_ids() → [uintVec](stdcpp_python_export.md#stdcpp_python_export.uintVec) Returns the ids for the next set of design vectors for which responses must be computed. This method is called at the begin of the iteration loop. It returns a reference to the internally stored set of infos of awaiting designs. + -#### get_next_design_infos() → [uintVec](stdcpp_python_export.md#stdcpp_python_export.uintVec) +### get_next_design_infos() → [uintVec](stdcpp_python_export.md#stdcpp_python_export.uintVec) Returns some information for the next set of design vectors for which responses must be computed. This method is called at the begin of the iteration loop. It returns a reference to the internally stored set of infos of awaiting designs. + -#### get_next_designs() → [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type) +### get_next_designs() → [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type) Returns the next set of design vectors for which responses must be computed. This method is called at the begin of the iteration loop. It returns a reference to the internally stored set of awaiting designs. + -#### get_num_awaiting_designs() → int +### get_num_awaiting_designs() → int + -#### get_num_computed_samples() → int +### get_num_computed_samples() → int + -#### get_num_function_calls() → int +### get_num_function_calls() → int + -#### get_num_inputs() → int +### get_num_inputs() → int + -#### get_num_safety_margins() → int +### get_num_safety_margins() → int + -#### get_num_successfully_computed_samples() → int +### get_num_successfully_computed_samples() → int + -#### get_probability_of_failure() → float +### get_probability_of_failure() → float Returns the probability of failure. + -#### get_reliability_index() → float +### get_reliability_index() → float The default implementation calls GetProbabilityOfFailure and computes beta from that. It should be called after finalize(). + -#### get_rv_set() → [RVSet](py_random_variables.md#py_random_variables.RVSet) +### get_rv_set() → [RVSet](py_random_variables.md#py_random_variables.RVSet) + -#### get_safety_margins() → [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type) +### get_safety_margins() → [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type) + -#### get_success_info_as_failure_event() → [bitset_type](dynardo_py_algorithms.md#dynardo_py_algorithms.bitset_type) +### get_success_info_as_failure_event() → [bitset_type](dynardo_py_algorithms.md#dynardo_py_algorithms.bitset_type) + -#### has_several_iterations() → bool +### has_several_iterations() → bool Returns True if the algorithm produces several design sets. + -#### has_total_design_set() → bool +### has_total_design_set() → bool Returns True if the algorithm produces a total design set. + -#### initialize(arg2: [SettingsBase](#reliability.SettingsBase)) +### initialize(arg2: [SettingsBase](#reliability.SettingsBase)) (re)sets the algorithm using the given definition data (“settings”). It must be called at least once before starting the iteration loop. It may be called several times during the lifetime of an algorithm object (then clears old data, reallocates and resets). + -#### is_converged() → bool +### is_converged() → bool Returns true if the iteration loop has converged. This method returns true if the algorithm has terminated and converged. + -#### is_terminated() → bool +### is_terminated() → bool Returns true if the iteration loop must be terminated. This method returns true if the algorithm has finished. If it either converged (or diverged or any other termination criterion is satisfied). + -#### restart() +### restart() (re)sets the algorithm without touching the settings and maybe time-consuming pre-calculations. Initialize must be called at least once before. + -#### set_criteria_success_info(arg2: [bitset_type](dynardo_py_algorithms.md#dynardo_py_algorithms.bitset_type)) +### set_criteria_success_info(arg2: [bitset_type](dynardo_py_algorithms.md#dynardo_py_algorithms.bitset_type)) Sets the success flags of the actually computed designs. It must be called before Appraise. The input argument tells the algorithm for which design point vector the external solver failed (or returned senseless results). + -#### set_inputs(arg2: [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type)) +### set_inputs(arg2: [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type)) Sets the design point vectors of the actually computed designs. It must be called before Appraise. + -#### set_safety_margins(arg2: [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type)) +### set_safety_margins(arg2: [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type)) Sets the safety margin function(s) of the actually computed designs. It must be called before Appraise. + -#### set_success_info_as_failure_event(arg2: [bitset_type](dynardo_py_algorithms.md#dynardo_py_algorithms.bitset_type)) +### set_success_info_as_failure_event(arg2: [bitset_type](dynardo_py_algorithms.md#dynardo_py_algorithms.bitset_type)) Sets the failure event flags of the actually computed designs without successful solver run. It must be called before Appraise. The input argument tells the algorithm for which design point vector the value success_info_[i]=false can be interpreted as a failure event. + -### *class* reliability.ReliabilityMonteCarlo +## *class* reliability.ReliabilityMonteCarlo This algorithm implements Monte Carlo sampling. The algorithm can be controlled either by a predefined number of samples, or by a desired accuracy (c.o.v.) of the estimator of Pf (or of (1-Pf) if Pf>0.5). In the latter case, the number of required samples will be selected by the algorithm during the iteration. The convergence test is carried out after each request of n parallel designs. If the desired accuracy can not be reached within the maximum allowed number of samples, the algorithm terminates without success. If any of the solver requests fails (success_info=false for a specific design) the algorithm either ignores this design, or it counts it as a failure event. + -#### \_\_init_\_() +### \_\_init_\_() + -### *class* reliability.SettingsARSMDS +## *class* reliability.SettingsARSMDS Reliability algorithm settings for ARSM with Directional Sampling. + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [RVSet](py_random_variables.md#py_random_variables.RVSet), arg3: int) +### \_\_init_\_(arg2: [RVSet](py_random_variables.md#py_random_variables.RVSet), arg3: int) + -#### *property* blow_up +### *property* blow_up + -#### *property* num_directions +### *property* num_directions + -#### *property* num_steps +### *property* num_steps + -#### *property* num_supports_initial_step +### *property* num_supports_initial_step + -#### *property* num_supports_per_step +### *property* num_supports_per_step + -### *class* reliability.SettingsAdaptiveSampling +## *class* reliability.SettingsAdaptiveSampling Reliability algorithm settings for Adaptive Sampling. + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [RVSet](py_random_variables.md#py_random_variables.RVSet), arg3: int) +### \_\_init_\_(arg2: [RVSet](py_random_variables.md#py_random_variables.RVSet), arg3: int) + -#### *property* accuracy +### *property* accuracy + -#### *property* automatic_sample_size +### *property* automatic_sample_size + -#### *property* initial_scale_factor +### *property* initial_scale_factor + -#### *property* num_designs_per_sample +### *property* num_designs_per_sample + -#### *property* num_steps +### *property* num_steps + -#### *property* num_total_samples_per_step +### *property* num_total_samples_per_step + -#### *property* use_standard_density +### *property* use_standard_density + -#### *property* write_weights +### *property* write_weights + -### *class* reliability.SettingsBase +## *class* reliability.SettingsBase Base class that define the reliability problem. + -#### \_\_init_\_() +### \_\_init_\_() Raises an exception This class cannot be instantiated from Python + -#### check_settings() +### check_settings() Check if settings are correct. Raises an error if they are not. + -#### *property* num_estimated_function_calls +### *property* num_estimated_function_calls + -#### *property* num_inputs +### *property* num_inputs + -#### *property* num_safety_margins +### *property* num_safety_margins + -#### *property* rand_generator_seed +### *property* rand_generator_seed + -#### *property* rvset +### *property* rvset + -#### set_defaults() +### set_defaults() + -#### *property* write_histories +### *property* write_histories + -#### *property* write_input_importance +### *property* write_input_importance + -### *class* reliability.SettingsDirectionalSampling +## *class* reliability.SettingsDirectionalSampling Reliability algorithm settings for directional sampling. + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [RVSet](py_random_variables.md#py_random_variables.RVSet), arg3: int) +### \_\_init_\_(arg2: [RVSet](py_random_variables.md#py_random_variables.RVSet), arg3: int) + -#### *property* linesearch_accuracy +### *property* linesearch_accuracy + -#### *property* linesearch_method +### *property* linesearch_method + -#### *property* linesearch_num_parallel_presample +### *property* linesearch_num_parallel_presample + -#### *property* num_directions +### *property* num_directions + -#### *property* num_parallel +### *property* num_parallel + -#### *property* search_direction_sampling_method +### *property* search_direction_sampling_method + -### *class* reliability.SettingsFORM +## *class* reliability.SettingsFORM Reliability algorithm settings for Form/OptimizerNLPQLP + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [RVSet](py_random_variables.md#py_random_variables.RVSet), arg3: int) +### \_\_init_\_(arg2: [RVSet](py_random_variables.md#py_random_variables.RVSet), arg3: int) + -#### *property* max_search_runs +### *property* max_search_runs + -#### *property* num_presamples +### *property* num_presamples + -#### *property* optimizer_settings +### *property* optimizer_settings FORM’s NLPQLP settings. Cannot be copied. + -### *class* reliability.SettingsISPUD +## *class* reliability.SettingsISPUD Reliability algorithm settings for ISPUD( Importance sampling using the design point). + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [RVSet](py_random_variables.md#py_random_variables.RVSet), arg3: int) +### \_\_init_\_(arg2: [RVSet](py_random_variables.md#py_random_variables.RVSet), arg3: int) + -#### *property* accuracy +### *property* accuracy + -#### *property* automatic_sample_size +### *property* automatic_sample_size + -#### *property* form_settings +### *property* form_settings ISPUD’s FORM settings. Cannot be copied. + -#### *property* num_designs_per_sample +### *property* num_designs_per_sample + -#### *property* num_total_samples +### *property* num_total_samples + -#### *property* use_median_sampling +### *property* use_median_sampling + -#### *property* use_start_designs +### *property* use_start_designs + -#### *property* vary_discrete_rvs +### *property* vary_discrete_rvs + -#### *property* write_weights +### *property* write_weights + -### *class* reliability.SettingsMonteCarlo +## *class* reliability.SettingsMonteCarlo Reliability algorithm settings for Monte Carlo. + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [RVSet](py_random_variables.md#py_random_variables.RVSet), arg3: int) +### \_\_init_\_(arg2: [RVSet](py_random_variables.md#py_random_variables.RVSet), arg3: int) + -#### *property* accuracy +### *property* accuracy + -#### *property* automatic_sample_size +### *property* automatic_sample_size + -#### *property* min_num_samples +### *property* min_num_samples + -#### *property* num_designs_per_sample +### *property* num_designs_per_sample + -#### *property* num_total_samples +### *property* num_total_samples + -#### *property* scaling_factor +### *property* scaling_factor diff --git a/2025R2/optiSLang-python-api/modules/stdcpp_python_export.md b/2025R2/optiSLang-python-api/modules/stdcpp_python_export.md index c2fb4ace5e..31a9c1adb0 100644 --- a/2025R2/optiSLang-python-api/modules/stdcpp_python_export.md +++ b/2025R2/optiSLang-python-api/modules/stdcpp_python_export.md @@ -1,892 +1,1152 @@ + -### *class* stdcpp_python_export.BasePathMode +# stdcpp_python_export + + + +## *class* stdcpp_python_export.BasePathMode **Enumeration** + -#### ABSOLUTE_PATH *= stdcpp_python_export.BasePathMode.ABSOLUTE_PATH* +### ABSOLUTE_PATH *= stdcpp_python_export.BasePathMode.ABSOLUTE_PATH* + -#### NUM_BASEPATH_MODES *= stdcpp_python_export.BasePathMode.NUM_BASEPATH_MODES* +### NUM_BASEPATH_MODES *= stdcpp_python_export.BasePathMode.NUM_BASEPATH_MODES* + -#### PROJECT_RELATIVE *= stdcpp_python_export.BasePathMode.PROJECT_RELATIVE* +### PROJECT_RELATIVE *= stdcpp_python_export.BasePathMode.PROJECT_RELATIVE* + -#### PROJECT_WORKING_DIR_RELATIVE *= stdcpp_python_export.BasePathMode.PROJECT_WORKING_DIR_RELATIVE* +### PROJECT_WORKING_DIR_RELATIVE *= stdcpp_python_export.BasePathMode.PROJECT_WORKING_DIR_RELATIVE* + -#### REFERENCE_FILES_DIR_RELATIVE *= stdcpp_python_export.BasePathMode.REFERENCE_FILES_DIR_RELATIVE* +### REFERENCE_FILES_DIR_RELATIVE *= stdcpp_python_export.BasePathMode.REFERENCE_FILES_DIR_RELATIVE* + -#### WORKING_DIR_RELATIVE *= stdcpp_python_export.BasePathMode.WORKING_DIR_RELATIVE* +### WORKING_DIR_RELATIVE *= stdcpp_python_export.BasePathMode.WORKING_DIR_RELATIVE* + -### *class* stdcpp_python_export.DoublePair +## *class* stdcpp_python_export.DoublePair + -#### \_\_init_\_() +### \_\_init_\_() + -#### *property* first +### *property* first + -#### *property* second +### *property* second + -### stdcpp_python_export.MakeVariableNameValid(arg1: str) → str +## stdcpp_python_export.MakeVariableNameValid(arg1: str) → str -### stdcpp_python_export.MakeVariableNameValid(arg1: str, arg2: object) → str +## stdcpp_python_export.MakeVariableNameValid(arg1: str, arg2: object) → str + -### *class* stdcpp_python_export.Path +## *class* stdcpp_python_export.Path + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) + -#### \_\_str_\_() → str +### \_\_str_\_() → str + -### *class* stdcpp_python_export.PathSet +## *class* stdcpp_python_export.PathSet A mutable set. + -#### \_\_and_\_(arg2: [PathSet](#stdcpp_python_export.PathSet)) → [PathSet](#stdcpp_python_export.PathSet) +### \_\_and_\_(arg2: [PathSet](#stdcpp_python_export.PathSet)) → [PathSet](#stdcpp_python_export.PathSet) Return the intersection of this set and other. + -#### \_\_contains_\_(arg2: [Path](#stdcpp_python_export.Path)) → bool +### \_\_contains_\_(arg2: [Path](#stdcpp_python_export.Path)) → bool + -#### \_\_delitem_\_(arg2: [Path](#stdcpp_python_export.Path)) +### \_\_delitem_\_(arg2: [Path](#stdcpp_python_export.Path)) + -#### \_\_hash_\_() +### \_\_hash_\_() + -#### \_\_init_\_() +### \_\_init_\_() + -#### \_\_iter_\_() → object +### \_\_iter_\_() → object + -#### \_\_len_\_() → int +### \_\_len_\_() → int + -#### \_\_or_\_(arg2: [PathSet](#stdcpp_python_export.PathSet)) → [PathSet](#stdcpp_python_export.PathSet) +### \_\_or_\_(arg2: [PathSet](#stdcpp_python_export.PathSet)) → [PathSet](#stdcpp_python_export.PathSet) Return the union of this set and other. + -#### \_\_sub_\_(arg2: [PathSet](#stdcpp_python_export.PathSet)) → [PathSet](#stdcpp_python_export.PathSet) +### \_\_sub_\_(arg2: [PathSet](#stdcpp_python_export.PathSet)) → [PathSet](#stdcpp_python_export.PathSet) Return elements of this set that are not in other. + -#### \_\_xor_\_(arg2: [PathSet](#stdcpp_python_export.PathSet)) → [PathSet](#stdcpp_python_export.PathSet) +### \_\_xor_\_(arg2: [PathSet](#stdcpp_python_export.PathSet)) → [PathSet](#stdcpp_python_export.PathSet) Return elements that are either in this set or in other but not in both. + -#### add(element: [Path](#stdcpp_python_export.Path)) +### add(element: [Path](#stdcpp_python_export.Path)) Add element. + -#### difference(other: [PathSet](#stdcpp_python_export.PathSet)) → [PathSet](#stdcpp_python_export.PathSet) +### difference(other: [PathSet](#stdcpp_python_export.PathSet)) → [PathSet](#stdcpp_python_export.PathSet) Return elements of this set that are not in other. + -#### intersection(other: [PathSet](#stdcpp_python_export.PathSet)) → [PathSet](#stdcpp_python_export.PathSet) +### intersection(other: [PathSet](#stdcpp_python_export.PathSet)) → [PathSet](#stdcpp_python_export.PathSet) Return the intersection of this set and other. + -#### remove(element: [Path](#stdcpp_python_export.Path)) +### remove(element: [Path](#stdcpp_python_export.Path)) Remove element. + -#### symmetric_difference(other: [PathSet](#stdcpp_python_export.PathSet)) → [PathSet](#stdcpp_python_export.PathSet) +### symmetric_difference(other: [PathSet](#stdcpp_python_export.PathSet)) → [PathSet](#stdcpp_python_export.PathSet) Return elements that are either in this set or in other but not in both. + -#### union(other: [PathSet](#stdcpp_python_export.PathSet)) → [PathSet](#stdcpp_python_export.PathSet) +### union(other: [PathSet](#stdcpp_python_export.PathSet)) → [PathSet](#stdcpp_python_export.PathSet) Return the union of this set and other. + -### *class* stdcpp_python_export.RelativeSplittedPath +## *class* stdcpp_python_export.RelativeSplittedPath + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: [Path](#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](#stdcpp_python_export.Path)) -#### \_\_init_\_(arg2: [Path](#stdcpp_python_export.Path), arg3: [BasePathMode](#stdcpp_python_export.BasePathMode)) +### \_\_init_\_(arg2: [Path](#stdcpp_python_export.Path), arg3: [BasePathMode](#stdcpp_python_export.BasePathMode)) -#### \_\_init_\_(arg2: [Path](#stdcpp_python_export.Path), arg3: [BasePathMode](#stdcpp_python_export.BasePathMode), arg4: [Path](#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](#stdcpp_python_export.Path), arg3: [BasePathMode](#stdcpp_python_export.BasePathMode), arg4: [Path](#stdcpp_python_export.Path)) -#### \_\_init_\_(arg2: [SplittedPath](#stdcpp_python_export.SplittedPath)) +### \_\_init_\_(arg2: [SplittedPath](#stdcpp_python_export.SplittedPath)) -#### \_\_init_\_(arg2: [SplittedPath](#stdcpp_python_export.SplittedPath), arg3: [BasePathMode](#stdcpp_python_export.BasePathMode)) +### \_\_init_\_(arg2: [SplittedPath](#stdcpp_python_export.SplittedPath), arg3: [BasePathMode](#stdcpp_python_export.BasePathMode)) -#### \_\_init_\_(arg2: [SplittedPath](#stdcpp_python_export.SplittedPath), arg3: [BasePathMode](#stdcpp_python_export.BasePathMode), arg4: [Path](#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [SplittedPath](#stdcpp_python_export.SplittedPath), arg3: [BasePathMode](#stdcpp_python_export.BasePathMode), arg4: [Path](#stdcpp_python_export.Path)) + -#### *property* base_path +### *property* base_path + -#### *property* base_path_mode +### *property* base_path_mode + -#### *property* splitted_path +### *property* splitted_path + -### *class* stdcpp_python_export.SizeSet +## *class* stdcpp_python_export.SizeSet A mutable set. + -#### \_\_and_\_(arg2: [SizeSet](#stdcpp_python_export.SizeSet)) → [SizeSet](#stdcpp_python_export.SizeSet) +### \_\_and_\_(arg2: [SizeSet](#stdcpp_python_export.SizeSet)) → [SizeSet](#stdcpp_python_export.SizeSet) Return the intersection of this set and other. + -#### \_\_contains_\_(arg2: int) → bool +### \_\_contains_\_(arg2: int) → bool + -#### \_\_delitem_\_(arg2: int) +### \_\_delitem_\_(arg2: int) + -#### \_\_hash_\_() +### \_\_hash_\_() + -#### \_\_init_\_() +### \_\_init_\_() + -#### \_\_iter_\_() → object +### \_\_iter_\_() → object + -#### \_\_len_\_() → int +### \_\_len_\_() → int + -#### \_\_or_\_(arg2: [SizeSet](#stdcpp_python_export.SizeSet)) → [SizeSet](#stdcpp_python_export.SizeSet) +### \_\_or_\_(arg2: [SizeSet](#stdcpp_python_export.SizeSet)) → [SizeSet](#stdcpp_python_export.SizeSet) Return the union of this set and other. + -#### \_\_sub_\_(arg2: [SizeSet](#stdcpp_python_export.SizeSet)) → [SizeSet](#stdcpp_python_export.SizeSet) +### \_\_sub_\_(arg2: [SizeSet](#stdcpp_python_export.SizeSet)) → [SizeSet](#stdcpp_python_export.SizeSet) Return elements of this set that are not in other. + -#### \_\_xor_\_(arg2: [SizeSet](#stdcpp_python_export.SizeSet)) → [SizeSet](#stdcpp_python_export.SizeSet) +### \_\_xor_\_(arg2: [SizeSet](#stdcpp_python_export.SizeSet)) → [SizeSet](#stdcpp_python_export.SizeSet) Return elements that are either in this set or in other but not in both. + -#### add(element: int) +### add(element: int) Add element. + -#### difference(other: [SizeSet](#stdcpp_python_export.SizeSet)) → [SizeSet](#stdcpp_python_export.SizeSet) +### difference(other: [SizeSet](#stdcpp_python_export.SizeSet)) → [SizeSet](#stdcpp_python_export.SizeSet) Return elements of this set that are not in other. + -#### intersection(other: [SizeSet](#stdcpp_python_export.SizeSet)) → [SizeSet](#stdcpp_python_export.SizeSet) +### intersection(other: [SizeSet](#stdcpp_python_export.SizeSet)) → [SizeSet](#stdcpp_python_export.SizeSet) Return the intersection of this set and other. + -#### remove(element: int) +### remove(element: int) Remove element. + -#### symmetric_difference(other: [SizeSet](#stdcpp_python_export.SizeSet)) → [SizeSet](#stdcpp_python_export.SizeSet) +### symmetric_difference(other: [SizeSet](#stdcpp_python_export.SizeSet)) → [SizeSet](#stdcpp_python_export.SizeSet) Return elements that are either in this set or in other but not in both. + -#### union(other: [SizeSet](#stdcpp_python_export.SizeSet)) → [SizeSet](#stdcpp_python_export.SizeSet) +### union(other: [SizeSet](#stdcpp_python_export.SizeSet)) → [SizeSet](#stdcpp_python_export.SizeSet) Return the union of this set and other. + -### *class* stdcpp_python_export.SplittedPath +## *class* stdcpp_python_export.SplittedPath + -#### \_\_init_\_() +### \_\_init_\_() -#### \_\_init_\_(arg2: str) +### \_\_init_\_(arg2: str) -#### \_\_init_\_(arg2: str, arg3: str) +### \_\_init_\_(arg2: str, arg3: str) -#### \_\_init_\_(arg2: [Path](#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](#stdcpp_python_export.Path)) -#### \_\_init_\_(arg2: [Path](#stdcpp_python_export.Path), arg3: [Path](#stdcpp_python_export.Path)) +### \_\_init_\_(arg2: [Path](#stdcpp_python_export.Path), arg3: [Path](#stdcpp_python_export.Path)) + -#### \_\_str_\_() → str +### \_\_str_\_() → str + -#### *property* head +### *property* head + -#### isSplitted() → bool +### isSplitted() → bool + -#### joined() → [Path](#stdcpp_python_export.Path) +### joined() → [Path](#stdcpp_python_export.Path) + -#### *property* tail +### *property* tail + -### *class* stdcpp_python_export.StrList +## *class* stdcpp_python_export.StrList + -#### StrExportList() → [StrList](#stdcpp_python_export.StrList) +### StrExportList() → [StrList](#stdcpp_python_export.StrList) + -#### \_\_contains_\_(arg2: object) → bool +### \_\_contains_\_(arg2: object) → bool + -#### \_\_delitem_\_(arg2: object) +### \_\_delitem_\_(arg2: object) + -#### \_\_getitem_\_(arg2: object) → object +### \_\_getitem_\_(arg2: object) → object + -#### \_\_init_\_() +### \_\_init_\_() + -#### \_\_iter_\_() → object +### \_\_iter_\_() → object + -#### \_\_len_\_() → int +### \_\_len_\_() → int + -#### \_\_setitem_\_(arg2: object, arg3: object) +### \_\_setitem_\_(arg2: object, arg3: object) + -#### append(arg2: object) +### append(arg2: object) + -#### extend(arg2: object) +### extend(arg2: object) + -#### push_back(arg2: str) +### push_back(arg2: str) + -#### size() → int +### size() → int + -#### sort() +### sort() + -### *class* stdcpp_python_export.StrPair +## *class* stdcpp_python_export.StrPair + -#### \_\_init_\_() +### \_\_init_\_() + -#### *property* first +### *property* first + -#### *property* second +### *property* second + -### *class* stdcpp_python_export.StrSet +## *class* stdcpp_python_export.StrSet A mutable set. + -#### \_\_and_\_(arg2: [StrSet](#stdcpp_python_export.StrSet)) → [StrSet](#stdcpp_python_export.StrSet) +### \_\_and_\_(arg2: [StrSet](#stdcpp_python_export.StrSet)) → [StrSet](#stdcpp_python_export.StrSet) Return the intersection of this set and other. + -#### \_\_contains_\_(arg2: str) → bool +### \_\_contains_\_(arg2: str) → bool + -#### \_\_delitem_\_(arg2: str) +### \_\_delitem_\_(arg2: str) + -#### \_\_hash_\_() +### \_\_hash_\_() + -#### \_\_init_\_() +### \_\_init_\_() + -#### \_\_iter_\_() → object +### \_\_iter_\_() → object + -#### \_\_len_\_() → int +### \_\_len_\_() → int + -#### \_\_or_\_(arg2: [StrSet](#stdcpp_python_export.StrSet)) → [StrSet](#stdcpp_python_export.StrSet) +### \_\_or_\_(arg2: [StrSet](#stdcpp_python_export.StrSet)) → [StrSet](#stdcpp_python_export.StrSet) Return the union of this set and other. + -#### \_\_sub_\_(arg2: [StrSet](#stdcpp_python_export.StrSet)) → [StrSet](#stdcpp_python_export.StrSet) +### \_\_sub_\_(arg2: [StrSet](#stdcpp_python_export.StrSet)) → [StrSet](#stdcpp_python_export.StrSet) Return elements of this set that are not in other. + -#### \_\_xor_\_(arg2: [StrSet](#stdcpp_python_export.StrSet)) → [StrSet](#stdcpp_python_export.StrSet) +### \_\_xor_\_(arg2: [StrSet](#stdcpp_python_export.StrSet)) → [StrSet](#stdcpp_python_export.StrSet) Return elements that are either in this set or in other but not in both. + -#### add(element: str) +### add(element: str) Add element. + -#### difference(other: [StrSet](#stdcpp_python_export.StrSet)) → [StrSet](#stdcpp_python_export.StrSet) +### difference(other: [StrSet](#stdcpp_python_export.StrSet)) → [StrSet](#stdcpp_python_export.StrSet) Return elements of this set that are not in other. + -#### intersection(other: [StrSet](#stdcpp_python_export.StrSet)) → [StrSet](#stdcpp_python_export.StrSet) +### intersection(other: [StrSet](#stdcpp_python_export.StrSet)) → [StrSet](#stdcpp_python_export.StrSet) Return the intersection of this set and other. + -#### remove(element: str) +### remove(element: str) Remove element. + -#### symmetric_difference(other: [StrSet](#stdcpp_python_export.StrSet)) → [StrSet](#stdcpp_python_export.StrSet) +### symmetric_difference(other: [StrSet](#stdcpp_python_export.StrSet)) → [StrSet](#stdcpp_python_export.StrSet) Return elements that are either in this set or in other but not in both. + -#### union(other: [StrSet](#stdcpp_python_export.StrSet)) → [StrSet](#stdcpp_python_export.StrSet) +### union(other: [StrSet](#stdcpp_python_export.StrSet)) → [StrSet](#stdcpp_python_export.StrSet) Return the union of this set and other. + -### *class* stdcpp_python_export.WStrList +## *class* stdcpp_python_export.WStrList + -#### StrExportList() → [WStrList](#stdcpp_python_export.WStrList) +### StrExportList() → [WStrList](#stdcpp_python_export.WStrList) + -#### \_\_contains_\_(arg2: object) → bool +### \_\_contains_\_(arg2: object) → bool + -#### \_\_delitem_\_(arg2: object) +### \_\_delitem_\_(arg2: object) + -#### \_\_getitem_\_(arg2: object) → object +### \_\_getitem_\_(arg2: object) → object + -#### \_\_init_\_() +### \_\_init_\_() + -#### \_\_iter_\_() → object +### \_\_iter_\_() → object + -#### \_\_len_\_() → int +### \_\_len_\_() → int + -#### \_\_setitem_\_(arg2: object, arg3: object) +### \_\_setitem_\_(arg2: object, arg3: object) + -#### append(arg2: object) +### append(arg2: object) + -#### extend(arg2: object) +### extend(arg2: object) + -#### push_back(arg2: str) +### push_back(arg2: str) + -#### size() → int +### size() → int + -#### sort() +### sort() + -### *class* stdcpp_python_export.WStrPair +## *class* stdcpp_python_export.WStrPair + -#### \_\_init_\_() +### \_\_init_\_() + -#### *property* first +### *property* first + -#### *property* second +### *property* second + -### *class* stdcpp_python_export.WStrSet +## *class* stdcpp_python_export.WStrSet A mutable set. + -#### \_\_and_\_(arg2: [WStrSet](#stdcpp_python_export.WStrSet)) → [WStrSet](#stdcpp_python_export.WStrSet) +### \_\_and_\_(arg2: [WStrSet](#stdcpp_python_export.WStrSet)) → [WStrSet](#stdcpp_python_export.WStrSet) Return the intersection of this set and other. + -#### \_\_contains_\_(arg2: str) → bool +### \_\_contains_\_(arg2: str) → bool + -#### \_\_delitem_\_(arg2: str) +### \_\_delitem_\_(arg2: str) + -#### \_\_hash_\_() +### \_\_hash_\_() + -#### \_\_init_\_() +### \_\_init_\_() + -#### \_\_iter_\_() → object +### \_\_iter_\_() → object + -#### \_\_len_\_() → int +### \_\_len_\_() → int + -#### \_\_or_\_(arg2: [WStrSet](#stdcpp_python_export.WStrSet)) → [WStrSet](#stdcpp_python_export.WStrSet) +### \_\_or_\_(arg2: [WStrSet](#stdcpp_python_export.WStrSet)) → [WStrSet](#stdcpp_python_export.WStrSet) Return the union of this set and other. + -#### \_\_sub_\_(arg2: [WStrSet](#stdcpp_python_export.WStrSet)) → [WStrSet](#stdcpp_python_export.WStrSet) +### \_\_sub_\_(arg2: [WStrSet](#stdcpp_python_export.WStrSet)) → [WStrSet](#stdcpp_python_export.WStrSet) Return elements of this set that are not in other. + -#### \_\_xor_\_(arg2: [WStrSet](#stdcpp_python_export.WStrSet)) → [WStrSet](#stdcpp_python_export.WStrSet) +### \_\_xor_\_(arg2: [WStrSet](#stdcpp_python_export.WStrSet)) → [WStrSet](#stdcpp_python_export.WStrSet) Return elements that are either in this set or in other but not in both. + -#### add(element: str) +### add(element: str) Add element. + -#### difference(other: [WStrSet](#stdcpp_python_export.WStrSet)) → [WStrSet](#stdcpp_python_export.WStrSet) +### difference(other: [WStrSet](#stdcpp_python_export.WStrSet)) → [WStrSet](#stdcpp_python_export.WStrSet) Return elements of this set that are not in other. + -#### intersection(other: [WStrSet](#stdcpp_python_export.WStrSet)) → [WStrSet](#stdcpp_python_export.WStrSet) +### intersection(other: [WStrSet](#stdcpp_python_export.WStrSet)) → [WStrSet](#stdcpp_python_export.WStrSet) Return the intersection of this set and other. + -#### remove(element: str) +### remove(element: str) Remove element. + -#### symmetric_difference(other: [WStrSet](#stdcpp_python_export.WStrSet)) → [WStrSet](#stdcpp_python_export.WStrSet) +### symmetric_difference(other: [WStrSet](#stdcpp_python_export.WStrSet)) → [WStrSet](#stdcpp_python_export.WStrSet) Return elements that are either in this set or in other but not in both. + -#### union(other: [WStrSet](#stdcpp_python_export.WStrSet)) → [WStrSet](#stdcpp_python_export.WStrSet) +### union(other: [WStrSet](#stdcpp_python_export.WStrSet)) → [WStrSet](#stdcpp_python_export.WStrSet) Return the union of this set and other. + -### *class* stdcpp_python_export.boolVec +## *class* stdcpp_python_export.boolVec + -#### \_\_contains_\_(arg2: object) → bool +### \_\_contains_\_(arg2: object) → bool + -#### \_\_delitem_\_(arg2: object) +### \_\_delitem_\_(arg2: object) + -#### \_\_getitem_\_(arg2: object) → object +### \_\_getitem_\_(arg2: object) → object + -#### \_\_init_\_() +### \_\_init_\_() + -#### \_\_iter_\_() → object +### \_\_iter_\_() → object + -#### \_\_len_\_() → int +### \_\_len_\_() → int + -#### \_\_setitem_\_(arg2: object, arg3: object) +### \_\_setitem_\_(arg2: object, arg3: object) + -#### append(arg2: object) +### append(arg2: object) + -#### extend(arg2: object) +### extend(arg2: object) + -#### push_back(arg2: bool) +### push_back(arg2: bool) + -#### size() → int +### size() → int + -### stdcpp_python_export.bool_list_to_vec(arg1: list) → [boolVec](#stdcpp_python_export.boolVec) +## stdcpp_python_export.bool_list_to_vec(arg1: list) → [boolVec](#stdcpp_python_export.boolVec) + -### stdcpp_python_export.convertList2Vec(arg1: [StrList](#stdcpp_python_export.StrList)) → [stringVec](#stdcpp_python_export.stringVec) +## stdcpp_python_export.convertList2Vec(arg1: [StrList](#stdcpp_python_export.StrList)) → [stringVec](#stdcpp_python_export.stringVec) + -### stdcpp_python_export.convertPyList2WList(arg1: list) → [WStrList](#stdcpp_python_export.WStrList) +## stdcpp_python_export.convertPyList2WList(arg1: list) → [WStrList](#stdcpp_python_export.WStrList) + -### stdcpp_python_export.convertVec2List(arg1: [stringVec](#stdcpp_python_export.stringVec)) → [StrList](#stdcpp_python_export.StrList) +## stdcpp_python_export.convertVec2List(arg1: [stringVec](#stdcpp_python_export.stringVec)) → [StrList](#stdcpp_python_export.StrList) + -### stdcpp_python_export.convertWList2PyList(arg1: [WStrList](#stdcpp_python_export.WStrList)) → list +## stdcpp_python_export.convertWList2PyList(arg1: [WStrList](#stdcpp_python_export.WStrList)) → list + -### stdcpp_python_export.convertWList2Vec(arg1: [WStrList](#stdcpp_python_export.WStrList)) → object +## stdcpp_python_export.convertWList2Vec(arg1: [WStrList](#stdcpp_python_export.WStrList)) → object + -### stdcpp_python_export.convertWVec2List(arg1: object) → [WStrList](#stdcpp_python_export.WStrList) +## stdcpp_python_export.convertWVec2List(arg1: object) → [WStrList](#stdcpp_python_export.WStrList) + -### *class* stdcpp_python_export.doubleVec +## *class* stdcpp_python_export.doubleVec + -#### \_\_contains_\_(arg2: object) → bool +### \_\_contains_\_(arg2: object) → bool + -#### \_\_delitem_\_(arg2: object) +### \_\_delitem_\_(arg2: object) + -#### \_\_getitem_\_(arg2: object) → object +### \_\_getitem_\_(arg2: object) → object + -#### \_\_init_\_() +### \_\_init_\_() + -#### \_\_iter_\_() → object +### \_\_iter_\_() → object + -#### \_\_len_\_() → int +### \_\_len_\_() → int + -#### \_\_setitem_\_(arg2: object, arg3: object) +### \_\_setitem_\_(arg2: object, arg3: object) + -#### append(arg2: object) +### append(arg2: object) + -#### extend(arg2: object) +### extend(arg2: object) + -#### push_back(arg2: float) +### push_back(arg2: float) + -#### size() → int +### size() → int + -### *class* stdcpp_python_export.doubleVecVec +## *class* stdcpp_python_export.doubleVecVec + -#### \_\_contains_\_(arg2: object) → bool +### \_\_contains_\_(arg2: object) → bool + -#### \_\_delitem_\_(arg2: object) +### \_\_delitem_\_(arg2: object) + -#### \_\_getitem_\_(arg2: object) → object +### \_\_getitem_\_(arg2: object) → object + -#### \_\_init_\_() +### \_\_init_\_() + -#### \_\_iter_\_() → object +### \_\_iter_\_() → object + -#### \_\_len_\_() → int +### \_\_len_\_() → int + -#### \_\_setitem_\_(arg2: object, arg3: object) +### \_\_setitem_\_(arg2: object, arg3: object) + -#### append(arg2: object) +### append(arg2: object) + -#### extend(arg2: object) +### extend(arg2: object) + -#### push_back(arg2: [doubleVec](#stdcpp_python_export.doubleVec)) +### push_back(arg2: [doubleVec](#stdcpp_python_export.doubleVec)) + -#### size() → int +### size() → int + -### stdcpp_python_export.doubleVec_list_to_vec(arg1: list) → [doubleVecVec](#stdcpp_python_export.doubleVecVec) +## stdcpp_python_export.doubleVec_list_to_vec(arg1: list) → [doubleVecVec](#stdcpp_python_export.doubleVecVec) + -### stdcpp_python_export.double_list_to_vec(arg1: list) → [doubleVec](#stdcpp_python_export.doubleVec) +## stdcpp_python_export.double_list_to_vec(arg1: list) → [doubleVec](#stdcpp_python_export.doubleVec) + -### stdcpp_python_export.eraseWListElement(arg1: [WStrList](#stdcpp_python_export.WStrList), arg2: int) +## stdcpp_python_export.eraseWListElement(arg1: [WStrList](#stdcpp_python_export.WStrList), arg2: int) + -### *class* stdcpp_python_export.intVec +## *class* stdcpp_python_export.intVec + -#### \_\_contains_\_(arg2: object) → bool +### \_\_contains_\_(arg2: object) → bool + -#### \_\_delitem_\_(arg2: object) +### \_\_delitem_\_(arg2: object) + -#### \_\_getitem_\_(arg2: object) → object +### \_\_getitem_\_(arg2: object) → object + -#### \_\_init_\_() +### \_\_init_\_() + -#### \_\_iter_\_() → object +### \_\_iter_\_() → object + -#### \_\_len_\_() → int +### \_\_len_\_() → int + -#### \_\_setitem_\_(arg2: object, arg3: object) +### \_\_setitem_\_(arg2: object, arg3: object) + -#### append(arg2: object) +### append(arg2: object) + -#### extend(arg2: object) +### extend(arg2: object) + -#### push_back(arg2: int) +### push_back(arg2: int) + -#### size() → int +### size() → int + -### stdcpp_python_export.int_list_to_vec(arg1: list) → [intVec](#stdcpp_python_export.intVec) +## stdcpp_python_export.int_list_to_vec(arg1: list) → [intVec](#stdcpp_python_export.intVec) + -### stdcpp_python_export.list_to_vec(arg1: list) → [intVec](#stdcpp_python_export.intVec) +## stdcpp_python_export.list_to_vec(arg1: list) → [intVec](#stdcpp_python_export.intVec) -### stdcpp_python_export.list_to_vec(arg1: list) → [uintVec](#stdcpp_python_export.uintVec) +## stdcpp_python_export.list_to_vec(arg1: list) → [uintVec](#stdcpp_python_export.uintVec) -### stdcpp_python_export.list_to_vec(arg1: list) → [doubleVec](#stdcpp_python_export.doubleVec) +## stdcpp_python_export.list_to_vec(arg1: list) → [doubleVec](#stdcpp_python_export.doubleVec) -### stdcpp_python_export.list_to_vec(arg1: list) → [stringVec](#stdcpp_python_export.stringVec) +## stdcpp_python_export.list_to_vec(arg1: list) → [stringVec](#stdcpp_python_export.stringVec) -### stdcpp_python_export.list_to_vec(arg1: list) → [doubleVecVec](#stdcpp_python_export.doubleVecVec) +## stdcpp_python_export.list_to_vec(arg1: list) → [doubleVecVec](#stdcpp_python_export.doubleVecVec) -### stdcpp_python_export.list_to_vec(arg1: list) → [boolVec](#stdcpp_python_export.boolVec) +## stdcpp_python_export.list_to_vec(arg1: list) → [boolVec](#stdcpp_python_export.boolVec) + -### *class* stdcpp_python_export.map_indexing_suite_string_to_bool_map_entry +## *class* stdcpp_python_export.map_indexing_suite_string_to_bool_map_entry + -#### \_\_init_\_() +### \_\_init_\_() + -#### \_\_repr_\_() → object +### \_\_repr_\_() → object + -#### data() → bool +### data() → bool + -#### key() → str +### key() → str + -### *class* stdcpp_python_export.map_indexing_suite_string_to_double_map_entry +## *class* stdcpp_python_export.map_indexing_suite_string_to_double_map_entry + -#### \_\_init_\_() +### \_\_init_\_() + -#### \_\_repr_\_() → object +### \_\_repr_\_() → object + -#### data() → float +### data() → float + -#### key() → str +### key() → str + -### *class* stdcpp_python_export.map_indexing_suite_string_to_uint_map_entry +## *class* stdcpp_python_export.map_indexing_suite_string_to_uint_map_entry + -#### \_\_init_\_() +### \_\_init_\_() + -#### \_\_repr_\_() → object +### \_\_repr_\_() → object + -#### data() → int +### data() → int + -#### key() → str +### key() → str + -### *class* stdcpp_python_export.stringVec +## *class* stdcpp_python_export.stringVec + -#### \_\_contains_\_(arg2: object) → bool +### \_\_contains_\_(arg2: object) → bool + -#### \_\_delitem_\_(arg2: object) +### \_\_delitem_\_(arg2: object) + -#### \_\_getitem_\_(arg2: object) → object +### \_\_getitem_\_(arg2: object) → object + -#### \_\_init_\_() +### \_\_init_\_() + -#### \_\_iter_\_() → object +### \_\_iter_\_() → object + -#### \_\_len_\_() → int +### \_\_len_\_() → int + -#### \_\_setitem_\_(arg2: object, arg3: object) +### \_\_setitem_\_(arg2: object, arg3: object) + -#### append(arg2: object) +### append(arg2: object) + -#### extend(arg2: object) +### extend(arg2: object) + -#### push_back(arg2: str) +### push_back(arg2: str) + -#### size() → int +### size() → int + -### stdcpp_python_export.string_list_to_vec(arg1: list) → [stringVec](#stdcpp_python_export.stringVec) +## stdcpp_python_export.string_list_to_vec(arg1: list) → [stringVec](#stdcpp_python_export.stringVec) + -### *class* stdcpp_python_export.string_to_bool_map +## *class* stdcpp_python_export.string_to_bool_map + -#### \_\_contains_\_(arg2: object) → bool +### \_\_contains_\_(arg2: object) → bool + -#### \_\_delitem_\_(arg2: object) +### \_\_delitem_\_(arg2: object) + -#### \_\_getitem_\_(arg2: object) → object +### \_\_getitem_\_(arg2: object) → object + -#### \_\_init_\_() +### \_\_init_\_() + -#### \_\_iter_\_() → object +### \_\_iter_\_() → object + -#### \_\_len_\_() → int +### \_\_len_\_() → int + -#### \_\_setitem_\_(arg2: object, arg3: object) +### \_\_setitem_\_(arg2: object, arg3: object) + -### *class* stdcpp_python_export.string_to_double_map +## *class* stdcpp_python_export.string_to_double_map + -#### \_\_contains_\_(arg2: object) → bool +### \_\_contains_\_(arg2: object) → bool + -#### \_\_delitem_\_(arg2: object) +### \_\_delitem_\_(arg2: object) + -#### \_\_getitem_\_(arg2: object) → object +### \_\_getitem_\_(arg2: object) → object + -#### \_\_init_\_() +### \_\_init_\_() + -#### \_\_iter_\_() → object +### \_\_iter_\_() → object + -#### \_\_len_\_() → int +### \_\_len_\_() → int + -#### \_\_setitem_\_(arg2: object, arg3: object) +### \_\_setitem_\_(arg2: object, arg3: object) + -### *class* stdcpp_python_export.string_to_uint_map +## *class* stdcpp_python_export.string_to_uint_map + -#### \_\_contains_\_(arg2: object) → bool +### \_\_contains_\_(arg2: object) → bool + -#### \_\_delitem_\_(arg2: object) +### \_\_delitem_\_(arg2: object) + -#### \_\_getitem_\_(arg2: object) → object +### \_\_getitem_\_(arg2: object) → object + -#### \_\_init_\_() +### \_\_init_\_() + -#### \_\_iter_\_() → object +### \_\_iter_\_() → object + -#### \_\_len_\_() → int +### \_\_len_\_() → int + -#### \_\_setitem_\_(arg2: object, arg3: object) +### \_\_setitem_\_(arg2: object, arg3: object) + -### *class* stdcpp_python_export.uintVec +## *class* stdcpp_python_export.uintVec + -#### \_\_contains_\_(arg2: object) → bool +### \_\_contains_\_(arg2: object) → bool + -#### \_\_delitem_\_(arg2: object) +### \_\_delitem_\_(arg2: object) + -#### \_\_getitem_\_(arg2: object) → object +### \_\_getitem_\_(arg2: object) → object + -#### \_\_init_\_() +### \_\_init_\_() + -#### \_\_iter_\_() → object +### \_\_iter_\_() → object + -#### \_\_len_\_() → int +### \_\_len_\_() → int + -#### \_\_setitem_\_(arg2: object, arg3: object) +### \_\_setitem_\_(arg2: object, arg3: object) + -#### append(arg2: object) +### append(arg2: object) + -#### extend(arg2: object) +### extend(arg2: object) + -#### push_back(arg2: int) +### push_back(arg2: int) + -#### size() → int +### size() → int + -### stdcpp_python_export.uint_list_to_vec(arg1: list) → [uintVec](#stdcpp_python_export.uintVec) +## stdcpp_python_export.uint_list_to_vec(arg1: list) → [uintVec](#stdcpp_python_export.uintVec) diff --git a/2025R2/optiSLang-python-api/toc.yml b/2025R2/optiSLang-python-api/toc.yml index 49e4315265..9c32fca4aa 100644 --- a/2025R2/optiSLang-python-api/toc.yml +++ b/2025R2/optiSLang-python-api/toc.yml @@ -1,83 +1,78 @@ -- name: Introduction +- name: optiSLang Python API href: index.md - name: Data types items: - - name: Custom types - href: modules/custom_types.md - - name: ID - href: modules/id.md - - name: Py Algorithm Info - href: modules/py_algorithm_info.md - - name: Py File Access - href: modules/py_file_access.md - - name: Py OMDB - href: modules/py_omdb.md - - name: Py OS Criterion - href: modules/py_os_criterion.md - - name: Py OS Design - href: modules/py_os_design.md - - name: Py OS Parameter - href: modules/py_os_parameter.md - - name: Py Project - href: modules/py_project.md - - name: Py Random Variables - href: modules/py_random_variables.md - - name: Py Transform - href: modules/py_transform.md - - name: Py Variant - href: modules/pyvariant.md - - name: StdCPP Python Export - href: modules/stdcpp_python_export.md + - name: custom_types + href: modules/custom_types.md + - name: id + href: modules/id.md + - name: py_algorithm_info + href: modules/py_algorithm_info.md + - name: py_file_access + href: modules/py_file_access.md + - name: py_omdb + href: modules/py_omdb.md + - name: py_os_criterion + href: modules/py_os_criterion.md + - name: py_os_design + href: modules/py_os_design.md + - name: py_os_parameter + href: modules/py_os_parameter.md + - name: py_project + href: modules/py_project.md + - name: py_random_variables + href: modules/py_random_variables.md + - name: py_transform + href: modules/py_transform.md + - name: pyvariant + href: modules/pyvariant.md + - name: stdcpp_python_export + href: modules/stdcpp_python_export.md - name: Algorithm - items: - - name: AMOP - href: modules/amop.md - - name: Dynardo Py Algorithms - href: modules/dynardo_py_algorithms.md - - name: OS DOE Py Export - href: modules/os_doe_py_export.md - - name: PyARSM - href: modules/PyARSM.md - - name: Py DOE Settings - href: modules/py_doe_settings.md - - name: PyMemetic - href: modules/PyMemetic.md - - name: Py MOP FMU Export - href: modules/py_mop_fmu_export.md - - name: PyNLPQLP - href: modules/PyNLPQLP.md - - name: PyNOA - href: modules/PyNOA.md - - name: PyNOA2 - href: modules/PyNOA2.md - - name: PyOptimizerBase - href: modules/PyOptimizerBase.md - - name: PyOptimizerGradientBase - href: modules/PyOptimizerGradientBase.md - - name: Py Reliability Adaptive - href: modules/py_reliability_adaptive.md - - name: Py Reliability Monte Carlo - href: modules/py_reliability_montecarlo.md - - name: PySimplex - href: modules/PySimplex.md - - name: Reliability - href: modules/reliability.md + items: + - name: amop + href: modules/amop.md + - name: dynardo_py_algorithms + href: modules/dynardo_py_algorithms.md + - name: os_doe_py_export + href: modules/os_doe_py_export.md + - name: PyARSM + href: modules/PyARSM.md + - name: py_doe_settings + href: modules/py_doe_settings.md + - name: PyMemetic + href: modules/PyMemetic.md + - name: py_mop_fmu_export + href: modules/py_mop_fmu_export.md + - name: PyNLPQLP + href: modules/PyNLPQLP.md + - name: PyNOA + href: modules/PyNOA.md + - name: PyNOA2 + href: modules/PyNOA2.md + - name: PyOptimizerBase + href: modules/PyOptimizerBase.md + - name: PyOptimizerGradientBase + href: modules/PyOptimizerGradientBase.md + - name: py_reliability_adaptive + href: modules/py_reliability_adaptive.md + - name: py_reliability_montecarlo + href: modules/py_reliability_montecarlo.md + - name: PySimplex + href: modules/PySimplex.md + - name: reliability + href: modules/reliability.md - name: Postprocessing items: - - name: Py Monitoring GUI - href: modules/py_monitoring_gui.md - - name: Py Monitoring Kernel - href: modules/py_monitoring_kernel.md - - name: Py OSL3 Bin File - href: modules/py_osl3binfile.md + - name: py_monitoring_gui + href: modules/py_monitoring_gui.md + - name: py_monitoring_kernel + href: modules/py_monitoring_kernel.md + - name: py_osl3binfile + href: modules/py_osl3binfile.md - name: Kernel items: - - name: optiSLang actors - href: modules/_optiSLang_Actors.md - - name: optiSLang kernel - href: modules/_optiSLang_Kernel.md - - - - - + - name: _optiSLang_Actors + href: modules/_optiSLang_Actors.md + - name: _optiSLang_Kernel + href: modules/_optiSLang_Kernel.md