_optiSLang_Kernel

    Enums

    AutoSaveMode
    NO_AUTO_SAVE
    AS_ACTOR_FINISHED
    AS_PSS_NTH_DESIGN_COLLECTED
    AS_ALGO_ITERATION_FINISHED
    CleanupFlags
    IDLE
    CLEANUP_INTERMEDIATE_SLOT_VALUES
    ReadMode
    READ_AND_WRITE_MODE
    CLASSIC_REEVALUATE_MODE

    Classes

    Actor

    Inherits from: Id

    Inherited by

    System VariableActor PathActor MonitoringActor VariantMonitoringActor PostprocessingActor AppendDesignsToBinFileActor DistinctWorkingDirActor SurrogateBaseActor DataExportActor DataImportActor DesignExportActor DesignImportActor
    Base class of all actor classes

    Constructors

    Enums

    SlotType
    VARIANT
    VARIANTSEQ
    STRING
    DESIGN
    DESIGNENTRY
    SAMPLING_DESIGN
    PATH
    PARAMETER_MANAGER
    CRITERION

    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

    add_file_provider_item

    add_file_provider_item( (FileProviderId)id) -> bool


    Add and use a file provider item.

    add_input_slot

    add_input_slot( (SlotType)slot_type, (str)id) -> None


    Add an input slot with slot_type and id.

    add_output_slot

    add_output_slot( (SlotType)slot_type, (str)id) -> None


    Add an output slot with slot_type and id.

    get_cleaning_mode

    get_cleaning_mode() -> int



    get_file_provider_items

    get_file_provider_items() -> object


    Get a list of file provider items used in this actor.

    get_processed_hids

    get_processed_hids() -> dict



    get_property

    get_property( (str)property_id, (ProvidedPath)default_value) -> ProvidedPath


    Get the value of a property specified by property_id. If no such property or datatype doesn't match, default_value is returned.

    ----

    get_property( (str)property_id, (RelativeSplittedPath)default_value) -> RelativeSplittedPath


    Get the value of a property specified by property_id. If no such property or datatype doesn't match, default_value is returned.

    ----

    get_property( (str)property_id, (SplittedPath)default_value) -> SplittedPath


    Get the value of a property specified by property_id. If no such property or datatype doesn't match, default_value is returned.

    ----

    get_property( (str)property_id, (Path)default_value) -> Path


    Get the value of a property specified by property_id. If no such property or datatype doesn't match, default_value is returned.

    ----

    get_property( (str)property_id, (str)default_value) -> str


    Get the value of a property specified by property_id. If no such property or datatype doesn't match, default_value is returned.

    ----

    get_property( (str)property_id, (uintVec)default_value) -> uintVec


    Get the value of a property specified by property_id. If no such property or datatype doesn't match, default_value is returned.

    ----

    get_property( (str)property_id, (WStrList)default_value) -> WStrList


    Get the value of a property specified by property_id. If no such property or datatype doesn't match, default_value is returned.

    ----

    get_property( (str)property_id, (PyParameterManager)default_value) -> PyParameterManager


    Get the value of a property specified by property_id. If no such property or datatype doesn't match, default_value is returned.

    ----

    get_property( (str)property_id, (PyOSDesign)default_value) -> PyOSDesign


    Get the value of a property specified by property_id. If no such property or datatype doesn't match, default_value is returned.

    ----

    get_property( (str)property_id, (PyOSDesignEntry)default_value) -> PyOSDesignEntry


    Get the value of a property specified by property_id. If no such property or datatype doesn't match, default_value is returned.

    ----

    get_property( (str)property_id, (PyOSDesignPoint)default_value) -> PyOSDesignPoint


    Get the value of a property specified by property_id. If no such property or datatype doesn't match, default_value is returned.

    ----

    get_property( (str)property_id, (PyOSDesignPointContainer)default_value) -> PyOSDesignPointContainer


    Get the value of a property specified by property_id. If no such property or datatype doesn't match, default_value is returned.

    ----

    get_property( (str)property_id, (PyOSDesignContainer)default_value) -> PyOSDesignContainer


    Get the value of a property specified by property_id. If no such property or datatype doesn't match, default_value is returned.

    ----

    get_property( (str)property_id, (boolVec)default_value) -> boolVec


    Get the value of a property specified by property_id. If no such property or datatype doesn't match, default_value is returned.

    ----

    get_property( (str)property_id, (PyOSCriterion)default_value) -> PyOSCriterion


    Get the value of a property specified by property_id. If no such property or datatype doesn't match, default_value is returned.

    ----

    get_property( (str)property_id, (PyOSCriterionContainer)default_value) -> PyOSCriterionContainer


    Get the value of a property specified by property_id. If no such property or datatype doesn't match, default_value is returned.

    get_property_bool

    get_property_bool( (str)property_id, (bool)default_value) -> bool


    Get the value of a property specified by property_id. If no such property or datatype doesn't match, default_value is returned.

    get_property_float

    get_property_float( (str)property_id, (float)default_value) -> float


    Get the value of a property specified by property_id. If no such property or datatype doesn't match, default_value is returned.

    get_property_int

    get_property_int( (str)property_id, (int)default_value) -> int


    Get the value of a property specified by property_id. If no such property or datatype doesn't match, default_value is returned.

    get_property_raw

    get_property_raw( (str)property_id) -> str


    Get the raw value of a property specified by property_id.

    get_property_uint

    get_property_uint( (str)property_id, (int)default_value) -> int


    Get the value of a property specified by property_id. If no such property or datatype doesn't match, default_value is returned.

    get_slot_value

    get_slot_value( (str)slot name, (HID)hid) -> object


    Get the value of a slot specified by its name and HID.

    is_finished

    is_finished( [, (bool)consider_inactive=False]) -> bool


    Whether an actor or a system including its children have finished their computation. If consider_inactive is set, an inactive actor will return whether it's truly finished. Otherwise it will always pretend to be finished.

    is_succeeded

    is_succeeded( [, (bool)consider_inactive=False]) -> bool


    Whether an actor or a system including its children have finished their computation successfully.

    remove_file_provider_item

    remove_file_provider_item( (FileProviderId)id) -> bool


    Remove a file provider item.

    set_cleaning_mode

    set_cleaning_mode( (int)mode [, (bool)recursive=True]) -> None


    Set clean-up mode to enable particular cleanup behavior using bitwise linked combinations of CleanupFlags

    set_property

    set_property( (str)property_id, (ProvidedPath)value) -> bool


    Set the value of a property specified by property_id. Returns true if set successful.

    ----

    set_property( (str)property_id, (RelativeSplittedPath)value) -> bool


    Set the value of a property specified by property_id. Returns true if set successful.

    ----

    set_property( (str)property_id, (SplittedPath)value) -> bool


    Set the value of a property specified by property_id. Returns true if set successful.

    ----

    set_property( (str)property_id, (Path)value) -> bool


    Set the value of a property specified by property_id. Returns true if set successful.

    ----

    set_property( (str)property_id, (str)value) -> bool


    Set the value of a property specified by property_id. Returns true if set successful.

    ----

    set_property( (str)property_id, (uintVec)value) -> bool


    Set the value of a property specified by property_id. Returns true if set successful.

    ----

    set_property( (str)property_id, (WStrList)value) -> bool


    Set the value of a property specified by property_id. Returns true if set successful.

    ----

    set_property( (str)property_id, (PyParameterManager)value) -> bool


    Set the value of a property specified by property_id. Returns true if set successful.

    ----

    set_property( (str)property_id, (PyOSDesign)value) -> bool


    Set the value of a property specified by property_id. Returns true if set successful.

    ----

    set_property( (str)property_id, (PyOSDesignEntry)value) -> bool


    Set the value of a property specified by property_id. Returns true if set successful.

    ----

    set_property( (str)property_id, (PyOSDesignPoint)value) -> bool


    Set the value of a property specified by property_id. Returns true if set successful.

    ----

    set_property( (str)property_id, (PyOSDesignPointContainer)value) -> bool


    Set the value of a property specified by property_id. Returns true if set successful.

    ----

    set_property( (str)property_id, (PyOSDesignContainer)value) -> bool


    Set the value of a property specified by property_id. Returns true if set successful.

    ----

    set_property( (str)property_id, (boolVec)value) -> bool


    Set the value of a property specified by property_id. Returns true if set successful.

    ----

    set_property( (str)property_id, (PyOSCriterion)value) -> bool


    Set the value of a property specified by property_id. Returns true if set successful.

    ----

    set_property( (str)property_id, (PyOSCriterionContainer)value) -> bool


    Set the value of a property specified by property_id. Returns true if set successful.

    set_property_bool

    set_property_bool( (str)property_id, (bool)value) -> bool


    Set the value of a property specified by property_id. Returns true if set successful.

    set_property_float

    set_property_float( (str)property_id, (float)value) -> bool


    Set the value of a property specified by property_id. Returns true if set successful.

    set_property_int

    set_property_int( (str)property_id, (int)value) -> bool


    Set the value of a property specified by property_id. Returns true if set successful.

    set_property_raw

    set_property_raw( (str)property_tree_json) -> bool


    Set the value of a property. Argument has to be a json object, containing one or more properties. Returns true if set successful.

    set_property_uint

    set_property_uint( (str)property_id, (int)value) -> bool


    Set the value of a property specified by property_id. Returns true if set successful.

    supports_read_mode

    supports_read_mode() -> bool



    supports_recycling

    supports_recycling() -> bool



    HID

    Constructors

    Methods

    GetChild

    GetChild() -> HID



    GetDepth

    GetDepth() -> int



    GetLeaf

    GetLeaf() -> HID



    GetNumber

    GetNumber() -> int



    HasChild

    HasChild() -> bool



    RemoveUndermostChild

    RemoveUndermostChild() -> HID



    ToString

    ToString() -> str



    Id

    Inherits from: Tag

    Inherited by

    Actor

    Constructors

    Properties

    ProvidedPath

    Constructors

    Properties

    • () actual_relative_split_path
      Actual RelativeSplittedPath. Takes central file registration into account.
    • (bool) empty
      True if ProvidedPath is empty
    • (NoneType) file_provider_id
      A FileProviderId in case a FileProviderId is contained, or None otherwise.
    • (RelativeSplittedPath) relative_split_path
      A RelativeSplittedPath in case a RelativeSplittedPath is contained, or None otherwise.

    Methods

    get_actual_path

    get_actual_path( (FileProvider)file_provider [, (Path)project_path [, (Path)working_dir]]) -> Path


    Return the actual file path. Takes central file registration into account.

    get_actual_relative_split_path

    get_actual_relative_split_path( (FileProvider)arg2) -> object



    deprecated

    get_file_provider_id

    get_file_provider_id() -> object



    deprecated

    get_relative_split_path

    get_relative_split_path() -> object



    deprecated

    is_empty

    is_empty() -> bool



    deprecated

    RunnableSystem

    Inherits from: System

    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.
    • (str) dot_graph
    • () 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

    get_working_directory

    get_working_directory() -> Path



    SequencingSystem

    Inherits from: System

    Inherited by

    ParametricSystemActor WhileActor

    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.
    • (str) dot_graph
    • () 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

    System

    Inherits from: Actor

    Inherited by

    SequencingSystem RunnableSystem

    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.
    • (str) dot_graph
    • () 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

    add_actor

    add_actor( (Actor)actor) -> None


    Add actor as child to this system.

    Example Code 
    param_system = actors.ParametricSystemActor("System")
add_actor(param_system)

    connect

    connect( (Actor)from_actor, (str)from_slot, (Actor)to_actor, (str)to_slot) -> bool



    ----

    connect( (str)from_actor, (str)from_slot, (Actor)to_actor, (str)to_slot) -> bool



    ----

    connect( (Actor)from_actor, (str)from_slot, (str)to_actor, (str)to_slot) -> bool



    ----

    connect( (str)from_actor, (str)from_slot, (str)to_actor, (str)to_slot) -> bool



    find_actor

    find_actor( (str)name) -> object



    get_children

    get_children() -> dict


    Return all descending actors in a dictionary.

    get_dot_graph

    get_dot_graph() -> str



    get_working_directory

    get_working_directory( (HID)hid) -> Path



    remove_actor

    remove_actor( (Actor)arg2) -> None



    reset_complete

    reset_complete() -> None


    Reset system's status, working directory and runtime data. Attempts to shrink database.