get_object_table#
- dlubal.api.rstab.Application.get_object_table(self, object_type, show_header_details=False, model_id=None, use_current_units=False, return_formulas=False, loading=None)#
Retrieves object data according to the object type wrapped in a DataFrame for more efficient analysis.
- Parameters:
object_type (ObjectType) – Unique identifier for the object type.
show_header_details (bool, optional) – If True, the DataFrame will have a two-row header (first row: id, second row: name). If False, only the id will be used as the header (default).
model_id (ModelId | None) – Unique identifier of the model. If None, the active model is used.
use_current_units (bool, optional) – Identifier whether user defined or SI units are used to represent values.
return_formulas (bool, optional) – Identifier whether formulas are shown.
loading (ObjectId) – Reference to the loading (e.g., load case, combination, etc.).
- Returns:
A Table table containing the object data for the specific object type as a DataFrame.
Method Type: Core
Usage
# Retrieves specified model object table wrapped in a DataFrame (.data)
object_table: common.Table = rstab_app.get_object_table(
object_type=rstab.OBJECT_TYPE_NODE,
show_header_details=True,
use_current_units=True,
return_formulas=True,
)
print(f"\nObject Table:\n{object_table.data}")
// Retrieves specified model object table wrapped in a DataFrame (.Data)
Common.Table object_table = rstabApp.get_object_table(
objectType: Rstab.ObjectType.Node,
showHeaderDetails: true,
useDefinedUnits: true,
showFormulas: true
);
Console.WriteLine("Object Table:");
object_table.Print(twoLineHeader: true);
Output:
Object Table:
node_no type reference_node coordinate_system coordinate_system_type coordinate_1 coordinate_2 coordinate_3 global_coordinate_1 global_coordinate_2 global_coordinate_3 comment
Node No. Node Type Reference Node Coordinate System Coordinate Type X/R [mm] Y/Θ [mm/deg] Z/Φ [mm/deg] X [mm] Y [mm] Z [mm] Comment
0 1 Standard 0 1 Cartesian 0.0 0.0 -4000.0 0.0 0.0 -4000.0
1 2 Standard 0 1 Polar 5656.854249 90.0 135.0 0.0 4000.0 -4000.0
2 3 Standard 0 1 Cartesian 6000.0 4000.0 -4000.0 6000.0 4000.0 -4000.0
3 4 Standard 0 1 Cartesian 6000.0 0.0 -4000.0 6000.0 0.0 -4000.0
4 5 Standard 0 1 Cartesian 6000.0 4000.0 0.0 6000.0 4000.0 0.0
5 6 Standard 0 1 Cartesian 6000.0 8000.0 -4000.0 6000.0 8000.0 -4000.0
6 7 Standard 0 1 Cartesian 10000.0 8000.0 -4000.0 10000.0 8000.0 -4000.0
7 8 Standard 0 1 Cartesian 10000.0 0.0 -4000.0 10000.0 0.0 -4000.0
8 9 Standard 0 1 Cartesian 10000.0 8000.0 0.0 10000.0 8000.0 0.0