Karabo Framework

This part of the documentation is intended for explaining details of the core system. Core parts of Karabo are the C++ library, it’s Python bindings, the native Python package and the pyQt-based GUI.

• Known Issues
  • C++ API
  • Bound Python API
  • Middlelayer API
  • Tools
  • Karabo GUI
• Policies
  • Signals and Slots
  • Commands, Properties and State
  • Macros working with devices
• C++ API
  • The karabo::core Namespace
  • The karabo::devices Namespace
  • The karabo::io Namespace
  • The karabo::net Namespace
  • The karabo::xms Namespace
  • The karabo::util Namespace
• Python Bound API
• Python Middlelayer API
  • The Karabo Hash Dictionary
  • Accessing remote devices with proxies
  • Accessing remote devices directly
  • Running devices on servers
  • Inspecting device servers
  • Working with devices
  • Working with Configurations and Timestamps
  • Util functions
  • Writing a device
  • Synchronization
  • Synchronization primitives
  • Karabo descriptors
    • The atomic Karabo descriptors
    • Descriptor categories
    • The atomic Karabo descriptors
    • Compound descriptors
    • Special descriptors
  • Karabo data types
• Service Devices In Karabo
  • C++ Service Devices
  • Python Service Devices
• States
  • Most Significant State
  • Derived States
    • Interlocked Devices
    • Devices with Binary-like behavior
    • Devices with Transitionatory Behavior
  • Changing States
• Testing
  • Unit tests for the C++ core
    • Creating a whole new test
    • Creating a new test class
    • Creating a new test function
    • Running C++ unit tests
  • Integration and long tests for the C++ core
    • Running C++ integration tests
    • Running C++ long tests
  • Unit tests for Python bindings (Bound API)
  • Unit tests for native Python code (Middlelayer API)
  • Integration/long tests for Python (both APIs)
• The Data Logger
  • Distinction from Data Acquisition
  • Configuring Logging
  • Retrieving Logged Information
  • Text-File based Backend
    • Logging Format
  • InfluxDB based Backend
    • Server infrastructure
    • Logging Database Organization
• Gui Server
  • GuiServerDevice
    • Concept
    • Protocol
• Widget Developer Checklist
  • MODEL
  • UNIT TESTS
  • WIDGET CONTROLLER
  • Connecting it all together
• Karabo GUI API
  • The Bindings
    • Binding functions
    • The atomic bindings
    • Category Bindings
    • Available Node Bindings
  • The Property Proxy
    • Util functions for Property Proxies
  • The GUI Parameter - The displayType
  • The Widget Controller
    • Util functions for controllers
    • Util functions to work with arrays and images
  • Validators
• Developing the Scene
  • Basic Architecture
  • Data Model
    • Scene File Versioning
    • The Scene File Format
    • Making Changes to the Scene File format
    • Unit Tests
  • The View
    • Adding a New Widget
    • Adding a New Shape
• Scene File Version 1
  • Scene SVG Object Classes
    • Rectangle
    • Line
    • FixedLayout
    • Path
  • Scene Object Classes
    • Layout
    • BoxLayout
    • FixedLayout
    • GridLayout
    • Label
    • Shape
    • Rectangle
    • Line
    • Path
    • BaseComponent
    • DisplayComponent
    • EditableNoApplyComponent
    • EditableApplyLaterComponent
    • EditAttributeComponent
    • ChoiceComponent
    • Item
    • WorkflowItem
    • WorkflowGroupItem
    • SceneLink
  • Widget Object Classes (DisplayWidget, EditableWidget, VacuumWidget)
    • EditableCheckBox
    • EditableChoiceElement
    • EditableComboBox
    • SingleBit
    • EditableLineEdit
    • EditableDirectory
    • EditableFileOut
    • EditableFileIn
    • Slider
    • Knob
    • FloatSpinBox
    • EditableSpinBox
    • EditableTableElement
    • DisplayTableElement
    • Bitfield
    • DoubleLineEdit
    • IntLineEdit
    • EditableList
    • EditableListElement
    • DisplayLabel
    • Evaluator
    • DisplayIconset
    • DisplayCheckBox
    • XYVector
    • DisplayPlot
    • XYPlot
    • DisplayTrendline
    • DisplayLineEdit
    • DisplayStateColor
    • Monitor
    • DisplayFileOut
    • DisplayFileIn
    • DisplayAlignedImage
    • DisplayImage
    • SelectionIcons
    • TextIcons
    • DigitIcons
    • DisplayImageElement
    • DisplayDirectory
    • DisplayCommand
    • DisplayChoiceElement
    • DisplayComboBox
    • MembranePumpWidget
    • RightAngleValveWidget
    • Hexadecimal
    • MotorWidget
    • ValveWidget
    • PressureSwitchWidget
    • TemperatureProbeWidget
    • PressureGaugeWidget
    • TurboPumpWidget
    • ShutOffValveWidget
    • MaxiGaugeWidget
    • HydraulicValveWidget
    • CryoCoolerWidget
• Package Version in the Device Configuration
  • Rationale
    • Known Issues
  • C++ API
  • Python
    • Bound API
    • Middlelayer API
• Performances
  • Maximum Message Input Rate
• Continuous Integration at the European XFEL
  • Automated Framework Builds
    • Dependencies binaries
    • Framework binaries
    • Conda Packages
  • Automated Framework Tests
    • Unit tests
    • Framework integration tests
    • Framework long tests
  • Automate Device Tests
• Table Element
  • Table Schema Rules and Restrictions
  • Attributes
  • Schema evolution