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

The collection of Plots the scenario is attached to. More...

Inheritance diagram for NXOpen.CAE.PostScenarioPlotHandleCollection:
NXOpen.TaggedObjectCollection NXOpen.Utilities.NXRemotableObject IEnumerable IMessageSink

Public Member Functions

unsafe
NXOpen.CAE.PostScenarioPlotHandle 
FindObject (string plotName)
 Finds a CAE.PostScenarioPlotHandle instance. More...
 
unsafe
NXOpen.CAE.PostScenarioPlotHandle 
FindObjectByDescriptiveName (string visualizationDefinitionName)
 Finds a CAE.PostScenarioPlotHandle based on the descriptive name of the plot. More...
 
unsafe
NXOpen.CAE.PostScenarioPlotHandle 
FindObjectByViewport (int viewportIndex)
 Finds a CAE.PostScenarioPlotHandle based on the viewport index. More...
 
NXOpen.CAE.PostScenarioPlotHandle[] ToArray ()
 Returns an array of NXOpen.CAE.PostScenarioPlotHandle objects. More...
 
- Public Member Functions inherited from NXOpen.TaggedObjectCollection
IEnumerator GetEnumerator ()
 Returns an enumerator that iterates through a collection. 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...
 

Protected Member Functions

override int EnumerateMoveNext (ref Tag currentTag, byte[] state)
 Advances the enumerator to the next element of the collection. More...
 
- Protected Member Functions inherited from NXOpen.TaggedObjectCollection
new void initialize ()
 <exclude> More...
 
- Protected Member Functions inherited from NXOpen.Utilities.NXRemotableObject
void initialize ()
 <exclude> More...
 

Properties

Tag Tag [get]
 Returns the tag of this object. More...
 

Detailed Description

The collection of Plots the scenario is attached to.

Access is provided via NXOpen.CAE.PostScenarioPlotHandle instances.

The Plots are determined by the selected CAE.PostScenarioBuilder.Visualization .

If multiple scenarios are overlaid, the resulting visualization can change.

To obtain an instance of this class, refer to NXOpen.CAE.PostScenario

Created in NX1899.0.0

Member Function Documentation

override int NXOpen.CAE.PostScenarioPlotHandleCollection.EnumerateMoveNext ( ref Tag  currentTag,
byte[]  state 
)
inlineprotectedvirtual

Advances the enumerator to the next element of the collection.

Implements NXOpen.TaggedObjectCollection.

unsafe NXOpen.CAE.PostScenarioPlotHandle NXOpen.CAE.PostScenarioPlotHandleCollection.FindObject ( string  plotName)
inline

Finds a CAE.PostScenarioPlotHandle instance.

In general, this method should not be used in handwritten code and it exists to support record and playback of journals.

For handwritten code, consider using the alternative Find methods of this class.

Created in NX1899.0.0

License requirements: None.

Parameters
plotName
Returns
unsafe NXOpen.CAE.PostScenarioPlotHandle NXOpen.CAE.PostScenarioPlotHandleCollection.FindObjectByDescriptiveName ( string  visualizationDefinitionName)
inline

Finds a CAE.PostScenarioPlotHandle based on the descriptive name of the plot.

Created in NX1899.0.0

License requirements: None.

Parameters
visualizationDefinitionName
Returns
unsafe NXOpen.CAE.PostScenarioPlotHandle NXOpen.CAE.PostScenarioPlotHandleCollection.FindObjectByViewport ( int  viewportIndex)
inline

Finds a CAE.PostScenarioPlotHandle based on the viewport index.

Created in NX1899.0.0

License requirements: None.

Parameters
viewportIndex
Returns
NXOpen.CAE.PostScenarioPlotHandle [] NXOpen.CAE.PostScenarioPlotHandleCollection.ToArray ( )
inline

Returns an array of NXOpen.CAE.PostScenarioPlotHandle objects.

Property Documentation

Tag NXOpen.CAE.PostScenarioPlotHandleCollection.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.