Section/Property

UPT Profiles

User-Provided Table sections — custom cross-sections defined in an external table and referenced by members.

19 functions

Create

AddUPTPropertyANGLE

Description

Adds the UPT property ANGLE.

Parameters

table_reference_id (int): table reference id.
section_name (str): section name.
depth_of_angle (float): depth of angle.
width_of_angle (float): width of angle.
flange_thickness (float): flange thickness.
gyration_radius (float): gyration radius.
shear_area_y (float): shear area y.
shear_area_z (float): shear area z.

Returns

bool: True if the call succeeded, False otherwise.

Example

from openstaad import ops

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

AddUPTPropertyCHANNEL

Description

Adds the UPT property CHANNEL.

Parameters

table_reference_id (int): table reference id.
stn_name (str): stn name.
cro_sec_area (value): cro sec area.
sectn_depth (float): sectn depth.
web_Thickness (float): web thickness.
top_flange_width (float): top flange width.
top_flange_thickness (float): top flange thickness.
torsional_constant (value): torsional constant.
moi_l_y (float): moi l y.
moi_l_z (float): moi l z.
c_z (float): c z.
shear_area_y (float): shear area y.
shear_area_z (float): shear area z.

Returns

bool: True if the call succeeded, False otherwise.

Example

from openstaad import ops

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

AddUPTPropertyDOUBLEANGLE

Description

Adds the UPT property DOUBLEANGLE.

Parameters

table_reference_id (int): table reference id.
section_name (str): section name.
depth_angle (float): depth angle.
width_angle (float): width angle.
flanges_thickness (float): flanges thickness.
distance_between_two_angles (bool): distance between two angles.
torsional_constant (value): torsional constant.
moi_y (float): moi y.
moi_z (float): moi z.
dist_z_top_section (bool): dist z top section.
shear_area_y (float): shear area y.
shear_area_z (float): shear area z.

Returns

bool: True if the call succeeded, False otherwise.

Example

from openstaad import ops

s = ops.connect()
result = s.AddUPTPropertyDOUBLEANGLE(1, "value", 1.0, 1.0, 1.0, True, 1, 1.0, 1.0, True, 1.0, 1.0)
print(result)

AddUPTPropertyGENERAL

Description

Adds the UPT property GENERAL.

Parameters

table_reference_id (int): table reference id.
section_name (str): section name.
cross_section_area (value): cross section area.
section_depth (float): section depth.
thickness_parallel_depth (float): thickness parallel depth.
width_of_section (float): width of section.
thickness_parallel_flange (float): thickness parallel flange.
torsional_constant (value): torsional constant.
moi_y (float): moi y.
moi_z (float): moi z.
section_modulus_z (float): section modulus z.
section_modulus_y (float): section modulus y.
shear_area_y (float): shear area y.
shear_area_z (float): shear area z.
plastic_modulus_z (float): plastic modulus z.
plastic_modulus_y (float): plastic modulus y.
warping_constant (value): warping constant.
depth_of_web (float): depth of web.

Returns

bool: True if the call succeeded, False otherwise.

Example

from openstaad import ops

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

AddUPTPropertyISECTION

Description

Adds the UPT property ISECTION.

Parameters

table_reference_id (int): table reference id.
section_name (str): section name.
depth_of_web (float): depth of web.
thickness_of_web (float): thickness of web.
depth_of_web1 (float): depth of web 1.
width_of_top_flange (float): width of top flange.
thickness_of_top_flange (float): thickness of top flange.
width_of_bottom_flange (float): width of bottom flange.
thickness_of_bottom_flange (float): thickness of bottom flange.
shear_area_y (float): shear area y.
shear_area_z (float): shear area z.
torsional_constant (value): torsional constant.

Returns

bool: True if the call succeeded, False otherwise.

Example

from openstaad import ops

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

AddUPTPropertyPIPE

Description

Adds the UPT property PIPE.

Parameters

table_reference_id (int): table reference id.
section_name (str): section name.
out_diameter (value): out diameter.
in_diameter (value): in diameter.
shear_area_y (float): shear area y.
shear_area_z (float): shear area z.

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.AddUPTPropertyPIPE(1, "value", 1, 1, 1.0, 1.0)
print(result)

AddUPTPropertyPRISMATIC

Description

Adds the UPT property PRISMATIC.

Parameters

table_reference_id (int): table reference id.
section_name (str): section name.
cross_section_area (value): cross section area.
torsional_constant (value): torsional constant.
moment_of_inertia_y (float): moment of inertia y.
moment_of_inertia_z (float): moment of inertia z.
shear_area_y (float): shear area y.
shear_area_z (float): shear area z.
depth_y (float): depth y.
depth_z (float): depth z.

Returns

bool: True if the call succeeded, False otherwise.

Example

from openstaad import ops

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

AddUPTPropertyTEE

Description

Adds the UPT property TEE.

Parameters

table_reference_id (int): table reference id.
section_name (str): section name.
cross_section_area (value): cross section area.
section_depth (float): section depth.
top_flange_width (float): top flange width.
top_flange_thickness (float): top flange thickness.
web_thickness (float): web thickness.
torsional_constant (value): torsional constant.
moi_y (float): moi y.
moi_z (float): moi z.
dist_z_top_section (bool): dist z top section.
shear_area_y (float): shear area y.
shear_area_z (float): shear area z.

Returns

bool: True if the call succeeded, False otherwise.

Example

from openstaad import ops

s = ops.connect()
result = s.AddUPTPropertyTEE(1, "value", 1, 1.0, 1.0, 1.0, 1.0, 1, 1.0, 1.0, True, 1.0, 1.0)
print(result)

AddUPTPropertyTUBE

Description

Adds the UPT property TUBE.

Parameters

table_reference_id (int): table reference id.
section_name (str): section name.
cross_section_area (value): cross section area.
section_depth (float): section depth.
top_flange_width (float): top flange width.
top_flange_thickness (float): top flange thickness.
torsional_constant (value): torsional constant.
moi_y (float): moi y.
moi_z (float): moi z.
shear_area_y (float): shear area y.
shear_area_z (float): shear area z.

Returns

bool: True if the call succeeded, False otherwise.

Example

from openstaad import ops

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

AddUPTPropertyWIDEFLANGE

Description

Adds the UPT property WIDEFLANGE.

Parameters

table_ref_id (int): table ref id.
stn_name (str): stn name.
cro_sec_area (value): cro sec area.
sectn_depth (float): sectn depth.
web_Thickness (float): web thickness.
top_flange_width (float): top flange width.
top_flange_thickness (float): top flange thickness.
torsional_constant (value): torsional constant.
moi_l_y (float): moi l y.
moi_l_z (float): moi l z.
shear_area_y (float): shear area y.
shear_area_z (float): shear area z.

Returns

bool: True if the call succeeded, False otherwise.

Example

from openstaad import ops

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

AddUPTPropertyWIDEFLANGECOMPOSITE

Description

Adds the UPT property WIDEFLANGECOMPOSITE.

Parameters

table_reference_id (int): table reference id.
section_name (str): section name.
profile_spec_list (list): profile 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.AddUPTPropertyWIDEFLANGECOMPOSITE(1, "value", [1, 2])
print(result)

AddUPTPropertyWIDEFLANGEUNEQUAL

Description

Adds the UPT property WIDEFLANGEUNEQUAL.

Parameters

table_reference_id (int): table reference id.
section_name (str): section name.
profile_spec_list (list): profile 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.AddUPTPropertyWIDEFLANGEUNEQUAL(1, "value", [1, 2])
print(result)

CreatePropertyFromUPTTable

Description

Creates the property from UPT table.

Parameters

table_id (int): 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.CreatePropertyFromUPTTable(1, "value")
print(result)

CreateUPTTable

Description

Creates the UPT table.

Parameters

table_type (int): table 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.CreateUPTTable(1)
print(result)

CreateUPTTableEx

Description

Creates the UPT table ex.

Parameters

table_ref_id (int): table ref id.
table_type (int): table 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.CreateUPTTableEx(1, 1)
print(result)

Get

GetUptGeneralProfileBoundaryPoints

Description

Returns the Upt general profile boundary points.

Parameters

table_number_id (int): table number id.
section_name (str): section name.
is_inner (bool): is inner.

Returns

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

Example

from openstaad import ops

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

GetUptGeneralProfilePointsCount

Description

Returns the Upt general profile points count.

Parameters

table_reference_id (int): table reference id.
section_name (str): section name.

Returns

tuple: A tuple of (int, int).

Example

from openstaad import ops

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

Delete

RemovePropertyFromUPTTable

Description

Removes the property from UPT table.

Parameters

table_reference_id (int): table reference 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.RemovePropertyFromUPTTable(1, "value")
print(result)

RemoveUPTTable

Description

Removes the UPT table.

Parameters

table_ref_id (int): table ref 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.RemoveUPTTable(1)
print(result)