3.12

CatalogListInvestigationTypes v1

../_images/CatalogListInvestigationTypes-v1_dlg.png

CatalogListInvestigationTypes dialog.

Summary

Obtains a list of investigation types for active catalogs.

Properties

Name Direction Type Default Description
Session Input string   The session information of the catalog to use.
InvestigationTypes Output str list   A list containing investigation types.

Description

This algorithm obtains a list of investigation types for all catalogs by default or a specific session if specified.

Usage

Example - obtain the investigation types from current catalogs.

# Assuming you have previously logged into the ISIS catalog.
investigation_types = CatalogListInvestigations()

# How many different types of investigations are at ISIS?
print("The number of investigation types are: {}".format(len(investigation_types)))

# Print and view the investigation types
for investigation in investigation_types:
    print("Investigation type is: {}".format(investigation))

Output:

The number of instruments at ISIS is: 9

Investigation type is: Disordered Materials Published Data
...
Investigation type is: unknown

Categories: Algorithms | DataHandling\Catalog

Source

C++ source: CatalogListInvestigationTypes.cpp (last modified: 2016-02-22)

C++ header: CatalogListInvestigationTypes.h (last modified: 2016-02-12)