Srsgui APIs

• srsgui.inst package
  • srsgui.inst.communications package
    • srsgui.inst.communications.interface module
      • Interface
    • srsgui.inst.communications.serialinterface module
      • SerialInterface
    • srsgui.inst.communications.serial_ports module
      • serial_ports()
    • srsgui.inst.communications.tcpipinterface module
      • TcpipInterface
  • srsgui.inst.instrument module
    • Instrument
      • Instrument.id_query_cmd
      • Instrument.available_interfaces
      • Instrument.connect()
      • Instrument.disconnect()
      • Instrument.is_connected()
      • Instrument.set_term_char()
      • Instrument.get_term_char()
      • Instrument.send()
      • Instrument.query_text()
      • Instrument.query_int()
      • Instrument.query_float()
      • Instrument.check_id()
      • Instrument.get_available_interfaces()
      • Instrument.get_info()
      • Instrument.get_status()
      • Instrument.handle_command()
      • Instrument.reset()
      • Instrument.connect_with_parameter_string()
      • Instrument.exclude_capture
  • srsgui.inst.component module
    • Component
      • Component.dir
      • Component.exclude_capture
      • Component.allow_run_button
      • Component.is_connected()
      • Component.set_name()
      • Component.get_name()
      • Component.update_components()
      • Component.get_lists()
      • Component.get_component_dict()
      • Component.get_command_dict()
      • Component.get_method_list()
      • Component.get_command_info()
      • Component.assert_command_key()
      • Component.capture_commands()
  • srsgui.inst.commands module
    • Command
    • GetCommand
    • SetCommand
    • BoolCommand
    • BoolGetCommand
    • BoolSetCommand
    • IntCommand
    • IntGetCommand
    • IntSetCommand
    • FloatCommand
    • FloatGetCommand
    • FloatSetCommand
    • DictCommand
      • DictCommand.key_to_value()
      • DictCommand.value_to_key()
    • DictGetCommand
  • srsgui.inst.indexcommands module
    • IndexCommand
    • IndexGetCommand
    • BoolIndexCommand
    • BoolIndexGetCommand
    • IntIndexCommand
    • IntIndexGetCommand
    • FloatIndexCommand
    • FloatIndexGetCommand
    • DictIndexCommand
      • DictIndexCommand.key_to_value()
      • DictIndexCommand.value_to_key()
  • srsgui.inst.exceptions module
    • InstException
    • InstCommunicationError
    • InstLoginFailureError
    • InstIdError
    • InstSetError
    • InstQueryError
    • InstIndexError
• srsgui.task package
  • srsgui.task.task module
    • Task
      • Task.TaskException
      • Task.TaskSetupFailed
      • Task.TaskRunFailed
      • Task.input_parameters
      • Task.additional_figure_names
      • Task.InitialImage
      • Task.setup()
      • Task.test()
      • Task.cleanup()
      • Task.get_logger()
      • Task.basic_setup()
      • Task.basic_cleanup()
      • Task.run()
      • Task.start()
      • Task.stop()
      • Task.delay()
      • Task.set_session_handler()
      • Task.set_callback_handler()
      • Task.set_inst_dict()
      • Task.set_data_dict()
      • Task.set_figure_dict()
      • Task.get_figure()
      • Task.clear_figures()
      • Task.is_running()
      • Task.is_error_raised()
      • Task.set_error_raised()
      • Task.add_details()
      • Task.create_table()
      • Task.add_data_to_table()
      • Task.create_table_in_file()
      • Task.add_to_table_in_file()
      • Task.add_dict_to_file()
      • Task.save_result()
      • Task.round_float()
      • Task.update_status()
      • Task.display_device_info()
      • Task.display_result()
      • Task.write_text()
      • Task.get_input_parameter()
      • Task.get_all_input_parameters()
      • Task.set_input_parameter()
      • Task.notify_parameter_changed()
      • Task.request_figure_update()
      • Task.update_figure()
      • Task.notify_data_available()
      • Task.update()
      • Task.get_instrument()
      • Task.ask_question()
      • Task.question_background_update()
      • Task.set_log_error_detail()
      • Task.log_exception()
  • srsgui.task.callbacks module
    • DummyFigure
    • Callbacks
      • Callbacks.started()
      • Callbacks.finished()
      • Callbacks.text_available()
      • Callbacks.parameter_changed()
      • Callbacks.figure_update_requested()
      • Callbacks.data_available()
      • Callbacks.new_question()
  • srsgui.task.inputs module
    • BaseInput
      • BaseInput.get_value()
      • BaseInput.set_value()
    • StringInput
    • PasswordInput
    • IntegerInput
    • FloatInput
    • ListInput
      • ListInput.get_value()
      • ListInput.set_value()
      • ListInput.get_index()
      • ListInput.set_index()
    • BoolInput
      • BoolInput.get_value()
      • BoolInput.set_value()
    • IntegerListInput
      • IntegerListInput.get_value()
      • IntegerListInput.set_value()
    • FloatListInput
      • FloatListInput.get_value()
      • FloatListInput.set_value()
    • InstrumentInput
    • FindListInput
    • Ip4Input
      • Ip4Input.get_value()
    • CommandInput
      • CommandInput.set_inst_name()
      • CommandInput.get_value()
  • srsgui.task.config module
    • Config
      • Config.ResultDirectory
      • Config.DataRootDirectory
      • Config.LocalModulePath
      • Config.load()
      • Config.load_task_from_line()
      • Config.load_inst_from_line()
      • Config.load_docs_from_line()
      • Config.get_base_log_file_name()
  • srsgui.task.sessionhandler module
    • SessionHandler
      • SessionHandler.FileExtension
      • SessionHandler.is_open()
      • SessionHandler.set_data_directory()
      • SessionHandler.open_session()
      • SessionHandler.close_session()
      • SessionHandler.create_new_task_result()
      • SessionHandler.create_file()
      • SessionHandler.add_dict_to_file()
      • SessionHandler.create_table_in_file()
      • SessionHandler.add_to_table_in_file()
      • SessionHandler.close_file()
      • SessionHandler.close_data_dir()
      • SessionHandler.is_data_dir_closed()
      • SessionHandler.get_data_dir()
      • SessionHandler.get_last_run_number()
  • srsgui.task.taskresult module
    • timestamp_now()
    • strip_tags()
    • ResultLogHandler
      • ResultLogHandler.emit()
    • TaskResult
      • TaskResult.reserved
      • TaskResult.clear()
      • TaskResult.set_start_time_now()
      • TaskResult.set_stop_time_now()
      • TaskResult.set_aborted()
      • TaskResult.set_passed()
      • TaskResult.append_error()
      • TaskResult.add_details()
      • TaskResult.create_table()
      • TaskResult.add_data_to_table()
• srsgui.ui package
  • srsgui.ui.commandtree package
    • srsgui.ui.commandtree.commanditem module
      • Index
      • CommandItem
    • srsgui.ui.commandtree.commandmodel module
      • CommandModel
    • srsgui.ui.commandtree.commandhandler module
      • CommandWorker
      • CommandHandler
    • srsgui.ui.commandtree.commanddelegate module
      • CommandDelegate
    • srsgui.ui.commandtree.commandspinbox module
      • IntegerSpinBox
      • FloatSpinBox
      • RunButton
    • srsgui.ui.commandtree.commandtreeview module
      • CommandTreeView
    • srsgui.ui.commandtree.commandtreewidget module
      • CommandTreeWidget
  • srsgui.ui.qt package
    • srsgui.ui.qt.QtCore module
    • srsgui.ui.qt.QtGui module
    • srsgui.ui.qt.QtWidgets module
  • srsgui.ui.taskmain module
    • TaskMain
      • TaskMain.DefaultConfigFile
      • TaskMain.OrganizationName
      • TaskMain.ApplicationName
      • TaskMain.LogoImageFile
      • TaskMain.LogoFile
      • TaskMain.DocsSuffix
      • TaskMain.TextAbout
      • TaskMain.load_tasks()
      • TaskMain.print_redirect()
      • TaskMain.onTaskStarted()
      • TaskMain.onTaskFinished()
      • TaskMain.is_task_running()
      • TaskMain.update_figure()
      • TaskMain.onTaskSelect()
      • TaskMain.onRun()
      • TaskMain.onStop()
      • TaskMain.onOpen()
      • TaskMain.onInstrumentSelect()
      • TaskMain.onConnect()
      • TaskMain.onDisconnect()
      • TaskMain.display_question()
      • TaskMain.okToContinue()
      • TaskMain.closeEvent()
      • TaskMain.get_logo_file()
      • TaskMain.handle_initial_image()
      • TaskMain.onHelp()
      • TaskMain.onAbout()
      • TaskMain.load_settings()
      • TaskMain.save_settings()
      • TaskMain.staticMetaObject
  • srsgui.ui.connectdlg module
    • ConnectDlg
      • ConnectDlg.create_tab()
      • ConnectDlg.create_input_widget()
      • ConnectDlg.accept()
      • ConnectDlg.save_settings()
      • ConnectDlg.load_setting()
      • ConnectDlg.staticMetaObject
  • srsgui.ui.commandterminal module
    • CommandTerminal
      • CommandTerminal.command_requested
      • CommandTerminal.setup_widget()
      • CommandTerminal.on_clear()
      • CommandTerminal.on_up_pressed()
      • CommandTerminal.on_down_pressed()
      • CommandTerminal.on_send()
      • CommandTerminal.handle_command()
      • CommandTerminal.staticMetaObject
  • srsgui.ui.deviceinfohandler module
    • DeviceInfoHandler
      • DeviceInfoHandler.select_browser()
      • DeviceInfoHandler.update_info()
      • DeviceInfoHandler.update_tabs()
      • DeviceInfoHandler.add_tab()
      • DeviceInfoHandler.remove_tab()
  • srsgui.ui.dockhandler module
    • DockHandler
      • DockHandler.DefaultConsoleName
      • DockHandler.DefaultTerminalName
      • DockHandler.DefaultFigureName
      • DockHandler.MenuDocksName
      • DockHandler.MenuPlotName
      • DockHandler.TitleFormat
      • DockHandler.init_plot_menu()
      • DockHandler.onTightLayout()
      • DockHandler.onToolbar()
      • DockHandler.init_console()
      • DockHandler.init_terminal()
      • DockHandler.init_inst_dock()
      • DockHandler.setup_figure_canvas()
      • DockHandler.init_figure_dock()
      • DockHandler.display_image()
      • DockHandler.get_terminal()
      • DockHandler.get_figure()
      • DockHandler.set_figure_update_period()
      • DockHandler.get_figure_update_period()
      • DockHandler.update_figure()
      • DockHandler.get_dock()
      • DockHandler.onMenuDocksSelected()
      • DockHandler.reset_inst_docks()
      • DockHandler.reset_figures()
      • DockHandler.update_menu()
      • DockHandler.get_figure_dict()
      • DockHandler.clear_figures()
      • DockHandler.show_toolbar()
      • DockHandler.stop_command_handlers()
  • srsgui.ui.inputpanel module
    • InputPanel
      • InputPanel.FirstColumn
      • InputPanel.SecondColumn
      • InputPanel.update()
      • InputPanel.on_default()
      • InputPanel.on_apply()
      • InputPanel.handle_reply()
      • InputPanel.get_cmd_instance()
      • InputPanel.staticMetaObject
  • srsgui.ui.qtloghandler module
    • QtLogHandler
      • QtLogHandler.SignalObject
      • QtLogHandler.emit()
      • QtLogHandler.append()
  • srsgui.ui.signalhandler module
    • SignalHandler
      • SignalHandler.sig_started
      • SignalHandler.sig_finished
      • SignalHandler.sig_text_available
      • SignalHandler.sig_parameter_changed
      • SignalHandler.sig_figure_update_requested
      • SignalHandler.sig_data_available
      • SignalHandler.sig_new_question
      • SignalHandler.signals
      • SignalHandler.started()
      • SignalHandler.finished()
      • SignalHandler.text_available()
      • SignalHandler.parameter_changed()
      • SignalHandler.figure_update_requested()
      • SignalHandler.data_available()
      • SignalHandler.new_question()
      • SignalHandler.disconnect_all()
      • SignalHandler.staticMetaObject
  • srsgui.ui.stdout module
    • StdOut
      • StdOut.textWritten
      • StdOut.write()
      • StdOut.flush()
      • StdOut.staticMetaObject