Server commands#

These methods are specific to the ansys.optislang.core.tcp.server_commands module and can be used to generate commands to the optiSLang server:

apply_wizard(actor_uid, type_[, ...])

Generate JSON string of apply_wizzard command.

add_criterion(actor_uid, criterion_type, ...)

Generate JSON string of add_criterion command.

close([password])

Generate JSON string of close command.

connect_nodes(from_actor_uid, from_slot, ...)

Generate JSON string of connect_nodes command.

create_input_slot(actor_uid, slot_name[, ...])

Generate JSON string of create_input_slot command.

create_node(type_[, name, algorithm_type, ...])

Generate JSON string of create_node command.

create_output_slot(actor_uid, slot_name[, ...])

Generate JSON string of create_output_slot command.

create_start_designs(actor_uid, sampling_type)

Generate JSON string of create_start_design command.

disconnect_slot(actor_uid, slot_name, direction)

Generate JSON string of disconnect_slot command.

evaluate_design(parameters[, password])

Generate JSON string of evaluate_design command.

export_designs(actor_uid, path[, format, ...])

Generate JSON string of export_designs command.

finalize(actor_uid[, password])

Generate JSON string of finalize command.

link_registered_file(actor_uid, uid[, password])

Generate JSON string of link_registered_file command.

load(actor_uid[, password])

Generate JSON string of load command.

new([password])

Generate JSON string of new command.

open(path, do_force, do_restore, do_reset[, ...])

Generate JSON string of open command.

pause([password])

Generate JSON string of pause command.

reevaluate_state(actor_uid[, hid, password])

Generate JSON string of reevaluate_state command.

refresh_listener_registration(uid[, password])

Generate JSON string of refresh_listener_registration command.

register_file([uid, ident, local_location, ...])

Generate JSON string of register_file command.

register_listener([id, host, port, timeout, ...])

Generate JSON string of register_listener command.

register_location_as_input_slot(actor_uid, ...)

Generate JSON string of register_location_as_input_slot command.

register_location_as_internal_variable(...)

Generate JSON string of register_location_as_internal_variable command.

register_location_as_output_slot(actor_uid, ...)

Generate JSON string of register_location_as_output_slot command.

register_location_as_parameter(actor_uid, ...)

Generate JSON string of register_location_as_parameter command.

register_locations_as_parameter(actor_uid[, ...])

Generate JSON string of register_locations_as_parameter command.

register_location_as_response(actor_uid, ...)

Generate JSON string of register_location_as_response command.

register_locations_as_response(actor_uid[, ...])

Generate JSON string of register_locations_as_response command.

remove_criteria(actor_uid[, password])

Generate JSON string of remove_criteria command.

remove_criterion(actor_uid, name[, password])

Generate JSON string of remove_criterion command.

remove_node(actor_uid[, password])

Generate JSON string of remove node command.

re_register_locations_as_parameter(actor_uid)

Generate JSON string of re_register_locations_as_parameter command.

re_register_locations_as_response(actor_uid)

Generate JSON string of re_register_locations_as_response command.

reset([actor_uid, hid, password])

Generate JSON string of reset command.

restart([actor_uid, hid, password])

Generate JSON string of restart command.

resume([password])

Generate JSON string of resume command.

run_python_script(script[, args_, password])

Generate JSON string of register_listener command.

run_registered_files_actions([uid, password])

Generate JSON string of run registered files actions command.

save([password])

Generate JSON string of save command.

save_as(path, do_force, do_restore, do_reset)

Generate JSON string of save_as command.

save_copy(path[, password])

Generate JSON string of save_copy command.

set_actor_property(actor_uid, name, value[, ...])

Generate JSON string of set_actor_property command.

set_actor_setting(actor_uid, name, value[, ...])

Generate JSON string of set actor setting command.

set_actor_state_property(actor_uid, name, value)

Generate JSON string of set actor state property command.

set_criterion_property(actor_uid, ...[, ...])

Generate JSON string of set_criterion_property command.

set_placeholder_value(name, value[, password])

Generate JSON string of set placeholder value command.

set_project_setting(name, value[, password])

Generate JSON string of set project settings command.

set_registered_file_value(uid, name, value)

Generate JSON string of set registered file value command.

set_start_designs(actor_uid, start_designs)

Generate JSON string of set start designs command.

set_succeeded_state(actor_uid[, hid, password])

Generate JSON string of set succeeded state command.

show_dialog(type_[, usage_mode, ...])

Generate JSON string of show dialog command.

show_node_dialog(actor_uid[, blocking, ...])

Generate JSON string of show node dialog command.

shutdown([force, password])

Generate JSON string of shutdown command.

shutdown_when_finished([password])

Generate JSON string of shutdown_when_finished command.

start([actor_uid, hid, password])

Generate JSON string of start command.

stop([actor_uid, hid, password])

Generate JSON string of stop command.

stop_gently([actor_uid, hid, password])

Generate JSON string of stop_gently command.

subscribe_for_push_notifications(uid, ...[, ...])

Generate JSON string of subscribe_for_push_notifications command.

unlink_registered_file(actor_uid, uid[, ...])

Generate JSON string of unlink registered file command.

unregister_file(uid[, password])

Generate JSON string of unregister file command.

unregister_listener(uid[, password])

Generate JSON string of unregister listener command.

write_monitoring_database(actor_uid[, path, ...])

Generate JSON string of write monitoring database command.