Surface#

Attribute Name

Data Type

Description

no

int

No.

geometry

Geometry

Surface type

boundary_lines

List[int]

Boundary lines

analytical_area

float

Analytical area | A

analytical_volume

float

Analytical volume | V

analytical_mass

float

Analytical mass | M

analytical_center_of_gravity

Vector3d

Analytical center of gravity

analytical_center_of_gravity_x

float

Analytical center of gravity | X_C

analytical_center_of_gravity_y

float

Analytical center of gravity | Y_C

analytical_center_of_gravity_z

float

Analytical center of gravity | Z_C

area

float

Area | A

volume

float

Volume | V

mass

float

Mass | M

center_of_gravity

Vector3d

Center of gravity

center_of_gravity_x

float

Center of gravity | X_C

center_of_gravity_y

float

Center of gravity | Y_C

center_of_gravity_z

float

Center of gravity | Z_C

position

str

Position (full)

position_short

str

Position

reversed_normal

bool

Reversed normal

parent_layer

int

Parent layer

is_locked_by_parent_layer

bool

Locked by parent layer

is_generated

bool

Generated by

generating_object_info

str

Generated by

comment

str

Comment

nurbs_control_point_count_in_direction_u

int

Number of control points in direction u

nurbs_control_point_count_in_direction_v

int

Number of control points in direction v

nurbs_order_in_direction_u

int

Order in direction u

nurbs_order_in_direction_v

int

Order in direction v

nurbs_control_points

SurfaceNurbsControlPointsRowsTable

Coordinates - Control Point | 2D matrix of NURBS control points. Each point is defined by its attributes: Coordinates (as a vector) and Weight .

quadrangle_corner_node_1

int

Corner node 1

quadrangle_corner_node_2

int

Corner node 2

quadrangle_corner_node_3

int

Corner node 3

quadrangle_corner_node_4

int

Corner node 4

quadrangle_corner_nodes

List[int]

Corner nodes

quadrangle_preferable_shape

QuadranglePreferableShape

Preferable shape

pipe_radius

float

Radius | r_1

pipe_radius_end

float

End radius | r_2

pipe_use_radius_end

bool

Use end radius

pipe_center_line

int

Center line

pipe_generated_lines

List[int]

Generated lines No.

min_curv_spline_reference_plane_coordinate_system

int

Reference plane coordinate system

min_curv_spline_reference_work_plane_orientation

MinCurvSplineReferenceWorkPlaneOrientation

Reference plane orientation

min_curv_spline_definition_type

MinCurvSplineDefinitionType

Definition type

min_curv_spline_grid_x_point_count

int

Number of grid points in x-direction | n_x

min_curv_spline_grid_y_point_count

int

Number of grid points in y-direction | n_y

min_curv_spline_reference_boundary_lines

List[int]

Reference boundary lines

min_curv_spline_reference_probe_coordinates

MinCurvSplineReferenceProbeCoordinatesTable

Reference probe coordinates

min_curv_spline_global_probe_coordinates

MinCurvSplineGlobalProbeCoordinatesTable

Global probe coordinates

rotated_boundary_line

int

Boundary line No.

rotated_angle_of_rotation

float

Angle of rotation | α

rotated_point_p

Vector3d

Rotation axis point P

rotated_point_p_x

float

Rotation axis point P | X

rotated_point_p_y

float

Rotation axis point P | Y

rotated_point_p_z

float

Rotation axis point P | Z

rotated_point_r

Vector3d

Rotation axis point R

rotated_point_r_x

float

Rotation axis point R | X

rotated_point_r_y

float

Rotation axis point R | Y

rotated_point_r_z

float

Rotation axis point R | Z

rotated_generated_lines

List[int]

Generated lines No.

type

Type

Stiffness Type

thickness

int

Thickness with Material

material

int

Material of Thickness

grid_enabled

bool

Grid enabled

activate_eccentricity

bool

Activate eccentricity

activate_load_transfer

bool

Activate load transfer

is_deactivated_for_calculation

bool

Deactivated for calculation

is_surface_cells_deactivated

bool

Surface cells deactivated

design_properties_via_surface

bool

Design properties via surface

design_properties_via_parent_surface_set

bool

Design properties via parent surface set

design_properties_parent_surface_set

int

Design properties | Parent surface set

is_active_in_compression

bool

Active in compression

load_transfer_direction

LoadTransferDirection

Load distribution direction

is_surface_weight_enabled

bool

Surface weight enabled

is_advanced_distribution_settings_enabled

bool

Advanced distribution settings enabled

surface_weight

float

Surface weight | g

smoothing_factor

float

Smoothing factor | k

stripe_width

float

Stripe width | b

minimum_number_of_stripes

int

Minimum number of stripes on surface | n_min

consider_member_eccentricity

bool

Consider member eccentricity

consider_cross_section_distribution

bool

Consider cross-section distribution

load_distribution

LoadDistribution

Load distribution

neglect_equilibrium_of_moments

bool

Neglect equilibrium of moments

neglect_defined_surface_stiffness

bool

Neglect defined surface stiffness

excluded_members

List[int]

Excluded members

excluded_parallel_to_members

List[int]

Members with excluded parallel objects

excluded_lines

List[int]

Excluded lines

excluded_parallel_to_lines

List[int]

Lines with excluded parallel objects

excluded_nodes

List[int]

Excluded nodes

loaded_members

List[int]

Loaded members

loaded_lines

List[int]

Loaded lines

loaded_nodes

List[int]

Loaded nodes

modify_line_support_condition

bool

Modify line support condition

modify_nodal_support_condition

bool

Modify nodal support condition

load_transfer_line_support

int

Load transfer line support

load_transfer_nodal_support

int

Load transfer nodal support

load_distribution_factor_table

LoadDistributionFactorTable

List of Load Distribution Factors

has_line_hinges

bool

List of Load Distribution Factors enabled optional bool has_load_distribution_factor_table = 98; Has line hinges

support

int

Surface support

eccentricity

int

Surface eccentricity | e_z

mesh_refinement

int

Surface mesh refinement

meshing_type

MeshingType

Meshing type

input_axes_rotation_specification_type

InputAxesRotationSpecificationType

Input axes category

input_axes_angular_rotation

float

Angular rotation | α

input_axes_axis

InputAxesAxis

Axis

input_axes_lines

List[int]

Parallel to lines No.

input_axes_point_1

Vector3d

Direct to point 1

input_axes_point_1_x

float

Direct to point 1 | X

input_axes_point_1_y

float

Direct to point 1 | Y

input_axes_point_1_z

float

Direct to point 1 | Z

input_axes_point_2

Vector3d

Direct to point 2

input_axes_point_2_x

float

Direct to point 2 | X

input_axes_point_2_y

float

Direct to point 2 | Y

input_axes_point_2_z

float

Direct to point 2 | Z

input_axes_coordinate_system

int

Coordinate system

result_axes_rotation_specification_type

ResultAxesRotationSpecificationType

Result axes category

grid_type

GridType

Grid type

grid_origin

Vector3d

Grid origin

grid_origin_x

float

Grid origin | X

grid_origin_y

float

Grid origin | Y

grid_origin_z

float

Grid origin | Z

grid_point_count_negative_x

int

Grid point count | n_-x

grid_point_count_positive_x

int

Grid point count | n_+x

grid_point_count_negative_y

int

Grid point count | n_-y

grid_point_count_positive_y

int

Grid point count | n_+y

grid_numbering_increment

int

Grid numbering increment

grid_point_count_r

int

Grid point count | n_+r

grid_distance_x

float

Grid distances | b

grid_distance_y

float

Grid distances | h

grid_distance_r

float

Grid distances | R

grid_rotation_alpha

float

Grid rotation | α

grid_rotation_beta

float

Grid rotation | β

grid_angle_gamma

float

Grid distances | α

grid_adapt_automatically

bool

Adapt grid automatically

auto_detection_of_integrated_objects

bool

Automatic detection of integrated objects

integrated_nodes

List[int]

Nodes No.

integrated_lines

List[int]

Lines No.

integrated_openings

List[int]

Openings No.

has_integrated_objects

bool

Has integrated objects

has_input_axes_rotation

bool

Has rotation of input axes

has_result_axes_rotation

bool

Has rotation of result axes

surface_steel_design_uls_configuration

int

Ultimate configuration for steel surface design

surface_steel_design_sls_configuration

int

Serviceability configuration for steel surface design

surface_timber_design_uls_configuration

int

Ultimate configuration for timber surface design

surface_timber_design_sls_configuration

int

Serviceability configuration for timber surface design

surface_timber_design_fr_configuration

int

Fire resistance configuration for timber surface design

timber_service_class

int

Service class for timber design

timber_moisture_class

int

Moisture class for timber design

timber_service_conditions

int

Service conditions for timber design

surface_aluminum_design_uls_configuration

int

Ultimate configuration for aluminum surface design

surface_aluminum_design_sls_configuration

int

Serviceability configuration for aluminum surface design

surface_glass_design_uls_configuration

int

Ultimate configuration for glass surface design

surface_glass_design_sls_configuration

int

Serviceability configuration for glass surface design

surface_reinforcements

List[int]

Surface reinforcements

is_user_defined_concrete_cover_enabled

bool

User-Defined Concrete Cover

concrete_cover_top

float

Concrete Cover - Top | c_nom,-z (top)

concrete_cover_bottom

float

Concrete Cover - Bottom | c_nom,+z (bottom)

user_defined_concrete_cover_top

float

User-Defined Concrete Cover - Top | c_-z (top)

user_defined_concrete_cover_bottom

float

User-Defined Concrete Cover - Bottom | c_+z (bottom)

concrete_durability_top

int

Concrete durability - Top

concrete_durability_bottom

int

Concrete durability - Bottom

reinforcement_direction_top

int

Reinforcement direction - Top

reinforcement_direction_bottom

int

Reinforcement direction - Bottom

deflection_check_surface_type

DeflectionCheckSurfaceType

Deflection analysis surface type

deflection_check_double_supported_surface_type

DeflectionCheckDoubleSupportedSurfaceType

Deflection analysis - Double-supported surface type

deflection_check_displacement_reference

DeflectionCheckDisplacementReference

Deflection analysis displacement reference

deflection_check_reference_length_z

float

Deflection analysis reference length L_z | L_z

deflection_check_reference_length_z_definition_type

DeflectionCheckReferenceLengthZDefinitionType

Deflection analysis for reference length L_z

deflection_check_reference_plane_point_1

Vector3d

Point 1 of reference plane

deflection_check_reference_plane_point_1_x

float

Coordinate of point 1 of reference plane | X

deflection_check_reference_plane_point_1_y

float

Coordinate of point 1 of reference plane | Y

deflection_check_reference_plane_point_1_z

float

Coordinate of point 1 of reference plane | Z

deflection_check_reference_plane_point_2

Vector3d

Point 2 of reference plane

deflection_check_reference_plane_point_2_x

float

Coordinate of point 2 of reference plane | X

deflection_check_reference_plane_point_2_y

float

Coordinate of point 2 of reference plane | Y

deflection_check_reference_plane_point_2_z

float

Coordinate of point 2 of reference plane | Z

deflection_check_reference_plane_point_3

Vector3d

Point 3 of reference plane

deflection_check_reference_plane_point_3_x

float

Coordinate of point 3 of reference plane | X

deflection_check_reference_plane_point_3_y

float

Coordinate of point 3 of reference plane | Y

deflection_check_reference_plane_point_3_z

float

Coordinate of point 3 of reference plane | Z

surface_reinforcement_table

SurfaceReinforcementTable

List of Surface Reinforcements

surface_concrete_design_uls_configuration

int

Ultimate configuration for concrete surface design

surface_concrete_design_sls_configuration

int

Serviceability configuration for concrete surface design

surface_concrete_design_fr_configuration

int

Fire resistance configuration for concrete surface design

surface_concrete_design_seismic_configuration

int

Seismic configuration for concrete surface design

wind_simulation_enable_specific_settings

bool

Enable specific settings of wind simulation

wind_simulation_shrink_wrapping

int

Shrink wrapping

wind_simulation_roughness_and_permeability

int

Roughness and permeability

wind_simulation_exclude_from_wind_tunnel

bool

Exclude from wind tunnel

wind_simulation_consider_surface_thickness_above

bool

Consider surface thickness above

wind_simulation_consider_surface_thickness_above_value

float

Consider surface thickness above (value) | d_s

bracing_type

BracingType

Bracing type

bracing_span_direction

BracingSpanDirection

Bracing | Span direction

bracing_cross_members

List[int]

Bracing of cross members

bracing_longitudinal_members

List[int]

Bracing of longitudinal members

bracing_end_panel_members

List[int]

Bracing of end panel members

bracing_internal_panel_members

List[int]

Bracing of internal panel members

bracing_excluded_members

List[int]

Bracing | Excluded members

bracing_excluded_parallel_to_members

List[int]

Bracing | Excluded | Parallel to members

bracing_parameters_surface_config

BracingParametersSurfaceConfigTreeTable

Bracing parameters for surface configuration

bracing_parameters_support_config

BracingParametersSupportConfigTreeTable

Bracing parameters for support configuration

tolerances_members_in_plane

TolerancesMembersInPlane

Tolerances | Members in plane

tolerances_in_plane_distance

float

Tolerances | Distance

tolerances_in_plane_angles

float

Tolerances | Angles

tolerances_parralel_perpendicular_members

TolerancesParralelPerpendicularMembers

Tolerances | Parallel/perpendicular members

tolerances_parralel_perpendicular_angle

float

Tolerances | Angles

tolerances_parallel_perpendicualr_distance

float

Tolerances | Distance

tolerances_parallel_perpendicular_angle_axes

float

Tolerances | Angle of axes

different_spring_stiffness_list

DifferentSpringStiffnessListTable

Different spring stiffness list

stress_analysis_configuration

int

Stress-strain analysis configuration

surface_releases_assignment

SurfaceReleasesAssignmentTable

Assignment of Surface Releases

bim_ifc_properties

BimIfcPropertiesTreeTable

IFC properties

id_for_export_import

str

metadata_for_export_import

str

Associated Data Types

SurfaceNurbsControlPointsRowsTable#

Note

No attributes available for this object.

MinCurvSplineReferenceProbeCoordinatesTable#

Attribute Name

Data Type

Description

rows

List[MinCurvSplineReferenceProbeCoordinatesRow]

MinCurvSplineReferenceProbeCoordinatesRow#

Attribute Name

Data Type

Description

no

int

description

str

coordinate_x

float

coordinate_y

float

coordinate_z

float

MinCurvSplineGlobalProbeCoordinatesTable#

Attribute Name

Data Type

Description

rows

List[MinCurvSplineGlobalProbeCoordinatesRow]

MinCurvSplineGlobalProbeCoordinatesRow#

Attribute Name

Data Type

Description

no

int

description

str

coordinate_x

float

coordinate_y

float

coordinate_z

float

LoadDistributionFactorTable#

Attribute Name

Data Type

Description

rows

List[LoadDistributionFactorTableRow]

LoadDistributionFactorTableRow#

Attribute Name

Data Type

Description

no

int

description

str

lines

List[int]

members

List[int]

distribution_factor

float

comment

str

SurfaceReinforcementTable#

Attribute Name

Data Type

Description

rows

List[SurfaceReinforcementTableRow]

SurfaceReinforcementTableRow#

Attribute Name

Data Type

Description

no

int

description

str

surface_reinforcement

int

BracingParametersSurfaceConfigTreeTable#

Attribute Name

Data Type

Description

rows

List[BracingParametersSurfaceConfigTreeTableRow]

BracingParametersSurfaceConfigTreeTableRow#

Attribute Name

Data Type

Description

key

str

caption

str

symbol

str

value

Value

unit

str

rows

List[BracingParametersSurfaceConfigTreeTableRow]

BracingParametersSupportConfigTreeTable#

Attribute Name

Data Type

Description

rows

List[BracingParametersSupportConfigTreeTableRow]

BracingParametersSupportConfigTreeTableRow#

Attribute Name

Data Type

Description

key

str

caption

str

symbol

str

value

Value

unit

str

rows

List[BracingParametersSupportConfigTreeTableRow]

DifferentSpringStiffnessListTable#

Attribute Name

Data Type

Description

rows

List[DifferentSpringStiffnessListRow]

DifferentSpringStiffnessListRow#

Attribute Name

Data Type

Description

no

int

description

str

loading

int

is_different

bool

c100_value

float

a_value

float

SurfaceReleasesAssignmentTable#

Attribute Name

Data Type

Description

rows

List[SurfaceReleasesAssignmentRow]

SurfaceReleasesAssignmentRow#

Attribute Name

Data Type

Description

no

int

description

str

assigned_object_no

int

active

bool

release_no

int

release_location

ReleaseLocation

released_objects

str

generated_objects

str

BimIfcPropertiesTreeTable#

Attribute Name

Data Type

Description

rows

List[BimIfcPropertiesTreeTableRow]

BimIfcPropertiesTreeTableRow#

Attribute Name

Data Type

Description

key

str

name

str

value

str

rows

List[BimIfcPropertiesTreeTableRow]

Associated Enums

Geometry#

Name

GEOMETRY_UNKNOWN

GEOMETRY_MINIMUM_CURVATURE_SPLINE

GEOMETRY_NURBS

GEOMETRY_PIPE

GEOMETRY_PLANE

GEOMETRY_QUADRANGLE

GEOMETRY_ROTATED

GEOMETRY_TRIMMED

QuadranglePreferableShape#

Name

QUADRANGLE_PREFERABLE_SHAPE_ROTATED

QUADRANGLE_PREFERABLE_SHAPE_PIPE

MinCurvSplineReferenceWorkPlaneOrientation#

Name

MIN_CURV_SPLINE_REFERENCE_WORK_PLANE_ORIENTATION_XY

MIN_CURV_SPLINE_REFERENCE_WORK_PLANE_ORIENTATION_XZ

MIN_CURV_SPLINE_REFERENCE_WORK_PLANE_ORIENTATION_YZ

MinCurvSplineDefinitionType#

Name

MIN_CURV_SPLINE_DEFINITION_TYPE_REFERENCE_PLANE_BOUNDARY_LINES

Type#

Name

TYPE_STANDARD

TYPE_FLOOR

TYPE_FLOOR_DIAPHRAGM

TYPE_FLOOR_FLEXIBLE_DIAPHRAGM

TYPE_FLOOR_SEMIRIGID

TYPE_GROUNDWATER

TYPE_LOAD_TRANSFER

TYPE_MEMBRANE

TYPE_RIGID

TYPE_WITHOUT_MEMBRANE_TENSION

TYPE_WITHOUT_THICKNESS

LoadTransferDirection#

Name

LOAD_TRANSFER_DIRECTION_IN_X

LOAD_TRANSFER_DIRECTION_IN_BOTH

LOAD_TRANSFER_DIRECTION_IN_Y

LOAD_TRANSFER_DIRECTION_ISOTROPIC

LoadDistribution#

Name

LOAD_DISTRIBUTION_UNIFORM

LOAD_DISTRIBUTION_VARYING_LINEAR

MeshingType#

Name

MESHING_TYPE_USE_GLOBAL_SETTINGS

MESHING_TYPE_FREE

MESHING_TYPE_MAPPED

InputAxesRotationSpecificationType#

Name

INPUT_AXES_ROTATION_SPECIFICATION_TYPE_ANGULAR_ROTATION

INPUT_AXES_ROTATION_SPECIFICATION_TYPE_DIRECT_TO_POINT

INPUT_AXES_ROTATION_SPECIFICATION_TYPE_PARALLEL_TO_COORDINATE_SYSTEM

INPUT_AXES_ROTATION_SPECIFICATION_TYPE_PARALLEL_TO_LINES

InputAxesAxis#

Name

INPUT_AXES_AXIS_X

INPUT_AXES_AXIS_Y

ResultAxesRotationSpecificationType#

Name

RESULT_AXES_ROTATION_SPECIFICATION_TYPE_IDENTICAL_TO_INPUT_AXES

GridType#

Name

GRID_TYPE_CARTESIAN

GRID_TYPE_POLAR

DeflectionCheckSurfaceType#

Name

DEFLECTION_CHECK_SURFACE_TYPE_DOUBLE_SUPPORTED

DEFLECTION_CHECK_SURFACE_TYPE_CANTILEVER

DeflectionCheckDoubleSupportedSurfaceType#

Name

DEFLECTION_CHECK_DOUBLE_SUPPORTED_SURFACE_TYPE_GENERAL

DEFLECTION_CHECK_DOUBLE_SUPPORTED_SURFACE_TYPE_WALK_ON_DESIGN

DeflectionCheckDisplacementReference#

Name

DEFLECTION_CHECK_DISPLACEMENT_REFERENCE_DEFORMED_USER_DEFINED_REFERENCE_PLANE

DEFLECTION_CHECK_DISPLACEMENT_REFERENCE_PARALLEL_SURFACE

DEFLECTION_CHECK_DISPLACEMENT_REFERENCE_UNDEFORMED_SYSTEM

DeflectionCheckReferenceLengthZDefinitionType#

Name

DEFLECTION_CHECK_REFERENCE_LENGTH_Z_DEFINITION_TYPE_MANUALLY

DEFLECTION_CHECK_REFERENCE_LENGTH_Z_DEFINITION_TYPE_BY_MAXIMUM_BOUNDARY_LINE

DEFLECTION_CHECK_REFERENCE_LENGTH_Z_DEFINITION_TYPE_BY_MINIMUM_BOUNDARY_LINE

BracingType#

Name

BRACING_TYPE_SURFACE

BracingSpanDirection#

Name

BRACING_SPAN_DIRECTION_X

BRACING_SPAN_DIRECTION_Y

TolerancesMembersInPlane#

Name

TOLERANCES_MEMBERS_IN_PLANE_ABSOLUTE_BY_DISTANCE

TOLERANCES_MEMBERS_IN_PLANE_RELATIVE_BY_ANGLE

TolerancesParralelPerpendicularMembers#

Name

TOLERANCES_PARRALEL_PERPENDICULAR_MEMBERS_ABSOLUTE_BY_DISTANCE

TOLERANCES_PARRALEL_PERPENDICULAR_MEMBERS_RELATIVE_BY_ANGLE

ReleaseLocation#

Name

RELEASE_LOCATION_ORIGIN

RELEASE_LOCATION_RELEASED