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

This class represents a NXOpen.CAE.PostScenarioBuilder . More...

Inheritance diagram for NXOpen.CAE.PostScenarioBuilder:
NXOpen.Builder NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Member Functions

unsafe bool CheckSelectionParameters (NXOpen.CAE.PostScenarioSelectionParameters parameters)
 Check the validity of a NXOpen.CAE.PostScenarioSelectionParameters before using it. More...
 
unsafe
NXOpen.CAE.PostScenarioDataDefinition[] 
GetAvailableDataDefinitions ()
 List NXOpen.CAE.PostScenarioDataDefinition s available for the selected NXOpen.CAE.PostScenarioInputDefinition . More...
 
unsafe
NXOpen.CAE.PostScenarioInputDefinition[] 
GetAvailableInputDefinitions ()
 List NXOpen.CAE.PostScenarioInputDefinition applicable to the currently selected NXOpen.CAE.PostScenarioDataDefinition . More...
 
unsafe
NXOpen.CAE.PostScenarioVisualizationDefinition[] 
GetAvailableVisualizationDefinitions ()
 List NXOpen.CAE.PostScenarioVisualizationDefinition s available for the selected NXOpen.CAE.PostScenarioInputDefinition and NXOpen.CAE.PostScenarioDataDefinition . More...
 
unsafe
NXOpen.CAE.PostScenarioSelectionParameters 
NewPostScenarioSelectionParameters ()
 Create a new instance of NXOpen.CAE.PostScenarioSelectionParameters . More...
 
unsafe void SetSelectionParameters (NXOpen.CAE.PostScenarioSelectionParameters parameters)
 Set the NXOpen.CAE.PostScenarioSelectionParameters . More...
 
unsafe void SetViewportIndex (int viewportIndex)
 Set the viewport index for the NXOpen.CAE.PostScenarioBuilder . More...
 
- Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject Commit ()
 Commits any edits that have been applied to the builder. More...
 
unsafe void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
unsafe NXOpen.NXObject[] GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
unsafe NXOpen.NXObject GetObject ()
 Returns the object currently being edited by this builder. More...
 
unsafe void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. 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

unsafe
NXOpen.CAE.PostScenarioDataDefinition 
DataDefinition [get, set]
 Returns or sets the selected NXOpen.CAE.PostScenarioDataDefinition . More...
 
NXOpen.CAE.PostScenarioBuilderDataDefinitionCollection DataDefinitions [get]
 Access available Data Source Data Definitions. More...
 
unsafe
NXOpen.CAE.PostScenarioInputDefinition 
InputDefinition [get, set]
 Returns or sets the selected NXOpen.CAE.PostScenarioInputDefinition . More...
 
unsafe
NXOpen.CAE.PostScenarioPlotTypes 
PlotType [get, set]
 Returns or sets the desired plotting behaviour. More...
 
NXOpen.CAE.PostScenarioBuilderSlotCollection Slots [get]
 Access the data slots available to the currently selected NXOpen.CAE.PostScenarioDescriptor . More...
 
unsafe
NXOpen.CAE.PostScenarioVisualizationDefinition 
Visualization [get, set]
 Returns or sets the selected NXOpen.CAE.PostScenarioVisualizationDefinition . More...
 
- Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder PreviewBuilder [get]
 Returns the preview builder subobject. More...
 
- Properties inherited from NXOpen.TaggedObject
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.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

This class represents a NXOpen.CAE.PostScenarioBuilder .

No support for KF.

Created in NX11.0.0

Member Function Documentation

unsafe bool NXOpen.CAE.PostScenarioBuilder.CheckSelectionParameters ( NXOpen.CAE.PostScenarioSelectionParameters  parameters)
inline

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

Created in NX11.0.0

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

Parameters
parameters
Returns
unsafe NXOpen.CAE.PostScenarioDataDefinition [] NXOpen.CAE.PostScenarioBuilder.GetAvailableDataDefinitions ( )
inline

List NXOpen.CAE.PostScenarioDataDefinition s available for the selected NXOpen.CAE.PostScenarioInputDefinition .

Created in NX11.0.0

Deprecated in NX12.0.0. Use CAE.PostScenarioBuilderSlot.GetAvailableDefinitionsForDataSource instead.

License requirements: None.

Returns
unsafe NXOpen.CAE.PostScenarioInputDefinition [] NXOpen.CAE.PostScenarioBuilder.GetAvailableInputDefinitions ( )
inline

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

Created in NX11.0.0

License requirements: None.

Returns
unsafe NXOpen.CAE.PostScenarioVisualizationDefinition [] NXOpen.CAE.PostScenarioBuilder.GetAvailableVisualizationDefinitions ( )
inline

List NXOpen.CAE.PostScenarioVisualizationDefinition s available for the selected NXOpen.CAE.PostScenarioInputDefinition and NXOpen.CAE.PostScenarioDataDefinition .

Created in NX11.0.0

License requirements: None.

Returns
unsafe NXOpen.CAE.PostScenarioSelectionParameters NXOpen.CAE.PostScenarioBuilder.NewPostScenarioSelectionParameters ( )
inline

Create a new instance of NXOpen.CAE.PostScenarioSelectionParameters .

Created in NX11.0.0

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

Returns
unsafe void NXOpen.CAE.PostScenarioBuilder.SetSelectionParameters ( NXOpen.CAE.PostScenarioSelectionParameters  parameters)
inline

Set the NXOpen.CAE.PostScenarioSelectionParameters .

Created in NX11.0.0

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

Parameters
parameters
unsafe void NXOpen.CAE.PostScenarioBuilder.SetViewportIndex ( int  viewportIndex)
inline

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

Created in NX12.0.0

License requirements: None.

Parameters
viewportIndex

Property Documentation

unsafe NXOpen.CAE.PostScenarioDataDefinition NXOpen.CAE.PostScenarioBuilder.DataDefinition
getset

Returns or sets the selected NXOpen.CAE.PostScenarioDataDefinition .

Created in NX11.0.0

Deprecated in NX12.0.0. Use CAE.PostScenarioBuilderSlot.GetDefinitions and CAE.PostScenarioBuilderSlot.DataSource instead.

License requirements to get this property: None.

License requirements to set this property: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

NXOpen.CAE.PostScenarioBuilderDataDefinitionCollection NXOpen.CAE.PostScenarioBuilder.DataDefinitions
get

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.

Created in NX11.0.0

Deprecated in NX12.0.0. Use CAE.PostScenarioBuilderSlot.GetAvailableDefinitionsForDataSource or CAE.DataSource.GetDefinitions instead.

unsafe NXOpen.CAE.PostScenarioInputDefinition NXOpen.CAE.PostScenarioBuilder.InputDefinition
getset

Returns or sets the selected NXOpen.CAE.PostScenarioInputDefinition .

Created in NX11.0.0

License requirements to get this property: None.

License requirements to set this property: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

unsafe NXOpen.CAE.PostScenarioPlotTypes NXOpen.CAE.PostScenarioBuilder.PlotType
getset

Returns or sets the desired plotting behaviour.

See NXOpen.CAE.PostScenarioPlotTypes .

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

NXOpen.CAE.PostScenarioBuilderSlotCollection NXOpen.CAE.PostScenarioBuilder.Slots
get

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

Created in NX12.0.0

unsafe NXOpen.CAE.PostScenarioVisualizationDefinition NXOpen.CAE.PostScenarioBuilder.Visualization
getset

Returns or sets the selected NXOpen.CAE.PostScenarioVisualizationDefinition .

Created in NX11.0.0

License requirements to get this property: None.

License requirements to set this property: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")


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