NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::CAE::GraphFromResultProbeBuilder Class Reference

Represents a NXOpen::CAE::GraphFromResultProbeBuilder
This is an abstract class and cannot be instantiated

Created in NX11.0.0. More...

Inheritance diagram for NXOpen::CAE::GraphFromResultProbeBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  PlotType { PlotTypeXy, PlotTypeXYInStack, PlotTypeXyz }
 Defines the Plot Type options. More...
 

Public Member Functions

std::vector
< NXOpen::CAE::PostGraph * > 
GetGraphs ()
 The graphs created will be returned. More...
 
void SetPlotType (NXOpen::CAE::GraphFromResultProbeBuilder::PlotType plotType)
 The plot type will be set
Created in NX11.0.0. More...
 
void SetResultProbes (const std::vector< NXOpen::CAE::ResultProbe * > &resultProbes)
 The plot type will be set
Created in NX11.0.0. More...
 
void SetViewIndex (int viewIndex)
 The view index will be set
Created in NX11.0.0. More...
 
void SetWindowIndex (int windowIndex)
 The window index will be set
Created in NX11.0.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a NXOpen::CAE::GraphFromResultProbeBuilder
This is an abstract class and cannot be instantiated

Created in NX11.0.0.


Member Enumeration Documentation

Defines the Plot Type options.

Enumerator
PlotTypeXy 

xy

PlotTypeXYInStack 

xyin stack

PlotTypeXyz 

xyz

Member Function Documentation

std::vector<NXOpen::CAE::PostGraph *> NXOpen::CAE::GraphFromResultProbeBuilder::GetGraphs ( )

The graphs created will be returned.

Returns
Get all graphs created by probe
Created in NX11.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
void NXOpen::CAE::GraphFromResultProbeBuilder::SetPlotType ( NXOpen::CAE::GraphFromResultProbeBuilder::PlotType  plotType)

The plot type will be set
Created in NX11.0.0.



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

Parameters
plotTypeplot type
void NXOpen::CAE::GraphFromResultProbeBuilder::SetResultProbes ( const std::vector< NXOpen::CAE::ResultProbe * > &  resultProbes)

The plot type will be set
Created in NX11.0.0.



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

Parameters
resultProbesresult probes
void NXOpen::CAE::GraphFromResultProbeBuilder::SetViewIndex ( int  viewIndex)

The view index will be set
Created in NX11.0.0.



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

Parameters
viewIndexview index
void NXOpen::CAE::GraphFromResultProbeBuilder::SetWindowIndex ( int  windowIndex)

The window index will be set
Created in NX11.0.0.



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

Parameters
windowIndexwindow index

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