Connector Axis Controller

Fastener and connector axes.

Domain of the linear assemblies that represent bolts, screws, dowels and similar connectors: their creation, validation, the catalog items attached to them (bolt, nut, washer, ...), per-item user fields, and the configuration UI for connector axes. Distinct from connector nodes and from drillings, which live in element_controller.

check_axis(axis_id: ElementId) -> bool

Returns if the axis is valid.

Parameters:

Name	Type	Description	Default
axis_id	ElementId	The id of the axis.	required

Returns:

Type	Description
bool	True if the axis is valid, false otherwise.

clear_errors() -> None

Clear all errors.

create_blank_connector(diameter: float, start_point: point_3d, end_point: point_3d) -> ElementId

Creates a blank connector between two points.

Parameters:

Name	Type	Description	Default
diameter	float	The diameter of the connector.	required
start_point	point_3d	The start point of the connector.	required
end_point	point_3d	The end point of the connector.	required

Returns:

Type	Description
ElementId	The element id of the created blank connector.

create_standard_connector(axis_name: str, point1: point_3d, point2: point_3d) -> ElementId

Creates a standard connector axis between two points.

Parameters:

Name	Type	Description	Default
axis_name	str	Name of the standard connector axis.	required
point1	point_3d	The first point defining the connector axis.	required
point2	point_3d	The second point defining the connector axis.	required

Returns:

Type	Description
ElementId	The element id of the created standard connector axis.

get_axis_item_material(guid: str) -> str

Returns the material of an axis item.

Parameters:

Name	Type	Description	Default
guid	str	The guid of the axis item.	required

Returns:

Type	Description
str	The material of the axis item.

get_axis_item_name(guid: str) -> str

Returns the name of an axis item.

Parameters:

Name	Type	Description	Default
guid	str	The guid of the axis item.	required

Returns:

Type	Description
str	The name of the axis item.

get_axis_item_norm(guid: str) -> str

Returns the norm of an axis item.

Parameters:

Name	Type	Description	Default
guid	str	The guid of the axis item.	required

Returns:

Type	Description
str	The norm of the axis item.

get_axis_item_order_number(guid: str) -> str

Returns the strength category of an axis item.

Parameters:

Name	Type	Description	Default
guid	str	The guid of the axis item.	required

Returns:

Type	Description
str	The strength category of the axis item.

get_axis_item_strength_category(guid: str) -> str

Returns the strength category of an axis item.

Parameters:

Name	Type	Description	Default
guid	str	The guid of the axis item.	required

Returns:

Type	Description
str	The strength category of the axis item.

get_axis_item_user_field(guid: str, user_item_number: int) -> str

Returns an userfield value of an axis item.

Parameters:

Name	Type	Description	Default
guid	str	The guid of the axis item.	required
user_item_number	int	The user item number.	required

Returns:

Type	Description
str	The user field value.

get_axis_items_guids(axis_id: ElementId) -> list[str]

Returns a list of GUIDs of all axis items.

Parameters:

Name	Type	Description	Default
axis_id	ElementId	The id of the axis.	required

Returns:

Type	Description
list[str]	The list of GUIDs of all axis items.

get_bolt_diameter(axis_id: ElementId) -> float

Gets the bolt diameter.

Parameters:

Name	Type	Description	Default
axis_id	ElementId	The id of the axis.	required

Returns:

Type	Description
float	The bolt diameter.

get_bolt_item_guid(axis_id: ElementId) -> str

Gets the Guid of the Bolt Item.

Parameters:

Name	Type	Description	Default
axis_id	ElementId	The id of the axis.	required

Returns:

Type	Description
str	The guid of the bolt item.

get_bolt_length(axis_id: ElementId) -> float

Gets the Bolt Length.

Parameters:

Name	Type	Description	Default
axis_id	ElementId	The id of the axis.	required

Returns:

Type	Description
float	The bolt length.

get_bolt_length_automatic(axis_id: ElementId) -> bool

Returns if Bolt Length Automatic is set.

Parameters:

Name	Type	Description	Default
axis_id	ElementId	The id of the axis.	required

Returns:

Type	Description
bool	True if the bolt length is automatic, false otherwise.

get_bolt_order_number(axis_id: ElementId) -> str

Returns the ordernumber of a bolt item.

Parameters:

Name	Type	Description	Default
axis_id	ElementId	The id of the axis.	required

Returns:

Type	Description
str	The order number of the bolt item.

get_bolt_over_length(axis_id: ElementId) -> float

Gets the Bolt OverLength.

Parameters:

Name	Type	Description	Default
axis_id	ElementId	The id of the axis.	required

Returns:

Type	Description
float	The bolt over length.

get_counterbore_depth_for_end_side(axis_id: ElementId, section_index: UnsignedInt) -> float

Gets the counterbore depth for the end side.

Parameters:

Name	Type	Description	Default
axis_id	ElementId	The id of the axis.	required
section_index	UnsignedInt	The index of the section.	required

Returns:

Type	Description
float	The counterbore depth for the end side.

get_counterbore_depth_for_start_side(axis_id: ElementId, section_index: UnsignedInt) -> float

Gets the counterbore depth for the start side.

Parameters:

Name	Type	Description	Default
axis_id	ElementId	The id of the axis.	required
section_index	UnsignedInt	The index of the section.	required

Returns:

Type	Description
float	The counterbore depth for the start side.

get_counterbore_diameter_for_end_side(axis_id: ElementId, section_index: UnsignedInt) -> float

Gets the counterbore diameter for the end side of a section.

Parameters:

Name	Type	Description	Default
axis_id	ElementId	The id of the axis.	required
section_index	UnsignedInt	The index of the section.	required

Returns:

Type	Description
float	The counterbore diameter for the end side.

get_counterbore_diameter_for_start_side(axis_id: ElementId, section_index: UnsignedInt) -> float

Gets the counterbore diameter for the start side.

Parameters:

Name	Type	Description	Default
axis_id	ElementId	The id of the axis.	required
section_index	UnsignedInt	The index of the section. (0-based index)	required
diameter		[UNUSED PARAMETER]	required
depth		[UNUSED PARAMETER]	required
is_conical		[UNUSED PARAMETER]	required

Returns:

Type	Description
float	The counterbore diameter for the start side.

get_counterbore_is_conical_for_end_side(axis_id: ElementId, section_index: UnsignedInt) -> bool

Get if counterbore is conical for end side.

Parameters:

Name	Type	Description	Default
axis_id	ElementId	The id of the axis.	required
section_index	UnsignedInt	The index of the section.	required

Returns:

Type	Description
bool	True if the counterbore is conical for the end side, false otherwise.

get_counterbore_is_conical_for_start_side(axis_id: ElementId, section_index: UnsignedInt) -> bool

Get if counterbore is conical for start side.

Parameters:

Name	Type	Description	Default
axis_id	ElementId	The id of the axis.	required
section_index	UnsignedInt	The index of the section	required

Returns:

Type	Description
bool	True if the counterbore is conical for the start side, false otherwise.

get_intersection_count(intersection_index: UnsignedInt) -> int

Get the intersection count.

Parameters:

Name	Type	Description	Default
intersection_index	UnsignedInt	The index of the intersection. (0-based index)	required

Returns:

Type	Description
int	The intersection count.

get_item_guid_by_name(name: str, item_type: vba_catalog_item_type) -> str

Get item guid by name.

Parameters:

Name	Type	Description	Default
name	str	The name of the item.	required
item_type	vba_catalog_item_type	The type of the item.	required

Returns:

Type	Description
str	The guid of the item.

get_item_guids_at_intersection(axis_id: ElementId, intersection_index: UnsignedInt) -> list[str]

Get item GUIDs at intersection.

Parameters:

Name	Type	Description	Default
axis_id	ElementId	The id of the axis.	required
intersection_index	UnsignedInt	The index of the intersection. (0-based index)	required

Returns:

Type	Description
list[str]	The list of item GUIDs at the intersection.

get_section_contact_element(axis_id: float, section_index: UnsignedInt) -> ElementId

Gets the section contact element.

Parameters:

Name	Type	Description	Default
axis_id	float	The id of the axis.	required
section_index	UnsignedInt	The index of the section. (0-based index)	required

Returns:

Type	Description
ElementId	The element id of the section contact element.

get_section_count(axis_id: ElementId) -> int

Returns the number of sections.

Parameters:

Name	Type	Description	Default
axis_id	ElementId	The id of the axis.	required

Returns:

Type	Description
int	The number of sections of the axis.

get_section_diameter(axis_id: ElementId, section_index: UnsignedInt) -> float

Gets the Drilling Diameter of a specific Sections.

Parameters:

Name	Type	Description	Default
axis_id	ElementId	The id of the axis.	required
section_index	UnsignedInt	The index of the section. (0-based index)	required

Returns:

Type	Description
float	The drilling diameter of the specified section.

get_section_length(axis_id: ElementId, section_index: UnsignedInt) -> float

Get section length.

Parameters:

Name	Type	Description	Default
axis_id	ElementId	The id of the axis.	required
section_index	UnsignedInt	The index of the section. (0-based index)	required

Returns:

Type	Description
float	The length of the section.

get_section_material_name(axis_id: ElementId, section_index: UnsignedInt) -> str

Returns material of a section contact element.

Parameters:

Name	Type	Description	Default
axis_id	ElementId	The id of the axis.	required
section_index	UnsignedInt	The index of the section. (0-based index)	required

Returns:

Type	Description
str	The material of the section contact element.

get_section_oblong_drilling_angle(axis_id: ElementId, section_index: UnsignedInt) -> float

Get section oblong drilling angle.

Parameters:

Name	Type	Description	Default
axis_id	ElementId	The id of the axis.	required
section_index	UnsignedInt	The index of the section. (0-based index)	required

Returns:

Type	Description
float	The angle of the section oblong drilling.

get_section_oblong_drilling_is_enabled(axis_id: ElementId, section_index: UnsignedInt) -> bool

Get if the section oblong drilling is enabled.

Parameters:

Name	Type	Description	Default
axis_id	ElementId	The id of the axis.	required
section_index	UnsignedInt	The index of the section. (0-based index)	required

Returns:

Type	Description
bool	True if the section oblong drilling is enabled, false otherwise.

get_section_oblong_drilling_negative_value(axis_id: ElementId, section_index: UnsignedInt) -> float

Get the section oblong drilling negative value

Parameters:

Name	Type	Description	Default
axis_id	ElementId	The id of the axis.	required
section_index	UnsignedInt	The index of the section. (0-based index)	required

Returns:

Type	Description
float	The negative value of the section oblong drilling.

get_section_oblong_drilling_positive_value(axis_id: ElementId, section_index: UnsignedInt) -> float

Get section oblong drilling positive value.

Parameters:

Name	Type	Description	Default
axis_id	ElementId	The id of the axis.	required
section_index	UnsignedInt	The index of the section. (0-based index)	required

Returns:

Type	Description
float	The positive value of the section oblong drilling.

get_standard_connector_list() -> list[str]

Returns a list of all standard connectors.

Returns:

Type	Description
list[str]	The list of standard connector names.

import_from_file(file_path: str) -> None

Import from file.

Parameters:

Name	Type	Description	Default
file_path	str	The path to the file to import.	required

set_bolt_item(axis_id: ElementId, item_guid: str) -> None

Sets the Bolt Item.

Parameters:

Name	Type	Description	Default
axis_id	ElementId	The id of the axis.	required
item_guid	str	The bolt item guid to set.	required

set_bolt_length(axis_id: ElementId, length: float) -> None

Sets the Bolt Length.

Parameters:

Name	Type	Description	Default
axis_id	ElementId	The id of the axis.	required
length	float	The bolt length.	required

set_bolt_length_automatic(axis_id: ElementId, length_automatic: bool) -> None

Sets the Bolt Length Automatic.

Parameters:

Name	Type	Description	Default
axis_id	ElementId	The id of the axis.	required
length_automatic	bool	True if the bolt length should be automatic, false otherwise.	required

set_bolt_over_length(axis_id: ElementId, over_length: float) -> None

Sets the Bolt OverLength.

Parameters:

Name	Type	Description	Default
axis_id	ElementId	The id of the axis.	required
over_length	float	The bolt over length.	required

set_counterbore_for_end_side(axis_id: ElementId, section_index: UnsignedInt, diameter: float, depth: float, is_conical: bool) -> None

Sets the counterbore for the end side.

Parameters:

Name	Type	Description	Default
axis_id	ElementId	The id of the axis.	required
section_index	UnsignedInt	The index of the section. (0-based index)	required
diameter	float	The diameter of the counterbore.	required
depth	float	The depth of the counterbore.	required
is_conical	bool	True if the counterbore is conical, false otherwise.	required

set_counterbore_for_start_side(axis_id: ElementId, section_index: UnsignedInt, diameter: float, depth: float, is_conical: bool) -> None

Sets the counterbore for the start side.

Parameters:

Name	Type	Description	Default
axis_id	ElementId	The id of the axis.	required
section_index	UnsignedInt	The index of the section. (0-based index)	required
diameter	float	The diameter of the counterbore.	required
depth	float	The depth of the counterbore.	required
is_conical	bool	True if the counterbore is conical, false otherwise.	required

set_diameter(axis_id: ElementId, diameter: float) -> None

Sets the Drilling Diameter for all Sections.

Parameters:

Name	Type	Description	Default
axis_id	ElementId	The id of the axis.	required
diameter	float	The drilling diameter to set for all sections.	required

set_item_guids_at_intersection(axis_id: ElementId, intersection_index: UnsignedInt, item_guids: list[str]) -> None

Sets item GUIDs at intersection.

Parameters:

Name	Type	Description	Default
axis_id	ElementId	The id of the axis.	required
intersection_index	UnsignedInt	The index of the intersection. (0-based index)	required
item_guids	list[str]	The item GUIDs to set.	required

set_items_at_intersection(axis_id: ElementId, intersection_index: UnsignedInt, items: list[connector_axis_item]) -> None

Sets item at intersection.

Parameters:

Name	Type	Description	Default
axis_id	ElementId	The id of the axis.	required
intersection_index	UnsignedInt	The index of the intersection. (0-based index)	required
items	list[connector_axis_item]	The items to set.	required

set_section_diameter(axis_id: ElementId, section_index: UnsignedInt, diameter: float) -> None

Sets the Drilling Diameter for a specific Sections.

Parameters:

Name	Type	Description	Default
axis_id	ElementId	The id of the axis.	required
section_index	UnsignedInt	The index of the section. (0-based index)	required
diameter	float	The drilling diameter to set for the specific section.	required

set_section_oblong_drilling_is_disabled(axis_id: ElementId, section_index: UnsignedInt) -> None

Disable the section oblong drilling.

Parameters:

Name	Type	Description	Default
axis_id	ElementId	The id of the axis.	required
section_index	UnsignedInt	The index of the section. (0-based index)	required

set_section_oblong_drilling_is_enabled(axis_id: ElementId, section_index: UnsignedInt, positive_value: float, negative_value: float, angle: float) -> None

Enable the section oblong drilling with parameters.

Parameters:

Name	Type	Description	Default
axis_id	ElementId	The id of the axis.	required
section_index	UnsignedInt	The index of the section. (0-based index)	required
positive_value	float	The positive value of the section oblong drilling.	required
negative_value	float	The negative value of the section oblong drilling.	required
angle	float	The angle of the section oblong drilling.	required

start_configuration_dialog() -> None

Starts the ConnectorAxis configuration dialog.

update_axis_cutting_ability(axis_id_list: list[ElementId]) -> None

Updates the Connection Config (CuttingAbility) of Axis/VBAs.

Parameters:

Name	Type	Description	Default
axis_id_list	list[ElementId]	The axis id list.	required