Skip to content

Attribute Controller

delete_additional_data(elements, data_id)

Deletes the element additional data

Parameters:

Name Type Description Default
elements List[int]

element IDs

required
data_id str

data ID

required
Source code in attribute_controller/__init__.py
def delete_additional_data(elements: List[int], data_id: str) -> None:
    """Deletes the element additional data

    Args:
        elements (List[int]): element IDs
        data_id (str): data ID
    """

disable_attribute_display()

disable attribute display

Source code in attribute_controller/__init__.py
def disable_attribute_display() -> None:
    """disable attribute display
    """

enable_attribute_display()

enable attribute display

Source code in attribute_controller/__init__.py
def enable_attribute_display() -> None:
    """enable attribute display
    """

get_additional_data(element, data_id)

Gets the element additional data

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
element int

element ID

required
data_id str

data id

required

Returns:

Type Description
str

additional data

Source code in attribute_controller/__init__.py
def get_additional_data(element: int, data_id: str) -> str:
    """Gets the element additional data

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        element (int): element ID
        data_id (str): data id 

    Returns:
        str: additional data
    """

get_additional_guid(element, data_id)

get additional guid

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
element int

element ID

required
data_id str

data

required

Returns:

Type Description
str

data

Source code in attribute_controller/__init__.py
def get_additional_guid(element: int, data_id: str) -> str:
    """get additional guid

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        element (int): element ID
        data_id (str): data

    Returns:
        str: data
    """

get_assembly_number(element)

Get the elmement assembly number

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
element int

element ID

required

Returns:

Type Description
str

assembly number

Source code in attribute_controller/__init__.py
def get_assembly_number(element: int) -> str:
    """Get the elmement assembly number

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        element (int): element ID

    Returns:
        str: assembly number
    """

get_auto_attribute(element, number)

Get auto attribute

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
element int

element ID

required
number int

auto attribute number

required

Returns:

Type Description
str

name (value)

Source code in attribute_controller/__init__.py
def get_auto_attribute(element: int, number: int) -> str:
    """Get auto attribute

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        element (int): element ID
        number (int): auto attribute number

    Returns:
        str: name (value)
    """

get_auto_attribute_name(element)

Get auto attribute name

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
element int

element ID

required

Returns:

Type Description
str

auto attribute name

Source code in attribute_controller/__init__.py
def get_auto_attribute_name(element: int) -> str:
    """Get auto attribute name

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        element (int): element ID

    Returns:
        str: auto attribute name
    """

get_comment(element)

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
element int

element ID

required

Returns:

Type Description
str

comment

Source code in attribute_controller/__init__.py
def get_comment(element: int) -> str:
    """
    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        element (int): element ID

    Returns:
        str: comment
    """

get_cutting_set(element)

Gets the element cutting set

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
element int

element ID

required

Returns:

Type Description
str

element cutting set

Source code in attribute_controller/__init__.py
def get_cutting_set(element: int) -> str:
    """Gets the element cutting set

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        element (int): element ID

    Returns:
        str: element cutting set
    """

get_element_material_name(element)

Gets the element material name

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
element int

element ID

required

Returns:

Type Description
bool

element material name

Source code in attribute_controller/__init__.py
def get_element_material_name(element: int) -> str:
    """Gets the element material name

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        element (int): element ID

    Returns:
        bool: element material name
    """

get_element_type(element)

Gets the element type

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
element int

element ID

required

Returns:

Type Description
element_type

type

Source code in attribute_controller/__init__.py
def get_element_type(element: int) -> element_type:
    """Gets the element type

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        element (int): element ID

    Returns:
        element_type: type
    """

get_extended_settings(element)

Gets the element extended settings

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
element int

element ID

required

Returns:

Type Description
extended_settings

extended settings

Source code in attribute_controller/__init__.py
def get_extended_settings(element: int) -> extended_settings:
    """Gets the element extended settings

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        element (int): element ID

    Returns:
        extended_settings: extended settings
    """

get_fastening_attribute(element)

Get the element fastening attribute

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
element int

element ID

required

Returns:

Type Description
str

element fastening attribute

Source code in attribute_controller/__init__.py
def get_fastening_attribute(element: int) -> str:
    """Get the element fastening attribute

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        element (int): element ID

    Returns:
        str: element fastening attribute
    """

get_group(element)

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
element int

element ID

required

Returns:

Type Description
str

group name

Source code in attribute_controller/__init__.py
def get_group(element: int) -> str:
    """
    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        element (int): element ID

    Returns:
        str: group name
    """

get_ignore_in_vba_calculation(element)

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
element int

element ID

required

Returns:

Type Description
bool

Ignore

Source code in attribute_controller/__init__.py
def get_ignore_in_vba_calculation(element: int) -> bool:
    """
    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        element (int): element ID

    Returns:
        bool: Ignore
    """

get_list_quantity(element)

Get element quantity

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
element int

elmement ID

required

Returns:

Type Description
int

elmement quantity

Source code in attribute_controller/__init__.py
def get_list_quantity(element: int) -> int:
    """Get element quantity

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        element (int): elmement ID

    Returns:
        int: elmement quantity 
    """

get_machine_calculation_set(element)

Gets the element machine calculation set

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
element int

element ID

required

Returns:

Type Description
str

element machine calculation set

Source code in attribute_controller/__init__.py
def get_machine_calculation_set(element: int) -> str:
    """Gets the element machine calculation set

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        element (int): element ID

    Returns:
        str: element machine calculation set
    """

get_name(element)

get element name

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
element int

elmement id

required

Returns:

Type Description
str

element name

Source code in attribute_controller/__init__.py
def get_name(element: int) -> str:
    """get element name

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        element (int): elmement id

    Returns:
        str: element name
    """

get_name_extended_settings(name)

Gets the extended settings for an element name

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
name str

element name

required

Returns:

Type Description
extended_settings

extended settings

Source code in attribute_controller/__init__.py
def get_name_extended_settings(name: str) -> extended_settings:
    """Gets the extended settings for an element name

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        name (str): element name

    Returns:
        extended_settings: extended settings
    """

get_name_process_type(name)

Gets the process type for an element name

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
name int

element name

required

Returns:

Type Description
process_type

process type

Source code in attribute_controller/__init__.py
def get_name_process_type(name: int) -> process_type:
    """Gets the process type for an element name

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        name (int): element name

    Returns:
        process_type: process type
    """

get_output_type(element)

Gets the element output type

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
element int

element ID

required

Returns:

Type Description
output_type

output type

Source code in attribute_controller/__init__.py
def get_output_type(element: int) -> output_type:
    """Gets the element output type

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        element (int): element ID

    Returns:
        output_type: output type
    """

get_part_number(element)

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
element int

element ID

required

Returns:

Type Description
int

part number

Source code in attribute_controller/__init__.py
def get_part_number(element: int) -> int:
    """
    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        element (int): element ID

    Returns:
        int: part number
    """

get_prefab_layer(element)

Get prefab layer. Returns layer values for "With dimensions", "Without dimensions", "Show Attributes".

Parameters:

Name Type Description Default
element int

element id

required

Returns:

Type Description
str

value

Source code in attribute_controller/__init__.py
def get_prefab_layer(element: int) -> str:
    """Get prefab layer. Returns layer values for "With dimensions", "Without dimensions", "Show Attributes".

    Args:
        element (int): element id

    Returns:
        str: value 
    """

get_prefab_layer_all_assigned(element)

Get all layer to which the element is assigned

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
element int

element ID

required

Returns:

Type Description
List[int]

Layer

Source code in attribute_controller/__init__.py
def get_prefab_layer_all_assigned(element: int) -> List[int]:
    """Get all layer to which the element is assigned

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        element (int): element ID

    Returns:
        List[int]: Layer
    """

get_prefab_layer_with_dimensions(element)

Check if element is exported with prefab layer with dimensions

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
element int

element ID

required

Returns:

Type Description
List[int]

layer number

Source code in attribute_controller/__init__.py
def get_prefab_layer_with_dimensions(element: int) -> List[int]:
    """Check if element is exported with prefab layer with dimensions

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        element (int): element ID

    Returns:
        List[int]: layer number
    """

get_prefab_layer_without_dimensions(element)

Check if element is exported with prefab layer without dimensions

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
element int

element ID

required

Returns:

Type Description
List[int]

layer number

Source code in attribute_controller/__init__.py
def get_prefab_layer_without_dimensions(element: int) -> List[int]:
    """Check if element is exported with prefab layer without dimensions

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        element (int): element ID

    Returns:
        List[int]: layer number
    """

get_production_number(element)

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
element int

element ID

required

Returns:

Type Description
int

number

Source code in attribute_controller/__init__.py
def get_production_number(element: int) -> int:
    """
    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        element (int): element ID

    Returns:
        int: number
    """

get_sku(element)

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
element int

element ID

required

Returns:

Type Description
str

sku code

Source code in attribute_controller/__init__.py
def get_sku(element: int) -> str:
    """

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        element (int): element ID

    Returns:
        str: sku code
    """

get_standard_element_name(element)

Get standard element name

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
element int

element ID

required

Returns:

Type Description
str

standard element name

Source code in attribute_controller/__init__.py
def get_standard_element_name(element: int) -> str:
    """Get standard element name

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        element (int): element ID

    Returns:
        str: standard element name
    """

get_steel_shape_name(element)

Get steel profile name ℹ Available for script filled attributes

Parameters:

Name Type Description Default
element int

element ID

required

Returns:

Type Description
str

steel profile name

Source code in attribute_controller/__init__.py
def get_steel_shape_name(element: int) -> str:
    """Get steel profile name
    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        element (int): element ID

    Returns:
        str: steel profile name
    """

get_subgroup(element)

get subgroup

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
element int

element ID

required

Returns:

Type Description
str

subgroup name

Source code in attribute_controller/__init__.py
def get_subgroup(element: int) -> str:
    """get subgroup

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        element (int): element ID

    Returns:
        str: subgroup name
    """

get_user_attribute(element, number)

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
element int

element ID

required
number int

number user attribute

required

Returns:

Type Description
str

user attribute name (key)

Source code in attribute_controller/__init__.py
def get_user_attribute(element: int, number: int) -> str:
    """
    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        element (int): element ID
        number (int): number user attribute

    Returns:
        str: user attribute name (key)
    """

get_user_attribute_name(number)

Gets the user attribute name

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
number int

Number user attribute number

required

Returns:

Type Description
str

user attribute name

Source code in attribute_controller/__init__.py
def get_user_attribute_name(number: int) -> str:
    """Gets the user attribute name

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        number (int): Number user attribute number

    Returns:
        str: user attribute name
    """

get_wall_situation(element)

Gets the element wall situation

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
element int

element ID

required

Returns:

Type Description
str

element wall situation

Source code in attribute_controller/__init__.py
def get_wall_situation(element: int) -> str:
    """Gets the element wall situation

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        element (int): element ID

    Returns:
        str: element wall situation
    """

is_architecture_wall_2dc(element)

Tests if the element has a 2dc reference wall

Parameters:

Name Type Description Default
element int

element ID

required

Returns:

Type Description
bool

is architecturewall 2dc

Source code in attribute_controller/__init__.py
def is_architecture_wall_2dc(element: int) -> bool:
    """Tests if the element has a 2dc reference wall

    Args:
        element (int): element ID

    Returns:
        bool: is architecturewall 2dc
    """

is_architecture_wall_xml(element)

Tests if the element has a xml reference wall

Parameters:

Name Type Description Default
element int

element ID

required

Returns:

Type Description
bool

is architecturewall xml

Source code in attribute_controller/__init__.py
def is_architecture_wall_xml(element: int) -> bool:
    """Tests if the element has a xml reference wall

    Args:
        element (int): element ID

    Returns:
        bool: is architecturewall xml
    """

is_auxiliary(element)

Tests if element is auxiliary

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
element int

element ID

required

Returns:

Type Description
bool

is element auxiliary

Source code in attribute_controller/__init__.py
def is_auxiliary(element: int) -> bool:
    """Tests if element is auxiliary

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        element (int): element ID

    Returns:
        bool: is element auxiliary
    """

is_beam(element)

Tests if element is beam

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
element int

element ID

required

Returns:

Type Description
bool

is element beam

Source code in attribute_controller/__init__.py
def is_beam(element: int) -> bool:
    """Tests if element is beam

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        element (int): element ID

    Returns:
        bool: is element beam
    """

is_caddy_object(element)

Tests if the element is caddy object

Parameters:

Name Type Description Default
element int

element ID

required

Returns:

Type Description
bool

is element caddy object

Source code in attribute_controller/__init__.py
def is_caddy_object(element: int) -> bool:
    """Tests if the element is caddy object

    Args:
        element (int): element ID

    Returns:
        bool: is element caddy object
    """

is_circular_mep(self, element_type)

Parameters:

Name Type Description Default
element_type _type_

element type

required

Returns:

Type Description
bool

condition

Source code in attribute_controller/__init__.py
def is_circular_mep(self, element_type) -> bool:
    """

    Args:
        element_type (_type_): element type 

    Returns:
        bool: condition
    """

is_connector_axis(element)

Tests if element is connector axis

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
element int

element ID

required

Returns:

Type Description
bool

is element connector axis

Source code in attribute_controller/__init__.py
def is_connector_axis(element: int) -> bool:
    """Tests if element is connector axis

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        element (int): element ID

    Returns:
        bool: is element connector axis
    """

is_container(element)

Tests if element is container

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
element int

element ID

required

Returns:

Type Description
bool

is element container

Source code in attribute_controller/__init__.py
def is_container(element: int) -> bool:
    """Tests if element is container

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        element (int): element ID

    Returns:
        bool: is element container
    """

is_drilling(element)

Tests if element is drilling

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
element int

element ID

required

Returns:

Type Description
bool

is element drilling

Source code in attribute_controller/__init__.py
def is_drilling(element: int) -> bool:
    """Tests if element is drilling

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        element (int): element ID

    Returns:
        bool: is element drilling
    """

is_envelope(element)

Tests if the element is envelope

Parameters:

Name Type Description Default
element int

element ID

required

Returns:

Type Description
bool

is element envelope

Source code in attribute_controller/__init__.py
def is_envelope(element: int) -> bool:
    """Tests if the element is envelope

    Args:
        element (int): element ID

    Returns:
        bool: is element envelope
    """

is_export_solid(element)

Tests if element is export solid

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
element int

element ID

required

Returns:

Type Description
bool

is element export solid

Source code in attribute_controller/__init__.py
def is_export_solid(element: int) -> bool:
    """Tests if element is export solid

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        element (int): element ID

    Returns:
        bool: is element export solid
    """

is_floor(element)

Tests if element is floor

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
element int

element ID

required

Returns:

Type Description
bool

is element floor

Source code in attribute_controller/__init__.py
def is_floor(element: int) -> bool:
    """Tests if element is floor

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        element (int): element ID

    Returns:
        bool: is element floor
    """

is_framed_floor(element)

Tests if element is a framed floor

Info

Available in script filled attribut

Parameters:

Name Type Description Default
element int

element ID

required

Returns:

Type Description
bool

is element a framed floor

Source code in attribute_controller/__init__.py
def is_framed_floor(element: int) -> bool:
    """Tests if element is a framed floor

    !!! Info
            Available in script filled attribut

    Args:
        element (int): element ID

    Returns:
        bool: is element a framed floor
    """

is_framed_roof(element)

Tests if element is a framed roof

Info

Available in script filled attribut

Parameters:

Name Type Description Default
element int

element ID

required

Returns:

Type Description
bool

is element a framed roof

Source code in attribute_controller/__init__.py
def is_framed_roof(element: int) -> bool:
    """Tests if element is a framed roof

    !!! Info
            Available in script filled attribut

    Args:
        element (int): element ID

    Returns:
        bool: is element a framed roof
    """

is_framed_wall(element)

Tests if element is a framed wall

Info

Available in script filled attribut

Parameters:

Name Type Description Default
element int

element ID

required

Returns:

Type Description
bool

is element a framed wall

Source code in attribute_controller/__init__.py
def is_framed_wall(element: int) -> bool:
    """Tests if element is a framed wall

    !!! Info
            Available in script filled attribut

    Args:
        element (int): element ID

    Returns:
        bool: is element a framed wall
    """

is_line(element)

Tests if element is line

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
element int

element ID

required

Returns:

Type Description
bool

is element line

Source code in attribute_controller/__init__.py
def is_line(element: int) -> bool:
    """Tests if element is line

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        element (int): element ID

    Returns:
        bool: is element line
    """

is_log_wall(element)

Tests if element is a log wall

Info

Available in script filled attribut

Parameters:

Name Type Description Default
element int

element ID

required

Returns:

Type Description
bool

is element a log wall

Source code in attribute_controller/__init__.py
def is_log_wall(element: int) -> bool:
    """Tests if element is a log wall

    !!! Info
            Available in script filled attribut

    Args:
        element (int): element ID

    Returns:
        bool: is element a log wall
    """

is_metal(element)

Tests if element is metal

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
element int

element ID

required

Returns:

Type Description
bool

is element metal

Source code in attribute_controller/__init__.py
def is_metal(element: int) -> bool:
    """Tests if element is metal

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        element (int): element ID

    Returns:
        bool: is element metal
    """

is_nesting_parent(element)

check if element is a nesting parent.

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
element int

element ID

required

Returns:

Type Description
bool

is nesting parent

Source code in attribute_controller/__init__.py
def is_nesting_parent(element: int) -> bool:
    """check if element is a nesting parent.

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        element (int): element ID

    Returns:
        bool: is nesting parent
    """

is_nesting_raw_part(element)

check if element is a nesting raw part.

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
element int

element ID

required

Returns:

Type Description
bool

is nesting raw part

Source code in attribute_controller/__init__.py
def is_nesting_raw_part(element: int) -> bool:
    """check if element is a nesting raw part.

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        element (int): element ID

    Returns:
        bool: is nesting raw part
    """

is_node(element)

Tests if element is node

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
element int

element ID

required

Returns:

Type Description
bool

is element node

Source code in attribute_controller/__init__.py
def is_node(element: int) -> bool:
    """Tests if element is node

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        element (int): element ID

    Returns:
        bool: is element node
    """

is_opening(element)

Tests if element is opening

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
element int

element ID

required

Returns:

Type Description
bool

is element opening

Source code in attribute_controller/__init__.py
def is_opening(element: int) -> bool:
    """Tests if element is opening

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        element (int): element ID

    Returns:
        bool: is element opening
    """

is_panel(element)

Tests if element is panel

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
element int

element ID

required

Returns:

Type Description
bool

is element panel

Source code in attribute_controller/__init__.py
def is_panel(element: int) -> bool:
    """Tests if element is panel

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        element (int): element ID

    Returns:
        bool: is element panel
    """

is_rectangular_mep(self, element_type)

Parameters:

Name Type Description Default
element_type _type_

element type

required

Returns:

Type Description
bool

condition

Source code in attribute_controller/__init__.py
def is_rectangular_mep(self, element_type) -> bool:
    """

    Args:
        element_type (_type_): element type 

    Returns:
        bool: condition
    """

is_roof(element)

Tests if element is roof

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
element int

element ID

required

Returns:

Type Description
bool

is element roof

Source code in attribute_controller/__init__.py
def is_roof(element: int) -> bool:
    """Tests if element is roof

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        element (int): element ID

    Returns:
        bool: is element roof
    """

is_roof_surface(element)

Tests if the element is caddy object

Parameters:

Name Type Description Default
element int

element ID

required

Returns:

Type Description
bool

is element caddy object

Source code in attribute_controller/__init__.py
def is_roof_surface(element: int) -> bool:
    """Tests if the element is caddy object

    Args:
        element (int): element ID

    Returns:
        bool: is element caddy object
    """

is_solid_floor(element)

Tests if element is a solid floor

Info

Available in script filled attribut

Parameters:

Name Type Description Default
element int

element ID

required

Returns:

Type Description
bool

is element a solid floor

Source code in attribute_controller/__init__.py
def is_solid_floor(element: int) -> bool:
    """Tests if element is a solid floor

    !!! Info
            Available in script filled attribut

    Args:
        element (int): element ID

    Returns:
        bool: is element a solid floor
    """

is_solid_roof(element)

Tests if element is a solid roof

Info

Available in script filled attribut

Parameters:

Name Type Description Default
element int

element ID

required

Returns:

Type Description
bool

is element a solid roof

Source code in attribute_controller/__init__.py
def is_solid_roof(element: int) -> bool:
    """Tests if element is a solid roof

    !!! Info
            Available in script filled attribut

    Args:
        element (int): element ID

    Returns:
        bool: is element a solid roof
    """

is_solid_wall(element)

Tests if element is a solid wall

Info

Available in script filled attribut

Parameters:

Name Type Description Default
element int

element ID

required

Returns:

Type Description
bool

is element a solid wall

Source code in attribute_controller/__init__.py
def is_solid_wall(element: int) -> bool:
    """Tests if element is a solid wall

    !!! Info
            Available in script filled attribut

    Args:
        element (int): element ID

    Returns:
        bool: is element a solid wall
    """

is_surface(element)

Tests if element is surface

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
element int

element ID

required

Returns:

Type Description
bool

is element surface

Source code in attribute_controller/__init__.py
def is_surface(element: int) -> bool:
    """Tests if element is surface

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        element (int): element ID

    Returns:
        bool: is element surface
    """

is_wall(element)

Tests if element is wall

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
element int

element ID

required

Returns:

Type Description
bool

is element wall

Source code in attribute_controller/__init__.py
def is_wall(element: int) -> bool:
    """Tests if element is wall

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        element (int): element ID

    Returns:
        bool: is element wall
    """

set_additional_data(elements, data_id, data_text)

Parameters:

Name Type Description Default
elements List[int]

element IDs

required
data_id str

data id

required
data_text str

additional data text

required
Source code in attribute_controller/__init__.py
def set_additional_data(elements: List[int], data_id: str, data_text: str) -> None:
    """

    Args:
        elements (List[int]): element IDs
        data_id (str): data id
        data_text (str): additional data text
    """

set_additional_guid(elements, data_id, guid)

set additional guid

Parameters:

Name Type Description Default
elements List[int]

element IDs

required
data_id str

data iD

required
guid str

a guid

required
Source code in attribute_controller/__init__.py
def set_additional_guid(elements: List[int], data_id: str, guid: str) -> None:
    """set additional guid

    Args:
        elements (List[int]): element IDs
        data_id (str): data iD
        guid (str): a guid
    """

set_assembly_number(elements, number)

Set the elmement assembly number

Parameters:

Name Type Description Default
elements List[int]

element IDs

required
number str

assembly number

required
Source code in attribute_controller/__init__.py
def set_assembly_number(elements: List[int], number: str) -> None:
    """Set the elmement assembly number

    Args:
        elements (List[int]): element IDs
        number (str): assembly number
    """

set_comment(elements, comment)

summary

Parameters:

Name Type Description Default
elements List[int]

element IDs

required
comment str

comment

required
Source code in attribute_controller/__init__.py
def set_comment(elements: List[int], comment: str) -> None:
    """_summary_

    Args:
        elements (List[int]): element IDs
        comment (str): comment
    """

set_element_material(elements, material_id)

Sets the element material

Parameters:

Name Type Description Default
elements List[int]

element IDs

required
material_id int

material ID

required
Source code in attribute_controller/__init__.py
def set_element_material(elements: List[int], material_id: int) -> None:
    """Sets the element material

    Args:
        elements (List[int]): element IDs
        material_id (int): material ID
    """

set_extended_settings(elements, extended_settings)

Sets the element extended settings

Parameters:

Name Type Description Default
elements List[int]

element IDs

required
extended_settings extended_settings

element extended settings

required
Source code in attribute_controller/__init__.py
def set_extended_settings(elements: List[int], extended_settings: extended_settings) -> None:
    """Sets the element extended settings

    Args:
        elements (List[int]): element IDs
        extended_settings (extended_settings): element extended settings
    """

set_fastening_attribute(elements, value)

Sets the element fastening attribute

Parameters:

Name Type Description Default
elements List[int]

element IDs

required
value str

Value element fastening attribute

required
Source code in attribute_controller/__init__.py
def set_fastening_attribute(elements: List[int], value: str) -> None:
    """Sets the element fastening attribute

    Args:
        elements (List[int]): element IDs
        value (str): Value element fastening attribute
    """

set_floor(elements)

Sets the element to floor

Parameters:

Name Type Description Default
elements List[int]

element IDs

required
Source code in attribute_controller/__init__.py
def set_floor(elements: List[int]) -> None:
    """Sets the element to floor

    Args:
        elements (List[int]): element IDs
    """

set_group(elements, group)

set group

Parameters:

Name Type Description Default
elements List[int]

element IDs

required
group str

group name

required
Source code in attribute_controller/__init__.py
def set_group(elements: List[int], group: str) -> None:
    """set group

    Args:
        elements (List[int]): element IDs
        group (str): group name
    """

set_ignore_in_vba_calculation(elements, value)

Sets if the element should be ignored in VBA Calculation

Parameters:

Name Type Description Default
elements List[int]

element IDs

required
value bool

Ignore

required
Source code in attribute_controller/__init__.py
def set_ignore_in_vba_calculation(elements: List[int], value: bool) -> None:
    """Sets if the element should be ignored in VBA Calculation

    Args:
        elements (List[int]): element IDs
        value (bool): Ignore
    """

set_layer_settings(elements, layer_settings)

Sets element layer settings

Parameters:

Name Type Description Default
elements List[int]

element IDs

required
layer_settings layer_settings

layer setting

required
Source code in attribute_controller/__init__.py
def set_layer_settings(elements: List[int], layer_settings: layer_settings) -> None:
    """Sets element layer settings

    Args:
        elements (List[int]): element IDs
        layer_settings (layer_settings): layer setting
    """

set_list_quantity(elements, quantity)

Set element quantity

Parameters:

Name Type Description Default
elements List[int]

element IDs

required
quantity int

elmement quantity

required
Source code in attribute_controller/__init__.py
def set_list_quantity(elements: List[int], quantity: int) -> None:
    """Set element quantity

    Args:
        elements (List[int]): element IDs
        quantity (int): elmement quantity 
    """

set_log_wall(elements)

Sets the element to log wall

Parameters:

Name Type Description Default
elements List[int]

element IDs

required
Source code in attribute_controller/__init__.py
def set_log_wall(elements: List[int]) -> None:
    """Sets the element to log wall

    Args:
        elements (List[int]): element IDs
    """

set_name(elements, name)

Parameters:

Name Type Description Default
elements List[int]

element IDs

required
name str

name

required
Source code in attribute_controller/__init__.py
def set_name(elements: List[int], name: str) -> None:
    """

    Args:
        elements (List[int]): element IDs
        name (str): name
    """

set_name_extended_settings(name, extended_settings)

Sets the extended settings for an element name

Parameters:

Name Type Description Default
name str

element name

required
extended_settings extended_settings

extended settings

required
Source code in attribute_controller/__init__.py
def set_name_extended_settings(name: str, extended_settings: extended_settings) -> None:
    """Sets the extended settings for an element name

    Args:
        name (str): element name
        extended_settings (extended_settings): extended settings
    """

set_name_process_type(name, process_type)

Sets the process type for an element name

Parameters:

Name Type Description Default
name str

element name

required
process_type process_type

process type

required
Source code in attribute_controller/__init__.py
def set_name_process_type(name: str, process_type: process_type) -> None:
    """Sets the process type for an element name

    Args:
        name (str): element name
        process_type (process_type): process type
    """

set_node_symbol(elements, node_symbol)

Set a node symbol. ChessSquare, Circle, Cross, CrossSquare, FilledCircle, FilledSquare, HalfFilledSquare ,SmallSquare, Square

Parameters:

Name Type Description Default
elements List[int]

element IDs

required
node_symbol int

node symbol number

required
Source code in attribute_controller/__init__.py
def set_node_symbol(elements: List[int], node_symbol: int) -> None:
    """Set a node symbol.
    ChessSquare, Circle, Cross, CrossSquare, FilledCircle, FilledSquare, HalfFilledSquare ,SmallSquare, Square

    Args:
        elements (List[int]): element IDs
        node_symbol (int): node symbol number
    """

set_opening(elements)

Sets the element to opening

Parameters:

Name Type Description Default
elements List[int]

element IDs

required
Source code in attribute_controller/__init__.py
def set_opening(elements: List[int]) -> None:
    """Sets the element to opening

    Args:
        elements (List[int]): element IDs
    """

set_output_type(elements, output_type)

Sets the element output type

Parameters:

Name Type Description Default
elements List[int]

element IDs

required
output_type output_type

element output type

required
Source code in attribute_controller/__init__.py
def set_output_type(elements: List[int], output_type: output_type) -> None:
    """Sets the element output type

    Args:
        elements (List[int]):  element IDs
        output_type (output_type): element output type
    """

set_part_number(elements, number)

Parameters:

Name Type Description Default
elements List[int]

element IDs

required
number int

part number

required
Source code in attribute_controller/__init__.py
def set_part_number(elements: List[int], number: int) -> None:
    """

    Args:
        elements (List[int]): element IDs
        number (int): part number
    """

set_process_type_and_extended_settings_from_name(elements)

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

Parameters:

Name Type Description Default
elements List[int]

ElementIDs

required
Source code in attribute_controller/__init__.py
def set_process_type_and_extended_settings_from_name(elements: List[int]) -> None:
    """ Sets the element process type and extended settings from the element name

    Args:
        elements (List[int]): ElementIDs
    """

set_production_number(elements, number)

Parameters:

Name Type Description Default
elements List[int]

element IDs

required
number int

production number

required
Source code in attribute_controller/__init__.py
def set_production_number(elements: List[int], number: int) -> None:
    """

    Args:
        elements (List[int]): element IDs
        number (int): production number
    """

set_reference_wall_2dc(elements, wall)

Applies a new 2dc reference wall to an element

Parameters:

Name Type Description Default
elements List[int]

element IDs

required
wall str

2dc file path

required
Source code in attribute_controller/__init__.py
def set_reference_wall_2dc(elements: List[int], wall: str) -> None:
    """Applies a new 2dc reference wall to an element

    Args:
        elements (List[int]): element IDs
        wall (str): 2dc file path
    """

set_sku(elements, sku)

summary

Parameters:

Name Type Description Default
elements List[int]

element IDs

required
sku str

sku code

required
Source code in attribute_controller/__init__.py
def set_sku(elements: List[int], sku: str) -> None:
    """_summary_

    Args:
        elements (List[int]): element IDs
        sku (str): sku code
    """

set_solid_floor(elements)

set property for element type to solid floor

Parameters:

Name Type Description Default
elements List[int]

element IDs

required
Source code in attribute_controller/__init__.py
def set_solid_floor(elements: List[int]) -> None:
    """set property for element type to solid floor 

    Args:
        elements (List[int]): element IDs
    """

set_solid_roof(elements)

set property for element type to solid roof

Parameters:

Name Type Description Default
elements List[int]

element IDs

required
Source code in attribute_controller/__init__.py
def set_solid_roof(elements: List[int]) -> None:
    """set property for element type to solid roof 

    Args:
        elements (List[int]): element IDs
    """

set_solid_wall(elements)

set property for element type to solid wall

Parameters:

Name Type Description Default
elements List[int]

element IDs

required
Source code in attribute_controller/__init__.py
def set_solid_wall(elements: List[int]) -> None:
    """set property for element type to solid wall 

    Args:
        elements (List[int]): element IDs
    """

set_standard_part(elements)

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

Parameters:

Name Type Description Default
elements List[int]

element IDs

required
Source code in attribute_controller/__init__.py
def set_standard_part(elements: List[int]) -> None:
    """Sets covers (wall, opening or floor) to standard part

    Args:
        elements (List[int]): element IDs
    """

set_subgroup(elements, subgroup)

Parameters:

Name Type Description Default
elements List[int]

element IDs

required
subgroup str

subgroup name

required
Source code in attribute_controller/__init__.py
def set_subgroup(elements: List[int], subgroup: str) -> None:
    """

    Args:
        elements (List[int]): element IDs
        subgroup (str): subgroup name
    """

set_user_attribute(elements, number, value)

Parameters:

Name Type Description Default
elements List[int]

element IDs

required
number int

user attribute (key)

required
value str

user attribute name (value)

required
Source code in attribute_controller/__init__.py
def set_user_attribute(elements: List[int], number: int, value: str) -> None:
    """

    Args:
        elements (List[int]): element IDs
        number (int): user attribute (key)
        value (str): user attribute name (value)
    """

set_user_attribute_name(number, name)

Sets the user attribute name

Parameters:

Name Type Description Default
number int

Number user attribute number

required
name str

User attribute name user attribute name

required
Source code in attribute_controller/__init__.py
def set_user_attribute_name(number: int, name: str) -> None:
    """Sets the user attribute name

    Args:
        number (int): Number user attribute number
        name (str): User attribute name user attribute name
    """

set_wall(elements)

set element to type wall

Parameters:

Name Type Description Default
elements List[int]

element IDs

required
Source code in attribute_controller/__init__.py
def set_wall(elements: List[int]) -> None:
    """set element to type wall

    Args:
        elements (List[int]): element IDs
    """

update_auto_attribute()

Start update auto attribute

Source code in attribute_controller/__init__.py
def update_auto_attribute() -> None:
    """Start update auto attribute
    """