Utility Controller
api_autostart(name, option)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str |
api name |
required |
option |
int |
option |
required |
Source code in utility_controller/__init__.py
def api_autostart(name: str, option: int) -> None:
"""
Args:
name (str): api name
option (int): option
"""
change_check_and_query_data_to_no_queries()
Source code in utility_controller/__init__.py
def change_check_and_query_data_to_no_queries() -> None:
"""
"""
change_check_and_query_data_to_queries()
Source code in utility_controller/__init__.py
def change_check_and_query_data_to_queries() -> None:
"""
"""
check_autostart(name)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str |
api name |
required |
Returns:
Type | Description |
---|---|
bool |
result |
Source code in utility_controller/__init__.py
def check_autostart(name: str) -> bool:
"""
Args:
name (str): api name
Returns:
bool: result
"""
create_new_guid()
Creates a new GUID
Returns:
Type | Description |
---|---|
str |
GUID |
Source code in utility_controller/__init__.py
def create_new_guid() -> str:
"""Creates a new GUID
Returns:
str: GUID
"""
delete_project_data(data_id)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
data_id |
str |
data id |
required |
Source code in utility_controller/__init__.py
def delete_project_data(data_id: str) -> None:
"""
Args:
data_id (str): data id
"""
disable_auto_display_refresh()
Disables automatic display refresh
Source code in utility_controller/__init__.py
def disable_auto_display_refresh() -> None:
"""Disables automatic display refresh
"""
disable_autostart(name)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str |
api name |
required |
Source code in utility_controller/__init__.py
def disable_autostart(name: str) -> None:
"""
Args:
name (str): api name
"""
enable_auto_display_refresh()
Enables automatic display refresh
Source code in utility_controller/__init__.py
def enable_auto_display_refresh() -> None:
"""Enables automatic display refresh
"""
enable_autostart(name)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str |
api name |
required |
Source code in utility_controller/__init__.py
def enable_autostart(name: str) -> None:
"""
Args:
name (str): api name
"""
execute_shortcut(shortcut_key_modifier, shortcut_key)
Executes a shortcut key modifiers: 0 = None, 1 = Ctrl, 2 = Shift, 4 = Alt shortcut key: F1 = 1, F2 = 2, F3 = 3, ...
Parameters:
Name | Type | Description | Default |
---|---|---|---|
shortcut_key_modifier |
int |
shortcut key modifier |
required |
shortcut_key |
int |
shortcut key |
required |
Source code in utility_controller/__init__.py
def execute_shortcut(shortcut_key_modifier: shortcut_key_modifier, shortcut_key: shortcut_key) -> None:
"""Executes a shortcut
key modifiers: 0 = None, 1 = Ctrl, 2 = Shift, 4 = Alt
shortcut key: F1 = 1, F2 = 2, F3 = 3, ...
Args:
shortcut_key_modifier (int): shortcut key modifier
shortcut_key (int): shortcut key
"""
export_screen_to_image(file, factor)
Exports the screen to an image
Parameters:
Name | Type | Description | Default |
---|---|---|---|
file |
str |
file path |
required |
factor |
int |
image factor |
required |
Source code in utility_controller/__init__.py
def export_screen_to_image(file: str, factor: int) -> None:
"""Exports the screen to an image
Args:
file (str): file path
factor (int): image factor
"""
get_3d_angular_display_units()
Gets the current angular display units
Returns:
Type | Description |
---|---|
str |
value |
Source code in utility_controller/__init__.py
def get_3d_angular_display_units() -> str:
"""Gets the current angular display units
Returns:
str: value
"""
get_3d_angular_units()
summary
Returns:
Type | Description |
---|---|
str |
value |
Source code in utility_controller/__init__.py
def get_3d_angular_units() -> str:
"""_summary_
Returns:
str: value
"""
get_3d_build()
Returns:
Type | Description |
---|---|
int |
3D build |
Source code in utility_controller/__init__.py
def get_3d_build() -> int:
"""
Returns:
int: 3D build
"""
get_3d_build_date()
Gets the current build date
Returns:
Type | Description |
---|---|
str |
value |
Source code in utility_controller/__init__.py
def get_3d_build_date() -> str:
"""Gets the current build date
Returns:
str: value
"""
get_3d_file_name()
Available for script filled attributes
Returns:
Type | Description |
---|---|
str |
file name |
Source code in utility_controller/__init__.py
def get_3d_file_name() -> str:
"""
[:information_source: Available for script filled attributes](#){.mark-text}
Returns:
str: file name
"""
get_3d_file_path()
Returns:
Type | Description |
---|---|
str |
3D file path |
Source code in utility_controller/__init__.py
def get_3d_file_path() -> str:
"""
Returns:
str: 3D file path
"""
get_3d_linear_display_units()
Gets the current display units
Returns:
Type | Description |
---|---|
str |
value |
Source code in utility_controller/__init__.py
def get_3d_linear_display_units() -> str:
"""Gets the current display units
Returns:
str: value
"""
get_3d_linear_units()
Gets the current linear units
Returns:
Type | Description |
---|---|
str |
value |
Source code in utility_controller/__init__.py
def get_3d_linear_units() -> str:
"""Gets the current linear units
Returns:
str: value
"""
get_3d_userprofil_path()
Get 3D userprofile path
Available for script filled attributes
Returns:
Type | Description |
---|---|
str |
path |
Source code in utility_controller/__init__.py
def get_3d_userprofil_path() -> str:
"""Get 3D userprofile path
[:information_source: Available for script filled attributes](#){.mark-text}
Returns:
str: path
"""
get_3d_version()
Returns:
Type | Description |
---|---|
int |
version |
Source code in utility_controller/__init__.py
def get_3d_version() -> int:
"""
Returns:
int: version
"""
get_client_number()
Returns:
Type | Description |
---|---|
str |
client number |
Source code in utility_controller/__init__.py
def get_client_number() -> str:
"""
Returns:
str: client number
"""
get_global_x_offset()
Returns:
Type | Description |
---|---|
float |
global x offset |
Source code in utility_controller/__init__.py
def get_global_x_offset() -> float:
"""
Returns:
float: global x offset
"""
get_global_y_offset()
Returns:
Type | Description |
---|---|
float |
global y offset |
Source code in utility_controller/__init__.py
def get_global_y_offset() -> float:
"""
Returns:
float: global y offset
"""
get_global_z_offset()
Returns:
Type | Description |
---|---|
float |
global z offset |
Source code in utility_controller/__init__.py
def get_global_z_offset() -> float:
"""
Returns:
float: global z offset
"""
get_imperial_string_from_millimetre(value)
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
value |
float |
millimetre value |
required |
Returns:
Type | Description |
---|---|
str |
imperial string |
Source code in utility_controller/__init__.py
def get_imperial_string_from_millimetre(value: float) -> str:
"""
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
value (float): millimetre value
Returns:
str: imperial string
"""
get_language()
Returns:
Type | Description |
---|---|
str |
language |
Source code in utility_controller/__init__.py
def get_language() -> str:
"""
Returns:
str: language
"""
get_licence_first_part()
Gets the first part of the licence
Returns:
Type | Description |
---|---|
str |
first part of license |
Source code in utility_controller/__init__.py
def get_licence_first_part() -> str:
"""Gets the first part of the licence
Returns:
str: first part of license
"""
get_licence_second_part()
Gets the second part of the licence
Returns:
Type | Description |
---|---|
str |
second part of licence |
Source code in utility_controller/__init__.py
def get_licence_second_part() -> str:
"""Gets the second part of the licence
Returns:
str: second part of licence
"""
get_millimetre_from_imperial_string(value)
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
value |
str |
imperial string |
required |
Returns:
Type | Description |
---|---|
float |
millimetre value |
Source code in utility_controller/__init__.py
def get_millimetre_from_imperial_string(value: str) -> float:
"""
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
value (str): imperial string
Returns:
float: millimetre value
"""
get_new_user_file_from_dialog(type_filter)
Gets a new file with a dialog
Parameters:
Name | Type | Description | Default |
---|---|---|---|
type_filter |
str |
dialog file filter |
required |
Returns:
Type | Description |
---|---|
str |
file path |
Source code in utility_controller/__init__.py
def get_new_user_file_from_dialog(type_filter: str) -> str:
"""Gets a new file with a dialog
Args:
type_filter (str): dialog file filter
Returns:
str: file path
"""
get_north_angle()
Returns:
Type | Description |
---|---|
float |
angle |
Source code in utility_controller/__init__.py
def get_north_angle() -> float:
"""
Returns:
float: angle
"""
get_plugin_path()
Get 3D plugin path
Available for script filled attributes
Returns:
Type | Description |
---|---|
str |
path |
Source code in utility_controller/__init__.py
def get_plugin_path() -> str:
"""Get 3D plugin path
[:information_source: Available for script filled attributes](#){.mark-text}
Returns:
str: path
"""
get_project_address()
Available for script filled attributes
Returns:
Type | Description |
---|---|
str |
value |
Source code in utility_controller/__init__.py
def get_project_address() -> str:
"""
[:information_source: Available for script filled attributes](#){.mark-text}
Returns:
str: value
"""
get_project_architect()
Available for script filled attributes
Returns:
Type | Description |
---|---|
str |
project architect |
Source code in utility_controller/__init__.py
def get_project_architect() -> str:
"""
[:information_source: Available for script filled attributes](#){.mark-text}
Returns:
str: project architect
"""
get_project_city()
Available for script filled attributes
Returns:
Type | Description |
---|---|
str |
value |
Source code in utility_controller/__init__.py
def get_project_city() -> str:
"""
[:information_source: Available for script filled attributes](#){.mark-text}
Returns:
str: value
"""
get_project_country()
Available for script filled attributes
Returns:
Type | Description |
---|---|
str |
value |
Source code in utility_controller/__init__.py
def get_project_country() -> str:
"""
[:information_source: Available for script filled attributes](#){.mark-text}
Returns:
str: value
"""
get_project_customer()
Available for script filled attributes
Returns:
Type | Description |
---|---|
str |
value |
Source code in utility_controller/__init__.py
def get_project_customer() -> str:
"""
[:information_source: Available for script filled attributes](#){.mark-text}
Returns:
str: value
"""
get_project_data(data_id)
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
data_id |
str |
project data ID |
required |
Returns:
Type | Description |
---|---|
str |
project data |
Source code in utility_controller/__init__.py
def get_project_data(data_id: str) -> str:
"""
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
data_id (str): project data ID
Returns:
str: project data
"""
get_project_deadline()
Available for script filled attributes
Returns:
Type | Description |
---|---|
str |
value |
Source code in utility_controller/__init__.py
def get_project_deadline() -> str:
"""
[:information_source: Available for script filled attributes](#){.mark-text}
Returns:
str: value
"""
get_project_designer()
Available for script filled attributes
Returns:
Type | Description |
---|---|
str |
value |
Source code in utility_controller/__init__.py
def get_project_designer() -> str:
"""
[:information_source: Available for script filled attributes](#){.mark-text}
Returns:
str: value
"""
get_project_elevation()
Gets the project elevation
Returns:
Type | Description |
---|---|
float |
elevation |
Source code in utility_controller/__init__.py
def get_project_elevation() -> float:
"""Gets the project elevation
Returns:
float: elevation
"""
get_project_guid()
Returns:
Type | Description |
---|---|
str |
GUID |
Source code in utility_controller/__init__.py
def get_project_guid() -> str:
"""
Returns:
str: GUID
"""
get_project_latitude()
Available for script filled attributes
Returns:
Type | Description |
---|---|
float |
latitude |
Source code in utility_controller/__init__.py
def get_project_latitude() -> float:
"""
[:information_source: Available for script filled attributes](#){.mark-text}
Returns:
float: latitude
"""
get_project_longitude(value)
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
value |
float |
longitude |
required |
Source code in utility_controller/__init__.py
def get_project_longitude(value: float) -> None:
"""
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
value (float): longitude
"""
get_project_name()
Available for script filled attributes
Returns:
Type | Description |
---|---|
str |
project name |
Source code in utility_controller/__init__.py
def get_project_name() -> str:
"""
[:information_source: Available for script filled attributes](#){.mark-text}
Returns:
str: project name
"""
get_project_number()
Available for script filled attributes
Returns:
Type | Description |
---|---|
str |
project number |
Source code in utility_controller/__init__.py
def get_project_number() -> str:
"""
[:information_source: Available for script filled attributes](#){.mark-text}
Returns:
str: project number
"""
get_project_part()
Available for script filled attributes
Returns:
Type | Description |
---|---|
str |
project part |
Source code in utility_controller/__init__.py
def get_project_part() -> str:
"""
[:information_source: Available for script filled attributes](#){.mark-text}
Returns:
str: project part
"""
get_project_postal_code()
Available for script filled attributes
Returns:
Type | Description |
---|---|
str |
value |
Source code in utility_controller/__init__.py
def get_project_postal_code() -> str:
"""
[:information_source: Available for script filled attributes](#){.mark-text}
Returns:
str: value
"""
get_project_user_attribute(number)
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
number |
int |
user attribute number |
required |
Returns:
Type | Description |
---|---|
str |
value |
Source code in utility_controller/__init__.py
def get_project_user_attribute(number: int) -> str:
"""
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
number (int): user attribute number
Returns:
str: value
"""
get_project_user_attribute_name(number)
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
number |
int |
user attribute number |
required |
Returns:
Type | Description |
---|---|
str |
value |
Source code in utility_controller/__init__.py
def get_project_user_attribute_name(number: int) -> str:
"""
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
number (int): user attribute number
Returns:
str: value
"""
get_user_bool(text, default=True)
Prompts the user for a boolean
Parameters:
Name | Type | Description | Default |
---|---|---|---|
text |
str |
message |
required |
default |
bool |
Yes default value |
True |
Returns:
Type | Description |
---|---|
bool |
user boolean |
Source code in utility_controller/__init__.py
def get_user_bool(text: str, default: bool = True) -> bool:
"""Prompts the user for a boolean
Args:
text (str): message
default (bool): Yes default value
Returns:
bool: user boolean
"""
get_user_color(color)
Gets a color choosen by the user
Parameters:
Name | Type | Description | Default |
---|---|---|---|
color |
int |
initial color |
required |
Returns:
Type | Description |
---|---|
int |
color number |
Source code in utility_controller/__init__.py
def get_user_color(color: int) -> int:
"""Gets a color choosen by the user
Args:
color (int): initial color
Returns:
int: color number
"""
get_user_double(text)
Prompts the user for a double
Parameters:
Name | Type | Description | Default |
---|---|---|---|
text |
str |
message |
required |
Returns:
Type | Description |
---|---|
float |
user double |
Source code in utility_controller/__init__.py
def get_user_double(text: str) -> float:
"""Prompts the user for a double
Args:
text (str): message
Returns:
float: user double
"""
get_user_file_from_dialog(type_filter)
ets a file with a dialog
Parameters:
Name | Type | Description | Default |
---|---|---|---|
type_filter |
str |
dialog file filter |
required |
Returns:
Type | Description |
---|---|
str |
file path |
Source code in utility_controller/__init__.py
def get_user_file_from_dialog(type_filter: str) -> str:
"""ets a file with a dialog
Args:
type_filter (str): dialog file filter
Returns:
str: file path
"""
get_user_int(text)
Prompts the user for an integer
Parameters:
Name | Type | Description | Default |
---|---|---|---|
text |
str |
message |
required |
Returns:
Type | Description |
---|---|
int |
user integer |
Source code in utility_controller/__init__.py
def get_user_int(text: str) -> int:
"""Prompts the user for an integer
Args:
text (str): message
Returns:
int: user integer
"""
get_user_path_from_dialog_in_path(path)
Prompt user to select a path.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
path |
str |
initial path |
required |
Returns:
Type | Description |
---|---|
str |
selected path |
Source code in utility_controller/__init__.py
def get_user_path_from_dialog_in_path(path: str) -> str:
"""Prompt user to select a path.
Args:
path (str): initial path
Returns:
str: selected path
"""
get_user_point()
Gets a point from the user
Returns:
Type | Description |
---|---|
point_3d |
user point |
Source code in utility_controller/__init__.py
def get_user_point() -> point_3d:
"""Gets a point from the user
Returns:
point_3d: user point
"""
get_user_points()
Prompt user to select points. A rubberband is shown during the point selection.
Examples:
>>> utility_controller.get_user_points()
[[-13717.500000, -23.500000, 6227.000000], [-18757.500000, 8177.500000, 6254.000000],
[-16257.500000, 8177.500000, 6254.000000], [-13757.500000, 8177.500000, 6254.000000]]
Returns:
Type | Description |
---|---|
List[point_3d] |
point list |
Source code in utility_controller/__init__.py
def get_user_points() -> List[point_3d]:
"""Prompt user to select points. A rubberband is shown during the point selection.
Examples:
>>> utility_controller.get_user_points()
[[-13717.500000, -23.500000, 6227.000000], [-18757.500000, 8177.500000, 6254.000000],
[-16257.500000, 8177.500000, 6254.000000], [-13757.500000, 8177.500000, 6254.000000]]
Returns:
List[point_3d]: point list
"""
get_user_points_with_count(count)
Prompt user to select n points. A rubberband is shown during the point selection.
Examples:
>>> utility_controller.get_user_points_with_count(3)
[[-7271.500000, -23.500000, 6227.000000], [-8757.500000, 8177.500000, 6254.000000],
[-11157.500000, 8112.500000, 6254.000000]]
Parameters:
Name | Type | Description | Default |
---|---|---|---|
count |
int |
count points to select |
required |
Returns:
Type | Description |
---|---|
List[point_3d] |
selected points |
Source code in utility_controller/__init__.py
def get_user_points_with_count(count: int) -> List[point_3d]:
"""Prompt user to select n points. A rubberband is shown during the point selection.
Examples:
>>> utility_controller.get_user_points_with_count(3)
[[-7271.500000, -23.500000, 6227.000000], [-8757.500000, 8177.500000, 6254.000000],
[-11157.500000, 8112.500000, 6254.000000]]
Args:
count (int): count points to select
Returns:
List[point_3d]: selected points
"""
get_user_string(text)
Prompts the user for a string
Parameters:
Name | Type | Description | Default |
---|---|---|---|
text |
str |
message |
required |
Returns:
Type | Description |
---|---|
str |
user string |
Source code in utility_controller/__init__.py
def get_user_string(text: str) -> str:
"""Prompts the user for a string
Args:
text (str): message
Returns:
str: user string
"""
hide_north_arrow()
Source code in utility_controller/__init__.py
def hide_north_arrow() -> None:
"""
"""
hide_progress_bar()
Hides the ProgressBar
Source code in utility_controller/__init__.py
def hide_progress_bar() -> None:
"""Hides the ProgressBar
"""
is_north_arrow_visible()
checks if north arrow is visible
Returns:
Type | Description |
---|---|
bool |
is visible |
Source code in utility_controller/__init__.py
def is_north_arrow_visible() -> bool:
"""checks if north arrow is visible
Returns:
bool: is visible
"""
load_attribute_display_settings(file_path)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
file_path |
str |
a file path |
required |
Source code in utility_controller/__init__.py
def load_attribute_display_settings(file_path: str) -> None:
"""
Args:
file_path (str): a file path
"""
load_element_attribute_display_settings(file_path, elements)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
file_path |
str |
a file path |
required |
elements |
List[int] |
element IDs |
required |
Source code in utility_controller/__init__.py
def load_element_attribute_display_settings(file_path: str, elements: List[int]) -> None:
"""
Args:
file_path (str): a file path
elements (List[int]): element IDs
"""
pop_check_and_query_data()
restores check and query prompts utility_controller.pop_check_and_query_data()
Source code in utility_controller/__init__.py
def pop_check_and_query_data() -> None:
"""restores check and query prompts
utility_controller.pop_check_and_query_data()
"""
print_error(text)
prints a message. 'locks' 3d GUI until user confirms with a right-click.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
text |
str |
message/text |
required |
Source code in utility_controller/__init__.py
def print_error(text: str) -> None:
"""prints a message. 'locks' 3d GUI until user confirms with a right-click.
Args:
text (str): message/text
"""
print_message(text, row, column)
Prints a message
Parameters:
Name | Type | Description | Default |
---|---|---|---|
text |
str |
message/text |
required |
row |
int |
a row |
required |
column |
int |
a column |
required |
Source code in utility_controller/__init__.py
def print_message(text: str, row: int, column: int) -> None:
"""Prints a message
Args:
text (str): message/text
row (int): a row
column (int): a column
"""
print_to_console(text)
Prints a message to the console
Parameters:
Name | Type | Description | Default |
---|---|---|---|
text |
str |
message |
required |
Source code in utility_controller/__init__.py
def print_to_console(text: str) -> None:
"""Prints a message to the console
Args:
text (str): message
"""
push_check_and_query_data()
disable check and query prompts utility_controller.push_check_and_query_data() utility_controller.change_check_and_query_data_to_no_queries()
Source code in utility_controller/__init__.py
def push_check_and_query_data() -> None:
"""disable check and query prompts
utility_controller.push_check_and_query_data()
utility_controller.change_check_and_query_data_to_no_queries()
"""
run_external_program(name)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str |
external program name |
required |
Source code in utility_controller/__init__.py
def run_external_program(name: str) -> None:
"""
Args:
name (str): external program name
"""
save_3d_file_silently()
Saves the 3D file silently
Source code in utility_controller/__init__.py
def save_3d_file_silently() -> None:
"""Saves the 3D file silently
"""
set_global_x_offset(offset)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
offset |
float |
a offset value |
required |
Source code in utility_controller/__init__.py
def set_global_x_offset(offset: float) -> None:
"""
Args:
offset (float): a offset value
"""
set_global_y_offset(offset)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
offset |
float |
a offset value |
required |
Source code in utility_controller/__init__.py
def set_global_y_offset(offset: float) -> None:
"""
Args:
offset (float): a offset value
"""
set_global_z_offset(offset)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
offset |
float |
a offset value |
required |
Source code in utility_controller/__init__.py
def set_global_z_offset(offset: float) -> None:
"""
Args:
offset (float): a offset value
"""
set_north_angle(north_angle)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
north_angle |
float |
a angle value |
required |
Source code in utility_controller/__init__.py
def set_north_angle(north_angle: float) -> None:
"""
Args:
north_angle (float): a angle value
"""
set_project_address(value)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
value |
float |
adress |
required |
Source code in utility_controller/__init__.py
def set_project_address(value: float) -> None:
"""
Args:
value (float): adress
"""
set_project_architect(value)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
value |
str |
project architect |
required |
Source code in utility_controller/__init__.py
def set_project_architect(value: str) -> None:
"""
Args:
value (str): project architect
"""
set_project_city(value)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
value |
float |
value |
required |
Source code in utility_controller/__init__.py
def set_project_city(value: float) -> None:
"""
Args:
value (float): value
"""
set_project_country(value)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
value |
float |
value |
required |
Source code in utility_controller/__init__.py
def set_project_country(value: float) -> None:
"""
Args:
value (float): value
"""
set_project_customer(value)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
value |
str |
value |
required |
Source code in utility_controller/__init__.py
def set_project_customer(value: str) -> None:
"""
Args:
value (str): value
"""
set_project_data(data_id, value)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
data_id |
str |
project data ID |
required |
value |
str |
project data |
required |
Source code in utility_controller/__init__.py
def set_project_data(data_id: str, value: str) -> None:
"""
Args:
data_id (str): project data ID
value (str): project data
"""
set_project_deadline(value)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
value |
str |
value |
required |
Source code in utility_controller/__init__.py
def set_project_deadline(value: str) -> None:
"""
Args:
value (str): value
"""
set_project_designer(value)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
value |
str |
value |
required |
Source code in utility_controller/__init__.py
def set_project_designer(value: str) -> None:
"""
Args:
value (str): value
"""
set_project_elevation(value)
Sets the project elevation
Parameters:
Name | Type | Description | Default |
---|---|---|---|
value |
float |
value |
required |
Source code in utility_controller/__init__.py
def set_project_elevation(value: float) -> None:
"""Sets the project elevation
Args:
value (float): value
"""
set_project_latitude()
Returns:
Type | Description |
---|---|
float |
latitude value |
Source code in utility_controller/__init__.py
def set_project_latitude() -> float:
"""
Returns:
float: latitude value
"""
set_project_longitude(value)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
value |
float |
longitude value |
required |
Source code in utility_controller/__init__.py
def set_project_longitude(value: float) -> None:
"""
Args:
value (float): longitude value
"""
set_project_name(value)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
value |
str |
project name |
required |
Source code in utility_controller/__init__.py
def set_project_name(value: str) -> None:
"""
Args:
value (str): project name
"""
set_project_number(value)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
value |
str |
project number |
required |
Source code in utility_controller/__init__.py
def set_project_number(value: str) -> None:
"""
Args:
value (str): project number
"""
set_project_part(value)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
value |
str |
project part |
required |
Source code in utility_controller/__init__.py
def set_project_part(value: str) -> None:
"""
Args:
value (str): project part
"""
set_project_postal_code(value)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
value |
float |
postal code |
required |
Source code in utility_controller/__init__.py
def set_project_postal_code(value: float) -> None:
"""
Args:
value (float): postal code
"""
set_project_user_attribute(number, value)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
number |
int |
user attribute number |
required |
value |
str |
value |
required |
Source code in utility_controller/__init__.py
def set_project_user_attribute(number: int, value: str) -> None:
"""
Args:
number (int): user attribute number
value (str): value
"""
set_project_user_attribute_name(number, value)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
number |
int |
user attribute number |
required |
value |
str |
value |
required |
Source code in utility_controller/__init__.py
def set_project_user_attribute_name(number: int, value: str) -> None:
"""
Args:
number (int): user attribute number
value (str): value
"""
show_north_arrow()
Source code in utility_controller/__init__.py
def show_north_arrow() -> None:
"""
"""
show_progress_bar()
Shows a ProgressBar in the CommandBar
Source code in utility_controller/__init__.py
def show_progress_bar() -> None:
"""Shows a ProgressBar in the CommandBar
"""
update_progress_bar(status)
Updates the ProgressBar with a value
Parameters:
Name | Type | Description | Default |
---|---|---|---|
status |
int |
Value between 0 and 100 |
required |
Source code in utility_controller/__init__.py
def update_progress_bar(status: int) -> None:
"""Updates the ProgressBar with a value
Args:
status (int): Value between 0 and 100
"""