OPS

Member Section & Material

Links each member to a cross-section and a material, plus its beta angle — what the member is made of, not its shape in space. Sections are defined in the section domains; materials in Material.

21 functions

Create

CreateBeamPropertyFromTable

Description

Creates a beam section property from the STAAD.Pro section table and returns its property ID, ready to be passed to AssignBeamProperty.

Parameters

  • country_code (int): Country/section-table code. See table below.
  • section_name (str): Name of the section, exactly as it appears in the STAAD.Pro table (e.g. "W12X26").
  • type_spec (int): Type specification number. See table below.
  • add_spec_1 (float): Free spacing for a double profile (0.0 if not applicable).
  • add_spec_2 (float): Reserved; set to 0.0.

Country Codes

CodeCountry
1American
2Australian
3British
4Canadian
5Chinese
6Dutch
7European
8French
9German
10Indian
11Japanese
12Russian
13SouthAfrican
14Spanish
15Venezuelan
16Korean
17Aluminum
18American cold formed
19Indian cold formed
20Mexican
21American Steel Joist
22AITCTimber
23Lysaght cold formed
24British cold formed
25Canadian Timber
26Butler cold formed
27Kingspan cold formed
28RCeco cold formed
29Japanese cold formed
30Australian cold formed
31Russian cold formed
32STOASChM
33Jindal
34European cold formed
35Tata Structura
36Brazilian
37APL Apollo Tubes

Type specification (type_spec)

ValueType spec.Description
0ST
2DDouble profile.
5TTee section cut from an I-section (aluminum).

Returns

int: The new property ID.

Example

from openstaad import ops

s = ops.connect()
property_id = s.CreateBeamPropertyFromTable(1, "W12X26", 0, 0.0, 0.0)
print(property_id)

CreateBeamPropertyFromTableComposite

Description

Creates the beam property from table composite.

Parameters

  • country_code (int): country code.
  • section_name (str): section name.
  • spec_type (int): spec type.
  • additional_spec_list (list): additional spec list.

Returns

raw: The raw return value from the underlying OpenSTAAD COM call. Refer to the official Bentley OpenSTAAD API reference for this method's exact return semantics.

Example

from openstaad import ops

s = ops.connect()
result = s.CreateBeamPropertyFromTableComposite(1, "value", 1, [1, 2])
print(result)

CreateBeamPropertyFromTableEx

Description

Creates the beam property from table ex.

Parameters

  • country_code (int): country code.
  • section_name (str): section name.
  • solid_shape_type (int): solid shape type.

Returns

raw: The raw return value from the underlying OpenSTAAD COM call. Refer to the official Bentley OpenSTAAD API reference for this method's exact return semantics.

Example

from openstaad import ops

s = ops.connect()
result = s.CreateBeamPropertyFromTableEx(1, "value", 1)
print(result)

CreateBeamPropertyFromTableWithCoverPlates

Description

Creates the beam property from table with cover plates.

Parameters

  • country_code (int): country code.
  • section_name (str): section name.
  • spec_type (int): spec type.
  • additional_spec_list (list): additional spec list.

Returns

raw: The raw return value from the underlying OpenSTAAD COM call. Refer to the official Bentley OpenSTAAD API reference for this method's exact return semantics.

Example

from openstaad import ops

s = ops.connect()
result = s.CreateBeamPropertyFromTableWithCoverPlates(1, "value", 1, [1, 2])
print(result)

Get

GetBeamConstants

Description

Returns the beam constants.

Parameters

  • beam_id (int): beam id.

Returns

raw: The raw return value from the underlying OpenSTAAD COM call. Refer to the official Bentley OpenSTAAD API reference for this method's exact return semantics.

Example

from openstaad import ops

s = ops.connect()
result = s.GetBeamConstants(1)
print(result)

GetBeamMaterialName

Description

Returns the beam material name.

Parameters

  • beam_id (int): beam id.

Returns

raw: The raw return value from the underlying OpenSTAAD COM call. Refer to the official Bentley OpenSTAAD API reference for this method's exact return semantics.

Example

from openstaad import ops

s = ops.connect()
result = s.GetBeamMaterialName(1)
print(result)

GetBeamProperty

Description

Returns the beam property.

Parameters

  • beam_id (int): beam id.

Returns

tuple: eight floats, (width, depth, ax, ay, az, ix, iy, iz). In the model tested, ix behaved as the torsional constant (much smaller than iy and iz).

Values come back in the model's base units: width and depth in m or in, areas in m² or in², and inertias in m⁴ or in⁴.

Example

from openstaad import ops

s = ops.connect()
result = s.GetBeamProperty(1)
print(result)

GetBeamPropertyAll

Description

Returns the beam property all.

Parameters

  • beam_id (int): beam id.

Returns

raw: The raw return value from the underlying OpenSTAAD COM call. Refer to the official Bentley OpenSTAAD API reference for this method's exact return semantics.

Example

from openstaad import ops

s = ops.connect()
result = s.GetBeamPropertyAll(1)
print(result)

GetBeamSectionDisplayName

Description

Returns the beam section display name.

Parameters

  • beam_id (int): beam id.

Returns

raw: The raw return value from the underlying OpenSTAAD COM call. Refer to the official Bentley OpenSTAAD API reference for this method's exact return semantics.

Example

from openstaad import ops

s = ops.connect()
result = s.GetBeamSectionDisplayName(1)
print(result)

GetBeamSectionName

Description

Returns the section name assigned to a beam.

Parameters

  • beam_id (int): Beam number ID.

Returns

str: The section name as STAAD.Pro reports it.

See the following table for examples of probable section names:

Sl No.Section TypeIn STD fileGetBeamSectionName
1Standard steel database sectionTABLE ST W36X925W36X925
TABLE D W36X925 SP 1W36X925
5 TABLE SD L20205 SP 1L20205
2Tube and pipe definition8 TABLE ST PIPE OD 2 ID 1PIPE
8 TABLE ST TUBE TH 1 WT 2 DT 3TUBE
3Prismatic3 PRIS YD 1 ZD 2 YB 2 ZB 3Prismatic Tee
8 PRIS YD 3 ZD 1 ZB 2Prismatic Trapezoid
4Tapered3 TAPERED 1 2 3 1 2 3 1Taper
5Assigned profile3 ASSIGN ANGLE DOUBLEAssign Double Angle
6User provided table14 TO 23 UPT 2 LANG40404LANG40404

Example

from openstaad import ops

s = ops.connect()
name = s.GetBeamSectionName(1)
print(name)

GetBeamSectionPropertyRefNo

Description

Returns the section property reference number assigned to a beam.

Parameters

  • beam_id (int): Beam number ID.

Returns

int: Reference number of the section property assigned to the beam, or 0 if none is assigned.

Example

from openstaad import ops

s = ops.connect()
ref_no = s.GetBeamSectionPropertyRefNo(1)
print(ref_no)

GetBeamSectionPropertyTypeNo

Description

Returns the beam section property type no.

Parameters

  • beam_id (int): beam id.

Returns

raw: The raw return value from the underlying OpenSTAAD COM call. Refer to the official Bentley OpenSTAAD API reference for this method's exact return semantics.

Example

from openstaad import ops

s = ops.connect()
result = s.GetBeamSectionPropertyTypeNo(1)
print(result)

GetBeamSectionPropertyValuesEx

Description

Returns the beam section property values ex.

Parameters

  • beam_id (int): beam id.

Returns

tuple: A tuple of (int, list[float]).

Example

from openstaad import ops

s = ops.connect()
result = s.GetBeamSectionPropertyValuesEx(1)
print(result)

GetIsotropicMaterialAssignedBeamCount

Description

Returns the isotropic material assigned beam count.

Parameters

  • material_name (str): material name.

Returns

raw: The raw return value from the underlying OpenSTAAD COM call. Refer to the official Bentley OpenSTAAD API reference for this method's exact return semantics.

Example

from openstaad import ops

s = ops.connect()
result = s.GetIsotropicMaterialAssignedBeamCount("value")
print(result)

GetIsotropicMaterialAssignedBeamList

Description

Returns the isotropic material assigned beam list.

Parameters

  • material_name (str): material name.

Returns

list: A list of integers.

Example

from openstaad import ops

s = ops.connect()
result = s.GetIsotropicMaterialAssignedBeamList("value")
print(result)

GetSectionPropertyAssignedBeamCount

Description

Returns the section property assigned beam count.

Parameters

  • prof_type (int): prof type.

Returns

raw: The raw return value from the underlying OpenSTAAD COM call. Refer to the official Bentley OpenSTAAD API reference for this method's exact return semantics.

Example

from openstaad import ops

s = ops.connect()
result = s.GetSectionPropertyAssignedBeamCount(1)
print(result)

GetSectionPropertyAssignedBeamList

Description

Returns the section property assigned beam list.

Parameters

  • prof_type (int): prof type.

Returns

list: A list of integers.

Example

from openstaad import ops

s = ops.connect()
result = s.GetSectionPropertyAssignedBeamList(1)
print(result)

Set/Assign

AssignBeamProperty

Description

Assigns a previously created section property to one or more beams.

Parameters

  • beam_ids (int or list[int]): Beam number ID, or a list of beam number IDs, to assign the property to.
  • property_id (int): Numeric ID of the section property, as returned by a Create*PropertyFromTable/CreatePrismatic*Property function.

Returns

bool: True if the assignment succeeded, False otherwise.

Notes

Internally this wraps the OpenSTAAD COM call, which reports these codes on failure (all collapsed to False by ops):

CodeMeaning
0OK.
-106beam_ids array dimension error.
-3006Invalid member number ID(s).
-6001Invalid section / assigned property ID.
-6002Library error: property assignment.

Example

from openstaad import ops

s = ops.connect()
property_id = s.CreateBeamPropertyFromTable(1, "W12X26", 0, 0.0, 0.0)
ok = s.AssignBeamProperty([1, 2, 3], property_id)
print(ok)

AssignMaterialToMember

Description

Assigns a material to one or more members.

Parameters

  • material_name (str): Name of an existing material in the model (e.g. "STEEL", "CONCRETE").
  • member_ids (int or list[int]): Member number ID, or a list of member number IDs.

Returns

int: the raw OpenSTAAD result code — 1 if the assignment succeeded, 0 otherwise.

Example

from openstaad import ops

s = ops.connect()
result = s.AssignMaterialToMember("STEEL", [1, 2, 3])
print(result)

Remove

RemoveMaterialFromBeam

Description

Removes the material from beam.

Parameters

  • beam_id (int): beam id.

Returns

bool: True if the call succeeded, False otherwise.

Example

from openstaad import ops

s = ops.connect()
result = s.RemoveMaterialFromBeam(1)
print(result)

RemovePropertyFromBeam

Description

Removes the property from beam.

Parameters

  • beam_id (int): beam id.

Returns

bool: True if the call succeeded, False otherwise.

Example

from openstaad import ops

s = ops.connect()
result = s.RemovePropertyFromBeam(1)
print(result)