py_monitoring_kernel

    Enums

    ControlPositioning
    FREE_POSITIONING
    ABSOLUTE_POSITIONING
    RELATIVE_POSITIONING
    CorrelationTypes
    LinearCorr
    QuadraticCorr
    QuadraticMinusLinear
    SpearmanRankOrder
    DistanceCorr
    DimensionType
    DIM_TYPE_PARAMETER
    DIM_TYPE_RESPONSE
    DIM_TYPE_CRITERION
    DIM_TYPE_SIGNAL
    DIM_TYPE_INVALID
    LimitValue
    LIMIT_MEAN_VALUE
    LIMIT_MEAN_PLUS_STDDEV_VALUE
    LIMIT_DEFAULT_SAFETY_VALUE
    LIMIT_DEFAULT_FAILURE_VALUE
    LIMIT_MIN_VALUE
    LIMIT_MAX_VALUE
    LIMIT_NONE_VALUE
    PredefinedColor
    COLOR_DEFAULT
    COLOR_RED
    COLOR_GREEN
    COLOR_BLUE
    COLOR_YELLOW
    COLOR_MAGENTA
    COLOR_CYAN
    COLOR_VIOLET
    COLOR_ORANGE
    COLOR_PINK
    COLOR_BLACK
    PredefinedStipple
    STIPPLE_NONE
    STIPPLE_SOLID
    STIPPLE_DASHED
    STIPPLE_DOTTED
    PredefinedSymbol
    SYMBOL_NONE
    SYMBOL_CIRCLE
    SYMBOL_RECTANGLE
    SYMBOL_TRIANGLE
    SYMBOL_DIAMOND

    Functions

    default_style

    default_style() -> Style


    Default style of designs.

    DefaultStyle

    Classes

    Color

    Color object used to style designs.

    Constructors

    Properties

    • (int) a
      Alpha component of the color.
    • (int) b
      Blue component of the color.
    • (int) g
      Green component of the color.
    • (int) r
      Red component of the color.

    Control

    Inherits from: ControlInterface

    Inherited by

    Visual

    Constructors

    Methods

    ControlInterface

    Inherited by

    Control
    Base interface of a monitoring control. Controls display data and/or provide data editing functionality.

    Constructors

    Methods

    get_id

    get_id() -> Id



    GetId

    Controller

    Inherits from: ControllerInterface

    Constructors

    Methods

    ControllerInterface

    Inherited by

    Controller
    Base interface of a controller object, managing monitoring data, monitoring visuals and controls, and data change requests.

    Constructors

    Methods

    get_monitoring_data

    get_monitoring_data( (Id)arg2) -> MonitoringData


    Get a certain monitoring data object.

    GetMonitoringData

    Convenience

    Constructors

    Dimension

    Dimension object, which holds a dimension type (parameter/response/criterion) and a name.

    Constructors

    Properties

    • (str) name
      The name of the dimension.
    • (DimensionType) type
      The type of the dimension.

    DimensionList

    iterable has_length itemsetter itemgetter

    Constructors

    Methods

    append

    append( (object)arg2) -> None



    extend

    extend( (object)arg2) -> None



    push_back

    push_back( (Dimension)arg2) -> None



    size

    size() -> int



    DimensionVector

    iterable has_length itemsetter itemgetter

    Constructors

    Methods

    append

    append( (object)arg2) -> None



    extend

    extend( (object)arg2) -> None



    push_back

    push_back( (Dimension)arg2) -> None



    size

    size() -> int



    HID

    Constructors

    Methods

    GetChild

    GetChild() -> HID



    GetDepth

    GetDepth() -> int



    GetLeaf

    GetLeaf() -> HID



    GetNumber

    GetNumber() -> int



    HasChild

    HasChild() -> bool



    RemoveUndermostChild

    RemoveUndermostChild() -> HID



    ToString

    ToString() -> str



    Id

    An id to identify arbitrary objects within monitoring. Consists of a unique UUID and a name.

    Constructors

    Properties

    • (str) name
      Name of the object. May not be unique.

    Limit

    Limit object, which holds a default lower and a default upper value, an ID and a style.

    Constructors

    Properties

    • (LimitValue) default_lower_value
      The default lower value of the limit.
    • (LimitValue) default_upper_value
      The default upper value of the limit.
    • (str) name
      The name of the limit.
    • (Style) style
      The name of the limit.

    MonitoringData

    Encapsulates a block of data to be monitored.

    Constructors

    Properties

    • (Id) id
      The identifier of the data object.

    Methods

    get_algorithm_info

    get_algorithm_info() -> AlgorithmInfo


    Get structure providing information about the underlying algorithm that lead to the results.

    get_best_design_ids

    get_best_design_ids() -> SignalDesignList


    Returns a container of design IDs from the best active designs.

    get_bounds_of_parameter

    get_bounds_of_parameter( (Dimension)arg2) -> object



    get_criteria_names

    get_criteria_names() -> WStrList


    Get criteria names.

    get_design_sets

    get_design_sets() -> WStrList


    Get the names of available design sets.

    get_nominal_design

    get_nominal_design() -> PyOSDesign


    Get the nominal design if available.

    get_objective_names

    get_objective_names() -> WStrList


    Get objective names.

    get_original_designs

    get_original_designs() -> PyOSDesignContainer


    Get the original design container. Design deactivation states are not considered.

    get_original_parameter_manager

    get_original_parameter_manager() -> PyParameterManager


    Get the original parameter manager. Parameter deactivation states are not considered.

    get_parameter_names

    get_parameter_names() -> WStrList


    Get parameter names.

    get_reference_design

    get_reference_design() -> PyOSDesign


    Get the reference design if available.

    get_response_names

    get_response_names() -> WStrList


    Get response names.

    get_signal_names

    get_signal_names() -> WStrList


    Get signal names.

    get_surrogate_by_name

    get_surrogate_by_name( (str)arg2) -> object


    Get a certain actual surrogate model.

    get_surrogate_names_sorted_by_cop

    get_surrogate_names_sorted_by_cop() -> WStrList


    Get surrogate model names, sorted descending by their CoP.

    get_surrogates

    get_surrogates() -> list


    Get all surrogate models.

    GetAlgorithmInfo

    GetBoundsOfParameter

    GetCriteriaNames

    GetDesignSets

    GetNominalDesign

    GetObjectiveNames

    GetOriginalDesigns

    GetParameterNames

    GetReferenceDesign

    GetResponseNames

    GetSurrogateByName

    GetSurrogateNamesSortedByCoP

    has_embedded_user_settings

    has_embedded_user_settings() -> bool


    Returns whether data container has embedded user settings.

    PyControlContainer

    iterable has_length

    Inherited by

    MainWindow
    A (visual) container object, managing and displaying controls.

    Constructors

    Methods

    add_control

    add_control( (ControlInterface)arg2 [, (bool)arg3 [, (ControlPositioning)arg4 [, (float)arg5 [, (float)arg6 [, (float)arg7 [, (float)arg8 [, (str)arg9]]]]]]]) -> None



    find_control_by_name

    find_control_by_name( (str)arg2) -> ControlInterface


    Find control by name

    get_control

    get_control( (Id)arg2) -> ControlInterface


    Get control by ID

    open

    open( (Path)arg2) -> None


    Open a monitoring database

    remove_all_controls

    remove_all_controls() -> None


    Remove all controls from the container

    remove_control

    remove_control( (Id)arg2) -> None


    Remove a control from the container

    set_control_visible

    set_control_visible( (Id)arg2, (bool)arg3) -> None


    Show/Hide a control

    set_positioning

    set_positioning( (Id)arg2 [, (ControlPositioning)arg3 [, (float)arg4 [, (float)arg5 [, (float)arg6 [, (float)arg7]]]]]) -> None



    Stipple

    Stipple object used to style designs.

    Constructors

    Properties

    Style

    Style object used to style designs.

    Constructors

    Properties

    • (Color) color
      The color of the style.
    • (Stipple) stipple
      The stipple of the style.
    • (Symbol) symbol
      The symbol of the style.

    StyleList

    iterable

    Constructors

    Methods

    push_back

    push_back( (Style)arg2) -> None



    size

    size() -> int



    style_export_list

    style_export_list() -> StyleList



    Symbol

    Symbol object used to style designs.

    Constructors

    Properties