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()	Get basic project info, like name, location, global settings and status.
get_full_project_status_info()	Get full project status info.
get_full_project_tree()	Get full project tree.
get_full_project_tree_with_properties()	Get full project tree with properties..
get_host()	Get optiSLang server address or domain name.
get_hpc_licensing_forwarded_environment(uid)	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_osl_version()	Get version of used optiSLang.
get_osl_version_string()	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_project_description()	Get description of optiSLang project.
get_project_location()	Get path to the optiSLang project file.
get_project_name()	Get name of the optiSLang project.
get_project_status()	Get status of the optiSLang project.
get_project_tree_systems()	Get project tree systems without properties.
get_project_tree_systems_with_properties()	Get project tree systems with properties.
get_project_uid()	Get project uid.
get_server_info()	Get information about the application, the server configuration and the open projects.
get_server_is_alive()	Get info whether the server is alive.
get_systems_status_info()	Get project status info, including systems only.
get_timeout()	Get current timeout value for execution of commands.
get_working_dir()	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.