Application

class caris.ui.Application

An instance of the Caris Application.

get_active_cloud((Application)self) → object :

Get the active cloud, i.e. the cloud that is selected in the Layers window of the application

Returns:

The active cloud, or None

get_active_coverage((Application)self) → object :

Get the active coverage, i.e. the coverage that is selected in the Layers window of the application

Returns:

The active coverage, or None

get_active_dataset((Application)self) → Dataset :

Get the active dataset, i.e. the dataset that is selected in the Layers window of the application

Returns:

The active dataset, or None

get_active_raster((Application)self) → object :

Get the active raster, i.e. the raster that is selected in the Layers window of the application

Returns:

The active raster, or None

get_active_vrs((Application)self) → object :

Get the active vrs, i.e the variable resolution surface that is selected in the Layers window of the application

Returns:

The active variable resolution surface, or None

get_selected_features((Application)self) → FeatureRange :

Get the features that are selected in the application

Returns:

The selected features, or None

question_ok_cancel((Application)self, (str)title, (str)text) → bool :

Display a message box asking the user an Ok/Cancel question

Parameters:

• title (str) – The message box’s title

• text (str) – The message box’s text, or question

Returns:

True if ok was selected

question_yes_no((Application)self, (str)title, (str)text) → bool :

Display a message box asking the user a yes/no question

Parameters:

• title (str) – The message box’s title

• text (str) – The message box’s text, or question

Returns:

True if yes was selected

run_process_dialog((Application)self, (Process)process) → None :

Display the Run Process Model dialog with a specified process to run

Parameters:

process – The process to run

select_from_list((Application)self, (str)title, (str)text, (vector_string)choices) → object :

Display a dialog asking the user to select an item from a list

Parameters:

• title (str) – The title of the dialog box

• text (str) – The text to display on the dialog

• choices (list of str) – The list of choices

Returns:

The selected item as a string, or None if the dialog was canceled