Skip to content

End-Type Controller

endtype_controller special

clear_errors()

clear errors

Returns:

Type Description
None

None

Source code in endtype_controller/__init__.py
def clear_errors() -> None:
    """clear errors
    Args:

    Returns:
        None
    """

create_new_endtype(endtype_name, endtype_id, folder_name)

Creates a new Endtype

Parameters:

Name Type Description Default
endtype_name str

endtype_name

required
endtype_id int

endtype_id

required
folder_name str

folder_name

required

Returns:

Type Description
int

int

Source code in endtype_controller/__init__.py
def create_new_endtype(endtype_name: str, endtype_id: int, folder_name: str) -> int:
    """Creates a new Endtype 
    Args:
        endtype_name ( str): endtype_name
        endtype_id ( int): endtype_id
        folder_name ( str): folder_name

    Returns:
        int
    """

get_endtype_id(name)

Gets the endtypeID by endtypename

Parameters:

Name Type Description Default
name str

name

required

Returns:

Type Description
int

int

Source code in endtype_controller/__init__.py
def get_endtype_id(name: str) -> int:
    """Gets the endtypeID by endtypename 
    Args:
        name ( str): name

    Returns:
        int
    """

get_endtype_id_end(element_id)

Gets the endtypeID of the end face

Parameters:

Name Type Description Default
element_id int

element_id

required

Returns:

Type Description
int

int

Source code in endtype_controller/__init__.py
def get_endtype_id_end(element_id: int) -> int:
    """Gets the endtypeID of the end face 
    Args:
        element_id ( int): element_id

    Returns:
        int
    """

get_endtype_id_facet(a0, a1)

get endtype id facet

Parameters:

Name Type Description Default
a0 int

a0

required
a1 int

a1

required

Returns:

Type Description
int

int

Source code in endtype_controller/__init__.py
def get_endtype_id_facet(a0: int, a1: int) -> int:
    """get endtype id facet
    Args:
        a0 ( int): a0
        a1 ( int): a1

    Returns:
        int
    """

get_endtype_id_start(element_id)

Gets the endtypeID of the start face

Parameters:

Name Type Description Default
element_id int

element_id

required

Returns:

Type Description
int

int

Source code in endtype_controller/__init__.py
def get_endtype_id_start(element_id: int) -> int:
    """Gets the endtypeID of the start face 
    Args:
        element_id ( int): element_id

    Returns:
        int
    """

get_endtype_name(element_id)

Gets the endtypename by endtypeID

Parameters:

Name Type Description Default
element_id int

element_id

required

Returns:

Type Description
str

str

Source code in endtype_controller/__init__.py
def get_endtype_name(element_id: int) -> str:
    """Gets the endtypename by endtypeID 
    Args:
        element_id ( int): element_id

    Returns:
        str
    """

get_endtype_name_end(element_id)

Gets the endtypename of the end face

Parameters:

Name Type Description Default
element_id int

element_id

required

Returns:

Type Description
str

str

Source code in endtype_controller/__init__.py
def get_endtype_name_end(element_id: int) -> str:
    """Gets the endtypename of the end face 
    Args:
        element_id ( int): element_id

    Returns:
        str
    """

get_endtype_name_facet(a0, a1)

get endtype name facet

Parameters:

Name Type Description Default
a0 int

a0

required
a1 int

a1

required

Returns:

Type Description
str

str

Source code in endtype_controller/__init__.py
def get_endtype_name_facet(a0: int, a1: int) -> str:
    """get endtype name facet
    Args:
        a0 ( int): a0
        a1 ( int): a1

    Returns:
        str
    """

get_endtype_name_start(element_id)

Gets the endtypename of the start face

Parameters:

Name Type Description Default
element_id int

element_id

required

Returns:

Type Description
str

str

Source code in endtype_controller/__init__.py
def get_endtype_name_start(element_id: int) -> str:
    """Gets the endtypename of the start face 
    Args:
        element_id ( int): element_id

    Returns:
        str
    """

get_last_error(error_code)

get last error

Parameters:

Name Type Description Default
error_code int

error_code

required

Returns:

Type Description
str

str

Source code in endtype_controller/__init__.py
def get_last_error(error_code: int) -> str:
    """get last error
    Args:
        error_code ( int): error_code

    Returns:
        str
    """

set_endtype_id_end(element_id, endtype_id)

Sets the endtype to end face by endtypeID

Parameters:

Name Type Description Default
element_id int

element_id

required
endtype_id int

endtype_id

required

Returns:

Type Description
None

None

Source code in endtype_controller/__init__.py
def set_endtype_id_end(element_id: int, endtype_id: int) -> None:
    """Sets the endtype to end face by endtypeID 
    Args:
        element_id ( int): element_id
        endtype_id ( int): endtype_id

    Returns:
        None
    """

set_endtype_id_facet(a0, a1, a2)

set endtype id facet

Parameters:

Name Type Description Default
a0 int

a0

required
a1 int

a1

required
a2 int

a2

required

Returns:

Type Description
None

None

Source code in endtype_controller/__init__.py
def set_endtype_id_facet(a0: int, a1: int, a2: int) -> None:
    """set endtype id facet
    Args:
        a0 ( int): a0
        a1 ( int): a1
        a2 ( int): a2

    Returns:
        None
    """

set_endtype_id_start(element_id, endtype_id)

Sets the endtype to start face by endtypeID

Parameters:

Name Type Description Default
element_id int

element_id

required
endtype_id int

endtype_id

required

Returns:

Type Description
None

None

Source code in endtype_controller/__init__.py
def set_endtype_id_start(element_id: int, endtype_id: int) -> None:
    """Sets the endtype to start face by endtypeID 
    Args:
        element_id ( int): element_id
        endtype_id ( int): endtype_id

    Returns:
        None
    """

set_endtype_name_end(element_id, name)

Sets the endtype to end face by endtypename

Parameters:

Name Type Description Default
element_id int

element_id

required
name str

name

required

Returns:

Type Description
None

None

Source code in endtype_controller/__init__.py
def set_endtype_name_end(element_id: int, name: str) -> None:
    """Sets the endtype to end face by endtypename 
    Args:
        element_id ( int): element_id
        name ( str): name

    Returns:
        None
    """

set_endtype_name_facet(a0, a1, a2)

set endtype name facet

Parameters:

Name Type Description Default
a0 int

a0

required
a1 str

a1

required
a2 int

a2

required

Returns:

Type Description
None

None

Source code in endtype_controller/__init__.py
def set_endtype_name_facet(a0: int, a1: str, a2: int) -> None:
    """set endtype name facet
    Args:
        a0 ( int): a0
        a1 ( str): a1
        a2 ( int): a2

    Returns:
        None
    """

set_endtype_name_start(element_id, name)

Sets the endtype to start face by endtypename

Parameters:

Name Type Description Default
element_id int

element_id

required
name str

name

required

Returns:

Type Description
None

None

Source code in endtype_controller/__init__.py
def set_endtype_name_start(element_id: int, name: str) -> None:
    """Sets the endtype to start face by endtypename 
    Args:
        element_id ( int): element_id
        name ( str): name

    Returns:
        None
    """