BuildingElement

Script for BuildingElement

BuildingElement

Canonical path: BuildingElement.BuildingElement

Definition of class BuildingElement

data_column_width property writable

data_column_width: int

Get data column width

Returns:

• int –

  data column width

element_id property writable

element_id: str

Get the element id

Returns:

• str –

  element id

geometry_expand property writable

geometry_expand: bool

Get geometry expand state

Returns:

• bool –

  true/false state of geometry expand.

is_interactor property writable

is_interactor: bool

Get the interactor state

Returns:

• bool –

  true/false interactor state

node_index property writable

node_index: int

Get the node_index for VS

Returns:

• int –

  node_index

pyp_file_name property writable

pyp_file_name: str

Get corresponding pyp file name

Returns:

• str –

  name of the pyp file.

pyp_file_path property writable

pyp_file_path: str

Get corresponding pyp file path

Returns:

• str –

  name of the pyp file path.

read_last_input property writable

read_last_input: bool

Get read last input state

Returns:

• bool –

  true/false state of read last input

script_name property writable

script_name: str

Get corresponding script name

Returns:

• str –

  name of the script.

script_uuid property writable

script_uuid: str

Get the UUID of the pyp file

Returns:

• str –

  UUID of the pyp file

show_favorite_buttons property writable

show_favorite_buttons: bool

Get the show_favorite_button state

Returns:

• bool –

  show_favorite_buttons state

skip_eval property writable

skip_eval: bool

Get corresponding skip_eval

Returns:

• bool –

  status fo skip_eval

title property writable

title: str

Get the property palette title

Returns:

• str –

  property palette title

version property writable

version: str

Get the version number as string

Returns:

• str –

  Version number

vs_multi_placement property writable

vs_multi_placement: bool

Get the VS multi placement state

Returns:

• bool –

  true/false VS multi placement

vs_placement_point_input property writable

vs_placement_point_input: bool

Get the VS placement point input state

Returns:

• bool –

  true/false VS is placed by point input

PageData dataclass

Canonical path: BuildingElement.BuildingElement.PageData

implementation of the page data class

__init__

__init__()

Initialization of class BuildingElement

__repr__

__repr__() -> str

get the string from the object member

Returns:

• str –

  data string

add_constant

add_constant(name: str, value: Any)

Add a new constant to class

Parameters:

• name (str) –

  the name of the constant

• value (Any) –

  the value of the constant

add_material_string_table

add_material_string_table(
    global_material_str_table: BuildingElementMaterialStringTable,
)

Sets the global material string table

Parameters:

• global_material_str_table (BuildingElementMaterialStringTable) –

  global material string table

add_page

add_page(name: str, text: str, visible_condition: str, enable_condition: str)

Add pages for property dialog

Parameters:

• name (str) –

  the name of the page.

• text (str) –

  text of the page

• visible_condition (str) –

  visible condition of the page

• enable_condition (str) –

  enable condition of the page

add_property

add_property(name: str, value: ParameterProperty)

Add a new property to class

Parameters:

• name (str) –

  the name of the property.

• value (ParameterProperty) –

  the value of the property.

add_string_tables

add_string_tables(
    local_str_table: BuildingElementStringTable,
    global_str_table: BuildingElementStringTable,
)

Sets the local and global string table

Parameters:

• local_str_table (BuildingElementStringTable) –

  local string table

• global_str_table (BuildingElementStringTable) –

  global string table

change_property

change_property(handle_prop: HandleProperties, input_pnt: Point3D) -> bool

Change property value

Parameters:

• handle_prop (HandleProperties) –

  handle property

• input_pnt (Point3D) –

  input point

Returns:

• bool –

  update palette state

deep_copy

deep_copy() -> BuildingElement

deep copy of the object member

Returns:

• BuildingElement –

  copied building element

get_constant

get_constant(name: str) -> Any < None

get the constant by name

Parameters:

• name (str) –

  name of the constant

Returns:

• Any < None –

  constant value, None if not exist

get_constant_dict

get_constant_dict() -> dict[str, Any]

Get constants dictionary

Returns:

• dict[str, Any] –

  dictionary of constants

get_existing_property

get_existing_property(name: str) -> ParameterProperty

Get a mandatory property parameter by name. If the property doesn't exist, a message box is shown and an exception is thrown

Parameters:

• name (str) –

  the name of the property.

Returns:

• ParameterProperty –

  property

Raises:

• ValueError –

  raised in case of missing parameter

get_float_version

get_float_version() -> float

Get the version as float number from the string

Returns:

• float –

  version number as float value

get_hash

get_hash() -> str

Calculate a hash value for script name and parameter list

Returns:

• str –

  Calculated hash string.

get_insert_matrix

get_insert_matrix() -> Matrix3D

Get matrix for macro/ macro group update

Returns:

• Matrix3D –

  tuple matrix

get_material_string_table

get_material_string_table() -> BuildingElementMaterialStringTable

Get the global material string table

Returns:

• BuildingElementMaterialStringTable –

  global material string table

get_model_parameter_dict

get_model_parameter_dict(
    exclude_identical: bool = False,
) -> dict[str, ParameterProperty]

Get parameters dictionary for the model parameter

Parameters:

• exclude_identical (bool, default: False ) –

  exclude the parameter which should not be used for the identical check

Returns:

• dict[str, ParameterProperty] –

  dictionary of parameters.

get_modified_properties

get_modified_properties() -> Iterator[ParameterProperty]

Get an iterator for the modified properties

Yield

property iterator of the modified properties

get_pages

get_pages() -> list[PageData]

Get pages for property dialog

Returns:

• list[PageData] –

  list of the pages.

get_parameter_dict

get_parameter_dict() -> dict[str, Any]

Get parameters dictionary

Returns:

• dict[str, Any] –

  dictionary of parameters.

get_params_list

get_params_list() -> list[str]

Get the list with the parameter values

Returns:

• list[str] –

  list with the parameter values

get_properties

get_properties() -> Iterator[ParameterProperty]

Get an iterator for the properties

Yield

property iterator

get_property

get_property(name: str) -> ParameterProperty | None

Get property parameter by name

Parameters:

• name (str) –

  the name of the property.

Returns:

• ParameterProperty | None –

  property parameter, None if not exist

get_reinforcement_definition_list

get_reinforcement_definition_list() -> list[ReinforcementDefinition]

Get reinforcement list

Returns:

• list[ReinforcementDefinition] –

  list of reinforcement.

get_string_tables

get_string_tables() -> (
    tuple[BuildingElementStringTable, BuildingElementStringTable]
)

Get the local and global string tables

Returns:

• tuple[BuildingElementStringTable, BuildingElementStringTable] –

  tuple of local and global string table

is_parameter_property staticmethod

is_parameter_property(name: str) -> bool

Check for a parameter property

Parameters:

• name (str) –

  name of the parameter property

Returns:

• bool –

  name has parameter property

modify_value_type

modify_value_type(value_type: str, value: Any)

Modify the value of a value type

Parameters:

• value_type (str) –

  Value type

• value (Any) –

  Value

print_values

print_values()

Print the building element values

reset_page

reset_page(name: str, text: str, visible_condition: str, enable_condition: str)

Reset pages for property dialog

Parameters:

• name (str) –

  the name of the page.

• text (str) –

  text of the page

• visible_condition (str) –

  visible condition

• enable_condition (str) –

  enable condition

reset_property_modified

reset_property_modified()

Reset the modified state of the properties

set_insert_matrix

set_insert_matrix(matrix: Matrix3D)

Sets matrix for insertion

Parameters:

• matrix (Matrix3D) –

  insertion matrix

set_property

set_property(name: str, value: Any)

Set property value by name

Parameters:

• name (str) –

  the name of the property.

• value (Any) –

  new value of the property.

set_reinforcement_definition_list

set_reinforcement_definition_list(reinf_list: list[ReinforcementDefinition])

Set reinforcement list

Parameters:

• reinf_list (list[ReinforcementDefinition]) –

  list of reinforcement.

Placeholder