Source Code Documentation

Contents:

• About Dialog
  • AboutDialog
    • AboutDialog.closeEvent()
    • AboutDialog.doDocsUrl()
    • AboutDialog.doIssuesUrl()
    • AboutDialog.doLicense()
    • AboutDialog.doUrl()
• Application starting point.
  • gui()
  • main()
• BRC_MVC
  • BRC_MVC
    • BRC_MVC.doPlotSlot()
    • BRC_MVC.doRunDoubleClickSlot()
    • BRC_MVC.doRunSelectedSlot()
    • BRC_MVC.getDataDescription()
    • BRC_MVC.refreshFilteredCatalogView()
    • BRC_MVC.splitter_settings_name()
• bluesky_runs_catalog_run_viz
• bluesky_runs_catalog_search
  • BRCSearchPanel
• bluesky_runs_catalog_table_model
  • BRCTableModel
    • BRCTableModel.columnCount()
    • BRCTableModel.data()
    • BRCTableModel.getMetadata()
    • BRCTableModel.headerData()
    • BRCTableModel.rowCount()
    • BRCTableModel.setRuns()
• bluesky_runs_catalog_table_view
  • BRCTableView
    • BRCTableView.calculateVisibleRows()
    • BRCTableView.checkForNewRuns()
    • BRCTableView.doPagerButtons()
    • BRCTableView.eventFilter()
    • BRCTableView.pagerAtEnd
    • BRCTableView.pagerAtStart
    • BRCTableView.run_double_selected
    • BRCTableView.run_selected
    • BRCTableView.setButtonPermissions()
    • BRCTableView.setPage()
    • BRCTableView.setup()
    • BRCTableView.updateModelData()
    • BRCTableView.updatePageSizeFromVisibleRows()
• Chartview
• DateTimeRangeSlider
  • DateTimeRangeSlider
    • DateTimeRangeSlider._slider_units()
    • DateTimeRangeSlider._timestamp_units()
    • DateTimeRangeSlider.adjustDates()
    • DateTimeRangeSlider.adjustSlider()
    • DateTimeRangeSlider.high()
    • DateTimeRangeSlider.low()
    • DateTimeRangeSlider.maximum()
    • DateTimeRangeSlider.minimum()
    • DateTimeRangeSlider.setHigh()
    • DateTimeRangeSlider.setLimits()
    • DateTimeRangeSlider.setLow()
    • DateTimeRangeSlider.setMaximum()
    • DateTimeRangeSlider.setMinimum()
    • DateTimeRangeSlider.setup()
• License Dialog
  • LicenseDialog
• Main Window of GUI
  • MainWindow
    • MainWindow._getSortPreference()
    • MainWindow.closeEvent()
    • MainWindow.connectServer()
    • MainWindow.doAboutDialog()
    • MainWindow.doClose()
    • MainWindow.doOpen()
    • MainWindow.isValidServerUri()
    • MainWindow.setCatalog()
    • MainWindow.setCatalogs()
    • MainWindow.setServer()
    • MainWindow.setServerList()
    • MainWindow.setServers()
    • MainWindow.setStatus()
    • MainWindow.toggleSortOrder()
• Range Slider
  • RangeSlider
    • RangeSlider.sliderMoved
• select_fields_tablemodel
  • ColumnDataType
  • FieldRuleType
    • FieldRuleType.apply()
  • SelectFieldsTableModel
    • SelectFieldsTableModel.applySelectionRules()
    • SelectFieldsTableModel.checkbox()
    • SelectFieldsTableModel.columnCount()
    • SelectFieldsTableModel.data()
    • SelectFieldsTableModel.fields()
    • SelectFieldsTableModel.flags()
    • SelectFieldsTableModel.headerData()
    • SelectFieldsTableModel.plotFields()
    • SelectFieldsTableModel.rowCount()
    • SelectFieldsTableModel.selections()
    • SelectFieldsTableModel.setCheckbox()
    • SelectFieldsTableModel.setColumns()
    • SelectFieldsTableModel.setData()
    • SelectFieldsTableModel.setFields()
    • SelectFieldsTableModel.setSelections()
    • SelectFieldsTableModel.setSelectionsItem()
    • SelectFieldsTableModel.updateCheckboxes()
  • TableColumn
  • TableField
• select_fields_tableview
  • SelectFieldsTableView
    • SelectFieldsTableView.responder()
    • SelectFieldsTableView.selected
• select_stream_fields
  • SelectFieldsWidget
    • SelectFieldsWidget.refreshFieldData()
    • SelectFieldsWidget.relayPlotSelections()
    • SelectFieldsWidget.selected
  • to_datasets()
• TAPI: Tiled Application Programmer Interface
  • QueryTimeSince()
  • QueryTimeUntil()
  • RunMetadata
    • RunMetadata._dataset_to_arrays()
    • RunMetadata._read_stream_arrays()
    • RunMetadata.force_refresh_stream_data()
    • RunMetadata.get_run_md()
    • RunMetadata.is_active
    • RunMetadata.plottable_signals()
    • RunMetadata.request_from_tiled_server()
    • RunMetadata.stream_data()
    • RunMetadata.stream_data_field_pv()
    • RunMetadata.stream_data_field_shape()
    • RunMetadata.stream_data_field_units()
    • RunMetadata.stream_data_fields()
    • RunMetadata.stream_metadata()
    • RunMetadata.summary()
  • TiledServerError
  • connect_tiled_server()
  • discover_catalogs()
  • get_run()
  • get_tiled_runs()
  • is_catalog_of_bluesky_runs()
  • is_not_container()
  • is_pure_container()
  • is_run()
• tiledserverdialog
  • TiledServerDialog
• User Settings
  • ApplicationQSettings
    • ApplicationQSettings._keySplit_()
    • ApplicationQSettings.getKey()
    • ApplicationQSettings.keyExists()
    • ApplicationQSettings.resetDefaults()
    • ApplicationQSettings.restoreSplitter()
    • ApplicationQSettings.restoreWindowGeometry()
    • ApplicationQSettings.saveSplitter()
    • ApplicationQSettings.saveWindowGeometry()
    • ApplicationQSettings.setKey()
    • ApplicationQSettings.to_dict()
  • settings
• Utility Functions
  • getUiFileName()
  • iso2dt()
  • iso2ts()
  • myLoadUi()
  • num2fstr()
  • removeAllLayoutWidgets()
  • run_in_thread()
  • ts2dt()
  • ts2iso()
• Developer - Testing the Code
  • Running the tests
  • Installing Packages for Unit Testing