CatalogGetDataSets dialog.
Table of Contents
| Name | Direction | Type | Default | Description |
|---|---|---|---|---|
| InvestigationId | Input | string | Mandatory | ID of the selected investigation |
| Session | Input | string | The session information of the catalog to use. | |
| OutputWorkspace | Output | TableWorkspace | Mandatory | The name of the workspace to store the results. |
This algorithm retrieves the information of the datasets associated to an investigation, and saves the results to a workspace.
Example - obtain the datasets for a given catalog investigation.
# Assumes you have logged in and stored the session information that is
# returned from CatalogLogin() inside the session variable.
datasets = CatalogGetDataSets(InvestigationId = '1193002', Session = session.getPropertyValue("Session"))
# Verify that we have any datafiles in the returned workspace.
print("The number of datasets for this investigation is: {}".format(len(datasets)))
Output:
The number of datafiles in this investigation is: 2
Categories: AlgorithmIndex | DataHandling\Catalog
C++ source: CatalogGetDataSets.cpp (last modified: 2019-06-04)
C++ header: CatalogGetDataSets.h (last modified: 2018-10-05)