set_objects_to_exclude#

dlubal.api.rstab.Application.set_objects_to_exclude(self, *, addon, objects_to_exclude=None, skip_invalid_attributes=None, model_id=None)#

Set objects excluded from the design of particular design situations and combinations. Only the rows contained in the request are modified, the remaining rows are left untouched. A row is addressed by its ‘case_object’. A list of objects replaces the whole column and an empty list leaves the column as it was. A list containing an object which does not exist is refused with an error, or left out and reported as a warning when ‘skip_invalid_attributes’ is set.

Parameters:

addon (DesignAddons) – The design addon whose table of objects to exclude is set.
objects_to_exclude (ObjectsToExcludeTable | None) – Rows of the table which are to be modified, addressed by ‘case_object’.
skip_invalid_attributes (bool | None) – Leaves out the values the model does not accept instead of refusing the whole request; they are reported as warnings.
model_id (ModelId | None) – Unique identifier of the model. Active model is used if this field is not set.

Method Type: Core

Usage

# A row is addressed by its case object - the design situation or the
# load combination the row belongs to. Only the rows contained in the
# request are modified.
rstab_app.set_objects_to_exclude(
    addon=rstab.DesignAddons.STEEL_DESIGN,
    objects_to_exclude=rstab.ObjectsToExcludeTable(rows=[
        rstab.ObjectsToExcludeRow(
            case_object=rstab.ObjectId(
                object_type=rstab.ObjectType.OBJECT_TYPE_LOAD_COMBINATION,
                no=2,
            ),
            members=[1],
        ),
    ]),
)

// A row is addressed by its case object - the design situation or the
// load combination the row belongs to. Only the rows contained in the
// request are modified.
rstabApp.set_objects_to_exclude(
    addon: Rstab.DesignAddons.SteelDesign,
    objectsToExclude: new Rstab.ObjectsToExcludeTable {
        Rows = {
            new Rstab.ObjectsToExcludeRow {
                CaseObject = new Rstab.ObjectId {
                    ObjectType = Rstab.ObjectType.LoadCombination,
                    No = 2,
                },
                Members = { 1 },
            }
        }
    }
);