Connector Axis Controller

check_axis(number)

Check connector axis.

Parameters:

Name	Type	Description	Default
number	int	element ID	required

Returns:

Type	Description
bool	result

Source code in connector_axis_controller/__init__.py

def check_axis(number: int) -> bool: 
    """Check connector axis. 

    Args:
        number (int): element ID

    Returns:
        bool: result
    """

create_standard_connector(name, start, end)

Creates a standard connector axis between two points.

Parameters:

Name	Type	Description	Default
name	str	Name of the standard axis	required
start	point_3d	Point 1	required
end	point_3d	Point 2	required

Returns:

Type	Description
int	element ID

Source code in connector_axis_controller/__init__.py

def create_standard_connector(name: str, start: point_3d, end: point_3d) -> int: 
    """Creates a standard connector axis between two points.

    Args:
        name (str): Name of the standard axis
        start (point_3d): Point 1
        end (point_3d): Point 2

    Returns:
        int: element ID
    """

get_axis_item_material(name)

Returns the material of an axis item.

Available for script filled attributes

Parameters:

Name	Type	Description	Default
name	str	guid	required

Returns:

Type	Description
str	element name

Source code in connector_axis_controller/__init__.py

def get_axis_item_material(name: str) -> str: 
    """Returns the material of an axis item.

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

    Args:
        name (str): guid

    Returns:
        str: element name
    """

get_axis_item_name(guid)

Returns the name of an axis item.

Available for script filled attributes

Parameters:

Name	Type	Description	Default
name	str	guid	required

Returns:

Type	Description
str	element name

Source code in connector_axis_controller/__init__.py

def get_axis_item_name(guid: str) -> str: 
    """Returns the name of an axis item.

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

    Args:
        name (str): guid

    Returns:
        str: element name
    """

get_axis_item_norm(name)

Returns the norm of an axis item.

Available for script filled attributes

Parameters:

Name	Type	Description	Default
name	str	guid	required

Returns:

Type	Description
str	norm

Source code in connector_axis_controller/__init__.py

def get_axis_item_norm(name: str) -> str: 
    """Returns the norm of an axis item.

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

    Args:
        name (str): guid

    Returns:
        str: norm
    """

get_axis_item_order_number(name)

Returns the strength category of an axis item.

Available for script filled attributes

Parameters:

Name	Type	Description	Default
name	str	guid	required

Returns:

Type	Description
str	item order number

Source code in connector_axis_controller/__init__.py

def get_axis_item_order_number(name: str) -> str: 
    """Returns the strength category of an axis item.

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

    Args:
        name (str): guid

    Returns:
        str: item order number
    """

get_axis_item_strength_category(name)

Returns the strength category of an axis item.

Available for script filled attributes

Parameters:

Name	Type	Description	Default
name	str	guid	required

Returns:

Type	Description
str	strength category

Source code in connector_axis_controller/__init__.py

def get_axis_item_strength_category(name: str) -> str: 
    """Returns the strength category of an axis item.

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

    Args:
        name (str): guid

    Returns:
        str: strength category 
    """

get_axis_item_user_field(name, number)

Returns an userfield value of an axis item.

Available for script filled attributes

Parameters:

Name	Type	Description	Default
name	str	guid	required
number	int	item number	required

Returns:

Type	Description
str	item user field

Source code in connector_axis_controller/__init__.py

def get_axis_item_user_field(name: str, number: int) -> str: 
    """Returns an userfield value of an axis item.

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

    Args:
        name (str): guid
        number (int): item number

    Returns:
        str: item user field
    """

get_axis_items_guids(number)

Returns a list of GUIDs of all axis items.

Available for script filled attributes

Parameters:

Name	Type	Description	Default
number	int	element ID	required

Returns:

Type	Description
List[str]	elemnt IDs

Source code in connector_axis_controller/__init__.py

def get_axis_items_guids(number: int) -> List[str]: 
    """Returns a list of GUIDs of all axis items.

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

    Args:
        number (int): element ID

    Returns:
        List[str]: elemnt IDs
    """

get_bolt_item_guid(number)

Gets the Guid of the Bolt Item

Available for script filled attributes

Parameters:

Name	Type	Description	Default
number	int	description	required

Returns:

Type	Description
str	description

Source code in connector_axis_controller/__init__.py

def get_bolt_item_guid(number: int) -> str: 
    """Gets the Guid of the Bolt Item

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

    Args:
        number (int): _description_

    Returns:
        str: _description_
    """

get_bolt_length(number)

Gets the Bolt Length

Available for script filled attributes

Parameters:

Name	Type	Description	Default
number	int	element ID	required

Returns:

Type	Description
float	bolt length

Source code in connector_axis_controller/__init__.py

def get_bolt_length(number: int) -> float: 
    """Gets the Bolt Length

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

    Args:
        number (int): element ID

    Returns:
        float: bolt length
    """

get_bolt_length_automatic(number)

Returns if Bolt Length Automatic is set

Available for script filled attributes

Parameters:

Name	Type	Description	Default
number	int	element ID	required

Returns:

Type	Description
bool	check if automatic is set

Source code in connector_axis_controller/__init__.py

def get_bolt_length_automatic(number: int) -> bool: 
    """Returns if Bolt Length Automatic is set

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

    Args:
        number (int): element ID

    Returns:
        bool: check if automatic is set
    """

get_bolt_order_number(number)

Returns the ordernumber of a bolt item.

Available for script filled attributes

Parameters:

Name	Type	Description	Default
number	int	element ID	required

Returns:

Type	Description
str	Order number

Source code in connector_axis_controller/__init__.py

def get_bolt_order_number(number: int) -> str: 
    """Returns the ordernumber of a bolt item.

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

    Args:
        number (int): element ID

    Returns:
        str: Order number
    """

get_bolt_over_length(number)

Gets the Bolt OverLength

Available for script filled attributes

Parameters:

Name	Type	Description	Default
number	int	element ID	required

Returns:

Type	Description
float	bolt length

Source code in connector_axis_controller/__init__.py

def get_bolt_over_length(number: int) -> float: 
    """Gets the Bolt OverLength

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

    Args:
        number (int): element ID

    Returns:
        float: bolt length
    """

get_item_guid_by_name(name, number)

Get CA guid item by element name

Available for script filled attributes

Parameters:

Name	Type	Description	Default
name	str	CA name	required
number	int	item type	required

Returns:

Type	Description
str	guid

Source code in connector_axis_controller/__init__.py

def get_item_guid_by_name(name: str, number: int) -> str: 
    """Get CA guid item by element name

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

    Args:
        name (str): CA name
        number (int): item type

    Returns:
        str: guid
    """

get_section_contact_element(element, section_nr)

Get section contact element.

Examples:

>>> element_ids = [610415]
>>> ac.get_section_contact_element(*element_ids, 0)
>>> 545121

Parameters:

Name	Type	Description	Default
element	int	a axis ID	required
section_nr	int	a section number	required

Returns:

Type	Description
int	element ID

Source code in connector_axis_controller/__init__.py

def get_section_contact_element(element: int, section_nr:int) -> int:
    """Get section contact element.

    Examples:
        >>> element_ids = [610415]
        >>> ac.get_section_contact_element(*element_ids, 0)
        >>> 545121

    Args:
        element (int): a axis ID
        section_nr (int): a section number

    Returns:
        int: element ID
    """

get_section_count(element)

Return the number of section

Available for script filled attributes

Parameters:

Name	Type	Description	Default
element	int	axis ID	required

Returns:

Type	Description
int	number of section

Source code in connector_axis_controller/__init__.py

def get_section_count(element: int) -> int:
    """Return the number of section

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

    Args:
        element (int): axis ID

    Returns:
        int: number of section
    """

get_section_diameter(number, section_nr)

Gets the Drilling Diameter of a specific Sections

Available for script filled attributes

Parameters:

Name	Type	Description	Default
number	int	element ID	required
other_number	int	Section number	required

Returns:

Type	Description
float	diameter

Source code in connector_axis_controller/__init__.py

def get_section_diameter(number: int, section_nr: int) -> float: 
    """Gets the Drilling Diameter of a specific Sections

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

    Args:
        number (int): element ID
        other_number (int): Section number

    Returns:
        float: diameter
    """

get_section_material_name(element, section_nr)

Returns material of a section contact element

Available for script filled attributes

Parameters:

Name	Type	Description	Default
element	int	axis ID	required
section_nr	int	section nr	required

Returns:

Type	Description
str	material name

Source code in connector_axis_controller/__init__.py

def get_section_material_name(element: int, section_nr:int) -> str:
    """Returns material of a section contact element

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

    Args:
        element (int): axis ID
        section_nr (int): section nr

    Returns:
        str: material name
    """

set_bolt_item(number, item)

Sets the Bolt Item

Parameters:

Name	Type	Description	Default
number	int	element ID	required
item	str	Item Guid	required

Source code in connector_axis_controller/__init__.py

def set_bolt_item(number: int, item: str) -> None: 
    """Sets the Bolt Item

    Args:
        number (int): element ID
        item (str): Item Guid
    """

set_bolt_length(number, value)

Sets the Bolt Length

Available for script filled attributes

Parameters:

Name	Type	Description	Default
number	int	element ID	required
value	float	length	required

Source code in connector_axis_controller/__init__.py

def set_bolt_length(number: int, value: float) -> None: 
    """Sets the Bolt Length

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

    Args:
        number (int): element ID
        value (float): length
    """

set_bolt_length_automatic(number, value)

Set bolt length automatic

Parameters:

Name	Type	Description	Default
number	int	element ID	required
value	bool	length automatic	required

Source code in connector_axis_controller/__init__.py

def set_bolt_length_automatic(number: int, value: bool) -> None: 
    """Set bolt length automatic

    Args:
        number (int): element ID
        value (bool): length automatic
    """

set_bolt_over_length(number, value)

Set bolt OverLength

Parameters:

Name	Type	Description	Default
number	int	element ID	required
value	float	length	required

Source code in connector_axis_controller/__init__.py

def set_bolt_over_length(number: int, value: float) -> None: 
    """Set bolt OverLength

    Args:
        number (int): element ID
        value (float): length
    """

set_diameter(number, value)

Sets the Drilling Diameter

Parameters:

Name	Type	Description	Default
number	int	element ID	required
value	float	diameter	required

Source code in connector_axis_controller/__init__.py

def set_diameter(number: int, value: float) -> None: 
    """Sets the Drilling Diameter

    Args:
        number (int): element ID
        value (float): diameter
    """

set_section_diameter(number, section_nr, value)

Sets the Drilling Diameter for a specific Sections

Parameters:

Name	Type	Description	Default
number	int	element ID	required
section_nr	int	Section number	required
value	float	diameter	required

Source code in connector_axis_controller/__init__.py

def set_section_diameter(number: int, section_nr: int, value: float) -> None: 
    """Sets the Drilling Diameter for a specific Sections

    Args:
        number (int): element ID
        section_nr (int): Section number
        value (float): diameter
    """

update_axis_cutting_ability(elements)

Update Connector axis cutting ability.

Parameters:

Name	Type	Description	Default
elements	List[int]	element IDs	required

Source code in connector_axis_controller/__init__.py

def update_axis_cutting_ability(elements:List[int]) -> None:
    """Update Connector axis cutting ability.

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