PostScenarioBuilderSlot Class — NXOpen Python API Reference 12.0.0 documentation

# PostScenarioBuilderSlot Class

class `NXOpen.CAE.``PostScenarioBuilderSlot`

  Bases: `NXOpen.Builder`

  This class represents a `NXOpen.CAE.PostScenarioBuilderSlot`.

  A `NXOpen.CAE.PostScenarioBuilder` can contain multiple slots to which `NXOpen.CAE.DataSource`s and respective :py:class:`NXOpen.CAE.PostScenarioDefinition`s are assigned. The scenario retrieves data from these data sources in order to process it and display it via :py:meth:`NXOpen.CAE.PostScenarioBuilder.Visualization`.

  No support for KF.

  New in version NX12.0.0.

# Properties

Property | Description
--- | ---
DataSource | Returns the selected `CAE.DataSource`
Name | Returns the name of the input definition slot.
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
Destroy | Deletes the builder, and cleans up any objects created by the builder.
GetAvailableDataSources | List `CAE.DataSource` applicable to the current slot.
GetAvailableDefinitionsForDataSource | List `NXOpen.CAE.PostScenarioDefinition` applicable to the current slot for a particular `CAE.DataSource`.
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit.
GetDefinitions | Returns the selected `CAE.PostScenarioDefinition`
GetObject | Returns the object currently being edited by this builder.
SetDataSource | Assign data to this slot.
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Property Detail

## DataSource

`PostScenarioBuilderSlot.``DataSource`

  Returns the selected `CAE.DataSource`

  `-------------------------------------`

  Getter Method

  Signature `DataSource`

  Returns: |
  Return type: | `NXOpen.CAE.DataSource`

  New in version NX12.0.0.

  License requirements: None.

## Name

`PostScenarioBuilderSlot.``Name`

  Returns the name of the input definition slot.

  `-------------------------------------`

  Getter Method

  Signature `Name`

  Returns: |
  Return type: | str

  New in version NX12.0.0.

  License requirements: None.

# Method Detail

## GetAvailableDataSources

`PostScenarioBuilderSlot.``GetAvailableDataSources`

  List `CAE.DataSource` applicable to the current slot.

  Data Sources are retrieved from `NXOpen.CAE.PostScenarioManager.DataSources()` and filtered to only contain data applicable to the current scenario slot.

  Signature `GetAvailableDataSources()`

  Returns: |
  Return type: | list of `NXOpen.CAE.DataSource`

  New in version NX12.0.0.

  License requirements: None.

## GetAvailableDefinitionsForDataSource

`PostScenarioBuilderSlot.``GetAvailableDefinitionsForDataSource`

  List `NXOpen.CAE.PostScenarioDefinition` applicable to the current slot for a particular `CAE.DataSource`.

  This is a utility method. The dataSource parameter should have been retrieved via `NXOpen.CAE.PostScenarioBuilderSlot.GetAvailableDataSources()`.

  Signature `GetAvailableDefinitionsForDataSource(dataSource)`

  Parameters: | dataSource (`NXOpen.CAE.DataSource`) –
  Returns: |
  Return type: | list of `NXOpen.CAE.PostScenarioDefinition`

  New in version NX12.0.0.

  License requirements: None.

## GetDefinitions

`PostScenarioBuilderSlot.``GetDefinitions`

  Returns the selected `CAE.PostScenarioDefinition`

  Signature `GetDefinitions()`

  Returns: |
  Return type: | list of `NXOpen.CAE.PostScenarioDefinition`

  New in version NX12.0.0.

  License requirements: None.

## SetDataSource

`PostScenarioBuilderSlot.``SetDataSource`

  Overloaded method SetDataSource

  - `SetDataSource(dataSource, dataDefinition)`
  - `SetDataSource(dataSource, dataDefinitions)`

  `-------------------------------------`

  Assign data to this slot. This assignment applies to the owning `NXOpen.CAE.PostScenarioBuilder`. The `NXOpen.CAE.DataSource` and `NXOpen.CAE.PostScenarioDataDefinition` have to be consistent and relevant to this scenario. See `NXOpen.CAE.PostScenarioBuilderSlot.GetAvailableDataSources()` and `NXOpen.CAE.PostScenarioBuilderSlot.GetAvailableDefinitionsForDataSource()`. This overload should be used for data assignments.

  Signature `SetDataSource(dataSource, dataDefinition)`

  Parameters:

  - dataSource (`NXOpen.CAE.DataSource`) – should be retrieved through `NXOpen.CAE.PostScenarioBuilderSlot.GetAvailableDataSources()`.
  - dataDefinition (`NXOpen.CAE.PostScenarioDefinition`) – Should be retrieved by calling `NXOpen.CAE.PostScenarioBuilderSlot.GetAvailableDefinitionsForDataSource()` with the dataSource parameter.

  New in version NX12.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

  `-------------------------------------`

  Assign data to this slot. This assignment applies to the owning `NXOpen.CAE.PostScenarioBuilder`. The `NXOpen.CAE.DataSource` and `NXOpen.CAE.PostScenarioDefinition` have to be consistent and relevant to this scenario. See `NXOpen.CAE.PostScenarioBuilderSlot.GetAvailableDataSources()` and `NXOpen.CAE.PostScenarioBuilderSlot.GetAvailableDefinitionsForDataSource()`. This overload should be used for FE Model assignments.

  Signature `SetDataSource(dataSource, dataDefinitions)`

  Parameters:

  - dataSource (`NXOpen.CAE.DataSource`) – should be retrieved through `NXOpen.CAE.PostScenarioBuilderSlot.GetAvailableDataSources()`.
  - dataDefinitions (list of `NXOpen.CAE.PostScenarioDefinition`) – Should be retrieved by calling `NXOpen.CAE.PostScenarioBuilderSlot.GetAvailableDefinitionsForDataSource()` with the dataSource parameter.

  New in version NX12.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

  `-------------------------------------`

## Validate

`PostScenarioBuilderSlot.``Validate`

  Validate whether the inputs to the component are sufficient for commit to be called.

  If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

  Signature `Validate()`

  Returns: | Was self validation successful
  Return type: | bool

  New in version NX3.0.1.

  License requirements: None.