pysyncrosim.scenario.Scenario.datasheets

Scenario.datasheets(name=None, summary=True, optional=False, empty=False, filter_column=None, filter_value=None, include_key=False, show_full_paths=False, return_hidden=False)

Retrieves a DataFrame of Scenario Datasheets.

Parameters:

  • name (String, optional) – Datasheet name. The default is None.

  • summary (Logical or String, optional) – Whether to list package Datasheets or core Datasheets. The default is True.

  • optional (Logical, optional) – Return optional columns. The default is False.

  • empty (Logical, optional) – If True, returns an empty Datasheet. The default is False.

  • filter_column (String) – The column and value to filter the output Datasheet by (e.g. “TransitionGroupID=20”). The default is None.

  • include_key (Logical, optional) – Whether to include the primary key of the Datasheet, corresponding to the SQL database. Default is False.

  • show_full_paths (Logical, optional) – Whether to show the full path of any external files in the Datasheet. Default is False.

  • return_hidden (Logical, optional) – If set to True, returns all records in a Datasheet, including those hidden from the user. Results in a slower query. Default is False.

Returns:

If optional=False, then returns a DataFrame of Datasheet information including Package, Name, and Display Name. If optional=True, also returns Scope, Is Single, and Is Output.

Return type:

pandas.DataFrame