Extract data from a specific position in a COM result value. Args: result: Raw return value from a COM call index: Position

Extract the return code from a COM result value. For tuple/list results, the return code is expected at `result[-1]`. If a scalar intege

Ensure the COM connection is still valid. All public methods that use `self._model` should call this first. Raises:

Safely convert a string value to `float`.

Create a single object. Args: obj: Object to create, such as `Point`, `Frame`, or `Material` Returns:

Get a group by name Args: model: SAP2000 SapModel object name: Group name Retur

Get the list of all group names Returns: List of group names

Return the first non-empty value among candidate field names.

Get the total number of groups Returns: Number of groups

Return a child logger. Args: name: Child logger name Returns: A child logger inheriting the package logger

Get display table data (array format). Args: model: SapModel object table_key: table key

Set the current display units. API: SetPresentUnits(Units) -> Long Args: model: SAP2000 SapModel object

Convert to list-of-dicts format Returns: list of dicts (one per row)

Get point coordinates (using current model units) Args: model: SAP2000 SapModel object point_name: Point name

Apply rotation and translation to profile points (for SD sub-shapes). Args: points: Source profile points (relative to shape cen

Return an environment variable with the `PYSAP_` prefix.

Generate circular profile points

Try to fetch a table and return `None` instead of raising.

Get the current display units. API: GetPresentUnits() -> eUnits Returns: Active `UnitSystem`.

Retrieve a single object. Args: obj: Object with a `no` attribute identifying the target item

Get group members of a specific type Args: model: SAP2000 SapModel object object_type: Object type

Format values, showing `-` when `0` means not applicable.

Clear the current selection Args: model: SAP2000 SapModel object Returns: `0` on success Examp

Rename an object. Args: obj: Object to rename; it must provide a `change_name` method new_name: New

Set the active degrees of freedom. API: Analyze.SetActiveDOF(DOF[]) -> Long Args: model: SAP2000 SapModel objec

Fetch frame data from SAP2000.

Read an integer environment variable.

Set the active output case and combo selection.

Add an element

Get the active degrees of freedom. API: Analyze.GetActiveDOF(DOF[]) -> Long Returns: `DOFState` instance.

Get a specific cell value Args: row_index: row index (0-based) field_name: field name

Select all objects Args: model: SAP2000 SapModel object Returns: `0` on success Example:

Set a GB 50017-2010 overwrite value. Args: model: SAP2000 SapModel object name: Object name, group name, or ignored depending on

Set a GB 50017-2010 preference value. Args: model: SAP2000 SapModel object item: Preference index (1–15) value: Value to

Build an index for faster lookup by name.

Change point coordinates (using current model units)

Create or update the group in SAP2000 Updates the group if it exists; otherwise creates a new one. Returns:

Read a boolean environment variable.

Get section type, parameters, and material Returns: (section_type, section_params, material)

Build a short object description for log messages.

Restore original units

Save current units and switch to `N-mm-C`

Get all link-object names

Retrieve multiple objects. Args: obj_type: Object class nos: Optional list of object identifiers; `N

Get all area section-property names Args: model: SapModel object Returns: List

Set the selection state of an area object. Args: model: SAP2000 SapModel object area_name: Area object name sele

Set the selection state of a frame object. Args: model: SAP2000 SapModel object frame_name: Frame object name se

Set the selection state of a link object. Args: model: SAP2000 SapModel object link_name: Link object name selec

Update a single object. Args: obj: Object to update Returns: `0` on success

Warn if the section is missing from the model.

Fetch cable-object data from SAP2000. API: GetPoints(Name, Point1, Point2) -> (Point1, Point2, ret) API: GetProperty

Retrieve load pattern data from the model. Args: model: SAP2000 SapModel object Returns:

Fetch the point GUID.

Get area-object GUID

Generic last-resort material getter.

Parse the result returned by the create call.

Apply edited tables Apply all pending changes set by `set_table_for_editing` to the model. Args:

Run analysis. Returns: `0` on success Raises: SAPConnectionError: The COM connection is no longer v

Rename the group Note: the `"ALL"` group cannot be renamed. Args: model: SAP2000 SapModel objec

Deselect all cases and combinations for output. This is commonly called before querying results so the caller can select only the requir

Finish batch modification mode and refresh the view.

Get active model degrees of freedom Args: model: SAP2000 SapModel object Returns: `ActiveDOF` instance, or

Get all tables (including empty tables) Args: model: SapModel object Returns: list

Get available table list (tables with data) Args: model: SapModel object Returns: l

Get link object by name Example: link = Link.get_by_name(model, "1") print(f"Properties: {link.prope

Get the list of all constraint names. Returns: List of constraint names.

Get the constraint type. Args: name: Constraint name Returns: `ConstraintType`, or `None` if the query fail

Return the database unit system. All model data is stored internally using database units and converted to the active displa

Get the groups assigned to a frame. Args: model: SAP2000 SapModel object frame_name: Frame object name Returns:

Return the end-release state of a frame. Args: model: `SapModel` object frame_name: Frame name Returns:

Return the active model filename. Args: include_path: Whether to include the full path Retu

Generate I-section profile points

Get the active steel design code Args: model: SAP2000 SapModel object Returns: Code name string

Convenience function to get steel usage Args: model: SapModel object group_by: Grouping mode; `None` returns total, `"se

Get editable table data (array format). Similar to `get_table_for_display`, but returns editable data. Args

Get a short label for the unit system (e.g. ``kN-m-C``). Args: units: Unit system Returns: Label st

Set whether a case is selected for output. Args: model: SAP2000 SapModel object case_name: Case name selected: `

Validate a coordinate value. Args: value: Coordinate value coord_name: Coordinate label used in error messages Returns:

Insert an image and add a centered caption.

Add a centered bold title.

Compute the projection of point P onto line AB Args: point_a: Point A on the line `(x, y, z)` point_b: Point B on the li

Compute the frame length. Args: model: `SapModel` object point_cache: Optional point-coordinate cach

Create or update the named modifier Args: model: SAP2000 SapModel object Returns:

Create the point in SAP2000. Args: model: `SapModel` object Returns: `0` on suc

Create the frame in SAP2000. Returns: `0` on success

Create a shell property.

Delete the group from SAP2000 Note: the `"ALL"` group cannot be deleted. Returns: `0` on succes

Attach a deprecation warning to a legacy exception class.

Write a DataFrame into a Word table.

Discover steel design tables by probing known table names directly.

Convert a release tuple to a readable label string.

Fetch area-object data from SAP2000.

Load group data from SAP2000 Returns: self

Get automatic meshing settings

Get cable data API: GetCableData(Name, CableType, NumSegs, Weight, ProjectedLoad, UseDeformedGeom

Get frame local-axis rotation angle Args: frame_name: Frame name Returns: Rotat

Get groups containing this area object