Attribute Controller

Non-geometric properties and classification of elements.

Covers everything that describes an element without changing its shape: identification and labelling (name, group, comment, production data), user-defined attributes and their lists, element-type classification (beam, panel, auxiliary, wall, roof, floor, drilling, export-solid, ...), and the configuration of how these attributes are displayed in the different views of the application.

add_item_to_comment_list(item: str) -> None

Add item to comment list.

Parameters:

Name	Type	Description	Default
item	str	The item to add in the comment list.	required

add_item_to_group_list(item: str) -> None

Add item to group list.

Parameters:

Name	Type	Description	Default
item	str	The item to add in the group list.	required

add_item_to_name_list(item: str) -> None

Add item to name list.

Parameters:

Name	Type	Description	Default
item	str	The item to add in the name list.	required

add_item_to_sku_list(item: str) -> None

Add item to sku list.

Parameters:

Name	Type	Description	Default
item	str	The item to add in the sku list.	required

add_item_to_subgroup_list(item: str) -> None

Add item to subgroup list.

Parameters:

Name	Type	Description	Default
item	str	The item to add in the subgroup list.	required

add_item_to_user_attribute_list(attribute_number: UserAttributeId, item: str) -> None

Add item to user attribute list.

Parameters:

Name	Type	Description	Default
attribute_number	UserAttributeId	The attribute number.	required
item	str	The item to add in the user attribute list.	required

clear_errors() -> None

clear all errors.

delete_additional_data(element_id_list: list[ElementId], data_id: str) -> None

Deletes the element additional data.

Parameters:

Name	Type	Description	Default
element_id_list	list[ElementId]	The element id list.	required
data_id	str	The data id.	required

delete_item_from_comment_list(item: str) -> bool

Delete item from comment list.

Parameters:

Name	Type	Description	Default
item	str	The item to delete from the comment list.	required

Returns:

Type	Description
bool	True if the item was successfully deleted, false otherwise.

delete_item_from_group_list(item: str) -> bool

Delete item from group list.

Parameters:

Name	Type	Description	Default
item	str	The item to delete from the group list.	required

Returns:

Type	Description
bool	True if the item was successfully deleted, false otherwise.

delete_item_from_sku_list(item: str) -> bool

Delete item from sku list.

Parameters:

Name	Type	Description	Default
item	str	The item to delete from the sku list.	required

Returns:

Type	Description
bool	True if the item was successfully deleted, false otherwise.

delete_item_from_subgroup_list(item: str) -> bool

Delete item from subgroup list.

Parameters:

Name	Type	Description	Default
item	str	The item to delete from the subgroup list.	required

Returns:

Type	Description
bool	True if the item was successfully deleted, false otherwise.

delete_item_from_user_attribute_list(attribute_number: UserAttributeId, item: str) -> bool

Delete item from user attribute list.

Parameters:

Name	Type	Description	Default
attribute_number	UserAttributeId	The attribute number.	required
item	str	The item to delete from the user attribute list.	required

Returns:

Type	Description
bool	True if the item was successfully deleted, false otherwise.

delete_user_attribute(number: UserAttributeId) -> bool

Delete user attribute from attribute list. The attribute is only deleted when the attribute is not used.

Parameters:

Name	Type	Description	Default
number	UserAttributeId	The attribute number.	required

Returns:

Type	Description
bool	True if the attribute was successfully deleted, false otherwise.

disable_attribute_display() -> None

Disable attribute display.

enable_attribute_display() -> None

Enable attribute display.

get_additional_data(element_id: ElementId, data_id: str) -> str

Gets the element additional data.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required
data_id	str	The data id.	required

Returns:

Type	Description
str	The element additional data.

get_additional_guid(element_id: ElementId, data_id: str) -> str

Get additional guid.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required
data_id	str	The data id.	required

Returns:

Type	Description
str	The additional guid associated with the element and data id.

get_assembly_number(element_id: ElementId) -> str

Get assembly number.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
str	The assembly number.

get_associated_nesting_name(element_id: ElementId) -> str

Get associated nesting name

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
str	The associated nesting name.

get_associated_nesting_number(element_id: ElementId) -> str

Get associated nesting number.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
str	The associated nesting number.

get_attribute_display_settings_for_2d() -> attribute_display_settings

Get attribute display settings for 2d.

Returns:

Type	Description
attribute_display_settings	The attribute display settings for 2d.

get_attribute_display_settings_for_2d_with_layout() -> attribute_display_settings

Get attribute display settings for 2d with layout.

Returns:

Type	Description
attribute_display_settings	The attribute display settings for 2d with layout.

get_attribute_display_settings_for_2d_without_layout() -> attribute_display_settings

Get attribute display settings for 2d without layout.

Returns:

Type	Description
attribute_display_settings	The attribute display settings for 2d without layout.

get_attribute_display_settings_for_3d() -> attribute_display_settings

Get attribute display settings for 3d.

Returns:

Type	Description
attribute_display_settings	The attribute display settings for 3d.

get_attribute_display_settings_for_container() -> attribute_display_settings

Get attribute display settings for container.

Returns:

Type	Description
attribute_display_settings	The attribute display settings for container.

get_attribute_display_settings_for_export_solid() -> attribute_display_settings

Get attribute display settings for export solid.

Returns:

Type	Description
attribute_display_settings	The attribute display settings for export solid.

get_attribute_display_settings_for_framed_wall_axis() -> attribute_display_settings

Get attribute display settings for framed wall axis.

Returns:

Type	Description
attribute_display_settings	The attribute display settings for framed wall axis.

get_attribute_display_settings_for_framed_wall_beam() -> attribute_display_settings

Get attribute display settings for framed wall beam.

Returns:

Type	Description
attribute_display_settings	The attribute display settings for framed wall beam.

get_attribute_display_settings_for_framed_wall_opening() -> attribute_display_settings

Get attribute display settings for framed wall opening.

Returns:

Type	Description
attribute_display_settings	The attribute display settings for framed wall opening.

get_attribute_display_settings_for_framed_wall_panel() -> attribute_display_settings

Get attribute display settings for framed wall panel.

Returns:

Type	Description
attribute_display_settings	The attribute display settings for framed wall panel.

get_attribute_display_settings_for_log_wall_axis() -> attribute_display_settings

Get attribute display settings for log wall axis.

Returns:

Type	Description
attribute_display_settings	The attribute display settings for log wall axis.

get_attribute_display_settings_for_log_wall_beam() -> attribute_display_settings

Get attribute display settings for log wall beam.

Returns:

Type	Description
attribute_display_settings	The attribute display settings for log wall beam.

get_attribute_display_settings_for_log_wall_opening() -> attribute_display_settings

Get attribute display settings for log wall opening.

Returns:

Type	Description
attribute_display_settings	The attribute display settings for log wall opening.

get_attribute_display_settings_for_log_wall_panel() -> attribute_display_settings

Get attribute display settings for log wall panel.

Returns:

Type	Description
attribute_display_settings	The attribute display settings for log wall panel.

get_attribute_display_settings_for_machine() -> attribute_display_settings

Get attribute display settings for machine.

Returns:

Type	Description
attribute_display_settings	The attribute display settings for machine.

get_attribute_display_settings_for_nesting_element() -> attribute_display_settings

Get attribute display settings for nesting element.

Returns:

Type	Description
attribute_display_settings	The attribute display settings for nesting element.

get_attribute_display_settings_for_nesting_volume() -> attribute_display_settings

Get attribute display settings for nesting volume.

Returns:

Type	Description
attribute_display_settings	The attribute display settings for nesting volume.

get_attribute_display_settings_for_solid_wall_axis() -> attribute_display_settings

Get attribute display settings for solid wall axis.

Returns:

Type	Description
attribute_display_settings	The attribute display settings for solid wall axis.

get_attribute_display_settings_for_solid_wall_beam() -> attribute_display_settings

Get attribute display settings for solid wall beam.

Returns:

Type	Description
attribute_display_settings	The attribute display settings for solid wall beam.

get_attribute_display_settings_for_solid_wall_opening() -> attribute_display_settings

Get attribute display settings for solid wall opening.

Returns:

Type	Description
attribute_display_settings	The attribute display settings for solid wall opening.

get_attribute_display_settings_for_solid_wall_panel() -> attribute_display_settings

Get attribute display settings for solid wall panel.

Returns:

Type	Description
attribute_display_settings	The attribute display settings for solid wall panel.

get_auto_attribute(element_id: ElementId, number: UnsignedInt) -> str

Get auto attribute.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required
number	UnsignedInt	The auto attribute number.	required

Returns:

Type	Description
str	The auto attribute value.

get_auto_attribute_name(number: UnsignedInt) -> str

Get auto attribute name.

Parameters:

Name	Type	Description	Default
number	UnsignedInt	The auto attribute number.	required

Returns:

Type	Description
str	The auto attribute name.

get_comment(element_id: ElementId) -> str

Gets the element comment.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
str	The element comment.

get_comment_list_items() -> list[str]

Get comment list items.

Returns:

Type	Description
list[str]	The list of comment list items.

get_container_number(element_id: ElementId) -> UnsignedInt

Get container number.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
UnsignedInt	The container number associated with the element.

get_container_number_with_prefix(element_id: ElementId) -> str

Get container number with prefix.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
str	The container number with prefix associated with the element.

get_cutting_set(element_id: ElementId) -> str

Gets the element cutting set.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
str	The element cutting set.

get_element_grouping_type() -> element_grouping_type

Get the element grouping type (group, subgroup).

Returns:

Type	Description
element_grouping_type	The element grouping type.

get_element_material_name(element_id: ElementId) -> str

Gets the element material name.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
str	The element material name.

get_element_type(element_id: ElementId) -> element_type

Gets the element type.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
element_type	The element type.

get_extended_settings(element_id: ElementId) -> extended_settings

Gets the element extended settings.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
extended_settings	The element extended settings.

get_fastening_attribute(element_id: ElementId) -> str

Get the element fastening attribute.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
str	The element fastening attribute.

get_group(element_id: ElementId) -> str

Gets the element group.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
str	The element group.

get_group_list_items() -> list[str]

Get group list items.

Returns:

Type	Description
list[str]	The list of group list items.

get_ignore_in_vba_calculation(element_id: ElementId) -> bool

Get ignore in vba calculation.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
bool	True if the element is ignored in VBA calculation, false otherwise.

get_list_quantity(element_id: ElementId) -> UnsignedInt

Get list quantity.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
UnsignedInt	The list quantity.

get_machine_calculation_set(element_id: ElementId) -> str

Gets the element machine calculation set.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
str	The element machine calculation set.

get_machine_calculation_set_machine_type(element_id: ElementId) -> str

Get machine calculation set machine type.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
str	The machine calculation set machine type of the element.

get_machine_calculation_state(element_id: ElementId) -> str

Get machine calculation state.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
str	The machine calculation state of the element.

get_name(element_id: ElementId) -> str

Gets the element name.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
str	The element name.

get_name_extended_settings(name: str) -> extended_settings

Gets the extended settings for an element name.

Parameters:

Name	Type	Description	Default
name	str	The element name.	required

Returns:

Type	Description
extended_settings	The extended settings.

get_name_list_items() -> list[str]

Retrieve a list of name for all items

Returns:

Type	Description
list[str]	A list of names for all items.

get_name_list_items_by_element_type(element_type: element_type) -> list[str]

Get name list items by element type.

Parameters:

Name	Type	Description	Default
element_type	element_type	The element type to filter by.	required

Returns:

Type	Description
list[str]	The list of names for the specified element type.

get_name_process_type(name: str) -> process_type

Gets the process type for an element name.

Parameters:

Name	Type	Description	Default
name	str	The element name.	required

Returns:

Type	Description
process_type	The process type.

get_node_symbol(element_id: ElementId) -> node_symbol

Get node symbol.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
node_symbol	The node symbol of the element.

get_output_type(element_id: ElementId) -> process_type

Gets the element output type.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
process_type	The element output type.

get_part_number(element_id: ElementId) -> UnsignedInt

Gets the element part number.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
UnsignedInt	The element part number.

get_prefab_layer(element_id: ElementId) -> str

Gets the element prefab layer.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
str	The element prefab layer.

get_prefab_layer_all_assigned(element_id: ElementId) -> list[int]

Get all assigned prefab layers.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
list[int]	The list of all assigned prefab layers for the element.

get_prefab_layer_with_dimensions(element_id: ElementId) -> list[int]

Get prefab layer with dimensions.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
list[int]	The list of prefab layers with dimensions for the element.

get_prefab_layer_without_dimensions(element_id: ElementId) -> list[int]

Get prefab layer without dimensions.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
list[int]	The list of prefab layers without dimensions for the element.

get_production_number(element_id: ElementId) -> UnsignedInt

Gets the element production number.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
UnsignedInt	The element production number.

get_sku(element_id: ElementId) -> str

Gets the element SKU.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
str	The element SKU.

get_sku_list_items() -> list[str]

Get sku list items.

Returns:

Type	Description
list[str]	The list of sku list items.

get_standard_element_material_id(element_id: ElementId) -> int

Get standard element material id.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
int	The standard element material id.

get_standard_element_name(element_id: ElementId) -> str

Get standard element name.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
str	The standard element name.

get_steel_shape_name(element_id: ElementId) -> str

Get steel shape name.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
str	The steel shape name.

get_subgroup(element_id: ElementId) -> str

Gets the element subgroup.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
str	The element subgroup.

get_subgroup_list_items() -> list[str]

Get subgroup list items.

Returns:

Type	Description
list[str]	The list of subgroup list items.

get_user_attribute(element_id: ElementId, number: UserAttributeId) -> str

Gets the element user attribute.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required
number	UserAttributeId	The user attribute number.	required

Returns:

Type	Description
str	The element user attribute.

get_user_attribute_count() -> UnsignedInt

Get user attribute count.

Returns:

Type	Description
UnsignedInt	The count of user attributes.

get_user_attribute_list_items(element_id: ElementId) -> list[str]

Get user attribute list items.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
list[str]	The list of user attribute list items.

get_user_attribute_name(number: UserAttributeId) -> str

Gets the user attribute name.

Parameters:

Name	Type	Description	Default
number	UserAttributeId	The user attribute number.	required

Returns:

Type	Description
str	The user attribute name.

get_wall_situation(element_id: ElementId) -> str

Gets the element wall situation.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
str	The element wall situation.

is_architecture_wall_2dc(element_id: ElementId) -> bool

Tests if the element is a 2dc reference wall.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
bool	True if the element is a 2dc reference wall, false otherwise.

is_architecture_wall_xml(element_id: ElementId) -> bool

Tests if the element is a xml reference wall.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
bool	True if the element is a xml reference wall, false otherwise.

is_attribute_display_enabled() -> bool

Is attribute display enabled.

Returns:

Type	Description
bool	True if attribute display is enabled, false otherwise.

is_attribute_visible_in_modify_window(number: UnsignedInt) -> bool

Test if attribute is visible in modify window.

Parameters:

Name	Type	Description	Default
number	UnsignedInt	The attribute number.	required

Returns:

Type	Description
bool	True if the attribute is visible in the modify window, false otherwise.

is_auxiliary(element_id: ElementId) -> bool

Tests if element is auxiliary.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
bool	True if the element is auxiliary, false otherwise.

is_beam(element_id: ElementId) -> bool

Tests if element is beam.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
bool	True if the element is a beam, false otherwise.

is_btl_processing_group(element_id: ElementId) -> bool

Test if element is btl processing group.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
bool	True if the element is a btl processing group, false otherwise.

is_caddy_object(element_id: ElementId) -> bool

Tests if the element is caddy object.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
bool	True if the element is a caddy object, false otherwise.

is_circular_mep(element_id: ElementId) -> bool

Test if element is circular mep.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
bool	True if the element is a circular mep, false otherwise.

is_connector_axis(element_id: ElementId) -> bool

Tests if element is connector axis.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
bool	True if the element is a connector axis, false otherwise.

is_container(element_id: ElementId) -> bool

Tests if element is container.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
bool	True if the element is a container, false otherwise.

is_drilling(element_id: ElementId) -> bool

Tests if element is drilling.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
bool	True if the element is drilling, false otherwise.

is_envelope(element_id: ElementId) -> bool

Tests if the element is an envelope.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
bool	True if the element is an envelope, false otherwise.

is_export_solid(element_id: ElementId) -> bool

Tests if element is export solid.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
bool	True if the element is an export solid, false otherwise.

is_floor(element_id: ElementId) -> bool

Tests if element is floor.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
bool	True if the element is a floor, false otherwise.

is_framed_floor(element_id: ElementId) -> bool

Tests if the element is a framed floor.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
bool	True if the element is a framed floor, false otherwise.

is_framed_roof(element_id: ElementId) -> bool

Tests if the element is a framed roof.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
bool	True if the element is a framed roof, false otherwise.

is_framed_wall(element_id: ElementId) -> bool

Tests if the element is a framed wall.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
bool	True if the element is a framed wall, false otherwise.

is_hundegger_processing_group(element_id: ElementId) -> bool

Test if element is hundegger processing group.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
bool	True if the element is a hundegger processing group, false otherwise.

is_line(element_id: ElementId) -> bool

Tests if the element is a Line.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
bool	True if the element is a Line, false otherwise.

is_log_wall(element_id: ElementId) -> bool

Tests if the element is a log wall.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
bool	True if the element is a log wall, false otherwise.

is_metal(element_id: ElementId) -> bool

Tests if element is metal.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
bool	True if the element is metal, false otherwise.

is_nesting_parent(element_id: ElementId) -> bool

Tests if the element is a nesting parent.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
bool	True if the element is a nesting parent, false otherwise.

is_nesting_raw_part(element_id: ElementId) -> bool

Tests if the element is a nesting raw part.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
bool	True if the element is a nesting raw part, false otherwise.

is_node(element_id: ElementId) -> bool

Tests if element is node.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
bool	True if the element is a node, false otherwise.

is_opening(element_id: ElementId) -> bool

Tests if element is opening.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
bool	True if the element is an opening, false otherwise.

is_panel(element_id: ElementId) -> bool

Tests if element is panel.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
bool	True if the element is a panel, false otherwise.

is_processing(element_id: ElementId) -> bool

Tests if element is processing.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
bool	True if the element is processing, false otherwise.

is_rectangular_mep(element_id: ElementId) -> bool

Test if element is rectangular mep.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
bool	True if the element is a rectangular mep, false otherwise.

is_roof(element_id: ElementId) -> bool

Tests if element is roof.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
bool	True if the element is a roof, false otherwise.

is_roof_surface(element_id: ElementId) -> bool

Tests if the element is roof surface.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
bool	True if the element is a roof surface, false otherwise.

is_solid_floor(element_id: ElementId) -> bool

Tests if the element is a solid floor.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
bool	True if the element is a solid floor, false otherwise.

is_solid_roof(element_id: ElementId) -> bool

Tests if the element is a solid roof.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
bool	True if the element is a solid roof, false otherwise.

is_solid_wall(element_id: ElementId) -> bool

Tests if the element is a solid wall.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
bool	True if the element is a solid wall, false otherwise.

is_surface(element_id: ElementId) -> bool

Tests if the element is a Surface.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
bool	True if the element is a Surface, false otherwise.

is_wall(element_id: ElementId) -> bool

Tests if element is wall.

Parameters:

Name	Type	Description	Default
element_id	ElementId	The element id.	required

Returns:

Type	Description
bool	True if the element is a wall, false otherwise.

set_additional_data(element_id_list: list[ElementId], data_id: str, data_text: str) -> None

Sets the element additional data.

Parameters:

Name	Type	Description	Default
element_id_list	list[ElementId]	The element id list.	required
data_id	str	The data id.	required
data_text	str	The element additional data.	required

set_additional_guid(element_id_list: list[ElementId], data_id: str, guid: str) -> None

Set additional guid.

Parameters:

Name	Type	Description	Default
element_id_list	list[ElementId]	The element id list.	required
data_id	str	The data id.	required
guid	str	The guid to set.	required

set_assembly_number(element_id_list: list[ElementId], assembly_number: str) -> None

set assembly number.

Parameters:

Name	Type	Description	Default
element_id_list	list[ElementId]	The element id list.	required
assembly_number	str	The assembly number.	required

set_attribute_display_settings_for_2d(settings: attribute_display_settings) -> None

Set attribute display settings for 2d.

Parameters:

Name	Type	Description	Default
settings	attribute_display_settings	The display settings to apply.	required

set_attribute_display_settings_for_2d_with_layout(settings: attribute_display_settings) -> None

Set attribute display settings for 2d with layout.

Parameters:

Name	Type	Description	Default
settings	attribute_display_settings	The display settings to apply.	required

set_attribute_display_settings_for_2d_without_layout(settings: attribute_display_settings) -> None

Set attribute display settings for 2d without layout.

Parameters:

Name	Type	Description	Default
settings	attribute_display_settings	The display settings to apply.	required

set_attribute_display_settings_for_3d(settings: attribute_display_settings) -> None

Set attribute display settings for 3d.

Parameters:

Name	Type	Description	Default
settings	attribute_display_settings	The display settings to apply.	required

set_attribute_display_settings_for_container(settings: attribute_display_settings) -> None

Set attribute display settings for container.

Parameters:

Name	Type	Description	Default
settings	attribute_display_settings	The display settings to apply.	required

set_attribute_display_settings_for_export_solid(settings: attribute_display_settings) -> None

Set attribute display settings for export solid.

Parameters:

Name	Type	Description	Default
settings	attribute_display_settings	The display settings to apply.	required

set_attribute_display_settings_for_framed_wall_axis(settings: attribute_display_settings) -> None

Set attribute display settings for framed wall axis.

Parameters:

Name	Type	Description	Default
settings	attribute_display_settings	The display settings to apply.	required

set_attribute_display_settings_for_framed_wall_beam(settings: attribute_display_settings) -> None

Set attribute display settings for framed wall beam.

Parameters:

Name	Type	Description	Default
settings	attribute_display_settings	The display settings to apply.	required

set_attribute_display_settings_for_framed_wall_opening(settings: attribute_display_settings) -> None

Set attribute display settings for framed wall opening.

Parameters:

Name	Type	Description	Default
settings	attribute_display_settings	The display settings to apply.	required

set_attribute_display_settings_for_framed_wall_panel(settings: attribute_display_settings) -> None

Set attribute display settings for framed wall panel.

Parameters:

Name	Type	Description	Default
settings	attribute_display_settings	The display settings to apply.	required

set_attribute_display_settings_for_log_wall_axis(settings: attribute_display_settings) -> None

Set attribute display settings for log wall axis.

Parameters:

Name	Type	Description	Default
settings	attribute_display_settings	The display settings to apply.	required

set_attribute_display_settings_for_log_wall_beam(settings: attribute_display_settings) -> None

Set attribute display settings for log wall beam.

Parameters:

Name	Type	Description	Default
settings	attribute_display_settings	The display settings to apply.	required

set_attribute_display_settings_for_log_wall_opening(settings: attribute_display_settings) -> None

Set attribute display settings for log wall opening.

Parameters:

Name	Type	Description	Default
settings	attribute_display_settings	The display settings to apply.	required

set_attribute_display_settings_for_log_wall_panel(settings: attribute_display_settings) -> None

Set attribute display settings for log wall panel.

Parameters:

Name	Type	Description	Default
settings	attribute_display_settings	The display settings to apply.	required

set_attribute_display_settings_for_machine(settings: attribute_display_settings) -> None

Set attribute display settings for machine.

Parameters:

Name	Type	Description	Default
settings	attribute_display_settings	The display settings to apply.	required

set_attribute_display_settings_for_nesting_element(settings: attribute_display_settings) -> None

Set attribute display settings for nesting element.

Parameters:

Name	Type	Description	Default
settings	attribute_display_settings	The display settings to apply.	required

set_attribute_display_settings_for_nesting_volume(settings: attribute_display_settings) -> None

Set attribute display settings for nesting volume.

Parameters:

Name	Type	Description	Default
settings	attribute_display_settings	The display settings to apply.	required

set_attribute_display_settings_for_solid_wall_axis(settings: attribute_display_settings) -> None

Set attribute display settings for solid wall axis.

Parameters:

Name	Type	Description	Default
settings	attribute_display_settings	The display settings to apply.	required

set_attribute_display_settings_for_solid_wall_beam(settings: attribute_display_settings) -> None

Set attribute display settings for solid wall beam.

Parameters:

Name	Type	Description	Default
settings	attribute_display_settings	The display settings to apply.	required

set_attribute_display_settings_for_solid_wall_opening(settings: attribute_display_settings) -> None

Set attribute display settings for solid wall opening.

Parameters:

Name	Type	Description	Default
settings	attribute_display_settings	The display settings to apply.	required

set_attribute_display_settings_for_solid_wall_panel(settings: attribute_display_settings) -> None

Set attribute display settings for solid wall panel.

Parameters:

Name	Type	Description	Default
settings	attribute_display_settings	The display settings to apply.	required

set_attribute_visibility_in_modify_window(number: UnsignedInt, visibility: bool) -> None

Set attribute visibility in modify window.

Parameters:

Name	Type	Description	Default
number	UnsignedInt	The attribute number.	required
visibility	bool	The visibility state.	required

set_comment(element_id_list: list[ElementId], comment: str) -> None

Sets the element comment.

Parameters:

Name	Type	Description	Default
element_id_list	list[ElementId]	The element id list.	required
comment	str	The element comment.	required

set_container_number(element_id_list: list[ElementId], number: UnsignedInt) -> None

Set container number.

Parameters:

Name	Type	Description	Default
element_id_list	list[ElementId]	The element id list.	required
number	UnsignedInt	The container number.	required

set_cutting_set(element_id_list: list[ElementId], cutting_set_name: str) -> bool

Set cutting set.

Parameters:

Name	Type	Description	Default
element_id_list	list[ElementId]	The list of element ids.	required
cutting_set_name	str	The name of the cutting set.	required

Returns:

Type	Description
bool	True if the cutting set was successfully set, false otherwise.

set_element_grouping_type(element_grouping_type: element_grouping_type) -> None

Set the element grouping type (group, subgroup).

Parameters:

Name	Type	Description	Default
element_grouping_type	element_grouping_type	The element grouping type to set.	required

set_element_material(element_id_list: list[ElementId], material: MaterialId) -> None

Sets the element material.

Parameters:

Name	Type	Description	Default
element_id_list	list[ElementId]	The element id list.	required
material	MaterialId	The element material id.	required

set_extended_settings(element_id_list: list[ElementId], extended_settings: extended_settings) -> None

Sets the element extended settings.

Parameters:

Name	Type	Description	Default
element_id_list	list[ElementId]	The element id list.	required
extended_settings	extended_settings	The extended settings.	required

set_fastening_attribute(element_id_list: list[ElementId], value: str) -> None

Sets the element fastening attribute.

Parameters:

Name	Type	Description	Default
element_id_list	list[ElementId]	The element id list.	required
value	str	The fastening attribute value.	required

set_floor(element_id_list: list[ElementId]) -> None

Set floor.

Deprecated

Use set_framed_floor instead.

Parameters:

Name	Type	Description	Default
element_id_list	list[ElementId]	The element id list.	required

set_framed_floor(element_id_list: list[ElementId]) -> None

Sets the elements to framed floor.

Parameters:

Name	Type	Description	Default
element_id_list	list[ElementId]	The element id list.	required

set_framed_roof(element_id_list: list[ElementId]) -> None

Sets the elements to framed roof.

Parameters:

Name	Type	Description	Default
element_id_list	list[ElementId]	The element id list.	required

set_framed_wall(element_id_list: list[ElementId]) -> None

Sets the element to framed wall.

Parameters:

Name	Type	Description	Default
element_id_list	list[ElementId]	The element id list.	required

set_group(element_id_list: list[ElementId], group: str) -> None

Sets the element group.

Parameters:

Name	Type	Description	Default
element_id_list	list[ElementId]	The element id list.	required
group	str	The element group.	required

set_ignore_in_vba_calculation(element_id_list: list[ElementId], ignore: bool) -> None

Sets if the element should be ignored in VBA Calculation.

Parameters:

Name	Type	Description	Default
element_id_list	list[ElementId]	The element id list.	required
ignore	bool	True if the element should be ignored in VBA calculation, false otherwise.	required

set_layer_settings(element_id_list: list[ElementId], layer_settings: layer_settings) -> None

Set layer settings.

Parameters:

Name	Type	Description	Default
element_id_list	list[ElementId]	The element id list.	required
layer_settings	layer_settings	The layer settings.	required

set_list_quantity(element_id_list: list[ElementId], list_quantity: UnsignedInt) -> None

Set list quantity.

Parameters:

Name	Type	Description	Default
element_id_list	list[ElementId]	The element id list.	required
list_quantity	UnsignedInt	The list quantity.	required

set_log_wall(element_id_list: list[ElementId]) -> None

Sets elements to log wall.

Parameters:

Name	Type	Description	Default
element_id_list	list[ElementId]	The element id list.	required

set_machine_calculation_set(element_ids: list[ElementId], name: str) -> bool

Set machine calculation set for a list of elements.

Note

If multiple sets share the same name, the first matching set is used.

Parameters:

Name	Type	Description	Default
element_ids	list[ElementId]	The list of element ids.	required
name	str	The name of the machine calculation set to apply.	required

Examples:

>>> import attribute_controller as ac
>>> import element_controller as ec
>>> [element] = ec.get_active_identifiable_element_ids()
>>> current_set = ac.get_machine_calculation_set(element)
>>> success = ac.set_machine_calculation_set([element], "xyz_hundegger K2_BVN")

Returns:

Type	Description
bool	True if the machine calculation set was successfully applied, false otherwise.

set_name(element_id_list: list[ElementId], name: str) -> None

Sets the element name.

Parameters:

Name	Type	Description	Default
element_id_list	list[ElementId]	The element id list.	required
name	str	The element name.	required

set_name_extended_settings(name: str, extended_settings: extended_settings) -> None

Sets the extended settings for an element name.

Parameters:

Name	Type	Description	Default
name	str	The element name.	required
extended_settings	extended_settings	The extended settings.	required

set_name_process_type(name: str, process_type: process_type) -> None

Sets the process type for an element name.

Parameters:

Name	Type	Description	Default
name	str	The element name.	required
process_type	process_type	The process type.	required

set_node_symbol(element_id_list: list[ElementId], symbol: node_symbol) -> None

Set node symbol.

Parameters:

Name	Type	Description	Default
element_id_list	list[ElementId]	The element id list.	required
symbol	node_symbol	The node symbol.	required

set_opening(element_id_list: list[ElementId]) -> None

Sets the element to opening.

Parameters:

Name	Type	Description	Default
element_id_list	list[ElementId]	The element id list.	required

set_output_type(element_id_list: list[ElementId], process_type: process_type) -> None

Sets the element output type.

Parameters:

Name	Type	Description	Default
element_id_list	list[ElementId]	The element id list.	required
process_type	process_type	The process type.	required

set_part_number(element_id_list: list[ElementId], part_number: UnsignedInt) -> None

Sets the element part number.

Parameters:

Name	Type	Description	Default
element_id_list	list[ElementId]	The element id list.	required
part_number	UnsignedInt	The element part number.	required

set_process_type_and_extended_settings_from_name(element_id_list: list[ElementId]) -> None

Sets the element process type and extended settings from the element name.

Parameters:

Name	Type	Description	Default
element_id_list	list[ElementId]	The element id list.	required

set_production_number(element_id_list: list[ElementId], production_number: UnsignedInt) -> None

Sets the element production number.

Parameters:

Name	Type	Description	Default
element_id_list	list[ElementId]	The element id list.	required
production_number	UnsignedInt	The element production number.	required

set_reference_wall_2dc(element_id_list: list[ElementId], _2dc_file_path: str) -> None

Applies a new 2dc reference wall to an element.

Parameters:

Name	Type	Description	Default
element_id_list	list[ElementId]	The element id list.	required
_2dc_file_path	str	The 2dc file path.	required

set_roof(element_id_list: list[ElementId]) -> None

Set roof.

Deprecated

Use set_framed_roof instead.

Parameters:

Name	Type	Description	Default
element_id_list	list[ElementId]	The element id list.	required

set_sku(element_id_list: list[ElementId], sku: str) -> None

Sets the element SKU.

Parameters:

Name	Type	Description	Default
element_id_list	list[ElementId]	The element id list.	required
sku	str	The element SKU.	required

set_solid_floor(element_id_list: list[ElementId]) -> None

Sets elements to solid floor.

Parameters:

Name	Type	Description	Default
element_id_list	list[ElementId]	The element id list.	required

set_solid_roof(element_id_list: list[ElementId]) -> None

Sets elements to solid roof cover.

Parameters:

Name	Type	Description	Default
element_id_list	list[ElementId]	The element id list.	required

set_solid_wall(element_id_list: list[ElementId]) -> None

Sets elements to solid wall.

Parameters:

Name	Type	Description	Default
element_id_list	list[ElementId]	The element id list.	required

set_standard_part(element_id_list: list[ElementId]) -> None

Sets covers (wall,opening or floor) to standard part.

Parameters:

Name	Type	Description	Default
element_id_list	list[ElementId]	The element id list.	required

set_subgroup(element_id_list: list[ElementId], subgroup: str) -> None

Sets the element subgroup.

Parameters:

Name	Type	Description	Default
element_id_list	list[ElementId]	The element id list.	required
subgroup	str	The element subgroup.	required

set_user_attribute(element_id_list: list[ElementId], number: UserAttributeId, user_attribute: str) -> None

Sets the element user attribute.

Parameters:

Name	Type	Description	Default
element_id_list	list[ElementId]	The element id list.	required
number	UserAttributeId	The user attribute id.	required
user_attribute	str	The user attribute.	required

set_user_attribute_name(number: UserAttributeId, user_attribute_name: str) -> None

Sets the user attribute name.

Parameters:

Name	Type	Description	Default
number	UserAttributeId	The user attribute id.	required
user_attribute_name	str	The user attribute name.	required

set_wall(element_id_list: list[ElementId]) -> None

Sets the element to wall.

Deprecated

Use set_framed_wall instead.

Parameters:

Name	Type	Description	Default
element_id_list	list[ElementId]	The element id list.	required

update_auto_attribute() -> None

Update the auto attribute.