Section/Property
Standard Table Sections
Cross-sections from built-in country steel tables (AISC and others). Applied to members in Member › Section & Material.
27 functions
Create
CreateAnglePropertyFromTable
Description
Creates the angle property from table.
Parameters
country_code(int): country code.section_name(str): section name.specification_type_no(int): specification type no.add_spec(float): add spec.
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.CreateAnglePropertyFromTable(1, "value", 1, 1.0)
print(result)
CreateAssignProfileProperty
Description
Creates the assign profile property.
Parameters
profile_type(int): profile 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.CreateAssignProfileProperty(1)
print(result)
CreateChannelPropertyFromTable
Description
Creates the channel property from table.
Parameters
country_code(int): country code.section_name(str): section name.spec_type(int): spec type.additional_spec_1(float): additional spec 1.
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.CreateChannelPropertyFromTable(1, "value", 1, 1.0)
print(result)
CreatePipePropertyFromTable
Description
Creates the pipe property from table.
Parameters
country_code(int): country code.section_name(str): section name.spec_type(int): spec type.additional_spec_1(float): additional spec 1.additional_spec_2(float): additional spec 2.
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.CreatePipePropertyFromTable(1, "value", 1, 1.0, 1.0)
print(result)
CreatePrismaticTeeProperty
Description
Creates the prismatic tee property.
Parameters
total_section_depth(float): total section depth.flange_width(float): flange width.stem_depth(float): stem depth.stem_width(float): stem width.
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.CreatePrismaticTeeProperty(1.0, 1.0, 1.0, 1.0)
print(result)
CreatePropertyFromUserTable
Description
Creates the property from user table.
Parameters
section_name(str): section name.table_no(int): table no.
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.CreatePropertyFromUserTable("value", 1)
print(result)
CreateTaperedTubeProperty
Description
Creates the tapered tube property.
Parameters
tube_type(int): tube type.start_member_section_depth(float): start member section depth.end_member_section_depth(float): end member section depth.section_thickness(float): section thickness.
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.CreateTaperedTubeProperty(1, 1.0, 1.0, 1.0)
print(result)
CreateTeePropertyFromTable
Description
Creates the tee property from table.
Parameters
country_code(int): country code.section_name(str): section name.spec_type(int): spec 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.CreateTeePropertyFromTable(1, "value", 1)
print(result)
CreateTubePropertyFromTable
Description
Creates the tube property from table.
Parameters
country_code(int): country code.section_name(str): section name.spec_type(int): spec type.add_spec_1(float): add spec 1.add_spec_2(float): add spec 2.add_spec_3(float): add spec 3.
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.CreateTubePropertyFromTable(1, "value", 1, 1.0, 1.0, 1.0)
print(result)
CreateWideFlangePropertyFromTable
Description
Creates the wide flange property from table.
Parameters
country_code(int): country code.section_name(str): section name.spec_type(int): spec type.specs_list(list): specs 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.CreateWideFlangePropertyFromTable(1, "value", 1, [1, 2])
print(result)
Get
GetAlphaAngleForSection
Description
Returns the alpha angle of a section, in radians — the angle between the section's principal axis and its geometric axis.
Parameters
spec_property_id(int): ID of the section property.
Returns
float: The alpha angle, in radians.
Example
from openstaad import ops
s = ops.connect()
alpha = s.GetAlphaAngleForSection(1)
print(alpha)
GetDefaultStandardProfileDBFolder
Description
Returns the default standard profile DB folder.
Parameters
None.
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.GetDefaultStandardProfileDBFolder()
print(result)
GetPublishedProfileName
Description
Returns the published profile name.
Parameters
staad_profile_name(str): staad profile name.country_code(int): country code.
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.GetPublishedProfileName("value", 1)
print(result)
GetSTAADProfileName
Description
Returns the STAAD profile name.
Parameters
published_name(str): published name.country_code(int): country code.
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.GetSTAADProfileName("value", 1)
print(result)
GetStandardProfileDBFolder
Description
Returns the standard profile DB folder.
Parameters
None.
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.GetStandardProfileDBFolder()
print(result)
GetStandardSectionDatabaseName
Description
Returns the standard section database name.
Parameters
section_property_id(int): section property 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.GetStandardSectionDatabaseName(1)
print(result)
GetStandardSectionName
Description
Returns the standard section name.
Parameters
section_reference_id(int): section reference 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.GetStandardSectionName(1)
print(result)
GetStandardSectionTableName
Description
Returns the standard section table name.
Parameters
section_reference_id(int): section reference 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.GetStandardSectionTableName(1)
print(result)
GetUserProvidedTableSectionCount
Description
Returns the user provided table section count.
Parameters
table_id(int): table 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.GetUserProvidedTableSectionCount(1)
print(result)
GetUserProvidedTableSectionList
Description
Returns the user provided table section list.
Parameters
table_id(int): table id.
Returns
list: A list of strings.
Example
from openstaad import ops
s = ops.connect()
result = s.GetUserProvidedTableSectionList(1)
print(result)
GetUserProvidedTableSectionProperties
Description
Returns the user provided table section properties.
Parameters
table_id(int): table id.section_name(str): section name.property_count(int, optional (default24)): property count.
Returns
tuple: A tuple of (int, list[float]).
Example
from openstaad import ops
s = ops.connect()
result = s.GetUserProvidedTableSectionProperties(1, "value", 1)
print(result)
GetUserProvidedTableSectionPropertyCount
Description
Returns the user provided table section property count.
Parameters
upt_table_id(int): upt table id.section_name(str): section 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.GetUserProvidedTableSectionPropertyCount(1, "value")
print(result)
GetUserProvidedTableSectionType
Description
Returns the user provided table section type.
Parameters
table_id(int): table id.
Returns
int: An integer value returned by STAAD.Pro for this call.
Example
from openstaad import ops
s = ops.connect()
result = s.GetUserProvidedTableSectionType(1)
print(result)
Set/Assign
SetStandardProfileDBFolder
Description
Sets the standard profile DB folder.
Parameters
folder_name(str): folder name.
Returns
bool: True if the call succeeded, False otherwise.
Example
from openstaad import ops
s = ops.connect()
result = s.SetStandardProfileDBFolder("value")
print(result)
Execute
ComputeWallWindPressureProfile
Description
Calls the ComputeWallWindPressureProfile function on the OpenStaad ops session.
Parameters
loadingCode(int): loading code.windSpeed(float): wind speed.bldgClass(int): bldg class.bldgType(int): bldg type.expCat(int): exp cat.bEscarpment(bool): b escarpment.varUnitsData(list): var units data.varEscarpmentData(list): var escarpment data.varBldgData(list): var bldg data.wallType(int): wall 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.ComputeWallWindPressureProfile(1, 1.0, 1, 1, 1, True, [1, 2], [1, 2], [1, 2], 1)
print(result)
ComputeWallWindPressureProfileASCE72016
Description
Calls the ComputeWallWindPressureProfileASCE72016 function on the OpenStaad ops session.
Parameters
windSpeed(float): wind speed.heightAboveSeaLvl(float): height above sea lvl.bldgClass(int): bldg class.bldgType(int): bldg type.expCat(int): exp cat.bEscarpment(bool): b escarpment.varUnitsData(list): var units data.varEscarpmentData(list): var escarpment data.varBldgData(list): var bldg data.wallType(int): wall 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.ComputeWallWindPressureProfileASCE72016(1.0, 1.0, 1, 1, 1, True, [1, 2], [1, 2], [1, 2], 1)
print(result)
Is
IsStandardDatabaseSection
Description
Checks whether standard database section.
Parameters
section_reference_id(int): section reference 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.IsStandardDatabaseSection(1)
print(result)