OslServer#
- class ansys.optislang.core.osl_server.OslServer#
Base class for classes which provide access to optiSLang server.
Methods
__init__
()OslServer
class is an abstract base class and cannot be instantiated.dispose
()Terminate all local threads and unregister listeners.
evaluate_design
(evaluate_dict)Evaluate requested design.
get_actor_info
(uid)Get info about actor defined by uid.
get_actor_properties
(uid)Get properties of actor defined by uid.
get_actor_states
(uid)Get available actor states for a certain actor (only the IDs of the available states).
get_actor_status_info
(uid, hid)Get status info of actor defined by uid.
get_actor_supports
(uid, feature_name)Get supported features of actor defined by uid.
Get basic project info, like name, location, global settings and status.
Get full project status info.
Get full project tree.
Get full project tree with properties..
get_host
()Get optiSLang server address or domain name.
Get hpc licensing forwarded environment for certain actor.
get_input_slot_value
(uid, hid, slot_name)Get input slot value of actor defined by uid.
Get version of used optiSLang.
Get version of used optiSLang.
get_output_slot_value
(uid, hid, slot_name)Get output slot value of actor defined by uid.
get_port
()Get the port the osl server is listening on.
Get description of optiSLang project.
Get path to the optiSLang project file.
Get name of the optiSLang project.
Get status of the optiSLang project.
Get project tree systems without properties.
Get project tree systems with properties.
Get project uid.
Get information about the application, the server configuration and the open projects.
Get info whether the server is alive.
Get project status info, including systems only.
Get current timeout value for execution of commands.
Get path to the optiSLang project working directory.
new
()Create a new project.
open
(file_path[, force, restore, reset])Open a new project.
reset
()Reset complete project.
run_python_file
(file_path[, args])Read python script from the file, load it in a project context and execute it.
run_python_script
(script[, args])Load a Python script in a project context and execute it.
save
()Save the changed data and settings of the current project.
save_as
(file_path[, force, restore, reset])Save and open the current project at a new location.
save_copy
(file_path)Save the current project as a copy to a location.
send_command
(command)Send command or query to the optiSLang server.
set_timeout
([timeout])Set timeout value for execution of commands.
shutdown
([force])Shutdown the optiSLang server.
start
([wait_for_started, wait_for_finished])Start project execution.
stop
([wait_for_finished])Stop project execution.