Enums

AdaptiveSamplingActor

Inherits from: ReliabilityBaseActor

Reliability actor using the Adaptive Sampling method.

Constructors

AdaptiveSamplingActor()
AdaptiveSamplingActor( (str) )

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
(dict) 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.
(dict) 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.
() 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.
() 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.
(PyOSCriterionContainer) criteria
(float) design_point_tolerance
(str) dot_graph
() goal
() max_runtime
(str) name
(PyParameterManager) parameter_manager
(ParameterMergingMode) parameter_merging_mode
(bool) prefer_criteria_from_slot
() read_mode
(bool) register_avz_files
(bool) register_cax_files
(bool) register_images
(SettingsAdaptiveSampling) reliability_settings
() reliability_settings
(PyOSDesignPoint) responses
() result_file_path
() result_recycling
() retry_count
() retry_delay
() retry_enable
(bool) solve_duplicated
(bool) solve_reference
(bool) solve_start_designs_again
(bool) solve_violated
() start_designs
(PyOSDesignContainer) start_designs
() starting_delay
() starting_point
() stop_after_execution
(UpdateResultFileInterval) update_result_file
(UUID) uuid
(bool) write_osl3_bin_file_default

Methods

AlgorithmPluginSystem

Inherits from: AlgorithmSystemActor

Constructors

AlgorithmPluginSystem( (str) plugin name) -> object :
Create an algorithm plugin actor by name. The plugin must be loaded at runtime.

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
(dict) 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.
(dict) 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.
() 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.
() 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.
(PyOSCriterionContainer) criteria
(float) design_point_tolerance
(str) dot_graph
() goal
() max_runtime
(str) name
(PyParameterManager) parameter_manager
(ParameterMergingMode) parameter_merging_mode
(bool) prefer_criteria_from_slot
() read_mode
(bool) register_avz_files
(bool) register_cax_files
(bool) register_images
(PyOSDesignPoint) responses
() result_file_path
() result_recycling
() retry_count
() retry_delay
() retry_enable
(bool) solve_duplicated
(bool) solve_reference
(bool) solve_start_designs_again
(bool) solve_violated
() start_designs
(PyOSDesignContainer) start_designs
() starting_delay
() starting_point
() stop_after_execution
(UpdateResultFileInterval) update_result_file
(UUID) uuid
(bool) write_osl3_bin_file_default

Methods

get_internal_property_names

get_internal_property_names() -> list

Get names of properties defined by the plugin internally

get_plugin_id

get_plugin_id() -> str

The plugin id.

AlgorithmSystemActor

Inherits from: ParametricSystemActor

Inherited by

CustomAlgorithmActor AlgorithmPluginSystem SamplingActor AMOPActor OptimizationBaseActor ReliabilityBaseActor

Constructors

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
(dict) 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.
(dict) 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.
() 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.
() 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.
(PyOSCriterionContainer) criteria
(float) design_point_tolerance
(str) dot_graph
() goal
() max_runtime
(str) name
(PyParameterManager) parameter_manager
(ParameterMergingMode) parameter_merging_mode
(bool) prefer_criteria_from_slot
() read_mode
(bool) register_avz_files
(bool) register_cax_files
(bool) register_images
(PyOSDesignPoint) responses
() result_file_path
() result_recycling
() retry_count
() retry_delay
() retry_enable
(bool) solve_duplicated
(bool) solve_reference
(bool) solve_start_designs_again
(bool) solve_violated
() start_designs
(PyOSDesignContainer) start_designs
() starting_delay
() starting_point
() stop_after_execution
(UpdateResultFileInterval) update_result_file
(UUID) uuid
(bool) write_osl3_bin_file_default

Methods

AMOPActor

Inherits from: AlgorithmSystemActor

Constructors

AMOPActor()
AMOPActor( (str) )

Properties

() active
(AMopSettings) amop_settings
() auto_save_mode
() auto_save_on_nth_design_collected
(dict) 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.
(dict) 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.
() 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.
() 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.
(PyOSCriterionContainer) criteria
(float) design_point_tolerance
(str) dot_graph
() goal
() max_runtime
(MOPAdvancedSettings) mop_advanced_settings
(MOPAutomaticSettings) mop_automatic_settings
(str) name
(string_to_uint_map) parameter_importancy
(PyParameterManager) parameter_manager
(ParameterMergingMode) parameter_merging_mode
(bool) prefer_criteria_from_slot
() read_mode
(bool) register_avz_files
(bool) register_cax_files
(bool) register_images
(PyOSDesignPoint) responses
() result_file_path
() result_recycling
() retry_count
() retry_delay
() retry_enable
(eSettingsType) settings_type
(bool) solve_duplicated
(bool) solve_reference
(bool) solve_start_designs_again
(bool) solve_violated
() start_designs
(PyOSDesignContainer) start_designs
() starting_delay
() starting_point
() stop_after_execution
(UpdateResultFileInterval) update_result_file
(UUID) uuid
(bool) write_osl3_bin_file_default

Methods

AnsysAPDLInputActor

Inherits from: TextInputActor

Constructors

AnsysAPDLInputActor()
AnsysAPDLInputActor( (str) )

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
() 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.
() 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.
(str) content
() distinct_working_directory
(str) encoding
() error_code
() execution_policy
(str) file_content
(ProvidedPath) file_path
() goal
() instant_variable_update
() max_runtime
(str) name
() read_mode
(list) 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.
() result_recycling
() retry_count
() retry_delay
() retry_enable
() starting_delay
() starting_point
() stop_after_execution
(bool) store_content
(UUID) uuid

Methods

get_locations_from_file

get_locations_from_file( (Path)arg2, (PyOSDesignPoint)arg3) -> bool

get_locations_from_string

get_locations_from_string( (str)arg2, (PyOSDesignPoint)arg3) -> bool

register_location_as_parameter

register_location_as_parameter( (str)arg2 [, (str)arg3]) -> None

register_locations_as_parameter

register_locations_as_parameter() -> None

AnsysWorkbenchActor

Inherits from: IntegrationBaseActor

Constructors

AnsysWorkbenchActor()

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
() 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.
() 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.
(int) designs_per_process
() distinct_working_directory
() error_code
(Path) executable_path
() execution_policy
() goal
(int) group_size
(str) hostname
(InputFilesList) input_files
() instant_variable_update
() max_runtime
(str) name
(int) number_of_processes
(OutputFilesList) output_files
(Path) path_to_connect
(ProvidedPath) path_to_project
() ports
(ProjectSource) project_source
(ProvidedPath) python_script_path
() read_mode
() result_recycling
() retry_count
() retry_delay
() retry_enable
(bool) save_design_points
() starting_delay
() starting_point
() stop_after_execution
(bool) use_python_script
(bool) use_rsm
(UUID) uuid

Methods

add_input

add_input( (str)arg2, (PyOSDesignEntry)arg3) -> None

add_output

add_output( (str)arg2, (PyOSDesignEntry)arg3) -> None

add_parameter

add_parameter( (str)arg2, (PyOSDesignEntry)arg3) -> str

add_parameter_by_id

add_parameter_by_id( (str)arg2, (PyOSDesignEntry)arg3) -> str

add_response

add_response( (str)arg2, (PyOSDesignEntry)arg3) -> str

add_response_by_id

add_response_by_id( (str)arg2, (PyOSDesignEntry)arg3) -> str

close_project

close_project() -> bool

ensure_valid_connection

ensure_valid_connection() -> bool

get_connection

get_connection() -> MulticastInfo

get_input_name

get_input_name( (int)arg2) -> str

get_input_value

get_input_value( (int)arg2) -> PyOSDesignEntry

get_num_inputs

get_num_inputs() -> int

get_num_outputs

get_num_outputs() -> int

get_output_name

get_output_name( (int)arg2) -> str

get_output_value

get_output_value( (int)arg2) -> PyOSDesignEntry

open_project

open_project() -> bool

set_cleaning_mode

set_connection

set_connection( (MulticastInfo)arg2) -> None

AppendDesignsToBinFileActor

Inherits from: Actor

Constructors

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
() 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.
() 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.
() goal
() max_runtime
(str) name
() read_mode
() result_recycling
() retry_count
() retry_delay
() retry_enable
() starting_delay
() starting_point
() stop_after_execution
(UUID) uuid

Methods

ARSMActor

Inherits from: OptimizationBaseActor

Constructors

ARSMActor()
ARSMActor( (str) )

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
(dict) 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.
(dict) 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.
() 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.
() 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.
(PyOSCriterionContainer) criteria
(float) design_point_tolerance
(DOESettings) doe_settings
(str) dot_graph
() goal
() max_runtime
(str) name
(SettingsNLPQLP) nlpqlp_settings
(OptimizerSettingsARSM) optimizer_settings
() optimizer_settings
(PyParameterManager) parameter_manager
(ParameterMergingMode) parameter_merging_mode
(bool) prefer_criteria_from_slot
() read_mode
(bool) register_avz_files
(bool) register_cax_files
(bool) register_images
(PyOSDesignPoint) responses
() result_file_path
() result_recycling
() retry_count
() retry_delay
() retry_enable
(bool) solve_duplicated
(bool) solve_reference
(bool) solve_start_designs_again
(bool) solve_violated
() start_designs
(PyOSDesignContainer) start_designs
() starting_delay
() starting_point
() stop_after_execution
(UpdateResultFileInterval) update_result_file
(UUID) uuid
(bool) write_osl3_bin_file_default

Methods

ARSMDSActor

Inherits from: ReliabilityBaseActor

Reliability actor using ARSM with Directional Sampling.

Constructors

ARSMDSActor()
ARSMDSActor( (str) )

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
(dict) 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.
(dict) 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.
() 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.
() 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.
(PyOSCriterionContainer) criteria
(float) design_point_tolerance
(str) dot_graph
() goal
() max_runtime
(str) name
(PyParameterManager) parameter_manager
(ParameterMergingMode) parameter_merging_mode
(bool) prefer_criteria_from_slot
() read_mode
(bool) register_avz_files
(bool) register_cax_files
(bool) register_images
(SettingsARSMDS) reliability_settings
() reliability_settings
(PyOSDesignPoint) responses
() result_file_path
() result_recycling
() retry_count
() retry_delay
() retry_enable
(bool) solve_duplicated
(bool) solve_reference
(bool) solve_start_designs_again
(bool) solve_violated
() start_designs
(PyOSDesignContainer) start_designs
() starting_delay
() starting_point
() stop_after_execution
(UpdateResultFileInterval) update_result_file
(UUID) uuid
(bool) write_osl3_bin_file_default

Methods

AutoParamOutputVariable

Member class of: ETK

Inherits from: PythonBasedOutputVariable

Constructors

AutoParamOutputVariable()
AutoParamOutputVariable( (Path) )
AutoParamOutputVariable( (Path) , (Path) )
AutoParamOutputVariable( (Path) , (str) , (WStrList) )
AutoParamOutputVariable( (Path) , (Path) , (str) , (WStrList) )

Properties

() ident

BaseFileMapping

Member class of: ProcessActor

Inherited by

InputFileMapping OutputFileMapping

Constructors

BaseFileMapping()
BaseFileMapping( (Path) , (str) )
BaseFileMapping( (Path) , (str) , (ArchivalMode) )

Properties

(ArchivalMode) archival_mode
(str) slot_name
(Path) working_file_name

BashScriptActor

Inherits from: ScriptFileActor

Constructors

BashScriptActor()
BashScriptActor( (str) )

Properties

() active
(WStrList) arguments
() auto_save_mode
() auto_save_on_nth_design_collected
(str) command
() 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.
() 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.
() content
() distinct_working_directory
(bool) enable_multi_design_launch
(WStrList) environment
() error_code
() execution_policy
() goal
(bool) ignore_exit_code
(InputFilesList) input_files
() instant_variable_update
(int) max_parallel
() max_runtime
(int) multi_design_launch_num
(str) name
(OutputFilesList) output_files
(bool) prepend_project_bin_to_path
() read_mode
() result_recycling
() retry_count
() retry_delay
() retry_enable
() script_path
() starting_delay
() starting_point
() stop_after_execution
(UUID) uuid
(Path) working_dir

Methods

BatchScriptActor

Inherits from: ScriptFileActor

Constructors

BatchScriptActor()
BatchScriptActor( (str) )

Properties

() active
(WStrList) arguments
() auto_save_mode
() auto_save_on_nth_design_collected
(str) command
() 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.
() 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.
() content
() distinct_working_directory
(bool) enable_multi_design_launch
(WStrList) environment
() error_code
() execution_policy
() goal
(bool) ignore_exit_code
(InputFilesList) input_files
() instant_variable_update
(int) max_parallel
() max_runtime
(int) multi_design_launch_num
(str) name
(OutputFilesList) output_files
(bool) prepend_project_bin_to_path
() read_mode
() result_recycling
() retry_count
() retry_delay
() retry_enable
() script_path
() starting_delay
() starting_point
() stop_after_execution
(UUID) uuid
(Path) working_dir

Methods

CalculatorSetActor

Inherits from: IntegrationBaseActor

Constructors

CalculatorSetActor()
CalculatorSetActor( (str) )

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
() 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.
() 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.
() distinct_working_directory
() error_code
() execution_policy
() goal
() instant_variable_update
() max_runtime
(str) name
() read_mode
() result_recycling
() retry_count
() retry_delay
() retry_enable
() starting_delay
() starting_point
() stop_after_execution
(UUID) uuid

Methods

add_expression

add_expression( (str)arg2, (str)arg3 [, (bool)arg4]) -> None

add_output

add_output( (str)arg2, (str)arg3 [, (PyOSDesignEntry)arg4]) -> None

add_response

add_response( (str)arg2, (str)arg3 [, (PyOSDesignEntry)arg4]) -> None

register_as_internal_location

register_as_internal_location( (str)arg2, (str)arg3 [, (bool)arg4]) -> None

remove_expression

remove_expression( (str)arg2) -> None

unregister_from_internal_locations

unregister_from_internal_locations( (str)arg2) -> None

CatiaInputActor

Inherits from: TextInputActor

Constructors

CatiaInputActor()
CatiaInputActor( (str) )

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
() 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.
() 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.
(str) content
() distinct_working_directory
(str) encoding
() error_code
() execution_policy
(str) file_content
(ProvidedPath) file_path
() goal
() instant_variable_update
() max_runtime
(str) name
() read_mode
(list) 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.
() result_recycling
() retry_count
() retry_delay
() retry_enable
() starting_delay
() starting_point
() stop_after_execution
(bool) store_content
(UUID) uuid

Methods

get_locations_from_file

get_locations_from_file( (Path)arg2, (PyOSDesignPoint)arg3) -> bool

get_locations_from_string

get_locations_from_string( (str)arg2, (PyOSDesignPoint)arg3) -> bool

ColumnReader

Member class of: ETKTextOutputActor

Inherits from: TextMarker

Constructors

Properties

(int) initial_offset
() repeater
(int) width

Methods

ColumnReader

Member class of: ETK

Inherits from: TextMarker

Constructors

Properties

(int) initial_offset
() repeater
(int) width

Methods

ColumnReader

Member class of: ETKTextOutputActor

Inherits from: TextMarker

Constructors

Properties

(int) initial_offset
() repeater
(int) width

Methods

CustomAlgorithmActor

Inherits from: AlgorithmSystemActor

Constructors

CustomAlgorithmActor( (str) algorithm name) -> object :
Create a Custom Algorithm actor by name. The corresponding script must be located in CA path.

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
(dict) 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.
(dict) 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.
() 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.
() 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.
(PyOSCriterionContainer) criteria
(float) design_point_tolerance
(str) dot_graph
() goal
() id

The custom algorithm's ID as specified in the wrapper script filename.
() max_runtime
(str) name
(PyParameterManager) parameter_manager
(ParameterMergingMode) parameter_merging_mode
(bool) prefer_criteria_from_slot
() read_mode
(bool) register_avz_files
(bool) register_cax_files
(bool) register_images
(PyOSDesignPoint) responses
() result_file_path
() result_recycling
() retry_count
() retry_delay
() retry_enable
() settings
(bool) solve_duplicated
(bool) solve_reference
(bool) solve_start_designs_again
(bool) solve_violated
() start_designs
(PyOSDesignContainer) start_designs
() starting_delay
() starting_point
() stop_after_execution
(UpdateResultFileInterval) update_result_file
(UUID) uuid
(bool) write_osl3_bin_file_default

Methods

get_default_settings

get_default_settings() -> PyOSDesignPoint

get_dot_graph

CustomIntegrationActor

Inherits from: CustomizedBaseActor

Constructors

CustomIntegrationActor( (str) integration name) -> object :
Create a Custom Python Integration actor by name. The script must be located in CI path.

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
() 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.
() 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.
() distinct_working_directory
() error_code
() error_code
() error_code
() execution_policy
() goal
() id

The custom integration's ID as specified in the wrapper script filename.
() instant_variable_update
() instant_variable_update
() instant_variable_update
() max_parallel
() max_runtime
() multi_design_launch_num
(str) name
() path
() path
() read_mode
() result_recycling
() retry_count
() retry_delay
() retry_enable
() settings
() starting_delay
() starting_point
() stop_after_execution
() use_as_input_integration
() use_as_output_integration
() use_as_solver
(UUID) uuid

Methods

get_default_settings

get_default_settings( (bool)arg2) -> PyOSDesignPoint

CustomizedBaseActor

Inherits from: IntegrationBaseActor

Inherited by

CustomIntegrationActor TurboOptInputActor FloEFDInputActor SimpackInputActor

Constructors

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
() 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.
() 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.
() distinct_working_directory
() error_code
() error_code
() execution_policy
() goal
() instant_variable_update
() instant_variable_update
() max_runtime
(str) name
() path
() read_mode
() result_recycling
() retry_count
() retry_delay
() retry_enable
() starting_delay
() starting_point
() stop_after_execution
() use_as_input_integration
() use_as_output_integration
() use_as_solver
(UUID) uuid

Methods

add_input

add_input( (str)name and PyOSDesignEntry, (CustomizedBaseInfo)location) -> None

Assign location to input slot.

add_output

add_output( (str)name and PyOSDesignEntry, (CustomizedBaseInfo)location) -> None

Assign location to output slot.

add_parameter

add_parameter( (tuple)name and PyOSDesignEntry, (CustomizedBaseInfo)location) -> None

Assign location to parameter.

add_response

add_response( (tuple)name and PyOSDesignEntry, (CustomizedBaseInfo)location) -> None

Assign location to response.

register_as_internal_location

register_as_internal_location( (CustomizedBaseInfo)location [, (str)name [, (PyOSDesignEntry)reference value]]) -> bool

Assign location to an internal variable.

CustomizedBaseInfo

Constructors

CustomizedBaseInfo()
CustomizedBaseInfo( (str) , (IntegrationDirection) )
CustomizedBaseInfo( (PyOSDesignPoint) , (IntegrationDirection) )

CustomizedOutputVariable

Member class of: ETK

Inherits from: PythonBasedOutputVariable

Constructors

CustomizedOutputVariable()
CustomizedOutputVariable( (Path) )
CustomizedOutputVariable( (Path) , (Path) )
CustomizedOutputVariable( (Path) , (str) , (WStrList) )
CustomizedOutputVariable( (Path) , (Path) , (str) , (WStrList) )

Properties

() ident

Methods

set_custom_id

set_custom_id( (str)arg2) -> None

DataExportActor

Inherits from: Actor

Constructors

DataExportActor()
DataExportActor( (str) )

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
() 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.
() 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.
(ExportFailureTreatment) failure_treatment
() goal
() max_runtime
(str) name
(SplittedPath) path
() read_mode
() result_recycling
() retry_count
() retry_delay
() retry_enable
() starting_delay
() starting_point
() stop_after_execution
(UUID) uuid

Methods

DataImportActor

Inherits from: Actor

Constructors

DataImportActor()
DataImportActor( (str) )

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
() 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.
() 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.
(ImportFailureTreatment) failure_treatment
() goal
() max_runtime
(str) name
(SplittedPath) path
() read_mode
() result_recycling
() retry_count
() retry_delay
() retry_enable
() starting_delay
() starting_point
() stop_after_execution
(UUID) uuid

Methods

DataMiningActor

Inherits from: IntegrationBaseActor

Constructors

DataMiningActor()
DataMiningActor( (str) )

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
() 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.
() 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.
() distinct_working_directory
() error_code
() execution_policy
() goal
() instant_variable_update
() max_runtime
(str) name
() read_mode
() result_recycling
() retry_count
() retry_delay
() retry_enable
() starting_delay
() starting_point
() stop_after_execution
(UUID) uuid

Methods

init_append_best_designs

init_append_best_designs() -> None

Configure node with functionality to append best designs to an MDB file.

DerivedLocation

Constructors

DerivedLocation()
DerivedLocation( (str) , (str) )

Properties

(str) expression
(str) location_id

DesignCounts

Constructors

DesignCounts()

Methods

get_estimated

get_estimated() -> object

get_upper_bound

get_upper_bound() -> object

DesignExportActor

Inherits from: Actor

Constructors

DesignExportActor()
DesignExportActor( (str) )

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
() 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.
() 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.
(str) csv_delimiter
(NoneType) design_exporter
(ExportFormat) export_format
() goal
() max_runtime
(ProvidedPath) mdb_path
(str) name
(ProvidedPath) out_path
() read_mode
() result_recycling
() retry_count
() retry_delay
() retry_enable
() starting_delay
() starting_point
() stop_after_execution
(UUID) uuid

Methods

DesignImportActor

Inherits from: Actor

Constructors

DesignImportActor()
DesignImportActor( (str) )

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
() 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.
() 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.
(str) csv_delimiter
(NoneType) design_importer
() goal
(ImportFormat) import_format
(Path) in_path
() max_runtime
(Path) mdb_path
(str) name
() read_mode
() result_recycling
() retry_count
() retry_delay
() retry_enable
() starting_delay
() starting_point
() stop_after_execution
(UUID) uuid

Methods

DirectionalSamplingActor

Inherits from: ReliabilityBaseActor

Reliability actor using Directional Sampling.

Constructors

DirectionalSamplingActor()
DirectionalSamplingActor( (str) )

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
(dict) 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.
(dict) 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.
() 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.
() 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.
(PyOSCriterionContainer) criteria
(float) design_point_tolerance
(str) dot_graph
() goal
() max_runtime
(str) name
(PyParameterManager) parameter_manager
(ParameterMergingMode) parameter_merging_mode
(bool) prefer_criteria_from_slot
() read_mode
(bool) register_avz_files
(bool) register_cax_files
(bool) register_images
(SettingsDirectionalSampling) reliability_settings
() reliability_settings
(PyOSDesignPoint) responses
() result_file_path
() result_recycling
() retry_count
() retry_delay
() retry_enable
(bool) solve_duplicated
(bool) solve_reference
(bool) solve_start_designs_again
(bool) solve_violated
() start_designs
(PyOSDesignContainer) start_designs
() starting_delay
() starting_point
() stop_after_execution
(UpdateResultFileInterval) update_result_file
(UUID) uuid
(bool) write_osl3_bin_file_default

Methods

DistinctWorkingDirActor

Inherits from: Actor

Inherited by

IntegrationBaseActor

Constructors

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
() 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.
() 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.
() distinct_working_directory
() goal
() max_runtime
(str) name
() read_mode
() result_recycling
() retry_count
() retry_delay
() retry_enable
() starting_delay
() starting_point
() stop_after_execution
(UUID) uuid

Methods

DPSActor

Inherits from: IntegrationBaseActor

Constructors

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
() configuration
() 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.
() 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.
() distinct_working_directory
() error_code
() execution_policy
() goal
() instant_variable_update
() max_runtime
() max_submission_batch_size
(str) name
() output_files_to_fetch
() project
() read_mode
() refresh_token
() result_recycling
() retry_count
() retry_delay
() retry_enable
() starting_delay
() starting_point
() stop_after_execution
() url
(UUID) uuid

Methods

login

login( (str)arg2, (str)arg3) -> object

EAActor

Inherits from: NOAActor

Constructors

EAActor()
EAActor( (str) )

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
(dict) 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.
(dict) 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.
() 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.
() 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.
(PyOSCriterionContainer) criteria
(float) design_point_tolerance
(str) dot_graph
() goal
() max_runtime
(str) name
() optimizer_settings
() optimizer_settings
(PyParameterManager) parameter_manager
(ParameterMergingMode) parameter_merging_mode
(bool) prefer_criteria_from_slot
() read_mode
(bool) register_avz_files
(bool) register_cax_files
(bool) register_images
(PyOSDesignPoint) responses
() result_file_path
() result_recycling
() retry_count
() retry_delay
() retry_enable
(bool) solve_duplicated
(bool) solve_reference
(bool) solve_start_designs_again
(bool) solve_violated
() start_designs
(PyOSDesignContainer) start_designs
() starting_delay
() starting_point
() stop_after_execution
(UpdateResultFileInterval) update_result_file
(UUID) uuid
(bool) write_osl3_bin_file_default

Methods

ETK

Contains nested classes:

AutoParamOutputVariable ColumnReader CustomizedOutputVariable ETKAbaqusActor ETKActor ETKActorBase ETKActorSingle ETKFile ETKFileContainer ETKFloEFDActor ETKSimPackActor ETKTextOutputActor ETKTurboOptActor FileLocation FileVariable FloEFDOutputVariable IncrementRepeater LineReader MarkerRepeater ODBFieldOutputVariable ODBHistoryOutputVariable ODBSectionPointInfo ODBSectionPointInfoSet ODBSetInfo ODBSetInfoSet PythonBasedOutputVariable RegexSearcher RepeaterArgs SimPackOutputVariable TextMarker TextOutputVariable TokenReader TurboOptOutputVariable Variable

Constructors

ETKAbaqusActor

Member class of: ETK

Contains nested classes:

ODBFieldOutputVariable ODBHistoryOutputVariable ODBSectionPointInfo ODBSectionPointInfoSet ODBSetInfo ODBSetInfoSet

Inherits from: ETKActorSingle

Constructors

ETKAbaqusActor()
ETKAbaqusActor( (str) )

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
() 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.
() 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.
() distinct_working_directory
() error_code
() execution_policy
() file
() goal
() instant_variable_update
() max_runtime
(str) name
() path
() read_mode
() result_recycling
() retry_count
() retry_delay
() retry_enable
() splitted_path
() starting_delay
() starting_point
() stop_after_execution
(UUID) uuid

Methods

free_cached_resources

free_cached_resources() -> None

ETKAbaqusActor

Contains nested classes:

ODBFieldOutputVariable ODBHistoryOutputVariable ODBSectionPointInfo ODBSectionPointInfoSet ODBSetInfo ODBSetInfoSet

Inherits from: ETKActorSingle

Constructors

ETKAbaqusActor()
ETKAbaqusActor( (str) )

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
() 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.
() 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.
() distinct_working_directory
() error_code
() execution_policy
() file
() goal
() instant_variable_update
() max_runtime
(str) name
() path
() read_mode
() result_recycling
() retry_count
() retry_delay
() retry_enable
() splitted_path
() starting_delay
() starting_point
() stop_after_execution
(UUID) uuid

Methods

free_cached_resources

free_cached_resources() -> None

ETKActor

Member class of: ETK

Inherits from: ETKActorBase

Constructors

ETKActor()
ETKActor( (str) )

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
() 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.
() 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.
() distinct_working_directory
() error_code
() execution_policy
() goal
(ETKFileContainer) imported_files
() instant_variable_update
(int) max_parallel
() max_runtime
(str) name
() read_mode
() result_recycling
() retry_count
() retry_delay
() retry_enable
() starting_delay
() starting_point
() stop_after_execution
(UUID) uuid

Methods

ETKActor

Inherits from: ETKActorBase

Constructors

ETKActor()
ETKActor( (str) )

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
() 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.
() 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.
() distinct_working_directory
() error_code
() execution_policy
() goal
(ETKFileContainer) imported_files
() instant_variable_update
(int) max_parallel
() max_runtime
(str) name
() read_mode
() result_recycling
() retry_count
() retry_delay
() retry_enable
() starting_delay
() starting_point
() stop_after_execution
(UUID) uuid

Methods

ETKActorBase

Member class of: ETK

Inherits from: IntegrationBaseActor

Inherited by

ETKActorSingle ETKActor

Constructors

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
() 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.
() 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.
() distinct_working_directory
() error_code
() execution_policy
() goal
() instant_variable_update
() max_runtime
(str) name
() read_mode
() result_recycling
() retry_count
() retry_delay
() retry_enable
() starting_delay
() starting_point
() stop_after_execution
(UUID) uuid

Methods

add_output

add_output( (Variable)arg2 [, (bool)arg3]) -> None

add_response

add_response( (Variable)arg2 [, (bool)arg3]) -> None

----

add_response( (str)arg2, (PyOSDesignEntry)arg3, (DerivedLocation)arg4 [, (object)arg5]) -> str

----

add_response( (str)arg2, (PyOSDesignEntry)arg3, (Variable)arg4 [, (object)arg5]) -> str

register_as_internal_location

register_as_internal_location( (Variable)arg2) -> None

ETKActorSingle

Member class of: ETK

Inherits from: ETKActorBase

Inherited by

ETKTextOutputActor ETKAbaqusActor ETKTurboOptActor ETKFloEFDActor ETKSimPackActor

Constructors

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
() 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.
() 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.
() distinct_working_directory
() error_code
() execution_policy
() file
() goal
() instant_variable_update
() max_runtime
(str) name
() path
() read_mode
() result_recycling
() retry_count
() retry_delay
() retry_enable
() splitted_path
() starting_delay
() starting_point
() stop_after_execution
(UUID) uuid

Methods

ETKFile

Member class of: ETK

Constructors

ETKFile()
ETKFile( (ProvidedPath) , (str) )

Properties

(ProvidedPath) path
(str) type

ETKFileContainer

iterable has_length itemsetter itemgetter

Member class of: ETK

Constructors

ETKFileContainer()

Methods

append

append( (object)arg2) -> None

----

append( (ETKFile)arg2) -> None

extend

extend( (object)arg2) -> None

size

size() -> int

ETKFloEFDActor

Member class of: ETK

Contains nested classes:

FloEFDOutputVariable

Inherits from: ETKActorSingle

Constructors

ETKFloEFDActor()
ETKFloEFDActor( (str) )

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
() 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.
() 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.
() distinct_working_directory
() error_code
() execution_policy
() file
() goal
() instant_variable_update
() max_runtime
(str) name
() path
() read_mode
() result_recycling
() retry_count
() retry_delay
() retry_enable
() splitted_path
() starting_delay
() starting_point
() stop_after_execution
(UUID) uuid

Methods

ETKFloEFDActor

Contains nested classes:

FloEFDOutputVariable

Inherits from: ETKActorSingle

Constructors

ETKFloEFDActor()
ETKFloEFDActor( (str) )

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
() 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.
() 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.
() distinct_working_directory
() error_code
() execution_policy
() file
() goal
() instant_variable_update
() max_runtime
(str) name
() path
() read_mode
() result_recycling
() retry_count
() retry_delay
() retry_enable
() splitted_path
() starting_delay
() starting_point
() stop_after_execution
(UUID) uuid

Methods

ETKSimPackActor

Member class of: ETK

Contains nested classes:

SimPackOutputVariable

Inherits from: ETKActorSingle

Constructors

ETKSimPackActor()
ETKSimPackActor( (str) )

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
() 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.
() 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.
() distinct_working_directory
() error_code
() execution_policy
() file
() goal
() instant_variable_update
() max_runtime
(str) name
() path
() read_mode
() result_recycling
() retry_count
() retry_delay
() retry_enable
() splitted_path
() starting_delay
() starting_point
() stop_after_execution
(UUID) uuid

Methods

ETKSimPackActor

Contains nested classes:

SimPackOutputVariable

Inherits from: ETKActorSingle

Constructors

ETKSimPackActor()
ETKSimPackActor( (str) )

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
() 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.
() 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.
() distinct_working_directory
() error_code
() execution_policy
() file
() goal
() instant_variable_update
() max_runtime
(str) name
() path
() read_mode
() result_recycling
() retry_count
() retry_delay
() retry_enable
() splitted_path
() starting_delay
() starting_point
() stop_after_execution
(UUID) uuid

Methods

ETKTextOutputActor

Member class of: ETK

Contains nested classes:

ColumnReader IncrementRepeater LineReader MarkerRepeater RegexSearcher RepeaterArgs TextMarker TextOutputVariable TokenReader

Inherits from: ETKActorSingle

Constructors

ETKTextOutputActor()
ETKTextOutputActor( (str) )

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
() 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.
() 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.
() distinct_working_directory
() error_code
() execution_policy
() file
() goal
() instant_variable_update
(int) max_parallel
() max_runtime
(str) name
() path
() read_mode
() result_recycling
() retry_count
() retry_delay
() retry_enable
() splitted_path
() starting_delay
() starting_point
() stop_after_execution
(UUID) uuid

Methods

ETKTextOutputActor

Contains nested classes:

ColumnReader IncrementRepeater LineReader MarkerRepeater RegexSearcher RepeaterArgs TextMarker TextOutputVariable TokenReader

Inherits from: ETKActorSingle

Constructors

ETKTextOutputActor()
ETKTextOutputActor( (str) )

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
() 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.
() 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.
() distinct_working_directory
() error_code
() execution_policy
() file
() goal
() instant_variable_update
(int) max_parallel
() max_runtime
(str) name
() path
() read_mode
() result_recycling
() retry_count
() retry_delay
() retry_enable
() splitted_path
() starting_delay
() starting_point
() stop_after_execution
(UUID) uuid

Methods

ETKTurboOptActor

Member class of: ETK

Contains nested classes:

TurboOptOutputVariable

Inherits from: ETKActorSingle

Constructors

ETKTurboOptActor()
ETKTurboOptActor( (str) )

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
() 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.
() 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.
() distinct_working_directory
() error_code
() execution_policy
() file
() goal
() instant_variable_update
() max_runtime
(str) name
() path
() read_mode
() result_recycling
() retry_count
() retry_delay
() retry_enable
() splitted_path
() starting_delay
() starting_point
() stop_after_execution
(UUID) uuid

Methods

ETKTurboOptActor

Contains nested classes:

TurboOptOutputVariable

Inherits from: ETKActorSingle

Constructors

ETKTurboOptActor()
ETKTurboOptActor( (str) )

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
() 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.
() 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.
() distinct_working_directory
() error_code
() execution_policy
() file
() goal
() instant_variable_update
() max_runtime
(str) name
() path
() read_mode
() result_recycling
() retry_count
() retry_delay
() retry_enable
() splitted_path
() starting_delay
() starting_point
() stop_after_execution
(UUID) uuid

Methods

ExecutionPolicy

Constructors

ExecutionPolicy( (Continuation) continuation_behaviour=_optiSLang_Actors.Continuation.DEFAULT, (WStrList) expressions [, (Expressions) expressions_mode=_optiSLang_Actors.Expressions.FULFILL_ALL])
ExecutionPolicy( [, (Continuation) continuation_behaviour=_optiSLang_Actors.Continuation.DEFAULT [, (Expressions) expressions_mode=_optiSLang_Actors.Expressions.FULFILL_ALL]])

Properties

(Continuation) continuation_behaviour

Continuation behaviour in case of predecessor failure
(WStrList) expressions

Expression conditions
(Expressions) expressions_mode

Fulfillment mode for expression conditions

FileLocation

Member class of: ETK

Inherited by

FileVariable ODBFieldOutputVariable ODBHistoryOutputVariable

Constructors

FileMapping

Member class of: ProcessActor

Constructors

FileMapping()
FileMapping( (Path) , (str) )
FileMapping( (Path) , (str) , (ArchivalMode) )
FileMapping( (Path) , (Path) )
FileMapping( (Path) , (Path) , (ArchivalMode) )

Properties

(ArchivalMode) archival_mode
(Path) input_file_name_
(str) slot_name
(Path) working_file_name

FileVariable

Member class of: ETK

Inherits from: Variable

Inherited by

PythonBasedOutputVariable TextOutputVariable TurboOptOutputVariable FloEFDOutputVariable SimPackOutputVariable

Constructors

Properties

() ident

FloEFDInputActor

Inherits from: CustomizedBaseActor

Constructors

FloEFDInputActor( (str) )

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
() 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.
() 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.
() distinct_working_directory
() error_code
() error_code
() execution_policy
() goal
() instant_variable_update
() instant_variable_update
() max_runtime
(str) name
() path
() read_mode
() result_recycling
() retry_count
() retry_delay
() retry_enable
() starting_delay
() starting_point
() stop_after_execution
() use_as_input_integration
() use_as_output_integration
() use_as_solver
(UUID) uuid

Methods

FloEFDOutputVariable

Member class of: ETKFloEFDActor

Inherits from: FileVariable

Constructors

FloEFDOutputVariable()
FloEFDOutputVariable( (Path) )
FloEFDOutputVariable( (Path) , (Path) )
FloEFDOutputVariable( (Path) , (str) , (WStrList) )
FloEFDOutputVariable( (Path) , (Path) , (str) , (WStrList) )
FloEFDOutputVariable( (str) )
FloEFDOutputVariable( (str) , (str) , (WStrList) )

Properties

() ident

FloEFDOutputVariable

Member class of: ETK

Inherits from: FileVariable

Constructors

FloEFDOutputVariable()
FloEFDOutputVariable( (Path) )
FloEFDOutputVariable( (Path) , (Path) )
FloEFDOutputVariable( (Path) , (str) , (WStrList) )
FloEFDOutputVariable( (Path) , (Path) , (str) , (WStrList) )
FloEFDOutputVariable( (str) )
FloEFDOutputVariable( (str) , (str) , (WStrList) )

Properties

() ident

FloEFDOutputVariable

Member class of: ETKFloEFDActor

Inherits from: FileVariable

Constructors

FloEFDOutputVariable()
FloEFDOutputVariable( (Path) )
FloEFDOutputVariable( (Path) , (Path) )
FloEFDOutputVariable( (Path) , (str) , (WStrList) )
FloEFDOutputVariable( (Path) , (Path) , (str) , (WStrList) )
FloEFDOutputVariable( (str) )
FloEFDOutputVariable( (str) , (str) , (WStrList) )

Properties

() ident

FORMActor

Inherits from: ReliabilityBaseActor

Reliability actor using First Order Reliability Method.

Constructors

FORMActor()
FORMActor( (str) )

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
(dict) 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.
(dict) 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.
() 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.
() 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.
(PyOSCriterionContainer) criteria
(float) design_point_tolerance
(str) dot_graph
() goal
() max_runtime
(str) name
(PyParameterManager) parameter_manager
(ParameterMergingMode) parameter_merging_mode
(bool) prefer_criteria_from_slot
() read_mode
(bool) register_avz_files
(bool) register_cax_files
(bool) register_images
(SettingsFORM) reliability_settings
() reliability_settings
(PyOSDesignPoint) responses
() result_file_path
() result_recycling
() retry_count
() retry_delay
() retry_enable
(bool) solve_duplicated
(bool) solve_reference
(bool) solve_start_designs_again
(bool) solve_violated
() start_designs
(PyOSDesignContainer) start_designs
() starting_delay
() starting_point
() stop_after_execution
(UpdateResultFileInterval) update_result_file
(UUID) uuid
(bool) write_osl3_bin_file_default

Methods

IncrementRepeater

Member class of: ETKTextOutputActor

Inherits from: MarkerRepeater

Constructors

IncrementRepeater()
IncrementRepeater( (int) )
IncrementRepeater( (int) , (int) )
IncrementRepeater( (int) , (int) , (int) )

Properties

(int) increment
(int) max_increment
(int) offset

IncrementRepeater

Member class of: ETK

Inherits from: MarkerRepeater

Constructors

IncrementRepeater()
IncrementRepeater( (int) )
IncrementRepeater( (int) , (int) )
IncrementRepeater( (int) , (int) , (int) )

Properties

(int) increment
(int) max_increment
(int) offset

IncrementRepeater

Member class of: ETKTextOutputActor

Inherits from: MarkerRepeater

Constructors

IncrementRepeater()
IncrementRepeater( (int) )
IncrementRepeater( (int) , (int) )
IncrementRepeater( (int) , (int) , (int) )

Properties

(int) increment
(int) max_increment
(int) offset

InputFileMapping

Member class of: ProcessActor

Inherits from: BaseFileMapping

Constructors

InputFileMapping()
InputFileMapping( (Path) , (Path) )
InputFileMapping( (Path) , (Path) , (ArchivalMode) )
InputFileMapping( (Path) , (str) )
InputFileMapping( (Path) , (str) , (ArchivalMode) )

Properties

(ArchivalMode) archival_mode
(Path) input_file_name
(Path) input_file_name_
(str) slot_name
(Path) working_file_name

InputFilesList

iterable has_length itemsetter itemgetter

Member class of: ProcessActor

Constructors

InputFilesList()

Methods

append

append( (object)arg2) -> None

extend

extend( (object)arg2) -> None

push_back

push_back( (InputFileMapping)arg2) -> None

size

size() -> int

IntegrationBaseActor

Inherits from: DistinctWorkingDirActor

Inherited by

IntegrationPluginActor CalculatorSetActor ProcessActor SimtoolActor TextInputActor PythonActor MOPSolverActor AnsysWorkbenchActor CustomizedBaseActor PDMActor ETKActorBase DataMiningActor DPSActor

Constructors

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
() 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.
() 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.
() distinct_working_directory
() error_code
() execution_policy
() goal
() instant_variable_update
() max_runtime
(str) name
() read_mode
() result_recycling
() retry_count
() retry_delay
() retry_enable
() starting_delay
() starting_point
() stop_after_execution
(UUID) uuid

Methods

add_expression

add_expression( (DerivedLocation)arg2 [, (str)arg3 [, (PyOSDesignEntry)arg4]]) -> bool

----

add_expression( (str)arg2 [, (str)arg3 [, (PyOSDesignEntry)arg4]]) -> bool

add_parameter

add_parameter( (str)arg2, (PyOSDesignEntry)arg3 [, (object)arg4]) -> str

add_response

add_response( (tuple)arg2 [, (object)arg3]) -> str

----

add_response( (tuple)arg2 [, (DerivedLocation)arg3]) -> str

get_locations

get_locations() -> str

get_parameter

get_parameter( (PyOSDesignPoint)arg2) -> None

get_responses

get_responses( (PyOSDesignPoint)arg2) -> None

get_slot_value

register_as_internal_location

register_as_internal_location( (DerivedLocation)arg2 [, (str)arg3 [, (PyOSDesignEntry)arg4]]) -> bool

----

register_as_internal_location( (str)arg2 [, (str)arg3 [, (PyOSDesignEntry)arg4]]) -> bool

remove_expression

remove_expression( (str)arg2) -> bool

remove_input

remove_input( (str)arg2) -> None

remove_output

remove_output( (str)arg2) -> None

remove_parameter

remove_parameter( (str)arg2) -> None

remove_response

remove_response( (str)arg2) -> None

reread_parameter_reference_values

reread_parameter_reference_values( [, (bool)publish_reference_changes=True [, (bool)invalidate_on_fail=False]]) -> None

Re-reads parameter reference values and optionally updates values held by the parent system

reread_response_reference_values

reread_response_reference_values( [, (bool)publish_reference_changes=True [, (bool)invalidate_on_fail=False]]) -> None

Re-reads response reference values and optionally updates values held by the parent system

set_cleaning_mode

set_locations

set_locations( (str)arg2) -> bool

unregister_from_internal_locations

unregister_from_internal_locations( (str)arg2) -> bool

IntegrationPluginActor

Inherits from: IntegrationBaseActor

Constructors

IntegrationPluginActor( (str) plugin name) -> object :
Create an integration plugin actor by name. The plugin must be loaded at runtime.

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
() 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.
() 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.
() distinct_working_directory
() error_code
() error_code
() execution_policy
() goal
() instant_variable_update
() max_parallel
() max_runtime
(str) name
() read_mode
() result_recycling
() retry_count
() retry_delay
() retry_enable
() starting_delay
() starting_point
() stop_after_execution
(UUID) uuid

Methods

get_internal_property_names

get_internal_property_names() -> list

Get names of properties defined by the plugin internally

get_parameter

get_plugin_id

get_plugin_id() -> str

The plugin id.

get_registered_inputs

get_registered_inputs() -> list

Get registered input slots

get_registered_outputs

get_registered_outputs() -> list

Get registered output slots

get_registered_parameters

get_registered_parameters() -> list

Get registered parameters

get_registered_responses

get_registered_responses() -> list

Get registered responses

load

load() -> bool

Initialize integration according to specified properties

----

load( (str)json) -> bool

Initialize integration according to specified json-string content

re_register_locations_as_parameter

re_register_locations_as_parameter() -> None

re_register_locations_as_response

re_register_locations_as_response() -> None

register_location_as_input

register_location_as_input( (str)arg2 [, (str)arg3 [, (PyOSDesignEntry)arg4]]) -> None

register_location_as_internal_variable

register_location_as_internal_variable( (str)arg2 [, (str)arg3 [, (PyOSDesignEntry)arg4]]) -> None

register_location_as_output

register_location_as_output( (str)arg2 [, (str)arg3 [, (PyOSDesignEntry)arg4]]) -> None

register_location_as_parameter

register_location_as_parameter( (str)arg2 [, (str)arg3 [, (PyOSDesignEntry)arg4]]) -> None

register_location_as_response

register_location_as_response( (str)arg2 [, (str)arg3 [, (PyOSDesignEntry)arg4]]) -> None

register_locations_as_input

register_locations_as_input() -> None

register_locations_as_internal_variable

register_locations_as_internal_variable() -> None

register_locations_as_output

register_locations_as_output() -> None

register_locations_as_parameter

register_locations_as_parameter() -> None

register_locations_as_response

register_locations_as_response() -> None

ISPUDActor

Inherits from: ReliabilityBaseActor

Reliability actor that utilizes Importance Sampling Using the Design Point.

Constructors

ISPUDActor()
ISPUDActor( (str) )

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
(dict) 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.
(dict) 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.
() 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.
() 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.
(PyOSCriterionContainer) criteria
(float) design_point_tolerance
(str) dot_graph
() goal
() max_runtime
(str) name
(PyParameterManager) parameter_manager
(ParameterMergingMode) parameter_merging_mode
(bool) prefer_criteria_from_slot
() read_mode
(bool) register_avz_files
(bool) register_cax_files
(bool) register_images
(SettingsISPUD) reliability_settings
() reliability_settings
(PyOSDesignPoint) responses
() result_file_path
() result_recycling
() retry_count
() retry_delay
() retry_enable
(bool) solve_duplicated
(bool) solve_reference
(bool) solve_start_designs_again
(bool) solve_violated
() start_designs
(PyOSDesignContainer) start_designs
() starting_delay
() starting_point
() stop_after_execution
(UpdateResultFileInterval) update_result_file
(UUID) uuid
(bool) write_osl3_bin_file_default

Methods

LineReader

Member class of: ETKTextOutputActor

Inherits from: TextMarker

Constructors

LineReader()

Properties

() repeater

Methods

LineReader

Member class of: ETK

Inherits from: TextMarker

Constructors

LineReader()

Properties

() repeater

Methods

LineReader

Member class of: ETKTextOutputActor

Inherits from: TextMarker

Constructors

LineReader()

Properties

() repeater

Methods

LSDYNAInputActor

Inherits from: TextInputActor

Constructors

LSDYNAInputActor()
LSDYNAInputActor( (str) )

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
() 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.
() 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.
(str) content
() distinct_working_directory
(str) encoding
() error_code
() execution_policy
(str) file_content
(ProvidedPath) file_path
() goal
() instant_variable_update
() max_runtime
(str) name
() read_mode
(list) 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.
() result_recycling
() retry_count
() retry_delay
() retry_enable
() starting_delay
() starting_point
() stop_after_execution
(bool) store_content
(UUID) uuid

Methods

get_locations_from_file

get_locations_from_file( (Path)arg2, (PyOSDesignPoint)arg3) -> bool

get_locations_from_string

get_locations_from_string( (str)arg2, (PyOSDesignPoint)arg3) -> bool

MarkerRepeater

Member class of: ETKTextOutputActor

Inherited by

IncrementRepeater

Constructors

MarkerRepeater

Member class of: ETK

Inherited by

IncrementRepeater

Constructors

MarkerRepeater

Member class of: ETKTextOutputActor

Inherited by

IncrementRepeater

Constructors

MatlabActor

Inherits from: SimtoolActor

Constructors

MatlabActor()
MatlabActor( (str) )

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
() 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.
() 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.
() distinct_working_directory
() error_code
() execution_policy
() file_path
() goal
() instant_variable_update
(int) max_parallel
() max_runtime
(str) name
() pre_command
() read_mode
() result_recycling
() retry_count
() retry_delay
() retry_enable
() save
() starting_delay
() starting_point
() stop_after_execution
(bool) use_batch_mode
(UUID) uuid
() version

Methods

get_available_versions

get_available_versions() -> list

Return a list of tuples containing the displayed name and the value to set at the version property.

get_available_versions

MemeticActor

Inherits from: OptimizationBaseActor

Constructors

MemeticActor()
MemeticActor( (str) )

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
(dict) 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.
(dict) 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.
() 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.
() 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.
(PyOSCriterionContainer) criteria
(float) design_point_tolerance
(str) dot_graph
() goal
() max_runtime
(str) name
(MemeticSettings) optimizer_settings
() optimizer_settings
(PyParameterManager) parameter_manager
(ParameterMergingMode) parameter_merging_mode
(bool) prefer_criteria_from_slot
() read_mode
(bool) register_avz_files
(bool) register_cax_files
(bool) register_images
(PyOSDesignPoint) responses
() result_file_path
() result_recycling
() retry_count
() retry_delay
() retry_enable
(bool) solve_duplicated
(bool) solve_reference
(bool) solve_start_designs_again
(bool) solve_violated
() start_designs
(PyOSDesignContainer) start_designs
() starting_delay
() starting_point
() stop_after_execution
(UpdateResultFileInterval) update_result_file
(UUID) uuid
(bool) write_osl3_bin_file_default

Methods

MonitoringActor

Inherits from: Actor

Constructors

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
() 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.
() 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.
() goal
() max_runtime
(str) name
() read_mode
() result_recycling
() retry_count
() retry_delay
() retry_enable
() starting_delay
() starting_point
() stop_after_execution
(UUID) uuid

Methods

MonteCarloActor

Inherits from: ReliabilityBaseActor

Reliability actor using Monte Carlo methods.

Constructors

MonteCarloActor()
MonteCarloActor( (str) )

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
(dict) 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.
(dict) 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.
() 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.
() 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.
(PyOSCriterionContainer) criteria
(float) design_point_tolerance
(str) dot_graph
() goal
() max_runtime
(str) name
(PyParameterManager) parameter_manager
(ParameterMergingMode) parameter_merging_mode
(bool) prefer_criteria_from_slot
() read_mode
(bool) register_avz_files
(bool) register_cax_files
(bool) register_images
(SettingsMonteCarlo) reliability_settings
() reliability_settings
(PyOSDesignPoint) responses
() result_file_path
() result_recycling
() retry_count
() retry_delay
() retry_enable
(bool) solve_duplicated
(bool) solve_reference
(bool) solve_start_designs_again
(bool) solve_violated
() start_designs
(PyOSDesignContainer) start_designs
() starting_delay
() starting_point
() stop_after_execution
(UpdateResultFileInterval) update_result_file
(UUID) uuid
(bool) write_osl3_bin_file_default

Methods

MOPActor

Inherits from: SurrogateBaseActor

Constructors

MOPActor()
MOPActor( (str) )

Properties

() active
() advanced_settings

MOP advanced settings. Assigning to this property will activate advanced mode.
() auto_save_mode
() auto_save_on_nth_design_collected
() 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.
() 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.
() goal
() important_info
() max_runtime
() mdb_path
(eModelComplexityType) model_complexity
() mop_data

MOP parameter and response handling.
(str) name
(int) num_responses_parallel
() parameter_manager
(MOPAlgoSettings) pmop_settings
() read_mode
() responses
() responses_to_be_used
() result_recycling
() retry_count
() retry_delay
() retry_enable
(eSettingsType) settings_type
() show_pp_when_avaiable
() starting_delay
() starting_point
() stop_after_execution
() use_incomplete_designs
(UUID) uuid
(eVariableReductionType) variable_reduction

Methods

get_parameter_from_actor

get_responses_from_actor

get_resulting_parameters

MOPAdvancedSettings

Constructors

MOPAdvancedSettings()

Properties

(bool) adapt_bounds
(float) adapt_bounds_safety_factor
(WStrList) custom_surrogates
(str) cv_values_suffix
(Path) log_file_path
(bool) log_in_file
(bool) log_in_project_log
(int) num_parallel
(bool) use_incomplete
(bool) write_cv_values
(bool) write_function_string

MOPAlgoSettings

Constructors

MOPAlgoSettings()

Properties

(float) coefficient_factor_ascmo

Factor for minimum number of support points.
(float) coefficient_factor_kriging

Factor for minimum number of support points.
(float) coefficient_factor_mls

Factor for minimum number of support points.
(float) coefficient_factor_polynomial

Factor for minimum number of support points.
(float) correlation_input_check

Minimum correlation value for check.
(tuple) limits

Set limits as tuple of two values.
(float) max_cod

Maximum CoD step.
(float) max_coi

Maximum CoI step.
(float) max_input_correlation

Maximum correlation (multi-dimensional) for inputs.
(int) max_order_mls

Maximum basis order.
(int) max_order_polynomial

Maximum basis order.
(float) min_input_correlation

Minimum correlation (threshold) for inputs.
(float) min_significance

Limit for significance filter.
(int) num_correlation_steps

Number of steps for correlation filter combinations
(float) step_cod

Step size for CoD filter.
(float) step_coi

Step size for CoI filter.
(float) step_significance

Steps for filter reduction.
(TestingType) testing_type
(float) tolerance_cop_model
(float) tolerance_cop_variables
(bool) use_adjusted_cod
(bool) use_adjusted_cop
(bool) use_anisotropic_kernel_kriging
(bool) use_anisotropic_kernel_mls
(bool) use_ascmo

Use ASCMO.
(bool) use_boxcox

Use Box Cox.
(bool) use_cod_filter
(bool) use_coi_filter
(bool) use_correlation_filter
(bool) use_input_correlation_filter
(bool) use_interpolation

Use interpolation.
(bool) use_kriging

Use Kriging.
(bool) use_limits
(bool) use_mls

Use moving least squares.
(bool) use_polynomials

Use polynomials.
(bool) use_significance_filter
(bool) use_spearman

Use Spearman.
(bool) use_uniform_resample

Methods

get_custom_surrogate_usage

get_custom_surrogate_usage() -> dict

Return a dictionary of available custom surrogates and their usage state.

set_custom_surrogate

set_custom_surrogate( (str)name, (bool)use) -> None

Set use of custom surrogate by name. Add the surrogate if not yet present.

set_defaults

set_defaults() -> None

Reset settings to default values.

MOPAutomaticSettings

Constructors

MOPAutomaticSettings()

Properties

(eModelComplexityType) model_complexity
(int) num_parallel
(eVariableReductionType) variables_reduction

MOPData

Manages parameter importance and response usage for MOP.

Constructors

MOPData()

Properties

(string_to_uint_map) 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".
(string_to_bool_map) response_usage

Set usage per response. Provided map may be partial.

MOPSolverActor

Inherits from: IntegrationBaseActor

Constructors

MOPSolverActor()
MOPSolverActor( (str) )

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
(ExtrapolationType) boundary_handling
() 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.
() 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.
() distinct_working_directory
() error_code
() execution_policy
() goal
() instant_variable_update
() max_runtime
(ProvidedPath) mdb_path
(str) name
() read_mode
() result_recycling
() retry_count
() retry_delay
() retry_enable
() starting_delay
() starting_point
() stop_after_execution
(UUID) uuid

Methods

initialize_solver

initialize_solver( (Path)arg2 [, (int)arg3]) -> bool

----

initialize_solver( (ProvidedPath)arg2 [, (int)arg3]) -> bool

register_available_parameters

register_available_parameters() -> None

register_available_responses

register_available_responses() -> None

MulticastInfo

Constructors

MulticastInfo()

Methods

GetHost

GetHost() -> str

GetLock

GetLock() -> str

GetName

GetName() -> str

GetPort

GetPort() -> int

GetProject

GetProject() -> str

SetIP

SetIP( (str)arg2) -> None

SetLock

SetLock( (str)arg2) -> None

SetName

SetName( (str)arg2) -> None

SetPort

SetPort( (int)arg2) -> None

SetProject

SetProject( (str)arg2) -> None

MulticastInfoVec

iterable has_length itemsetter itemgetter

Constructors

MulticastInfoVec()

Methods

append

append( (object)arg2) -> None

extend

extend( (object)arg2) -> None

push_back

push_back( (MulticastInfo)arg2) -> None

size

size() -> int

NLPQLPActor

Inherits from: OptimizationBaseActor

Constructors

NLPQLPActor()
NLPQLPActor( (str) )

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
(dict) 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.
(dict) 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.
() 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.
() 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.
(PyOSCriterionContainer) criteria
(float) design_point_tolerance
(str) dot_graph
() goal
() max_runtime
(str) name
(SettingsNLPQLP) optimizer_settings
() optimizer_settings
(PyParameterManager) parameter_manager
(ParameterMergingMode) parameter_merging_mode
(bool) prefer_criteria_from_slot
() read_mode
(bool) register_avz_files
(bool) register_cax_files
(bool) register_images
(PyOSDesignPoint) responses
() result_file_path
() result_recycling
() retry_count
() retry_delay
() retry_enable
(bool) solve_duplicated
(bool) solve_reference
(bool) solve_start_designs_again
(bool) solve_violated
() start_designs
(PyOSDesignContainer) start_designs
() starting_delay
() starting_point
() stop_after_execution
(UpdateResultFileInterval) update_result_file
(UUID) uuid
(bool) write_osl3_bin_file_default

Methods

NOA2Actor

Inherits from: OptimizationBaseActor

Constructors

NOA2Actor()
NOA2Actor( (str) )

Properties

() active
(SupportedAlgorithms) algorithm_type
() auto_save_mode
() auto_save_on_nth_design_collected
(dict) 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.
(dict) 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.
() 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.
() 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.
(PyOSCriterionContainer) criteria
(float) design_point_tolerance
(str) dot_graph
() goal
() max_runtime
(str) name
(OptimizerSettingsEA) optimizer_settings
() optimizer_settings
(PyParameterManager) parameter_manager
(ParameterMergingMode) parameter_merging_mode
(bool) prefer_criteria_from_slot
() read_mode
(bool) register_avz_files
(bool) register_cax_files
(bool) register_images
(PyOSDesignPoint) responses
() result_file_path
() result_recycling
() retry_count
() retry_delay
() retry_enable
(bool) solve_duplicated
(bool) solve_reference
(bool) solve_start_designs_again
(bool) solve_violated
() start_designs
(PyOSDesignContainer) start_designs
() starting_delay
() starting_point
() stop_after_execution
(UpdateResultFileInterval) update_result_file
(UUID) uuid
(bool) write_osl3_bin_file_default

Methods

NOAActor

Inherits from: OptimizationBaseActor

Inherited by

EAActor PSOActor SDIActor

Constructors

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
(dict) 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.
(dict) 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.
() 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.
() 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.
(PyOSCriterionContainer) criteria
(float) design_point_tolerance
(str) dot_graph
() goal
() max_runtime
(str) name
() optimizer_settings
() optimizer_settings
(PyParameterManager) parameter_manager
(ParameterMergingMode) parameter_merging_mode
(bool) prefer_criteria_from_slot
() read_mode
(bool) register_avz_files
(bool) register_cax_files
(bool) register_images
(PyOSDesignPoint) responses
() result_file_path
() result_recycling
() retry_count
() retry_delay
() retry_enable
(bool) solve_duplicated
(bool) solve_reference
(bool) solve_start_designs_again
(bool) solve_violated
() start_designs
(PyOSDesignContainer) start_designs
() starting_delay
() starting_point
() stop_after_execution
(UpdateResultFileInterval) update_result_file
(UUID) uuid
(bool) write_osl3_bin_file_default

Methods

OctaveActor

Inherits from: SimtoolActor

Constructors

OctaveActor()
OctaveActor( (str) )

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
() 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.
() 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.
() distinct_working_directory
() error_code
() execution_policy
() file_path
() goal
() instant_variable_update
(int) max_parallel
() max_runtime
(str) name
() pre_command
() read_mode
() result_recycling
() retry_count
() retry_delay
() retry_enable
() save
() starting_delay
() starting_point
() stop_after_execution
(UUID) uuid
() version

Methods

get_available_versions

ODBFieldOutputVariable

Member class of: ETKAbaqusActor

Inherits from: Variable

Constructors

ODBFieldOutputVariable()
ODBFieldOutputVariable( (Path) )
ODBFieldOutputVariable( (Path) , (str) )
ODBFieldOutputVariable( (Path) , (Path) , (str) )

Properties

(str) component_name
(StrSet) element_types
(str) field_output_name
(int) frame
() ident
(Invariant) invariant
(Position) position
(str) section_point_name
(ODBSectionPointInfoSet) section_points
(ODBSetInfoSet) set_infos
(SetType) set_type
(str) step_name
(bool) use_last_frame

Methods

has_invariant

has_invariant() -> bool

reset_invariant

reset_invariant() -> None

ODBFieldOutputVariable

Member class of: ETK

Inherits from: Variable

Constructors

ODBFieldOutputVariable()
ODBFieldOutputVariable( (Path) )
ODBFieldOutputVariable( (Path) , (str) )
ODBFieldOutputVariable( (Path) , (Path) , (str) )

Properties

(str) component_name
(StrSet) element_types
(str) field_output_name
(int) frame
() ident
(Invariant) invariant
(Position) position
(str) section_point_name
(ODBSectionPointInfoSet) section_points
(ODBSetInfoSet) set_infos
(SetType) set_type
(str) step_name
(bool) use_last_frame

Methods

has_invariant

has_invariant() -> bool

reset_invariant

reset_invariant() -> None

ODBFieldOutputVariable

Member class of: ETKAbaqusActor

Inherits from: Variable

Constructors

ODBFieldOutputVariable()
ODBFieldOutputVariable( (Path) )
ODBFieldOutputVariable( (Path) , (str) )
ODBFieldOutputVariable( (Path) , (Path) , (str) )

Properties

(str) component_name
(StrSet) element_types
(str) field_output_name
(int) frame
() ident
(Invariant) invariant
(Position) position
(str) section_point_name
(ODBSectionPointInfoSet) section_points
(ODBSetInfoSet) set_infos
(SetType) set_type
(str) step_name
(bool) use_last_frame

Methods

has_invariant

has_invariant() -> bool

reset_invariant

reset_invariant() -> None

ODBHistoryOutputVariable

Member class of: ETKAbaqusActor

Inherits from: Variable

Constructors

ODBHistoryOutputVariable()
ODBHistoryOutputVariable( (Path) )
ODBHistoryOutputVariable( (Path) , (str) )
ODBHistoryOutputVariable( (Path) , (Path) , (str) )

Properties

(str) history_output_description
(str) history_output_name
() ident
(Position) point_position
(str) region_name
(str) step_name
() tip_set_info
(bool) tipset_bound

ODBHistoryOutputVariable

Member class of: ETK

Inherits from: Variable

Constructors

ODBHistoryOutputVariable()
ODBHistoryOutputVariable( (Path) )
ODBHistoryOutputVariable( (Path) , (str) )
ODBHistoryOutputVariable( (Path) , (Path) , (str) )

Properties

(str) history_output_description
(str) history_output_name
() ident
(Position) point_position
(str) region_name
(str) step_name
() tip_set_info
(bool) tipset_bound

ODBHistoryOutputVariable

Member class of: ETKAbaqusActor

Inherits from: Variable

Constructors

ODBHistoryOutputVariable()
ODBHistoryOutputVariable( (Path) )
ODBHistoryOutputVariable( (Path) , (str) )
ODBHistoryOutputVariable( (Path) , (Path) , (str) )

Properties

(str) history_output_description
(str) history_output_name
() ident
(Position) point_position
(str) region_name
(str) step_name
() tip_set_info
(bool) tipset_bound

ODBSectionPointInfo

Member class of: ETKAbaqusActor

Constructors

ODBSectionPointInfo()
ODBSectionPointInfo( (int) )
ODBSectionPointInfo( (int) , (str) )
ODBSectionPointInfo( (int) , (str) , (str) )

ODBSectionPointInfo

Member class of: ETK

Constructors

ODBSectionPointInfo()
ODBSectionPointInfo( (int) )
ODBSectionPointInfo( (int) , (str) )
ODBSectionPointInfo( (int) , (str) , (str) )

ODBSectionPointInfo

Member class of: ETKAbaqusActor

Constructors

ODBSectionPointInfo()
ODBSectionPointInfo( (int) )
ODBSectionPointInfo( (int) , (str) )
ODBSectionPointInfo( (int) , (str) , (str) )

ODBSectionPointInfoSet

iterable has_length

Member class of: ETKAbaqusActor

A mutable set.

Constructors

ODBSectionPointInfoSet()

Methods

add

add( (ODBSectionPointInfo)element) -> None

Add element.

difference

difference( (ODBSectionPointInfoSet)other) -> ODBSectionPointInfoSet

Return elements of this set that are not in other.

intersection

intersection( (ODBSectionPointInfoSet)other) -> ODBSectionPointInfoSet

Return the intersection of this set and other.

remove

remove( (ODBSectionPointInfo)element) -> None

Remove element.

symmetric_difference

symmetric_difference( (ODBSectionPointInfoSet)other) -> ODBSectionPointInfoSet

Return elements that are either in this set or in other but not in both.

union

union( (ODBSectionPointInfoSet)other) -> ODBSectionPointInfoSet

Return the union of this set and other.

ODBSectionPointInfoSet

iterable has_length

Member class of: ETK

A mutable set.

Constructors

ODBSectionPointInfoSet()

Methods

add

add( (ODBSectionPointInfo)element) -> None

Add element.

difference

difference( (ODBSectionPointInfoSet)other) -> ODBSectionPointInfoSet

Return elements of this set that are not in other.

intersection

intersection( (ODBSectionPointInfoSet)other) -> ODBSectionPointInfoSet

Return the intersection of this set and other.

remove

remove( (ODBSectionPointInfo)element) -> None

Remove element.

symmetric_difference

symmetric_difference( (ODBSectionPointInfoSet)other) -> ODBSectionPointInfoSet

Return elements that are either in this set or in other but not in both.

union

union( (ODBSectionPointInfoSet)other) -> ODBSectionPointInfoSet

Return the union of this set and other.

ODBSectionPointInfoSet

iterable has_length

Member class of: ETKAbaqusActor

A mutable set.

Constructors

ODBSectionPointInfoSet()

Methods

add

add( (ODBSectionPointInfo)element) -> None

Add element.

difference

difference( (ODBSectionPointInfoSet)other) -> ODBSectionPointInfoSet

Return elements of this set that are not in other.

intersection

intersection( (ODBSectionPointInfoSet)other) -> ODBSectionPointInfoSet

Return the intersection of this set and other.

remove

remove( (ODBSectionPointInfo)element) -> None

Remove element.

symmetric_difference

symmetric_difference( (ODBSectionPointInfoSet)other) -> ODBSectionPointInfoSet

Return elements that are either in this set or in other but not in both.

union

union( (ODBSectionPointInfoSet)other) -> ODBSectionPointInfoSet

Return the union of this set and other.

ODBSetInfo

Member class of: ETKAbaqusActor

Constructors

ODBSetInfo()
ODBSetInfo( (str) , (SetLocation) , (SetType) )
ODBSetInfo( (str) , (SetLocation) , (SetType) , (StrList) )
ODBSetInfo( (str) , (SetLocation) , (SetType) , (StrList) , (str) )

ODBSetInfo

Member class of: ETK

Constructors

ODBSetInfo()
ODBSetInfo( (str) , (SetLocation) , (SetType) )
ODBSetInfo( (str) , (SetLocation) , (SetType) , (StrList) )
ODBSetInfo( (str) , (SetLocation) , (SetType) , (StrList) , (str) )

ODBSetInfo

Member class of: ETKAbaqusActor

Constructors

ODBSetInfo()
ODBSetInfo( (str) , (SetLocation) , (SetType) )
ODBSetInfo( (str) , (SetLocation) , (SetType) , (StrList) )
ODBSetInfo( (str) , (SetLocation) , (SetType) , (StrList) , (str) )

ODBSetInfoSet

iterable has_length

Member class of: ETKAbaqusActor

A mutable set.

Constructors

ODBSetInfoSet()

Methods

add

add( (ODBSetInfo)element) -> None

Add element.

difference

difference( (ODBSetInfoSet)other) -> ODBSetInfoSet

Return elements of this set that are not in other.

intersection

intersection( (ODBSetInfoSet)other) -> ODBSetInfoSet

Return the intersection of this set and other.

remove

remove( (ODBSetInfo)element) -> None

Remove element.

symmetric_difference

symmetric_difference( (ODBSetInfoSet)other) -> ODBSetInfoSet

Return elements that are either in this set or in other but not in both.

union

union( (ODBSetInfoSet)other) -> ODBSetInfoSet

Return the union of this set and other.

ODBSetInfoSet

iterable has_length

Member class of: ETK

A mutable set.

Constructors

ODBSetInfoSet()

Methods

add

add( (ODBSetInfo)element) -> None

Add element.

difference

difference( (ODBSetInfoSet)other) -> ODBSetInfoSet

Return elements of this set that are not in other.

intersection

intersection( (ODBSetInfoSet)other) -> ODBSetInfoSet

Return the intersection of this set and other.

remove

remove( (ODBSetInfo)element) -> None

Remove element.

symmetric_difference

symmetric_difference( (ODBSetInfoSet)other) -> ODBSetInfoSet

Return elements that are either in this set or in other but not in both.

union

union( (ODBSetInfoSet)other) -> ODBSetInfoSet

Return the union of this set and other.

ODBSetInfoSet

iterable has_length

Member class of: ETKAbaqusActor

A mutable set.

Constructors

ODBSetInfoSet()

Methods

add

add( (ODBSetInfo)element) -> None

Add element.

difference

difference( (ODBSetInfoSet)other) -> ODBSetInfoSet

Return elements of this set that are not in other.

intersection

intersection( (ODBSetInfoSet)other) -> ODBSetInfoSet

Return the intersection of this set and other.

remove

remove( (ODBSetInfo)element) -> None

Remove element.

symmetric_difference

symmetric_difference( (ODBSetInfoSet)other) -> ODBSetInfoSet

Return elements that are either in this set or in other but not in both.

union

union( (ODBSetInfoSet)other) -> ODBSetInfoSet

Return the union of this set and other.

OptimizationBaseActor

Inherits from: AlgorithmSystemActor

Inherited by

ARSMActor NLPQLPActor NOAActor NOA2Actor MemeticActor SimplexActor

Constructors

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
(dict) 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.
(dict) 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.
() 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.
() 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.
(PyOSCriterionContainer) criteria
(float) design_point_tolerance
(str) dot_graph
() goal
() max_runtime
(str) name
() optimizer_settings
(PyParameterManager) parameter_manager
(ParameterMergingMode) parameter_merging_mode
(bool) prefer_criteria_from_slot
() read_mode
(bool) register_avz_files
(bool) register_cax_files
(bool) register_images
(PyOSDesignPoint) responses
() result_file_path
() result_recycling
() retry_count
() retry_delay
() retry_enable
(bool) solve_duplicated
(bool) solve_reference
(bool) solve_start_designs_again
(bool) solve_violated
() start_designs
(PyOSDesignContainer) start_designs
() starting_delay
() starting_point
() stop_after_execution
(UpdateResultFileInterval) update_result_file
(UUID) uuid
(bool) write_osl3_bin_file_default

Methods

OutputFileMapping

Member class of: ProcessActor

Inherits from: BaseFileMapping

Constructors

OutputFileMapping()
OutputFileMapping( (Path) , (str) )
OutputFileMapping( (Path) , (str) , (ArchivalMode) )
OutputFileMapping( (str) )
OutputFileMapping( (str) , (ArchivalMode) )

Properties

(ArchivalMode) archival_mode
(FileImportance) importance
(bool) remove_on_reset
(str) slot_name
(Path) working_file_name
(str) working_file_regex

OutputFilesList

iterable has_length itemsetter itemgetter

Member class of: ProcessActor

Constructors

OutputFilesList()

Methods

append

append( (object)arg2) -> None

extend

extend( (object)arg2) -> None

push_back

push_back( (OutputFileMapping)arg2) -> None

size

size() -> int

Parameter

Member class of: TextInputActor

Constructors

Parameter()
Parameter( (str) )
Parameter( (str) , (int) , (int) , (int) )
Parameter( (str) , (int) , (int) , (int) , (str) )
Parameter( (str) , (int) , (int) , (int) , (str) , (EntryType) )
Parameter( (str) , (int) , (int) , (int) , (str) , (EntryType) , (bool) )

Properties

(int) column
(int) end_in_line
(bool) expandable
(str) format
(int) length
(int) line
(str) marker
(str) name

Methods

get_text

get_text( (str)arg2, (bool)arg3, (int)arg4, (int)arg5, (int)arg6) -> str

intersects

intersects( (Parameter)arg2) -> bool

read

read( (str)arg2, (bool)arg3) -> PyOSDesignEntry

replace

replace( (PyOSDesignEntry)arg2, (str)arg3, (int)arg4) -> PyOSDesignEntry

to_string

to_string( (PyOSDesignEntry)arg2) -> str

ParametricSystemActor

Inherits from: SequencingSystem

Inherited by

AlgorithmSystemActor

Constructors

ParametricSystemActor()
ParametricSystemActor( (str) )

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
(dict) 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.
(dict) 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.
() 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.
() 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.
(PyOSCriterionContainer) criteria
(float) design_point_tolerance
(str) dot_graph
() goal
() max_runtime
(str) name
(PyParameterManager) parameter_manager
(ParameterMergingMode) parameter_merging_mode
(bool) prefer_criteria_from_slot
() read_mode
(bool) register_avz_files
(bool) register_cax_files
(bool) register_images
(PyOSDesignPoint) responses
() result_file_path
() result_recycling
() retry_count
() retry_delay
() retry_enable
(bool) solve_duplicated
(bool) solve_reference
(bool) solve_start_designs_again
(bool) solve_violated
(PyOSDesignContainer) start_designs
() starting_delay
() starting_point
() stop_after_execution
(UpdateResultFileInterval) update_result_file
(UUID) uuid
(bool) write_osl3_bin_file_default

Methods

CleanupResponses

CleanupResponses() -> None

CollectParameters

CollectParameters() -> None

GetDesignCounts

GetDesignCounts() -> DesignCounts

GetDesigns

GetDesigns() -> PyOSDesignContainer

remove_actor

RemoveAllResponses

RemoveAllResponses( [, (bool)arg2]) -> None

RemoveResponse

RemoveResponse( (str)arg2 [, (bool)arg3]) -> None

SetDesigns

SetDesigns( (PyOSDesignContainer)arg2) -> None

supports_read_mode

supports_recycling

PathActor

Inherits from: Actor

Constructors

PathActor()
PathActor( (str) )

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
() 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.
() 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.
() goal
() max_runtime
(str) name
(ProvidedPath) path
() read_mode
() result_recycling
() retry_count
() retry_delay
() retry_enable
() starting_delay
() starting_point
() stop_after_execution
(UUID) uuid

Methods

PDMActor

Inherits from: IntegrationBaseActor

Inherited by

PDMReceiveActor PDMSendActor

Constructors

PDMActor()
PDMActor( (str) )

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
() 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.
() 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.
() distinct_working_directory
() error_code
() execution_policy
() goal
() instant_variable_update
() max_runtime
(str) name
() read_mode
() result_recycling
() retry_count
() retry_delay
() retry_enable
() starting_delay
() starting_point
() stop_after_execution
(UUID) uuid

Methods

PDMReceiveActor

Inherits from: PDMActor

Constructors

PDMReceiveActor()
PDMReceiveActor( (str) )

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
() 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.
() 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.
() distinct_working_directory
() error_code
() execution_policy
() goal
() instant_variable_update
() max_runtime
(str) name
() read_mode
() result_recycling
() retry_count
() retry_delay
() retry_enable
() starting_delay
() starting_point
() stop_after_execution
(UUID) uuid

Methods

PDMSendActor

Inherits from: PDMActor

Constructors

PDMSendActor()
PDMSendActor( (str) )

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
() 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.
() 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.
() distinct_working_directory
() error_code
() execution_policy
() goal
() instant_variable_update
() max_runtime
(str) name
() read_mode
() result_recycling
() retry_count
() retry_delay
() retry_enable
() starting_delay
() starting_point
() stop_after_execution
(UUID) uuid

Methods

PerlScriptActor

Inherits from: ScriptFileActor

Constructors

PerlScriptActor()
PerlScriptActor( (str) )

Properties

() active
(WStrList) arguments
() auto_save_mode
() auto_save_on_nth_design_collected
(str) command
() 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.
() 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.
() content
() distinct_working_directory
(bool) enable_multi_design_launch
(WStrList) environment
() error_code
() execution_policy
() goal
(bool) ignore_exit_code
(InputFilesList) input_files
() instant_variable_update
(int) max_parallel
() max_runtime
(int) multi_design_launch_num
(str) name
(OutputFilesList) output_files
(bool) prepend_project_bin_to_path
() read_mode
() result_recycling
() retry_count
() retry_delay
() retry_enable
() script_path
() starting_delay
() starting_point
() stop_after_execution
(UUID) uuid
(Path) working_dir

Methods

PostprocessingActor

Inherits from: Actor

Constructors

PostprocessingActor()
PostprocessingActor( (str) )

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
() 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.
() 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.
(ProvidedPath) custom_script_path
(bool) force_classic
() goal
() max_runtime
(ProvidedPath) mdb_path
(MonitoringMode) monitoring_mode
(str) name
(PostprocessingModePP3) pp_mode
() read_mode
() result_recycling
() retry_count
() retry_delay
() retry_enable
(bool) show_pp_during_run
(bool) show_reduced_pp_when_avaiable
() starting_delay
() starting_point
() stop_after_execution
(ProvidedPath) template_file
(bool) use_custom_script
(bool) use_template
(UUID) uuid
(bool) wait_for_pp_to_finish

Methods

ProcessActor

Contains nested classes:

BaseFileMapping FileMapping InputFileMapping InputFilesList OutputFileMapping OutputFilesList SlotPathList

Inherits from: IntegrationBaseActor

Inherited by

AbaqusProcessActor ScriptFileActor

Constructors

ProcessActor()
ProcessActor( (str) )

Enums

ArchivalMode
archivalDefault
archivalCompressed
archivalDelete

FileImportance
OPTIONAL
REQUIRED
WAIT_SUCCESS
WAIT_FAIL

Properties

() active
(WStrList) arguments
() auto_save_mode
() auto_save_on_nth_design_collected
(str) command
() 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.
() 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.
() distinct_working_directory
(bool) enable_multi_design_launch
(WStrList) environment
() error_code
() execution_policy
() goal
(bool) ignore_exit_code
(InputFilesList) input_files
() instant_variable_update
(int) max_parallel
() max_runtime
(int) multi_design_launch_num
(str) name
(OutputFilesList) output_files
(bool) prepend_project_bin_to_path
() read_mode
() result_recycling
() retry_count
() retry_delay
() retry_enable
() starting_delay
() starting_point
() stop_after_execution
(UUID) uuid
(Path) working_dir

Methods

ProEInputActor

Inherits from: TextInputActor

Constructors

ProEInputActor()
ProEInputActor( (str) )

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
() 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.
() 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.
(str) content
() distinct_working_directory
(str) encoding
() error_code
() execution_policy
(str) file_content
(ProvidedPath) file_path
() goal
() instant_variable_update
() max_runtime
(str) name
() read_mode
(list) 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.
() result_recycling
() retry_count
() retry_delay
() retry_enable
() starting_delay
() starting_point
() stop_after_execution
(bool) store_content
(UUID) uuid

Methods

get_locations_from_file

get_locations_from_file( (Path)arg2, (PyOSDesignPoint)arg3) -> bool

get_locations_from_string

get_locations_from_string( (str)arg2, (PyOSDesignPoint)arg3) -> bool

PSOActor

Inherits from: NOAActor

Constructors

PSOActor()
PSOActor( (str) )

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
(dict) 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.
(dict) 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.
() 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.
() 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.
(PyOSCriterionContainer) criteria
(float) design_point_tolerance
(str) dot_graph
() goal
() max_runtime
(str) name
() optimizer_settings
() optimizer_settings
(PyParameterManager) parameter_manager
(ParameterMergingMode) parameter_merging_mode
(bool) prefer_criteria_from_slot
() read_mode
(bool) register_avz_files
(bool) register_cax_files
(bool) register_images
(PyOSDesignPoint) responses
() result_file_path
() result_recycling
() retry_count
() retry_delay
() retry_enable
(bool) solve_duplicated
(bool) solve_reference
(bool) solve_start_designs_again
(bool) solve_violated
() start_designs
(PyOSDesignContainer) start_designs
() starting_delay
() starting_point
() stop_after_execution
(UpdateResultFileInterval) update_result_file
(UUID) uuid
(bool) write_osl3_bin_file_default

Methods

Python2Actor

deprecated

Inherits from: PythonActor

Constructors

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
() 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.
() 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.
() distinct_working_directory
() error_code
() execution_policy
() goal
() instant_variable_update
(int) max_parallel
() max_runtime
(str) name
(ProvidedPath) path
() read_mode
() result_recycling
() retry_count
() retry_delay
() retry_enable
(str) source
() starting_delay
() starting_point
() stop_after_execution
(UUID) uuid

Methods

PythonActor

Inherits from: IntegrationBaseActor

Constructors

PythonActor()
PythonActor( (str) )

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
() 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.
() 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.
() distinct_working_directory
() error_code
() execution_policy
() goal
() instant_variable_update
(int) max_parallel
() max_runtime
(str) name
(ProvidedPath) path
() read_mode
() result_recycling
() retry_count
() retry_delay
() retry_enable
(str) source
() starting_delay
() starting_point
() stop_after_execution
(UUID) uuid

Methods

PythonBasedOutputVariable

Member class of: ETK

Inherits from: FileVariable

Inherited by

AutoParamOutputVariable CustomizedOutputVariable

Constructors

Properties

() ident

PythonScriptActor

Inherits from: ScriptFileActor

Constructors

PythonScriptActor()
PythonScriptActor( (str) )

Properties

() active
(WStrList) arguments
() auto_save_mode
() auto_save_on_nth_design_collected
(str) command
() 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.
() 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.
() content
() distinct_working_directory
(bool) enable_multi_design_launch
(WStrList) environment
() error_code
() execution_policy
() goal
(bool) ignore_exit_code
(InputFilesList) input_files
() instant_variable_update
(int) max_parallel
() max_runtime
(int) multi_design_launch_num
(str) name
(OutputFilesList) output_files
(bool) prepend_project_bin_to_path
() read_mode
() result_recycling
() retry_count
() retry_delay
() retry_enable
() script_path
() starting_delay
() starting_point
() stop_after_execution
(UUID) uuid
(Path) working_dir

Methods

ReevaluateActor

Inherits from: SamplingActor

Constructors

ReevaluateActor()
ReevaluateActor( (str) )

Properties

() active
(bool) adapt_bounds
() algorithm_settings
() auto_save_mode
() auto_save_on_nth_design_collected
(dict) 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.
(dict) 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.
() 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.
() 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.
(PyOSCriterionContainer) criteria
(str) design_dir_format
(Path) design_dir_path
(uintVec) design_numbers
(float) design_point_tolerance
(str) dot_graph
() dynamic_sampling
() goal
(Path) input_file_path
() max_runtime
(bool) merge_input_data
(bool) merge_output_data
(str) name
(PyParameterManager) parameter_manager
(ParameterMergingMode) parameter_merging_mode
(bool) prefer_criteria_from_slot
() preserve_start_design_ids
() read_mode
(bool) register_avz_files
(bool) register_cax_files
(bool) register_images
(PyOSDesignPoint) responses
() result_file_path
(OutputFileType) result_file_type
() result_recycling
() retry_count
() retry_delay
() retry_enable
(bool) solve_duplicated
(bool) solve_reference
(bool) solve_start_designs_again
(bool) solve_violated
() start_designs
(PyOSDesignContainer) start_designs
() starting_delay
() starting_point
() stop_after_execution
(UpdateResultFileInterval) update_result_file
(bool) use_input_file
(UUID) uuid
(bool) write_osl3_bin_file_default

Methods

RegexSearcher

Member class of: ETKTextOutputActor

Inherits from: TextMarker

Constructors

RegexSearcher()
RegexSearcher( (str) [, (str) ])

Properties

(str) end_search_string
(bool) end_search_string_is_regex
() repeater
(str) search_string
(bool) search_string_is_regex

Methods

RegexSearcher

Member class of: ETK

Inherits from: TextMarker

Constructors

RegexSearcher()
RegexSearcher( (str) [, (str) ])

Properties

(str) end_search_string
(bool) end_search_string_is_regex
() repeater
(str) search_string
(bool) search_string_is_regex

Methods

RegexSearcher

Member class of: ETKTextOutputActor

Inherits from: TextMarker

Constructors

RegexSearcher()
RegexSearcher( (str) [, (str) ])

Properties

(str) end_search_string
(bool) end_search_string_is_regex
() repeater
(str) search_string
(bool) search_string_is_regex

Methods

ReliabilityBaseActor

Inherits from: AlgorithmSystemActor

Inherited by

AdaptiveSamplingActor ARSMDSActor DirectionalSamplingActor ISPUDActor MonteCarloActor FORMActor

Constructors

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
(dict) 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.
(dict) 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.
() 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.
() 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.
(PyOSCriterionContainer) criteria
(float) design_point_tolerance
(str) dot_graph
() goal
() max_runtime
(str) name
(PyParameterManager) parameter_manager
(ParameterMergingMode) parameter_merging_mode
(bool) prefer_criteria_from_slot
() read_mode
(bool) register_avz_files
(bool) register_cax_files
(bool) register_images
() reliability_settings
(PyOSDesignPoint) responses
() result_file_path
() result_recycling
() retry_count
() retry_delay
() retry_enable
(bool) solve_duplicated
(bool) solve_reference
(bool) solve_start_designs_again
(bool) solve_violated
() start_designs
(PyOSDesignContainer) start_designs
() starting_delay
() starting_point
() stop_after_execution
(UpdateResultFileInterval) update_result_file
(UUID) uuid
(bool) write_osl3_bin_file_default

Methods

RepeaterArgs

Member class of: ETKTextOutputActor

Constructors

RepeaterArgs( (int) , (int) , (int) )

RepeaterArgs

Member class of: ETK

Constructors

RepeaterArgs( (int) , (int) , (int) )

RepeaterArgs

Member class of: ETKTextOutputActor

Constructors

RepeaterArgs( (int) , (int) , (int) )

RobustnessActor

Inherits from: SamplingActor

Constructors

RobustnessActor()
RobustnessActor( (str) )

Properties

() active
() algorithm_settings
() auto_save_mode
() auto_save_on_nth_design_collected
(dict) 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.
(dict) 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.
() 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.
() 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.
(PyOSCriterionContainer) criteria
(float) design_point_tolerance
(str) dot_graph
() dynamic_sampling
() goal
() max_runtime
(str) name
(PyOSDesignPoint) nominal_design_point
(PyParameterManager) parameter_manager
(ParameterMergingMode) parameter_merging_mode
(bool) prefer_criteria_from_slot
() preserve_start_design_ids
() read_mode
(bool) register_avz_files
(bool) register_cax_files
(bool) register_images
(PyOSDesignPoint) responses
() result_file_path
() result_recycling
() retry_count
() retry_delay
() retry_enable
(bool) solve_duplicated
(bool) solve_nominal_design
(bool) solve_reference
(bool) solve_start_designs_again
(bool) solve_violated
() start_designs
(PyOSDesignContainer) start_designs
() starting_delay
() starting_point
() stop_after_execution
(UpdateResultFileInterval) update_result_file
(UUID) uuid
(bool) write_osl3_bin_file_default

Methods

SamplingActor

Inherits from: AlgorithmSystemActor

Inherited by

SensitivityActor RobustnessActor ReevaluateActor

Constructors

Properties

() active
() algorithm_settings
() auto_save_mode
() auto_save_on_nth_design_collected
(dict) 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.
(dict) 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.
() 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.
() 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.
(PyOSCriterionContainer) criteria
(float) design_point_tolerance
(str) dot_graph
() dynamic_sampling
() goal
() max_runtime
(str) name
(PyParameterManager) parameter_manager
(ParameterMergingMode) parameter_merging_mode
(bool) prefer_criteria_from_slot
() preserve_start_design_ids
() read_mode
(bool) register_avz_files
(bool) register_cax_files
(bool) register_images
(PyOSDesignPoint) responses
() result_file_path
() result_recycling
() retry_count
() retry_delay
() retry_enable
(bool) solve_duplicated
(bool) solve_reference
(bool) solve_start_designs_again
(bool) solve_violated
() start_designs
(PyOSDesignContainer) start_designs
() starting_delay
() starting_point
() stop_after_execution
(UpdateResultFileInterval) update_result_file
(UUID) uuid
(bool) write_osl3_bin_file_default

Methods

ScriptFileActor

Inherits from: ProcessActor

Inherited by

BashScriptActor BatchScriptActor PerlScriptActor PythonScriptActor

Constructors

Properties

() active
(WStrList) arguments
() auto_save_mode
() auto_save_on_nth_design_collected
(str) command
() 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.
() 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.
() content
() distinct_working_directory
(bool) enable_multi_design_launch
(WStrList) environment
() error_code
() execution_policy
() goal
(bool) ignore_exit_code
(InputFilesList) input_files
() instant_variable_update
(int) max_parallel
() max_runtime
(int) multi_design_launch_num
(str) name
(OutputFilesList) output_files
(bool) prepend_project_bin_to_path
() read_mode
() result_recycling
() retry_count
() retry_delay
() retry_enable
() script_path
() starting_delay
() starting_point
() stop_after_execution
(UUID) uuid
(Path) working_dir

Methods

get_locations_from_file

get_locations_from_file( (Path)arg2, (PyOSDesignPoint)arg3) -> bool

get_locations_from_string

get_locations_from_string( (str)arg2, (PyOSDesignPoint)arg3) -> bool

register_location_as_parameter

register_location_as_parameter( (str)arg2 [, (str)arg3]) -> None

register_locations_as_parameter

register_locations_as_parameter() -> None

SDIActor

Inherits from: NOAActor

Constructors

SDIActor()
SDIActor( (str) )

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
(dict) 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.
(dict) 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.
() 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.
() 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.
(PyOSCriterionContainer) criteria
(float) design_point_tolerance
(str) dot_graph
() goal
() max_runtime
(str) name
() optimizer_settings
() optimizer_settings
(PyParameterManager) parameter_manager
(ParameterMergingMode) parameter_merging_mode
(bool) prefer_criteria_from_slot
() read_mode
(bool) register_avz_files
(bool) register_cax_files
(bool) register_images
(PyOSDesignPoint) responses
() result_file_path
() result_recycling
() retry_count
() retry_delay
() retry_enable
(bool) solve_duplicated
(bool) solve_reference
(bool) solve_start_designs_again
(bool) solve_violated
() start_designs
(PyOSDesignContainer) start_designs
() starting_delay
() starting_point
() stop_after_execution
(UpdateResultFileInterval) update_result_file
(UUID) uuid
(bool) write_osl3_bin_file_default

Methods

SensitivityActor

Inherits from: SamplingActor

Constructors

SensitivityActor()
SensitivityActor( (str) )

Properties

() active
() algorithm_settings
() auto_save_mode
() auto_save_on_nth_design_collected
(dict) 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.
(dict) 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.
() 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.
() 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.
(PyOSCriterionContainer) criteria
(float) design_point_tolerance
(str) dot_graph
() dynamic_sampling
() goal
() max_runtime
(str) name
(PyParameterManager) parameter_manager
(ParameterMergingMode) parameter_merging_mode
(bool) prefer_criteria_from_slot
() preserve_start_design_ids
() read_mode
(bool) register_avz_files
(bool) register_cax_files
(bool) register_images
(PyOSDesignPoint) responses
() result_file_path
() result_recycling
() retry_count
() retry_delay
() retry_enable
(bool) solve_duplicated
(bool) solve_reference
(bool) solve_start_designs_again
(bool) solve_violated
() start_designs
(PyOSDesignContainer) start_designs
() starting_delay
() starting_point
() stop_after_execution
(UpdateResultFileInterval) update_result_file
(UUID) uuid
(bool) write_osl3_bin_file_default

Methods

SimpackInputActor

Inherits from: CustomizedBaseActor

Constructors

SimpackInputActor( (str) )

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
() 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.
() 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.
() distinct_working_directory
() error_code
() error_code
() execution_policy
() goal
() instant_variable_update
() instant_variable_update
() max_runtime
(str) name
() path
() read_mode
() result_recycling
() retry_count
() retry_delay
() retry_enable
() starting_delay
() starting_point
() stop_after_execution
() use_as_input_integration
() use_as_output_integration
() use_as_solver
(UUID) uuid

Methods

SimPackOutputVariable

Member class of: ETKSimPackActor

Inherits from: FileVariable

Constructors

SimPackOutputVariable()
SimPackOutputVariable( (Path) )
SimPackOutputVariable( (Path) , (Path) )
SimPackOutputVariable( (Path) , (str) , (WStrList) )
SimPackOutputVariable( (Path) , (Path) , (str) , (WStrList) )
SimPackOutputVariable( (str) )
SimPackOutputVariable( (str) , (str) , (WStrList) )

Properties

() ident

SimPackOutputVariable

Member class of: ETK

Inherits from: FileVariable

Constructors

SimPackOutputVariable()
SimPackOutputVariable( (Path) )
SimPackOutputVariable( (Path) , (Path) )
SimPackOutputVariable( (Path) , (str) , (WStrList) )
SimPackOutputVariable( (Path) , (Path) , (str) , (WStrList) )
SimPackOutputVariable( (str) )
SimPackOutputVariable( (str) , (str) , (WStrList) )

Properties

() ident

SimPackOutputVariable

Member class of: ETKSimPackActor

Inherits from: FileVariable

Constructors

SimPackOutputVariable()
SimPackOutputVariable( (Path) )
SimPackOutputVariable( (Path) , (Path) )
SimPackOutputVariable( (Path) , (str) , (WStrList) )
SimPackOutputVariable( (Path) , (Path) , (str) , (WStrList) )
SimPackOutputVariable( (str) )
SimPackOutputVariable( (str) , (str) , (WStrList) )

Properties

() ident

SimplexActor

Inherits from: OptimizationBaseActor

Constructors

SimplexActor()
SimplexActor( (str) )

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
(dict) 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.
(dict) 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.
() 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.
() 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.
(PyOSCriterionContainer) criteria
(float) design_point_tolerance
(str) dot_graph
() goal
() max_runtime
(str) name
(OptimizerSettingsSimplex) optimizer_settings
() optimizer_settings
(PyParameterManager) parameter_manager
(ParameterMergingMode) parameter_merging_mode
(bool) prefer_criteria_from_slot
() read_mode
(bool) register_avz_files
(bool) register_cax_files
(bool) register_images
(PyOSDesignPoint) responses
() result_file_path
() result_recycling
() retry_count
() retry_delay
() retry_enable
(bool) solve_duplicated
(bool) solve_reference
(bool) solve_start_designs_again
(bool) solve_violated
() start_designs
(PyOSDesignContainer) start_designs
() starting_delay
() starting_point
() stop_after_execution
(UpdateResultFileInterval) update_result_file
(UUID) uuid
(bool) write_osl3_bin_file_default

Methods

SimtoolActor

Inherits from: IntegrationBaseActor

Inherited by

MatlabActor OctaveActor

Constructors

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
() 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.
() 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.
() distinct_working_directory
() error_code
() execution_policy
() file_path
() goal
() instant_variable_update
() max_runtime
(str) name
() pre_command
() read_mode
() result_recycling
() retry_count
() retry_delay
() retry_enable
() save
() starting_delay
() starting_point
() stop_after_execution
(UUID) uuid
() version

Methods

get_available_versions

get_available_versions( (bool)arg2) -> WStrList

SlotPathList

iterable has_length itemsetter itemgetter

Member class of: ProcessActor

Constructors

SlotPathList()

Methods

append

append( (object)arg2) -> None

extend

extend( (object)arg2) -> None

push_back

push_back( (FileMapping)arg2) -> None

size

size() -> int

SurrogateBaseActor

Inherits from: Actor

Inherited by

MOPActor

Constructors

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
() 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.
() 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.
() goal
() important_info
() max_runtime
() mdb_path
(str) name
() parameter_manager
() read_mode
() responses
() responses_to_be_used
() result_recycling
() retry_count
() retry_delay
() retry_enable
() show_pp_when_avaiable
() starting_delay
() starting_point
() stop_after_execution
() use_incomplete_designs
(UUID) uuid

Methods

get_parameter_from_actor

get_parameter_from_actor( (HID)arg2, (object)arg3) -> PyParameterManager

get_responses_from_actor

get_responses_from_actor( (HID)arg2, (object)arg3) -> PyOSDesignPoint

get_resulting_parameters

get_resulting_parameters() -> PyParameterManager

get_slot_value

is_valid

is_valid() -> bool

TaggedParametersActor

Inherits from: TextInputActor

Constructors

TaggedParametersActor()
TaggedParametersActor( (str) )

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
() 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.
() 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.
(str) content
() distinct_working_directory
(str) encoding
() error_code
() execution_policy
(str) file_content
(ProvidedPath) file_path
() goal
() instant_variable_update
() max_runtime
(str) name
() read_mode
(list) 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.
() result_recycling
() retry_count
() retry_delay
() retry_enable
() starting_delay
() starting_point
() stop_after_execution
(bool) store_content
(UUID) uuid

Methods

get_locations_from_file

get_locations_from_file( (Path)arg2, (PyOSDesignPoint)arg3) -> bool

get_locations_from_string

get_locations_from_string( (str)arg2, (PyOSDesignPoint)arg3) -> bool

register_location_as_parameter

register_location_as_parameter( (str)arg2 [, (str)arg3]) -> None

register_locations_as_parameter

register_locations_as_parameter() -> None

TextInputActor

Contains nested classes:

Parameter

Inherits from: IntegrationBaseActor

Inherited by

CatiaInputActor ProEInputActor LSDYNAInputActor AnsysAPDLInputActor TaggedParametersActor

Constructors

TextInputActor()
TextInputActor( (str) )

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
() 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.
() 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.
(str) content
() distinct_working_directory
(str) encoding
() error_code
() execution_policy
(str) file_content
(ProvidedPath) file_path
() goal
() instant_variable_update
() max_runtime
(str) name
() read_mode
(list) 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.
() result_recycling
() retry_count
() retry_delay
() retry_enable
() starting_delay
() starting_point
() stop_after_execution
(bool) store_content
(UUID) uuid

Methods

add_parameter

add_parameter( (Parameter)arg2) -> None

get_locations_from_file

get_locations_from_file( (Path)arg2, (object)arg3, (PyOSDesignPoint)arg4) -> bool

get_locations_from_string

get_locations_from_string( (str)arg2, (object)arg3, (PyOSDesignPoint)arg4) -> bool

has_parameter_location

has_parameter_location( (int)arg2, (int)arg3, (int)arg4) -> bool

remove_input

remove_output

remove_parameter

remove_parameter( (str)arg2) -> None

remove_parameter

remove_response

rename_parameter

rename_parameter( (str)arg2, (str)arg3) -> None

replace_parameter

replace_parameter( (Parameter)arg2, (Parameter)arg3) -> None

set_cleaning_mode

set_content

set_content() -> None

TextMarker

Member class of: ETKTextOutputActor

Inherited by

LineReader TokenReader ColumnReader RegexSearcher

Constructors

Properties

() repeater

Methods

append

append( (TextMarker)arg2) -> None

get_child

get_child() -> TextMarker

get_row_reader

get_row_reader() -> bool

has_child

has_child() -> bool

has_repeater

has_repeater() -> bool

is_row_reader

is_row_reader() -> bool

TextMarker

Member class of: ETK

Inherited by

LineReader TokenReader ColumnReader RegexSearcher

Constructors

Properties

() repeater

Methods

append

append( (TextMarker)arg2) -> None

get_child

get_child() -> TextMarker

get_row_reader

get_row_reader() -> bool

has_child

has_child() -> bool

has_repeater

has_repeater() -> bool

is_row_reader

is_row_reader() -> bool

TextMarker

Member class of: ETKTextOutputActor

Inherited by

LineReader TokenReader ColumnReader RegexSearcher

Constructors

Properties

() repeater

Methods

append

append( (TextMarker)arg2) -> None

get_child

get_child() -> TextMarker

get_row_reader

get_row_reader() -> bool

has_child

has_child() -> bool

has_repeater

has_repeater() -> bool

is_row_reader

is_row_reader() -> bool

TextOutputVariable

Member class of: ETKTextOutputActor

Inherits from: FileVariable

Constructors

TextOutputVariable()
TextOutputVariable( (Path) )
TextOutputVariable( (Path) , (Path) )
TextOutputVariable( (Path) , (str) )
TextOutputVariable( (Path) , (Path) , (str) )
TextOutputVariable( (str) )
TextOutputVariable( (str) , (str) )
TextOutputVariable( (Path) Output file path, (str) Variable name, (RepeaterArgs) Line reapeater arguments, (RepeaterArgs) Token repeater arguments [, (bool) Use text marker [, (RepeaterArgs) Regex repeater args [, (str) Begin marker [, (str) End marker [, (str) Separator]]]]])
Creates TextOutputVariable using token reader.
TextOutputVariable( (Path) Output file path, (Path) Base path, (str) Variable name, (RepeaterArgs) Line reapeater arguments, (RepeaterArgs) Token repeater arguments [, (bool) Use text marker [, (RepeaterArgs) Regex repeater args [, (str) Begin marker [, (str) End marker [, (str) Separator]]]]])
Creates TextOutputVariable using token reader.
TextOutputVariable( (Path) Output file path, (str) Variable name, (RepeaterArgs) Line reapeater arguments, (RepeaterArgs) Column repeater arguments, (int) Column offset, (int) Column width [, (bool) Use text marker [, (RepeaterArgs) Regex repeater args [, (str) Begin marker [, (str) End marker]]]])
Creates TextOutputVariable using column reader.
TextOutputVariable( (Path) Output file path, (Path) Base path, (str) Variable name, (RepeaterArgs) Line reapeater arguments, (RepeaterArgs) Column repeater arguments, (int) Column offset, (int) Column width [, (bool) Use text marker [, (RepeaterArgs) Regex repeater args [, (str) Begin marker [, (str) End marker]]]])
Creates TextOutputVariable using column reader.

Properties

() ident
(bool) prefer_signal

Prefer as signal.
(NoneType) reader

Contains the variable's reader.

TextOutputVariable

Member class of: ETK

Inherits from: FileVariable

Constructors

TextOutputVariable()
TextOutputVariable( (Path) )
TextOutputVariable( (Path) , (Path) )
TextOutputVariable( (Path) , (str) )
TextOutputVariable( (Path) , (Path) , (str) )
TextOutputVariable( (str) )
TextOutputVariable( (str) , (str) )
TextOutputVariable( (Path) Output file path, (str) Variable name, (RepeaterArgs) Line reapeater arguments, (RepeaterArgs) Token repeater arguments [, (bool) Use text marker [, (RepeaterArgs) Regex repeater args [, (str) Begin marker [, (str) End marker [, (str) Separator]]]]])
Creates TextOutputVariable using token reader.
TextOutputVariable( (Path) Output file path, (Path) Base path, (str) Variable name, (RepeaterArgs) Line reapeater arguments, (RepeaterArgs) Token repeater arguments [, (bool) Use text marker [, (RepeaterArgs) Regex repeater args [, (str) Begin marker [, (str) End marker [, (str) Separator]]]]])
Creates TextOutputVariable using token reader.
TextOutputVariable( (Path) Output file path, (str) Variable name, (RepeaterArgs) Line reapeater arguments, (RepeaterArgs) Column repeater arguments, (int) Column offset, (int) Column width [, (bool) Use text marker [, (RepeaterArgs) Regex repeater args [, (str) Begin marker [, (str) End marker]]]])
Creates TextOutputVariable using column reader.
TextOutputVariable( (Path) Output file path, (Path) Base path, (str) Variable name, (RepeaterArgs) Line reapeater arguments, (RepeaterArgs) Column repeater arguments, (int) Column offset, (int) Column width [, (bool) Use text marker [, (RepeaterArgs) Regex repeater args [, (str) Begin marker [, (str) End marker]]]])
Creates TextOutputVariable using column reader.

Properties

() ident
(bool) prefer_signal

Prefer as signal.
(NoneType) reader

Contains the variable's reader.

TextOutputVariable

Member class of: ETKTextOutputActor

Inherits from: FileVariable

Constructors

TextOutputVariable()
TextOutputVariable( (Path) )
TextOutputVariable( (Path) , (Path) )
TextOutputVariable( (Path) , (str) )
TextOutputVariable( (Path) , (Path) , (str) )
TextOutputVariable( (str) )
TextOutputVariable( (str) , (str) )
TextOutputVariable( (Path) Output file path, (str) Variable name, (RepeaterArgs) Line reapeater arguments, (RepeaterArgs) Token repeater arguments [, (bool) Use text marker [, (RepeaterArgs) Regex repeater args [, (str) Begin marker [, (str) End marker [, (str) Separator]]]]])
Creates TextOutputVariable using token reader.
TextOutputVariable( (Path) Output file path, (Path) Base path, (str) Variable name, (RepeaterArgs) Line reapeater arguments, (RepeaterArgs) Token repeater arguments [, (bool) Use text marker [, (RepeaterArgs) Regex repeater args [, (str) Begin marker [, (str) End marker [, (str) Separator]]]]])
Creates TextOutputVariable using token reader.
TextOutputVariable( (Path) Output file path, (str) Variable name, (RepeaterArgs) Line reapeater arguments, (RepeaterArgs) Column repeater arguments, (int) Column offset, (int) Column width [, (bool) Use text marker [, (RepeaterArgs) Regex repeater args [, (str) Begin marker [, (str) End marker]]]])
Creates TextOutputVariable using column reader.
TextOutputVariable( (Path) Output file path, (Path) Base path, (str) Variable name, (RepeaterArgs) Line reapeater arguments, (RepeaterArgs) Column repeater arguments, (int) Column offset, (int) Column width [, (bool) Use text marker [, (RepeaterArgs) Regex repeater args [, (str) Begin marker [, (str) End marker]]]])
Creates TextOutputVariable using column reader.

Properties

() ident
(bool) prefer_signal

Prefer as signal.
(NoneType) reader

Contains the variable's reader.

TokenReader

Member class of: ETKTextOutputActor

Inherits from: TextMarker

Constructors

TokenReader()

Properties

() repeater
(str) separator

Methods

TokenReader

Member class of: ETK

Inherits from: TextMarker

Constructors

TokenReader()

Properties

() repeater
(str) separator

Methods

TokenReader

Member class of: ETKTextOutputActor

Inherits from: TextMarker

Constructors

TokenReader()

Properties

() repeater
(str) separator

Methods

TurboOptInputActor

Inherits from: CustomizedBaseActor

Constructors

TurboOptInputActor( (str) )

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
() 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.
() 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.
() distinct_working_directory
() error_code
() error_code
() execution_policy
() goal
() instant_variable_update
() instant_variable_update
() max_runtime
(str) name
() path
() read_mode
() result_recycling
() retry_count
() retry_delay
() retry_enable
() starting_delay
() starting_point
() stop_after_execution
() use_as_input_integration
() use_as_output_integration
() use_as_solver
(UUID) uuid

Methods

TurboOptOutputVariable

Member class of: ETKTurboOptActor

Inherits from: FileVariable

Constructors

TurboOptOutputVariable()
TurboOptOutputVariable( (Path) )
TurboOptOutputVariable( (Path) , (Path) )
TurboOptOutputVariable( (Path) , (str) , (WStrList) )
TurboOptOutputVariable( (Path) , (Path) , (str) , (WStrList) )
TurboOptOutputVariable( (str) )
TurboOptOutputVariable( (str) , (str) , (WStrList) )

Properties

() ident

TurboOptOutputVariable

Member class of: ETK

Inherits from: FileVariable

Constructors

TurboOptOutputVariable()
TurboOptOutputVariable( (Path) )
TurboOptOutputVariable( (Path) , (Path) )
TurboOptOutputVariable( (Path) , (str) , (WStrList) )
TurboOptOutputVariable( (Path) , (Path) , (str) , (WStrList) )
TurboOptOutputVariable( (str) )
TurboOptOutputVariable( (str) , (str) , (WStrList) )

Properties

() ident

TurboOptOutputVariable

Member class of: ETKTurboOptActor

Inherits from: FileVariable

Constructors

TurboOptOutputVariable()
TurboOptOutputVariable( (Path) )
TurboOptOutputVariable( (Path) , (Path) )
TurboOptOutputVariable( (Path) , (str) , (WStrList) )
TurboOptOutputVariable( (Path) , (Path) , (str) , (WStrList) )
TurboOptOutputVariable( (str) )
TurboOptOutputVariable( (str) , (str) , (WStrList) )

Properties

() ident

Variable

Member class of: ETK

Inherited by

FileVariable ODBFieldOutputVariable ODBHistoryOutputVariable

Constructors

Properties

() ident

VariableActor

Inherits from: Actor

Constructors

VariableActor()
VariableActor( (str) )

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
() 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.
() 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.
() goal
() max_runtime
(str) name
() read_mode
() result_recycling
() retry_count
() retry_delay
() retry_enable
() starting_delay
() starting_point
() stop_after_execution
(UUID) uuid
(PyOSDesignEntry) variant

Methods

VariantMonitoringActor

Inherits from: Actor

Constructors

VariantMonitoringActor()
VariantMonitoringActor( (str) )

Properties

() active
() auto_save_mode
() auto_save_on_nth_design_collected
() 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.
() 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.
() goal
() max_runtime
(str) name
() read_mode
() result_recycling
() retry_count
() retry_delay
() retry_enable
() starting_delay
() starting_point
() stop_after_execution
(UUID) uuid

Methods