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

Represents a NXOpen.CAE.PostProcessingSessionApplicator which can be used to visualize a post processing pession. More...

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

Public Member Functions

unsafe bool GetApplyActiveLayoutState ()
 Gets the the apply active layout state flag. More...
 
unsafe bool GetCleanUpDataSources ()
 Gets doCleanDataSources value, if doCleanDataSources is true the applicator will perform a cleaning operation during the commit method. More...
 
unsafe string GetNthDataSourceName (int dataSourceIndex)
 Gets the file name of the DataSource at given dataSourceIndex. More...
 
unsafe string GetNthDataSourcePath (int dataSourceIndex)
 Gets the file path of the DataSource at given dataSourceIndex. More...
 
unsafe
NXOpen.CAE.CaePostProcessingSessionApplicatorLoadAction 
GetNthLoadingActions (int dataSourceIndex)
 Gets the loading action to be performed for the DataSource at given dataSourceIndex. More...
 
unsafe int GetNumDataSources ()
 Get the number of data sources found in the file previously loaded by a call to the NXOpen.CAE.PostProcessingSessionApplicator.SetFile method. More...
 
unsafe void SetApplyActiveLayoutState (bool apply)
 Sets the apply active layout state flag. More...
 
unsafe void SetCleanUpDataSources (bool doCleanDataSources)
 Configure the given applicator to perform a cleaning operation during the commit method. More...
 
unsafe void SetFile (string filePath)
 Sets the exported post processing pession that will be applied. More...
 
unsafe void SetNthDataSourcePath (int dataSourceIndex, string sourcePath)
 Sets the file path of the DataSource at given dataSourceIndex. More...
 
unsafe void SetNthLoadingActions (int dataSourceIndex, NXOpen.CAE.CaePostProcessingSessionApplicatorLoadAction action)
 Sets the loading action to be performed for the DataSource at given dataSourceIndex. 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...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 
- Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder PreviewBuilder [get]
 Returns the preview builder subobject. More...
 

Detailed Description

Represents a NXOpen.CAE.PostProcessingSessionApplicator which can be used to visualize a post processing pession.

Not support KF.

Created in NX12.0.0

Member Function Documentation

unsafe bool NXOpen.CAE.PostProcessingSessionApplicator.GetApplyActiveLayoutState ( )
inline

Gets the the apply active layout state flag.

If true, the active layout state is applied during the commit method. Saves a new layout state if the applying fails. The default value is false.

Created in NX1847.0.0

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

Returns
unsafe bool NXOpen.CAE.PostProcessingSessionApplicator.GetCleanUpDataSources ( )
inline

Gets doCleanDataSources value, if doCleanDataSources is true the applicator will perform a cleaning operation during the commit method.

See the description of JA_CAE_POST_PROCESSING_SESSION_APPLICATOR_set_clean_up_data_sources .

Created in NX1899.0.0

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

Returns
unsafe string NXOpen.CAE.PostProcessingSessionApplicator.GetNthDataSourceName ( int  dataSourceIndex)
inline

Gets the file name of the DataSource at given dataSourceIndex.

That index needs to be in the [0..N-1] range, where N is the number returned by the NXOpen.CAE.PostProcessingSessionApplicator.GetNumDataSources method. The DataSources are added when commit of the builder is called.

Created in NX1872.0.0

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

Parameters
dataSourceIndex
Returns
unsafe string NXOpen.CAE.PostProcessingSessionApplicator.GetNthDataSourcePath ( int  dataSourceIndex)
inline

Gets the file path of the DataSource at given dataSourceIndex.

That index needs to be in the [0..N-1] range, where N is the number returned by the NXOpen.CAE.PostProcessingSessionApplicator.GetNumDataSources method. The DataSources are added when commit of the builder is called.

Created in NX1872.0.0

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

Parameters
dataSourceIndex
Returns
unsafe NXOpen.CAE.CaePostProcessingSessionApplicatorLoadAction NXOpen.CAE.PostProcessingSessionApplicator.GetNthLoadingActions ( int  dataSourceIndex)
inline

Gets the loading action to be performed for the DataSource at given dataSourceIndex.

That index needs to be in the [0..N-1] range, where N is the number returned by the NXOpen.CAE.PostProcessingSessionApplicator.GetNumDataSources method. The DataSources are added when commit of the builder is called. The default value is JA_CAE_POST_PROCESSING_SESSION_APPLICATOR_load_action_do_nothing.

Created in NX1899.0.0

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

Parameters
dataSourceIndex
Returns
unsafe int NXOpen.CAE.PostProcessingSessionApplicator.GetNumDataSources ( )
inline

Get the number of data sources found in the file previously loaded by a call to the NXOpen.CAE.PostProcessingSessionApplicator.SetFile method.

The DataSources are added when commit of the builder is called.

Created in NX1872.0.0

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

Returns
unsafe void NXOpen.CAE.PostProcessingSessionApplicator.SetApplyActiveLayoutState ( bool  apply)
inline

Sets the apply active layout state flag.

If true, the active layout state is applied during the commit method. Saves a new layout state if the applying fails. The default value is false.

Created in NX1847.0.0

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

Parameters
apply
unsafe void NXOpen.CAE.PostProcessingSessionApplicator.SetCleanUpDataSources ( bool  doCleanDataSources)
inline

Configure the given applicator to perform a cleaning operation during the commit method.

This operation makes sure the session only contains the data sources from the imported file, all the other data sources are removed if the doCleanDataSources is set to true. By default doCleanDataSources is set to false.

Created in NX1899.0.0

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

Parameters
doCleanDataSources
unsafe void NXOpen.CAE.PostProcessingSessionApplicator.SetFile ( string  filePath)
inline

Sets the exported post processing pession that will be applied.

Created in NX12.0.0

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

Parameters
filePath
unsafe void NXOpen.CAE.PostProcessingSessionApplicator.SetNthDataSourcePath ( int  dataSourceIndex,
string  sourcePath 
)
inline

Sets the file path of the DataSource at given dataSourceIndex.

That index needs to be in the [0..N-1] range, where N is the number returned by the NXOpen.CAE.PostProcessingSessionApplicator.GetNumDataSources method. The DataSources are added when commit of the builder is called.

Created in NX1872.0.0

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

Parameters
dataSourceIndex
sourcePath
unsafe void NXOpen.CAE.PostProcessingSessionApplicator.SetNthLoadingActions ( int  dataSourceIndex,
NXOpen.CAE.CaePostProcessingSessionApplicatorLoadAction  action 
)
inline

Sets the loading action to be performed for the DataSource at given dataSourceIndex.

That index needs to be in the [0..N-1] range, where N is the number returned by the NXOpen.CAE.PostProcessingSessionApplicator.GetNumDataSources method. The DataSources are added when commit of the builder is called. The default value is JA_CAE_POST_PROCESSING_SESSION_APPLICATOR_load_action_do_nothing.

Created in NX1899.0.0

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

Parameters
dataSourceIndex
action

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