py_os_criterion

    Introduction

    This module provides classes to handle design criteria.

    A collection of criteria can be constructed in the following way:

    Example Code 
    from py_os_criterion import PyOSCriterion, PyOSCriterionContainer, DesignStatus

criteria = PyOSCriterionContainer()

# add objective
criteria.add("minimize_mass", PyOSCriterion(DesignStatus.MIN, "mass_1 + mass_2 + mass_3"))
# add constraint
criteria.add("max_cost", PyOSCriterion(DesignStatus.LESSEQUAL, "min(cost_1, cost_2)", "3.0"))
# add limit state
criteria.add("measured_stress", PyOSCriterion(DesignStatus.LESSLIMITSTATE, "yield_stress", "2.3e9"))

# print criteria names
crit_names = [crit[0] for crit in criteria]
print(crit_names)

    Enums

    DesignStatus
    IGNORE
    MIN
    MAX
    LESSEQUAL
    EQUAL
    GREATEREQUAL
    LESSLIMITSTATE
    GREATERLIMITSTATE

    Classes

    PyOSCriterion

    Constructors

    Methods

    get_expression

    get_expression() -> str



    get_float_value

    get_float_value() -> float



    get_left_expression

    get_left_expression() -> str



    get_right_expression

    get_right_expression() -> str



    get_type

    get_type() -> DesignStatus



    get_value

    get_value() -> PyOSDesignEntry



    GetExpression deprecated

    GetFloatValue deprecated

    GetLeftExpression deprecated

    GetRightExpression deprecated

    GetType deprecated

    GetValue deprecated

    is_constraint

    is_constraint() -> bool



    is_equal_zero

    is_equal_zero() -> bool



    is_equality_constraint

    is_equality_constraint() -> bool



    is_equality_constraint_violated

    is_equality_constraint_violated() -> bool



    is_inequality_constraint

    is_inequality_constraint() -> bool



    is_inequality_constraint_violated

    is_inequality_constraint_violated() -> bool



    is_objective

    is_objective() -> bool



    IsConstraint deprecated

    IsEqualityConstraint deprecated

    IsEqualityConstraintViolated deprecated

    IsEqualZero deprecated

    IsInequalityConstraint deprecated

    IsInequalityConstraintViolated deprecated

    IsObjective deprecated

    NeedEval deprecated

    needs_eval

    needs_eval() -> bool



    set_constraint

    set_constraint( (DesignStatus)type, (str)expression_left, (str)expression_right) -> None



    set_left

    set_left( (str)expression) -> None



    set_objective

    set_objective( (DesignStatus)type, (str)expression) -> None



    set_right

    set_right( (str)expression) -> None



    set_type

    set_type( (DesignStatus)type) -> None



    set_value

    set_value( (float)value) -> None



    ----

    set_value( (PyOSDesignEntry)value) -> None



    SetConstraint deprecated

    SetLeft deprecated

    SetObjective deprecated

    SetRight deprecated

    SetType deprecated

    SetValue deprecated

    PyOSCriterionContainer

    iterable has_length itemsetter itemgetter

    Constructors

    Methods

    add

    add( (str)name, (PyOSCriterion)value) -> None



    add_expression

    add_expression( (str)name, (PyOSCriterion)value) -> None



    remove

    remove( (str)name) -> None



    Remove deprecated

    remove_expression

    remove_expression( (str)name) -> None