PostScenarioBuilder Class

class NXOpen.CAE.PostScenarioBuilder

Bases: NXOpen.Builder

This class represents a NXOpen.CAE.PostScenarioBuilder.

No support for KF.

New in version NX11.0.0.

Properties

Property	Description
DataDefinition	Returns or sets the selected NXOpen.CAE.PostScenarioDataDefinition.
InputDefinition	Returns or sets the selected NXOpen.CAE.PostScenarioInputDefinition.
Tag	Returns the Tag for this object.
Visualization	Returns or sets the selected NXOpen.CAE.PostScenarioVisualizationDefinition.
DataDefinitions	Access available Data Source Data Definitions. A data definition defines the format of some data exposed by a data source. These are matched with a scenario Input Definition to provide a scenario interpreted view of that data.
Slots	Access the data slots available to the currently selected NXOpen.CAE.PostScenarioDescriptor. A post processing scenario can contain multiple slots to which :py:class:`NXOpen.CAE.DataSource`s and respective :py:class:`NXOpen.CAE.PostScenarioDataDefinition`s are assigned. The scenario retrieves data from these data sources in order to process it and display it via NXOpen.CAE.PostScenarioBuilder.Visualization().

Methods

Method	Description
CheckSelectionParameters	Check the validity of a NXOpen.CAE.PostScenarioSelectionParameters before using it.
Commit	Commits any edits that have been applied to the builder.
Destroy	Deletes the builder, and cleans up any objects created by the builder.
GetAvailableDataDefinitions	List NXOpen.CAE.PostScenarioDataDefinition`s available for the selected :py:class:`NXOpen.CAE.PostScenarioInputDefinition.
GetAvailableInputDefinitions	List NXOpen.CAE.PostScenarioInputDefinition applicable to the currently selected NXOpen.CAE.PostScenarioDataDefinition.
GetAvailableVisualizationDefinitions	List NXOpen.CAE.PostScenarioVisualizationDefinition`s available for the selected            :py:class:`NXOpen.CAE.PostScenarioInputDefinition and NXOpen.CAE.PostScenarioDataDefinition.
GetCommittedObjects	For builders that create more than one object, this method returns the objects that are created by commit.
GetObject	Returns the object currently being edited by this builder.
NewPostScenarioSelectionParameters	Create a new instance of NXOpen.CAE.PostScenarioSelectionParameters.
SetSelectionParameters	Set the NXOpen.CAE.PostScenarioSelectionParameters.
SetViewportIndex	Set the viewport index for the NXOpen.CAE.PostScenarioBuilder.
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

DataDefinition

PostScenarioBuilder.DataDefinition

Returns or sets the selected NXOpen.CAE.PostScenarioDataDefinition.

-------------------------------------

Getter Method

Signature DataDefinition

Returns: Return type:NXOpen.CAE.PostScenarioDataDefinition

New in version NX11.0.0.

Deprecated since version NX12.0.0: Use CAE.PostScenarioBuilderSlot.GetDefinitions() and CAE.PostScenarioBuilderSlot.DataSource() instead.

License requirements: None.

-------------------------------------

Setter Method

Signature DataDefinition

Parameters:dataDefinition (NXOpen.CAE.PostScenarioDataDefinition) –

New in version NX11.0.0.

Deprecated since version NX12.0.0: Use CAE.PostScenarioBuilderSlot.SetDataSource() instead.

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

InputDefinition

PostScenarioBuilder.InputDefinition

Returns or sets the selected NXOpen.CAE.PostScenarioInputDefinition.

-------------------------------------

Getter Method

Signature InputDefinition

Returns: Return type:NXOpen.CAE.PostScenarioInputDefinition

New in version NX11.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature InputDefinition

Parameters:inputDefinition (NXOpen.CAE.PostScenarioInputDefinition) –

New in version NX11.0.0.

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

Visualization

PostScenarioBuilder.Visualization

Returns or sets the selected NXOpen.CAE.PostScenarioVisualizationDefinition.

-------------------------------------

Getter Method

Signature Visualization

Returns: Return type:NXOpen.CAE.PostScenarioVisualizationDefinition

New in version NX11.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Visualization

Parameters:visualization (NXOpen.CAE.PostScenarioVisualizationDefinition) –

New in version NX11.0.0.

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

DataDefinitions

PostScenarioBuilder.DataDefinitions

Access available Data Source Data Definitions.

A data definition defines the format of some data exposed by a data source. These are matched with a scenario Input Definition to provide a scenario interpreted view of that data.

Signature DataDefinitions

New in version NX11.0.0.

Deprecated since version NX12.0.0: Use CAE.PostScenarioBuilderSlot.GetAvailableDefinitionsForDataSource() or CAE.DataSource.GetDefinitions() instead.

Returns: Return type:NXOpen.CAE.PostScenarioBuilderDataDefinitionCollection

Slots

PostScenarioBuilder.Slots

Access the data slots available to the currently selected NXOpen.CAE.PostScenarioDescriptor.

A post processing scenario can contain multiple slots to which NXOpen.CAE.DataSource`s and respective :py:class:`NXOpen.CAE.PostScenarioDataDefinition`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.

Signature Slots

New in version NX12.0.0.

Returns: Return type:NXOpen.CAE.PostScenarioBuilderSlotCollection

Method Detail

CheckSelectionParameters

PostScenarioBuilder.CheckSelectionParameters

Check the validity of a NXOpen.CAE.PostScenarioSelectionParameters before using it.

Signature CheckSelectionParameters(parameters)

Parameters:parameters (NXOpen.CAE.PostScenarioSelectionParameters) – Returns: Return type:bool

New in version NX11.0.0.

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

GetAvailableDataDefinitions

PostScenarioBuilder.GetAvailableDataDefinitions

List NXOpen.CAE.PostScenarioDataDefinition`s available for the selected :py:class:`NXOpen.CAE.PostScenarioInputDefinition.

Signature GetAvailableDataDefinitions()

Returns: Return type:list of NXOpen.CAE.PostScenarioDataDefinition

New in version NX11.0.0.

Deprecated since version NX12.0.0: Use CAE.PostScenarioBuilderSlot.GetAvailableDefinitionsForDataSource() instead.

License requirements: None.

GetAvailableInputDefinitions

PostScenarioBuilder.GetAvailableInputDefinitions

List NXOpen.CAE.PostScenarioInputDefinition applicable to the currently selected NXOpen.CAE.PostScenarioDataDefinition.

Signature GetAvailableInputDefinitions()

Returns: Return type:list of NXOpen.CAE.PostScenarioInputDefinition

New in version NX11.0.0.

License requirements: None.

GetAvailableVisualizationDefinitions

PostScenarioBuilder.GetAvailableVisualizationDefinitions

List NXOpen.CAE.PostScenarioVisualizationDefinition`s available for the selected :py:class:`NXOpen.CAE.PostScenarioInputDefinition and NXOpen.CAE.PostScenarioDataDefinition.

Signature GetAvailableVisualizationDefinitions()

Returns: Return type:list of NXOpen.CAE.PostScenarioVisualizationDefinition

New in version NX11.0.0.

License requirements: None.

NewPostScenarioSelectionParameters

PostScenarioBuilder.NewPostScenarioSelectionParameters

Create a new instance of NXOpen.CAE.PostScenarioSelectionParameters.

Signature NewPostScenarioSelectionParameters()

Returns: Return type:NXOpen.CAE.PostScenarioSelectionParameters

New in version NX11.0.0.

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

SetSelectionParameters

PostScenarioBuilder.SetSelectionParameters

Set the NXOpen.CAE.PostScenarioSelectionParameters.

Signature SetSelectionParameters(parameters)

Parameters:parameters (NXOpen.CAE.PostScenarioSelectionParameters) –

New in version NX11.0.0.

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

SetViewportIndex

PostScenarioBuilder.SetViewportIndex

Set the viewport index for the NXOpen.CAE.PostScenarioBuilder.

Signature SetViewportIndex(viewportIndex)

Parameters:viewportIndex (int) –

New in version NX12.0.0.

License requirements: None.

Validate

PostScenarioBuilder.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.