NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Member Functions | Properties | List of all members
NXOpen.CAE.PostScenarioManager Class Reference

Manages the creation of a NXOpen.CAE.PostScenarioBuilder . More...

Inheritance diagram for NXOpen.CAE.PostScenarioManager:
NXOpen.Utilities.NXRemotableObject IMessageSink

Public Member Functions

unsafe void AlignAxesOfPlots ()
 Aligns axes of all plots. More...
 
unsafe bool CheckScenarioDataSourceCompatible (NXOpen.CAE.PostScenarioParameters scenarioParameters)
 Checks if the scenario and the data source set in the NXOpen.CAE.PostScenarioParameters are compatible. More...
 
unsafe bool CheckValidDataSource (NXOpen.CAE.PostScenarioParameters scenarioParameters)
 Checks if the data source set in NXOpen.CAE.PostScenarioParameters is valid. More...
 
unsafe
NXOpen.CAE.PostScenarioBuilder 
CreatePostScenarioBuilderFromParameters (NXOpen.CAE.PostScenarioParameters scenarioParameters)
 Creates a transient object NXOpen.CAE.PostScenarioBuilder that is responsible for creating a post scenario object. More...
 
unsafe
NXOpen.CAE.PostScenarioBuilder 
CreatePostScenarioBuilderFromScenario (NXOpen.CAE.PostScenario scenario)
 Creates a builder for the Scenario retrieved from a Visualized Scenario. More...
 
unsafe
NXOpen.CAE.PostScenarioBuilder 
CreatePostScenarioBuilderFromViewport (int viewportIndex)
 Creates a builder for the Scenario retrieved from a Visualized Scenario from a certain viewport. More...
 
unsafe
NXOpen.CAE.ViewportSynchronizationOptions 
CreateViewportSynchronizationOptions ()
 Creates viewport synchronization options. More...
 
unsafe NXOpen.CAE.PostScenario[] GetScenariosInViewport (int viewportIndex)
 Retrieves the scenarios plotted in viewportIndex. More...
 
unsafe
NXOpen.CAE.PostScenarioVisualizationCustomizationCollection 
GetVisualizationCustomizationCollection (int viewPortId)
 Returns customization data for all visualizations (which support customization) in the specified viewPortId. More...
 
unsafe
NXOpen.CAE.PostScenarioParameters 
NewPostScenarioParameters ()
 Creates a transient object NXOpen.CAE.PostScenarioParameters that contains the settings required to create a post scenario. More...
 
unsafe void RemoveScenario (NXOpen.CAE.PostScenario scenario)
 Removes a visualized NXOpen.CAE.PostScenario from the viewport it is displayed in. More...
 
unsafe void SetViewportSynchronizationOptions (NXOpen.CAE.ViewportSynchronizationOptions options)
 Sets the viewport synchronization options. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Properties

NXOpen.CAE.PostScenarioAvailableDescriptorCollection AvailablePostScenarioDescriptors [get]
 Contains a NXOpen.CAE.PostScenarioAvailableDescriptorCollection . More...
 
NXOpen.CAE.DataSourceCollection DataSources [get]
 Contains a NXOpen.CAE.DataSourceCollection . More...
 
NXOpen.CAE.PostScenarioDescriptorCollection PostScenarioDescriptors [get]
 Contains a NXOpen.CAE.PostScenarioDescriptorCollection . More...
 
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.Utilities.NXRemotableObject
void initialize ()
 <exclude> More...
 

Detailed Description

Manages the creation of a NXOpen.CAE.PostScenarioBuilder .

To obtain an instance of this class use NXOpen.CAE.PostScenarioManager .

Created in NX11.0.0

Member Function Documentation

unsafe void NXOpen.CAE.PostScenarioManager.AlignAxesOfPlots ( )
inline

Aligns axes of all plots.

Ensures that all axes of a certain quantity (force, displacement, etc.) and data type (real, imaginary, magnitude, etc.) have the same unit, axis type and limits.

Created in NX1847.0.0

Deprecated in NX1872.0.0. UseNXOpen.CAE.Xyplot.XYPlotManager.AlignAxesOfPlots instead.

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

unsafe bool NXOpen.CAE.PostScenarioManager.CheckScenarioDataSourceCompatible ( NXOpen.CAE.PostScenarioParameters  scenarioParameters)
inline

Checks if the scenario and the data source set in the NXOpen.CAE.PostScenarioParameters are compatible.

Created in NX11.0.0

Deprecated in NX12.0.0. This function is no longer useful because the new API only lists compatible data sources per slot.

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

Parameters
scenarioParameters
Returns
unsafe bool NXOpen.CAE.PostScenarioManager.CheckValidDataSource ( NXOpen.CAE.PostScenarioParameters  scenarioParameters)
inline

Checks if the data source set in NXOpen.CAE.PostScenarioParameters is valid.

Created in NX11.0.0

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

Parameters
scenarioParameters
Returns
unsafe NXOpen.CAE.PostScenarioBuilder NXOpen.CAE.PostScenarioManager.CreatePostScenarioBuilderFromParameters ( NXOpen.CAE.PostScenarioParameters  scenarioParameters)
inline

Creates a transient object NXOpen.CAE.PostScenarioBuilder that is responsible for creating a post scenario object.

Created in NX11.0.0

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

Parameters
scenarioParameters
Returns
unsafe NXOpen.CAE.PostScenarioBuilder NXOpen.CAE.PostScenarioManager.CreatePostScenarioBuilderFromScenario ( NXOpen.CAE.PostScenario  scenario)
inline

Creates a builder for the Scenario retrieved from a Visualized Scenario.

Created in NX12.0.0

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

Parameters
scenario
Returns
unsafe NXOpen.CAE.PostScenarioBuilder NXOpen.CAE.PostScenarioManager.CreatePostScenarioBuilderFromViewport ( int  viewportIndex)
inline

Creates a builder for the Scenario retrieved from a Visualized Scenario from a certain viewport.

This method fails if the specified viewport does not represent a Visualized Scenario.

Created in NX11.0.0

Deprecated in NX12.0.0. Use NXOpen.CAE.PostScenarioManager.CreatePostScenarioBuilderFromScenario instead. Scenarios can be retrieved via NXOpen.CAE.PostScenarioManager.GetScenariosInViewport .

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

Parameters
viewportIndex
Returns
unsafe NXOpen.CAE.ViewportSynchronizationOptions NXOpen.CAE.PostScenarioManager.CreateViewportSynchronizationOptions ( )
inline

Creates viewport synchronization options.

These options synchronize selections and probes across the selected viewports.

Created in NX12.0.0

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

Returns
unsafe NXOpen.CAE.PostScenario [] NXOpen.CAE.PostScenarioManager.GetScenariosInViewport ( int  viewportIndex)
inline

Retrieves the scenarios plotted in viewportIndex.

Created in NX1847.0.0

License requirements: None.

Parameters
viewportIndex
Returns
unsafe NXOpen.CAE.PostScenarioVisualizationCustomizationCollection NXOpen.CAE.PostScenarioManager.GetVisualizationCustomizationCollection ( int  viewPortId)
inline

Returns customization data for all visualizations (which support customization) in the specified viewPortId.

Created in NX1847.0.0

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

Parameters
viewPortId
Returns
unsafe NXOpen.CAE.PostScenarioParameters NXOpen.CAE.PostScenarioManager.NewPostScenarioParameters ( )
inline

Creates a transient object NXOpen.CAE.PostScenarioParameters that contains the settings required to create a post scenario.

The object should be destroyed after the post scenario is created.

Created in NX11.0.0

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

Returns
unsafe void NXOpen.CAE.PostScenarioManager.RemoveScenario ( NXOpen.CAE.PostScenario  scenario)
inline

Removes a visualized NXOpen.CAE.PostScenario from the viewport it is displayed in.

The corresponding plots will be removed from the display. If there are other scenarios visualized in that viewport, their corresponding plots will continue to be visible. If there are no more scenarios displayed in that viewport, the viewport is returned to the model view.

Created in NX1847.0.0

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

Parameters
scenario
unsafe void NXOpen.CAE.PostScenarioManager.SetViewportSynchronizationOptions ( NXOpen.CAE.ViewportSynchronizationOptions  options)
inline

Sets the viewport synchronization options.

These options synchronize selections and probes across the selected viewports. Passing a null reference (Nothing in Visual Basic) will disable all synchronizations.

Created in NX12.0.0

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

Parameters
options

Property Documentation

NXOpen.CAE.PostScenarioAvailableDescriptorCollection NXOpen.CAE.PostScenarioManager.AvailablePostScenarioDescriptors
get

Contains a NXOpen.CAE.PostScenarioAvailableDescriptorCollection .

This member enumerates scenario descriptors available for use with the Data Sources selected in NXOpen.CAE.PostScenarioManager.DataSources .

Created in NX12.0.0

NXOpen.CAE.DataSourceCollection NXOpen.CAE.PostScenarioManager.DataSources
get

Contains a NXOpen.CAE.DataSourceCollection .

The NXOpen.CAE.DataSource s added to this collection will be used to populate the NXOpen.CAE.PostScenarioManager.AvailablePostScenarioDescriptors . These data sources will also be the ones available to any NXOpen.CAE.PostScenarioBuilder in the current session.

Created in NX12.0.0

NXOpen.CAE.PostScenarioDescriptorCollection NXOpen.CAE.PostScenarioManager.PostScenarioDescriptors
get
Tag NXOpen.CAE.PostScenarioManager.Tag
get

Returns the tag of this object.


The documentation for this class was generated from the following file:
Copyright 2019 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.