Skip to content

List Controller

check_position_numbers_part_list()

Checks the part list numbers and returns the element ids with discrepancies

Returns:

Type Description
List[int]

element ids with discrepancies
Source code in src/list_controller/__init__.pyi 
42
43
44
45
46
47
def check_position_numbers_part_list() -> List[int]:
    """Checks the part list numbers and returns the element ids with discrepancies

    Returns:
        element ids with discrepancies
    """

check_position_numbers_production_list()

Checks the production list numbers and returns the element ids with discrepancies

Returns:

Type Description
List[int]

element ids with discrepancies
Source code in src/list_controller/__init__.pyi 
35
36
37
38
39
40
def check_position_numbers_production_list() -> List[int]:
    """Checks the production list numbers and returns the element ids with discrepancies

    Returns:
        element ids with discrepancies
    """

clear_errors()

clear errors

Returns:

Type Description
None

None
Source code in src/list_controller/__init__.pyi 
49
50
51
52
53
54
def clear_errors() -> None:
    """clear errors

    Returns:
        None
    """

export_cover_list(element_id_list, file_path)

Exports a Wall/Roof/Floor list

Parameters:

Name Type Description Default
element_id_list List[int]

element_id_list

 required
file_path str

file_path

 required

Returns:

Type Description
None

None
Source code in src/list_controller/__init__.pyi 
146
147
148
149
150
151
152
153
154
155
def export_cover_list(element_id_list: List[int], file_path: str) -> None:
    """Exports a Wall/Roof/Floor list

    Parameters:
        element_id_list: element_id_list
        file_path: file_path

    Returns:
        None
    """

export_cover_list_with_settings(element_id_list, file_path, settings_file_path)

Exports a Wall/Roof/Floor list with settings file

Parameters:

Name Type Description Default
element_id_list List[int]

element_id_list

 required
file_path str

file_path

 required
settings_file_path str

settings_file_path

 required

Returns:

Type Description
None

None
Source code in src/list_controller/__init__.pyi 
157
158
159
160
161
162
163
164
165
166
167
def export_cover_list_with_settings(element_id_list: List[int], file_path: str, settings_file_path: str) -> None:
    """Exports a Wall/Roof/Floor list with settings file

    Parameters:
        element_id_list: element_id_list
        file_path: file_path
        settings_file_path: settings_file_path

    Returns:
        None
    """

export_part_list(element_id_list, file_path)

Exports a part list

Parameters:

Name Type Description Default
element_id_list List[int]

element_id_list

 required
file_path str

file_path

 required

Returns:

Type Description
None

None
Source code in src/list_controller/__init__.pyi 
24
25
26
27
28
29
30
31
32
33
def export_part_list(element_id_list: List[int], file_path: str) -> None:
    """Exports a part list

    Parameters:
        element_id_list: element_id_list
        file_path: file_path

    Returns:
        None
    """

export_part_list_with_settings(element_id_list, file_path, settings_file_path)

export part list with settings

Parameters:

Name Type Description Default
element_id_list List[int]

element_id_list

 required
file_path str

file_path

 required
settings_file_path str

settings_file_path

 required

Returns:

Type Description
None

None
Source code in src/list_controller/__init__.pyi 
68
69
70
71
72
73
74
75
76
77
78
def export_part_list_with_settings(element_id_list: List[int], file_path: str, settings_file_path: str) -> None:
    """export part list with settings

    Parameters:
        element_id_list: element_id_list
        file_path: file_path
        settings_file_path: settings_file_path

    Returns:
        None
    """

export_production_list(element_id_list, file_path)

Exports a production list

Parameters:

Name Type Description Default
element_id_list List[int]

element_id_list

 required
file_path str

file_path

 required

Returns:

Type Description
None

None
Source code in src/list_controller/__init__.pyi 
13
14
15
16
17
18
19
20
21
22
def export_production_list(element_id_list: List[int], file_path: str) -> None:
    """Exports a production list

    Parameters:
        element_id_list: element_id_list
        file_path: file_path

    Returns:
        None
    """

export_production_list_with_settings(element_id_list, file_path, settings_file_path)

export production list with settings

Parameters:

Name Type Description Default
element_id_list List[int]

element_id_list

 required
file_path str

file_path

 required
settings_file_path str

settings_file_path

 required

Returns:

Type Description
None

None
Source code in src/list_controller/__init__.pyi 
56
57
58
59
60
61
62
63
64
65
66
def export_production_list_with_settings(element_id_list: List[int], file_path: str, settings_file_path: str) -> None:
    """export production list with settings

    Parameters:
        element_id_list: element_id_list
        file_path: file_path
        settings_file_path: settings_file_path

    Returns:
        None
    """

generate_new_part_list_numbers(a0)

generate new part list numbers

Parameters:

Name Type Description Default
a0 List[int]

a0

 required

Returns:

Type Description
None

None
Source code in src/list_controller/__init__.pyi 
90
91
92
93
94
95
96
97
98
def generate_new_part_list_numbers(a0: List[int]) -> None:
    """generate new part list numbers

    Parameters:
        a0: a0

    Returns:
        None
    """

generate_new_part_list_silently(a0, a1, a2, a3)

generate new part list silently

Parameters:

Name Type Description Default
a0 List[int]

a0

 required
a1 int

a1

 required
a2 bool

a2

 required
a3 bool

a3

 required

Returns:

Type Description
None

None
Source code in src/list_controller/__init__.pyi 
133
134
135
136
137
138
139
140
141
142
143
144
def generate_new_part_list_silently(a0: List[int], a1: int, a2: bool, a3: bool) -> None:
    """generate new part list silently

    Parameters:
        a0: a0
        a1: a1
        a2: a2
        a3: a3

    Returns:
        None
    """

generate_new_production_list_numbers(a0)

generate new production list numbers

Parameters:

Name Type Description Default
a0 List[int]

a0

 required

Returns:

Type Description
None

None
Source code in src/list_controller/__init__.pyi 
80
81
82
83
84
85
86
87
88
def generate_new_production_list_numbers(a0: List[int]) -> None:
    """generate new production list numbers

    Parameters:
        a0: a0

    Returns:
        None
    """

generate_new_production_list_silently(a0, a1, a2, a3)

generate new production list silently

Parameters:

Name Type Description Default
a0 List[int]

a0

 required
a1 int

a1

 required
a2 bool

a2

 required
a3 bool

a3

 required

Returns:

Type Description
None

None
Source code in src/list_controller/__init__.pyi 
120
121
122
123
124
125
126
127
128
129
130
131
def generate_new_production_list_silently(a0: List[int], a1: int, a2: bool, a3: bool) -> None:
    """generate new production list silently

    Parameters:
        a0: a0
        a1: a1
        a2: a2
        a3: a3

    Returns:
        None
    """

get_last_error(error_code)

Gets the last error

Parameters:

Name Type Description Default
error_code int

error_code

 required

Returns:

Type Description
str

error string
Source code in src/list_controller/__init__.pyi 
 3
 4
 5
 6
 7
 8
 9
10
11
def get_last_error(error_code: int) -> str:
    """Gets the last error

    Parameters:
        error_code: error_code

    Returns:
        error string
    """

load_part_list_calculation_settings(a0)

load part list calculation settings

Parameters:

Name Type Description Default
a0 str

a0

 required

Returns:

Type Description
None

None
Source code in src/list_controller/__init__.pyi 
110
111
112
113
114
115
116
117
118
def load_part_list_calculation_settings(a0: str) -> None:
    """load part list calculation settings

    Parameters:
        a0: a0

    Returns:
        None
    """

load_production_list_calculation_settings(a0)

load production list calculation settings

Parameters:

Name Type Description Default
a0 str

a0

 required

Returns:

Type Description
None

None
Source code in src/list_controller/__init__.pyi 
100
101
102
103
104
105
106
107
108
def load_production_list_calculation_settings(a0: str) -> None:
    """load production list calculation settings

    Parameters:
        a0: a0

    Returns:
        None
    """