End-Type Controller

create_new_endtype(endtype_name, endtype_id, folder_name)

Create a new endtype

Parameters:

Name	Type	Description	Default
endtype_name	str	name	required
endtype_id	int	endtype id	required
folder_name	str	folder name	required

Returns:

Type	Description
int	endtype id

Source code in endtype_controller/__init__.py

def create_new_endtype(endtype_name: str, endtype_id: int, folder_name: str) -> int:
    """Create a new endtype

    Args:
        endtype_name (str): name
        endtype_id (int): endtype id
        folder_name (str): folder name

    Returns:
        int: endtype id
    """

get_endtype_id(name)

Gets the endtypeID by endtypename

Parameters:

Name	Type	Description	Default
name	str	endtype name	required

Returns:

Type	Description
int	endtype id

Source code in endtype_controller/__init__.py

def get_endtype_id(name: str) -> int:
    """Gets the endtypeID by endtypename

    Args:
        name (str): endtype name

    Returns:
        int: endtype id
    """

get_endtype_id_end(element_id)

Gets the endtypeID of the end face

Parameters:

Name	Type	Description	Default
arg0	int	elmement ID	required

Returns:

Type	Description
int	endtype id

Source code in endtype_controller/__init__.py

def get_endtype_id_end(element_id: int) -> int:
    """Gets the endtypeID of the end face

    Args:
        arg0 (int): elmement ID

    Returns:
        int: endtype id
    """

get_endtype_id_facet(element, face_number)

Gets the endtypeID of the face with a number

Parameters:

Name	Type	Description	Default
element	int	element ID	required
face_number	int	face number	required

Returns:

Type	Description
int	endtype id

Source code in endtype_controller/__init__.py

def get_endtype_id_facet(element: int, face_number: int) -> int:
    """Gets the endtypeID of the face with a number

    Args:
        element (int): element ID
        face_number (int): face number 

    Returns:
        int: endtype id
    """

get_endtype_id_start(element)

Gets the endtypeID of the start face

Parameters:

Name	Type	Description	Default
element	int	element ID	required

Returns:

Type	Description
int	endtype id

Source code in endtype_controller/__init__.py

def get_endtype_id_start(element: int) -> int:
    """Gets the endtypeID of the start face

    Args:
        element (int): element ID

    Returns:
        int: endtype id
    """

get_endtype_name(endtype_id)

Get endtype name

Available for script filled attributes

Parameters:

Name	Type	Description	Default
endtype_id	int	endtype ID	required

Returns:

Type	Description
str	endtype name

Source code in endtype_controller/__init__.py

def get_endtype_name(endtype_id: int) -> str:
    """Get endtype name

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

    Args:
        endtype_id (int): endtype ID

    Returns:
        str: endtype name
    """

get_endtype_name_end(element)

Get endtype name end

Available for script filled attributes

Parameters:

Name	Type	Description	Default
endtype_id	int	endtype ID	required

Returns:

Type	Description
str	endtype name

Source code in endtype_controller/__init__.py

def get_endtype_name_end(element: int) -> str:
    """Get endtype name end

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

    Args:
        endtype_id (int): endtype ID

    Returns:
        str: endtype name
    """

get_endtype_name_facet(element, face_number)

Gets the endtypename of the face with a number

Available for script filled attributes

Parameters:

Name	Type	Description	Default
element	int	element ID	required
face_number	int	face number	required

Returns:

Type	Description
str	endtype name facet

Source code in endtype_controller/__init__.py

def get_endtype_name_facet(element: int, face_number: int) -> str:
    """Gets the endtypename of the face with a number

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

    Args:
        element (int): element ID
        face_number (int): face number

    Returns:
        str: endtype name facet
    """

get_endtype_name_start(element)

Gets the endtypename of the start face

Available for script filled attributes

Parameters:

Name	Type	Description	Default
element	int	element ID	required

Returns:

Type	Description
str	endtype name start

Source code in endtype_controller/__init__.py

def get_endtype_name_start(element: int) -> str:
    """Gets the endtypename of the start face

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

    Args:
        element (int): element ID

    Returns:
        str: endtype name start
    """

set_endtype_id_end(element, endtype_id)

Sets the endtype to end face by endtypeID

Parameters:

Name	Type	Description	Default
element	int	element ID	required
endtype_id	int	endtype ID	required

Source code in endtype_controller/__init__.py

def set_endtype_id_end(element: int, endtype_id: int) -> None:
    """Sets the endtype to end face by endtypeID

    Args:
        element (int): element ID
        endtype_id (int): endtype ID
    """

set_endtype_id_facet(element, endtype_id, face_number)

Sets the endtype to a face by endtypeID

Parameters:

Name	Type	Description	Default
element	int	element ID	required
endtype_id	int	endtype ID	required
face_number	int	face number	required

Source code in endtype_controller/__init__.py

def set_endtype_id_facet(element: int, endtype_id: int, face_number: int) -> None:
    """Sets the endtype to a face by endtypeID

    Args:
        element (int): element ID
        endtype_id (int): endtype ID
        face_number (int): face number
    """

set_endtype_id_start(element, endtype_id)

Sets the endtype to start face by endtypeID

Parameters:

Name	Type	Description	Default
element	int	element ID	required
endtype_id	int	endtype ID	required

Source code in endtype_controller/__init__.py

def set_endtype_id_start(element: int, endtype_id: int) -> None:
    """Sets the endtype to start face by endtypeID

    Args:
        element (int): element ID
        endtype_id (int): endtype ID
    """

set_endtype_name_end(element, face_number)

Sets the endtype to end face by endtypename

Parameters:

Name	Type	Description	Default
element	int	element ID	required
face_number	str	face number	required

Source code in endtype_controller/__init__.py

def set_endtype_name_end(element: int, face_number: str) -> None:
    """Sets the endtype to end face by endtypename

    Args:
        element (int): element ID
        face_number (str): face number
    """

set_endtype_name_facet(element, name, face_number)

Sets the endtype to a face by endtypename

Parameters:

Name	Type	Description	Default
element	int	element ID	required
name	str	name	required
face_number	int	face number	required

Source code in endtype_controller/__init__.py

def set_endtype_name_facet(element: int, name: str, face_number: int) -> None:
    """Sets the endtype to a face by endtypename

    Args:
        element (int): element ID
        name (str): name
        face_number (int): face number
    """

set_endtype_name_start(element, face_number)

Sets the endtype to start face by endtypename

Parameters:

Name	Type	Description	Default
element	int	element ID	required
face_number	str	face number	required

Source code in endtype_controller/__init__.py

def set_endtype_name_start(element: int, face_number: str) -> None:
    """Sets the endtype to start face by endtypename

    Args:
        element (int): element ID
        face_number (str): face number
    """