Skip to content

End-Type Controller

clear_errors()

clear errors

Returns:

Type Description
None

None
Source code in src/endtype_controller/__init__.pyi 
125
126
127
128
129
130
def clear_errors() -> None:
    """clear errors

    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 src/endtype_controller/__init__.pyi 
132
133
134
135
136
137
138
139
140
141
142
def create_new_endtype(endtype_name: str, endtype_id: int, folder_name: str) -> int:
    """Creates a new Endtype

    Parameters:
        endtype_name: endtype_name
        endtype_id: endtype_id
        folder_name: 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 src/endtype_controller/__init__.pyi 
13
14
15
16
17
18
19
20
21
def get_endtype_id(name: str) -> int:
    """Gets the endtypeID by endtypename

    Parameters:
        name: 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 src/endtype_controller/__init__.pyi 
33
34
35
36
37
38
39
40
41
def get_endtype_id_end(element_id: int) -> int:
    """Gets the endtypeID of the end face

    Parameters:
        element_id: element_id

    Returns:
        int
    """

get_endtype_id_facet(element_id, face_number)

get endtype id facet

Parameters:

Name Type Description Default
element_id int

element_id

 required
face_number int

face_number

 required

Returns:

Type Description
int

int
Source code in src/endtype_controller/__init__.pyi 
44
45
46
47
48
49
50
51
52
53
def get_endtype_id_facet(element_id: int, face_number: int) -> int:
    """get endtype id facet

    Parameters:
        element_id: element_id
        face_number: face_number

    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 src/endtype_controller/__init__.pyi 
23
24
25
26
27
28
29
30
31
def get_endtype_id_start(element_id: int) -> int:
    """Gets the endtypeID of the start face

    Parameters:
        element_id: 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 src/endtype_controller/__init__.pyi 
144
145
146
147
148
149
150
151
152
def get_endtype_name(element_id: int) -> str:
    """Gets the endtypename by endtypeID

    Parameters:
        element_id: 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 src/endtype_controller/__init__.pyi 
164
165
166
167
168
169
170
171
172
def get_endtype_name_end(element_id: int) -> str:
    """Gets the endtypename of the end face

    Parameters:
        element_id: element_id

    Returns:
        str
    """

get_endtype_name_facet(element_id, face_number)

get endtype name facet

Parameters:

Name Type Description Default
element_id int

element_id

 required
face_number int

face_number

 required

Returns:

Type Description
str

str
Source code in src/endtype_controller/__init__.pyi 
175
176
177
178
179
180
181
182
183
184
def get_endtype_name_facet(element_id: int, face_number: int) -> str:
    """get endtype name facet

    Parameters:
        element_id: element_id
        face_number: face_number

    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 src/endtype_controller/__init__.pyi 
154
155
156
157
158
159
160
161
162
def get_endtype_name_start(element_id: int) -> str:
    """Gets the endtypename of the start face

    Parameters:
        element_id: element_id

    Returns:
        str
    """

get_existing_dovetail_dado_ids()

Get the existing dado endtypeIDs

Returns:

Type Description
List[int]

list of existing dado endtypeIDs
Source code in src/endtype_controller/__init__.pyi 
207
208
209
210
211
212
def get_existing_dovetail_dado_ids() -> List[int]:
    """Get the existing dado endtypeIDs

    Returns:
        list of existing dado endtypeIDs
    """

get_existing_dovetail_ids()

Get the existing dovetail endtypeIDs

Returns:

Type Description
List[int]

list of existing dovetail endtypeIDs
Source code in src/endtype_controller/__init__.pyi 
200
201
202
203
204
205
def get_existing_dovetail_ids() -> List[int]:
    """Get the existing dovetail endtypeIDs

    Returns:
        list of existing dovetail endtypeIDs
    """

get_existing_japanese_tenon_ids()

Get the existing japanese-tenon endtypeIDs

Returns:

Type Description
List[int]

list of existing japanese-tenon endtypeIDs
Source code in src/endtype_controller/__init__.pyi 
214
215
216
217
218
219
def get_existing_japanese_tenon_ids() -> List[int]:
    """Get the existing japanese-tenon endtypeIDs

    Returns:
        list of existing japanese-tenon endtypeIDs
    """

get_existing_lengthening_ids()

Get the existing lengthening endtypeIDs

Returns:

Type Description
List[int]

list of existing lengthening endtypeIDs
Source code in src/endtype_controller/__init__.pyi 
193
194
195
196
197
198
def get_existing_lengthening_ids() -> List[int]:
    """Get the existing lengthening endtypeIDs

    Returns:
        list of existing lengthening endtypeIDs
    """

get_existing_tenon_ids()

Get the existing tenon endtypeIDs

Returns:

Type Description
List[int]

list of existing tenon endtypeIDs
Source code in src/endtype_controller/__init__.pyi 
186
187
188
189
190
191
def get_existing_tenon_ids() -> List[int]:
    """Get the existing tenon endtypeIDs

    Returns:
        list of existing tenon endtypeIDs
    """

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 src/endtype_controller/__init__.pyi 
 3
 4
 5
 6
 7
 8
 9
10
11
def get_last_error(error_code: int) -> str:
    """get last error

    Parameters:
        error_code: 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 src/endtype_controller/__init__.pyi 
101
102
103
104
105
106
107
108
109
110
def set_endtype_id_end(element_id: int, endtype_id: int) -> None:
    """Sets the endtype to end face by endtypeID

    Parameters:
        element_id: element_id
        endtype_id: endtype_id

    Returns:
        None
    """

set_endtype_id_facet(element_id, endtype_id, face_number)

set endtype id facet

Parameters:

Name Type Description Default
element_id int

element_id

 required
endtype_id int

endtype_id

 required
face_number int

face_number

 required

Returns:

Type Description
None

None
Source code in src/endtype_controller/__init__.pyi 
113
114
115
116
117
118
119
120
121
122
123
def set_endtype_id_facet(element_id: int, endtype_id: int, face_number: int) -> None:
    """set endtype id facet

    Parameters:
        element_id: element_id
        endtype_id: endtype_id
        face_number: face_number

    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 src/endtype_controller/__init__.pyi 
90
91
92
93
94
95
96
97
98
99
def set_endtype_id_start(element_id: int, endtype_id: int) -> None:
    """Sets the endtype to start face by endtypeID

    Parameters:
        element_id: element_id
        endtype_id: 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 src/endtype_controller/__init__.pyi 
66
67
68
69
70
71
72
73
74
75
def set_endtype_name_end(element_id: int, name: str) -> None:
    """Sets the endtype to end face by endtypename

    Parameters:
        element_id: element_id
        name: name

    Returns:
        None
    """

set_endtype_name_facet(element_id, name, face_number)

set endtype name facet

Parameters:

Name Type Description Default
element_id int

element_id

 required
name str

name

 required
face_number int

face_number

 required

Returns:

Type Description
None

None
Source code in src/endtype_controller/__init__.pyi 
78
79
80
81
82
83
84
85
86
87
88
def set_endtype_name_facet(element_id: int, name: str, face_number: int) -> None:
    """set endtype name facet

    Parameters:
        element_id: element_id
        name: name
        face_number: face_number

    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 src/endtype_controller/__init__.pyi 
55
56
57
58
59
60
61
62
63
64
def set_endtype_name_start(element_id: int, name: str) -> None:
    """Sets the endtype to start face by endtypename

    Parameters:
        element_id: element_id
        name: name

    Returns:
        None
    """

start_endtype_dialog()

Start endtype dialog

Returns:

Type Description
int

Selected endtypeID
Source code in src/endtype_controller/__init__.pyi 
221
222
223
224
225
226
def start_endtype_dialog() -> int:
    """Start endtype dialog

    Returns:
        Selected endtypeID
    """