Skip to content

Connector Axis Controller

check_axis(axis_id)

Returns if the axis is valid.

Parameters:

Name Type Description Default
axis_id int

axis_id

 required

Returns:

Type Description
bool

bool
Source code in src/connector_axis_controller/__init__.pyi 
71
72
73
74
75
76
77
78
79
def check_axis(axis_id: int) -> bool:
    """Returns if the axis is valid.

    Parameters:
        axis_id: axis_id

    Returns:
        bool
    """

clear_errors()

clear errors

Returns:

Type Description
None

None
Source code in src/connector_axis_controller/__init__.pyi 
81
82
83
84
85
86
def clear_errors() -> None:
    """clear errors

    Returns:
        None
    """

create_blank_connector(a0, a1, a2)

create blank connector

Parameters:

Name Type Description Default
a0 float

a0

 required
a1 point_3d

a1

 required
a2 point_3d

a2

 required

Returns:

Type Description
int

int
Source code in src/connector_axis_controller/__init__.pyi 
109
110
111
112
113
114
115
116
117
118
119
def create_blank_connector(a0: float, a1: point_3d, a2: point_3d) -> int:
    """create blank connector

    Parameters:
        a0: a0
        a1: a1
        a2: a2

    Returns:
        int
    """

create_standard_connector(axis_name, point1, point2)

Creates a standard connector axis between two points.

Parameters:

Name Type Description Default
axis_name str

axis_name

 required
point1 point_3d

point1

 required
point2 point_3d

point2

 required

Returns:

Type Description
int

int
Source code in src/connector_axis_controller/__init__.pyi 
14
15
16
17
18
19
20
21
22
23
24
def create_standard_connector(axis_name: str, point1: point_3d, point2: point_3d) -> int:
    """Creates a standard connector axis between two points.

    Parameters:
        axis_name: axis_name
        point1: point1
        point2: point2

    Returns:
        int
    """

get_axis_item_material(guid)

Returns the material of an axis item.

Parameters:

Name Type Description Default
guid str

guid

 required

Returns:

Type Description
str

str
Source code in src/connector_axis_controller/__init__.pyi 
231
232
233
234
235
236
237
238
239
def get_axis_item_material(guid: str) -> str:
    """Returns the material of an axis item.

    Parameters:
        guid: guid

    Returns:
        str
    """

get_axis_item_name(guid)

Returns the name of an axis item.

Parameters:

Name Type Description Default
guid str

guid

 required

Returns:

Type Description
str

str
Source code in src/connector_axis_controller/__init__.pyi 
221
222
223
224
225
226
227
228
229
def get_axis_item_name(guid: str) -> str:
    """Returns the name of an axis item.

    Parameters:
        guid: guid

    Returns:
        str
    """

get_axis_item_norm(guid)

Returns the norm of an axis item.

Parameters:

Name Type Description Default
guid str

guid

 required

Returns:

Type Description
str

str
Source code in src/connector_axis_controller/__init__.pyi 
241
242
243
244
245
246
247
248
249
def get_axis_item_norm(guid: str) -> str:
    """Returns the norm of an axis item.

    Parameters:
        guid: guid

    Returns:
        str
    """

get_axis_item_order_number(guid)

Returns the strength category of an axis item.

Parameters:

Name Type Description Default
guid str

guid

 required

Returns:

Type Description
str

str
Source code in src/connector_axis_controller/__init__.pyi 
272
273
274
275
276
277
278
279
280
def get_axis_item_order_number(guid: str) -> str:
    """Returns the strength category of an axis item.

    Parameters:
        guid: guid

    Returns:
        str
    """

get_axis_item_strength_category(guid)

Returns the strength category of an axis item.

Parameters:

Name Type Description Default
guid str

guid

 required

Returns:

Type Description
str

str
Source code in src/connector_axis_controller/__init__.pyi 
251
252
253
254
255
256
257
258
259
def get_axis_item_strength_category(guid: str) -> str:
    """Returns the strength category of an axis item.

    Parameters:
        guid: guid

    Returns:
        str
    """

get_axis_item_user_field(guid, user_item_nr)

Returns an userfield value of an axis item.

Parameters:

Name Type Description Default
guid str

guid

 required
user_item_nr int

user_item_nr

 required

Returns:

Type Description
str

str
Source code in src/connector_axis_controller/__init__.pyi 
261
262
263
264
265
266
267
268
269
270
def get_axis_item_user_field(guid: str, user_item_nr: int) -> str:
    """Returns an userfield value of an axis item.

    Parameters:
        guid: guid
        user_item_nr: user_item_nr

    Returns:
        str
    """

get_axis_items_guids(axis_id)

Returns a list of GUIDs of all axis items.

Parameters:

Name Type Description Default
axis_id int

axis_id

 required

Returns:

Type Description
List[str]

List[str]
Source code in src/connector_axis_controller/__init__.pyi 
211
212
213
214
215
216
217
218
219
def get_axis_items_guids(axis_id: int) -> List[str]:
    """Returns a list of GUIDs of all axis items.

    Parameters:
        axis_id: axis_id

    Returns:
        List[str]
    """

get_bolt_diameter(a0)

get bolt diameter

Parameters:

Name Type Description Default
a0 int

a0

 required

Returns:

Type Description
float

float
Source code in src/connector_axis_controller/__init__.pyi 
324
325
326
327
328
329
330
331
332
def get_bolt_diameter(a0: int) -> float:
    """get bolt diameter

    Parameters:
        a0: a0

    Returns:
        float
    """

get_bolt_item_guid(axis_id)

Gets the Guid of the Bolt Item

Parameters:

Name Type Description Default
axis_id int

axis_id

 required

Returns:

Type Description
str

str
Source code in src/connector_axis_controller/__init__.pyi 
190
191
192
193
194
195
196
197
198
def get_bolt_item_guid(axis_id: int) -> str:
    """Gets the Guid of the Bolt Item

    Parameters:
        axis_id: axis_id

    Returns:
        str
    """

get_bolt_length(axis_id)

Gets the Bolt Length

Parameters:

Name Type Description Default
axis_id int

axis_id

 required

Returns:

Type Description
float

float
Source code in src/connector_axis_controller/__init__.pyi 
149
150
151
152
153
154
155
156
157
def get_bolt_length(axis_id: int) -> float:
    """Gets the Bolt Length

    Parameters:
        axis_id: axis_id

    Returns:
        float
    """

get_bolt_length_automatic(axis_id)

Returns if Bolt Length Automatic is set

Parameters:

Name Type Description Default
axis_id int

axis_id

 required

Returns:

Type Description
bool

bool
Source code in src/connector_axis_controller/__init__.pyi 
180
181
182
183
184
185
186
187
188
def get_bolt_length_automatic(axis_id: int) -> bool:
    """Returns if Bolt Length Automatic is set

    Parameters:
        axis_id: axis_id

    Returns:
        bool
    """

get_bolt_order_number(axis_id)

Returns the ordernumber of a bolt item.

Parameters:

Name Type Description Default
axis_id int

axis_id

 required

Returns:

Type Description
str

str
Source code in src/connector_axis_controller/__init__.pyi 
282
283
284
285
286
287
288
289
290
def get_bolt_order_number(axis_id: int) -> str:
    """Returns the ordernumber of a bolt item.

    Parameters:
        axis_id: axis_id

    Returns:
        str
    """

get_bolt_over_length(axis_id)

Gets the Bolt OverLength

Parameters:

Name Type Description Default
axis_id int

axis_id

 required

Returns:

Type Description
float

float
Source code in src/connector_axis_controller/__init__.pyi 
159
160
161
162
163
164
165
166
167
def get_bolt_over_length(axis_id: int) -> float:
    """Gets the Bolt OverLength

    Parameters:
        axis_id: axis_id

    Returns:
        float
    """

get_item_guid_by_name(name, item_type)

get item guid by name

Parameters:

Name Type Description Default
name str

name

 required
item_type int

item_type

 required

Returns:

Type Description
str

str
Source code in src/connector_axis_controller/__init__.pyi 
138
139
140
141
142
143
144
145
146
147
def get_item_guid_by_name(name: str, item_type: int) -> str:
    """get item guid by name

    Parameters:
        name: name
        item_type: item_type

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

    Parameters:
        error_code: error_code

    Returns:
        str
    """

get_section_contact_element(a0, a1)

get section contact element

Parameters:

Name Type Description Default
a0 float

a0

 required
a1 int

a1

 required

Returns:

Type Description
int

int
Source code in src/connector_axis_controller/__init__.pyi 
313
314
315
316
317
318
319
320
321
322
def get_section_contact_element(a0: float, a1: int) -> int:
    """get section contact element

    Parameters:
        a0: a0
        a1: a1

    Returns:
        int
    """

get_section_count(axis_id)

Returns the number of sections.

Parameters:

Name Type Description Default
axis_id int

axis_id

 required

Returns:

Type Description
int

int
Source code in src/connector_axis_controller/__init__.pyi 
292
293
294
295
296
297
298
299
300
def get_section_count(axis_id: int) -> int:
    """Returns the number of sections.

    Parameters:
        axis_id: axis_id

    Returns:
        int
    """

get_section_diameter(axis_id, section_nr)

Gets the Drilling Diameter of a specific Sections

Parameters:

Name Type Description Default
axis_id int

axis_id

 required
section_nr int

section_nr

 required

Returns:

Type Description
float

float
Source code in src/connector_axis_controller/__init__.pyi 
200
201
202
203
204
205
206
207
208
209
def get_section_diameter(axis_id: int, section_nr: int) -> float:
    """Gets the Drilling Diameter of a specific Sections

    Parameters:
        axis_id: axis_id
        section_nr: section_nr

    Returns:
        float
    """

get_section_material_name(axis_id, section_nr)

Returns material of a section contact element.

Parameters:

Name Type Description Default
axis_id int

axis_id

 required
section_nr int

section_nr

 required

Returns:

Type Description
str

str
Source code in src/connector_axis_controller/__init__.pyi 
302
303
304
305
306
307
308
309
310
311
def get_section_material_name(axis_id: int, section_nr: int) -> str:
    """Returns material of a section contact element.

    Parameters:
        axis_id: axis_id
        section_nr: section_nr

    Returns:
        str
    """

get_standard_connector_list()

Returns a list of all standard connectors.

Returns:

Type Description
List[str]

List[str]
Source code in src/connector_axis_controller/__init__.pyi 
334
335
336
337
338
339
def get_standard_connector_list() -> List[str]:
    """Returns a list of all standard connectors.

    Returns:
        List[str]
    """

import_from_file(a0)

import from file

Parameters:

Name Type Description Default
a0 str

a0

 required

Returns:

Type Description
None

None
Source code in src/connector_axis_controller/__init__.pyi 
121
122
123
124
125
126
127
128
129
def import_from_file(a0: str) -> None:
    """import from file

    Parameters:
        a0: a0

    Returns:
        None
    """

set_bolt_item(axis_id, item_guid)

Sets the Bolt Item

Parameters:

Name Type Description Default
axis_id int

axis_id

 required
item_guid str

item_guid

 required

Returns:

Type Description
None

None
Source code in src/connector_axis_controller/__init__.pyi 
 98
 99
100
101
102
103
104
105
106
107
def set_bolt_item(axis_id: int, item_guid: str) -> None:
    """Sets the Bolt Item

    Parameters:
        axis_id: axis_id
        item_guid: item_guid

    Returns:
        None
    """

set_bolt_length(axis_id, length)

Sets the Bolt Length

Parameters:

Name Type Description Default
axis_id int

axis_id

 required
length float

length

 required

Returns:

Type Description
None

None
Source code in src/connector_axis_controller/__init__.pyi 
26
27
28
29
30
31
32
33
34
35
def set_bolt_length(axis_id: int, length: float) -> None:
    """Sets the Bolt Length

    Parameters:
        axis_id: axis_id
        length: length

    Returns:
        None
    """

set_bolt_length_automatic(axis_id, length_automatic)

Sets the Bolt Length Automatic

Parameters:

Name Type Description Default
axis_id int

axis_id

 required
length_automatic bool

length_automatic

 required

Returns:

Type Description
None

None
Source code in src/connector_axis_controller/__init__.pyi 
37
38
39
40
41
42
43
44
45
46
def set_bolt_length_automatic(axis_id: int, length_automatic: bool) -> None:
    """Sets the Bolt Length Automatic

    Parameters:
        axis_id: axis_id
        length_automatic: length_automatic

    Returns:
        None
    """

set_bolt_over_length(axis_id, over_length)

Sets the Bolt OverLength

Parameters:

Name Type Description Default
axis_id int

axis_id

 required
over_length float

over_length

 required

Returns:

Type Description
None

None
Source code in src/connector_axis_controller/__init__.pyi 
169
170
171
172
173
174
175
176
177
178
def set_bolt_over_length(axis_id: int, over_length: float) -> None:
    """Sets the Bolt OverLength

    Parameters:
        axis_id: axis_id
        over_length: over_length

    Returns:
        None
    """

set_diameter(axis_id, diameter)

Sets the Drilling Diameter for all Sections

Parameters:

Name Type Description Default
axis_id int

axis_id

 required
diameter float

diameter

 required

Returns:

Type Description
None

None
Source code in src/connector_axis_controller/__init__.pyi 
48
49
50
51
52
53
54
55
56
57
def set_diameter(axis_id: int, diameter: float) -> None:
    """Sets the Drilling Diameter for all Sections

    Parameters:
        axis_id: axis_id
        diameter: diameter

    Returns:
        None
    """

set_section_diameter(axis_id, section_nr, diameter)

Sets the Drilling Diameter for a specific Sections

Parameters:

Name Type Description Default
axis_id int

axis_id

 required
section_nr int

section_nr

 required
diameter float

diameter

 required

Returns:

Type Description
None

None
Source code in src/connector_axis_controller/__init__.pyi 
59
60
61
62
63
64
65
66
67
68
69
def set_section_diameter(axis_id: int, section_nr: int, diameter: float) -> None:
    """Sets the Drilling Diameter for a specific Sections

    Parameters:
        axis_id: axis_id
        section_nr: section_nr
        diameter: diameter

    Returns:
        None
    """

start_configuration_dialog()

Starts the ConnectorAxis configuration dialog.

Returns:

Type Description
None

None
Source code in src/connector_axis_controller/__init__.pyi 
131
132
133
134
135
136
def start_configuration_dialog() -> None:
    """Starts the ConnectorAxis configuration dialog.

    Returns:
        None
    """

update_axis_cutting_ability(axis_i_ds)

updates the Connection Config (CuttingAbility) of Axis/VBAs

Parameters:

Name Type Description Default
axis_i_ds List[int]

axis_i_ds

 required

Returns:

Type Description
None

None
Source code in src/connector_axis_controller/__init__.pyi 
88
89
90
91
92
93
94
95
96
def update_axis_cutting_ability(axis_i_ds: List[int]) -> None:
    """updates the Connection Config (CuttingAbility) of Axis/VBAs

    Parameters:
        axis_i_ds: axis_i_ds

    Returns:
        None
    """