get_objects_to_design#

dlubal.api.rstab.Application.get_objects_to_design(self, *, addon, model_id=None)#

Get objects selected for design by a design addon. The table has a row for every object type and role the addon designs, identified by the pair ‘object_type’ and ‘role’. The rows follow the model and cannot be added through the API: a row exists as soon as the model contains objects of that type. ‘design_all’ follows the model and keeps the objects listed in ‘selected_objects’, so a manual selection survives switching it on and off. ‘to_design’, ‘not_valid_deactivated’ and ‘description’ are results of the selection. Addons which select whole model objects (Steel Joints, Component Design, Concrete Foundations) have no such table, the selection is an attribute of those objects.

Parameters:

  • addon (DesignAddons) – The design addon whose table of objects to design is read.

  • model_id (ModelId | None) – Unique identifier of the model. Active model is used if this field is not set.

Returns:

ObjectsToDesignTable

Method Type: Core

Usage

# Read the Objects to Design table of a design add-on
objects_to_design: rstab.ObjectsToDesignTable = rstab_app.get_objects_to_design(
    addon=rstab.DesignAddons.STEEL_DESIGN
)
print(f"OBJECTS TO DESIGN:\n{objects_to_design}")