Building Element

Class full path: BuildingElement.BuildingElement

Definition of class BuildingElement

Attributes

data_column_width: int property writable

Get data column width

Returns:

Type	Description
int	data column width

element_id: str property writable

Get the element id

Returns:

Type	Description
str	element id

geometry_expand: bool property writable

Get geometry expand state

Returns:

Type	Description
bool	true/false state of geometry expand.

is_interactor: bool property writable

Get the interactor state

Returns:

Type	Description
bool	true/false interactor state

node_index: int property writable

Get the node_index for VS

Returns:

Type	Description
int	node_index

pyp_file_name: str property writable

Get corresponding pyp file name

Returns:

Type	Description
str	name of the pyp file.

pyp_file_path: str property writable

Get corresponding pyp file path

Returns:

Type	Description
str	name of the pyp file path.

read_last_input: bool property writable

Get read last input state

Returns:

Type	Description
bool	true/false state of read last input

script_name: str property writable

Get corresponding script name

Returns:

Type	Description
str	name of the script.

script_uuid: str property writable

Get the UUID of the pyp file

Returns:

Type	Description
str	UUID of the pyp file

skip_eval: bool property writable

Get corresponding skip_eval

Returns:

Type	Description
bool	status fo skip_eval

title: str property writable

Get the property palette title

Returns:

Type	Description
str	property palette title

version: str property writable

Get the version number as string

Returns:

Type	Description
str	Version number

vs_multi_placement: bool property writable

Get the VS multi placement state

Returns:

Type	Description
bool	true/false VS multi placement

vs_placement_point_input: bool property writable

Get the VS placement point input state

Returns:

Type	Description
bool	true/false VS is placed by point input

Classes

PageData dataclass

implementation of the page data class

Functions

__init__()

Initialization of class BuildingElement

__repr__()

get the string from the object member

Returns:

Type	Description
str	data string

add_constant(name, value)

Add a new constant to class

Parameters:

Name	Type	Description	Default
name	str	the name of the constant	required
value	Any	the value of the constant	required

add_material_string_table(global_material_str_table)

Sets the global material string table

Parameters:

Name	Type	Description	Default
global_material_str_table	BuildingElementMaterialStringTable	global material string table	required

add_page(name, text, visible_condition, enable_condition)

Add pages for property dialog

Parameters:

Name	Type	Description	Default
name	str	the name of the page.	required
text	str	text of the page	required
visible_condition	str	visible condition of the page	required
enable_condition	str	enable condition of the page	required

add_property(name, value)

Add a new property to class

Parameters:

Name	Type	Description	Default
name	str	the name of the property.	required
value	ParameterProperty	the value of the property.	required

add_string_tables(local_str_table, global_str_table)

Sets the local and global string table

Parameters:

Name	Type	Description	Default
local_str_table	BuildingElementStringTable	local string table	required
global_str_table	BuildingElementStringTable	global string table	required

change_property(handle_prop, input_pnt)

Change property value

Parameters:

Name	Type	Description	Default
handle_prop	HandleProperties	handle property	required
input_pnt	Point3D	input point	required

Returns:

Type	Description
bool	update palette state

deep_copy()

deep copy of the object member

Returns:

Type	Description
BuildingElement	copied building element

get_constant(name)

get the constant by name

Parameters:

Name	Type	Description	Default
name	str	name of the constant	required

Returns:

Type	Description
Optional[Any]	constant value, None if not exist

get_constant_dict()

Get constants dictionary

Returns:

Type	Description
Dict[str, Any]	dictionary of constants

get_existing_property(name)

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	Type	Description	Default
name	str	the name of the property.	required

Returns:

Type	Description
ParameterProperty	property

Raises:

Type	Description
ValueError	raised in case of missing parameter

get_float_version()

Get the version as float number from the string

Returns:

Type	Description
float	version number as float value

get_hash()

Calculate a hash value for script name and parameter list

Returns:

Type	Description
str	Calculated hash string.

get_insert_matrix()

Get matrix for macro/ macro group update

Returns:

Type	Description
Matrix3D	tuple matrix

get_material_string_table()

Get the global material string table

Returns:

Type	Description
BuildingElementMaterialStringTable	global material string table

get_model_parameter_dict(exclude_identical=False)

Get parameters dictionary for the model parameter

Parameters:

Name	Type	Description	Default
exclude_identical	bool	exclude the parameter which should not be used for the identical check	False

Returns:

Type	Description
Dict[str, ParameterProperty]	dictionary of parameters.

get_modified_properties()

Get an iterator for the modified properties

Yield

property iterator of the modified properties

get_pages()

Get pages for property dialog

Returns:

Type	Description
List[PageData]	list of the pages.

get_parameter_dict()

Get parameters dictionary

Returns:

Type	Description
Dict[str, Any]	dictionary of parameters.

get_params_list()

Get the list with the parameter values

Returns:

Type	Description
List[str]	list with the parameter values

get_properties()

Get an iterator for the properties

Yield

property iterator

get_property(name)

Get property parameter by name

Parameters:

Name	Type	Description	Default
name	str	the name of the property.	required

Returns:

Type	Description
Optional[ParameterProperty]	property parameter, None if not exist

get_reinforcement_definition_list()

Get reinforcement list

Returns:

Type	Description
List[ReinforcementDefinition]	list of reinforcement.

get_string_tables()

Get the local and global string tables

Returns:

Type	Description
Tuple[BuildingElementStringTable, BuildingElementStringTable]	tuple of local and global string table

is_parameter_property(name) staticmethod

Check for a parameter property

Parameters:

Name	Type	Description	Default
name	str	name of the parameter property	required

Returns:

Type	Description
bool	name has parameter property

modify_value_type(value_type, value)

Modify the value of a value type

Parameters:

Name	Type	Description	Default
value_type	str	Value type	required
value	Any	Value	required

reset_page(name, text, visible_condition, enable_condition)

Reset pages for property dialog

Parameters:

Name	Type	Description	Default
name	str	the name of the page.	required
text	str	text of the page	required
visible_condition	str	visible condition	required
enable_condition	str	enable condition	required

reset_property_modified()

Reset the modified state of the properties

set_insert_matrix(matrix)

Sets matrix for insertion

Parameters:

Name	Type	Description	Default
matrix	Matrix3D	insertion matrix	required

set_property(name, value)

Set property value by name

Parameters:

Name	Type	Description	Default
name	str	the name of the property.	required
value	Any	new value of the property.	required

set_reinforcement_definition_list(reinf_list)

Set reinforcement list

Parameters:

Name	Type	Description	Default
reinf_list	List[ReinforcementDefinition]	list of reinforcement.	required